("alloc-tag");
auto creds = provider->GetAWSCredentials();
if (creds.IsEmpty()) {
std::cerr << "Failed authentication" << std::endl;
}
Aws::S3::S3Client s3Client(clientConfig);
auto outcome = s3Client.ListBuckets();
if (!outcome.IsSuccess()) {
std::cerr << "Failed with error: " << outcome.GetError() << std::endl;
result = 1;
} else {
std::cout << "Found " << outcome.GetResult().GetBuckets().size()
<< " buckets\n";
for (auto &bucket: outcome.GetResult().GetBuckets()) {
std::cout << bucket.GetName() << std::endl;
}
}
}
Aws::ShutdownAPI(options); // Should only be called once.
return result;
}
```
+ 如需 API 詳細資訊，請參閱*《適用於 C\$1\$1 的 AWS SDK API 參考》*中的 [ListBuckets](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/ListBuckets)。
------
#### [ Go ]
**SDK for Go V2**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/gov2/s3#code-examples)中設定和執行。
```
package main
import (
"context"
"errors"
"fmt"
"github.com/aws/aws-sdk-go-v2/config"
"github.com/aws/aws-sdk-go-v2/service/s3"
"github.com/aws/smithy-go"
)
// main uses the AWS SDK for Go V2 to create an Amazon Simple Storage Service
// (Amazon S3) client and list up to 10 buckets in your account.
// This example uses the default settings specified in your shared credentials
// and config files.
func main() {
ctx := context.Background()
sdkConfig, err := config.LoadDefaultConfig(ctx)
if err != nil {
fmt.Println("Couldn't load default configuration. Have you set up your AWS account?")
fmt.Println(err)
return
}
s3Client := s3.NewFromConfig(sdkConfig)
count := 10
fmt.Printf("Let's list up to %v buckets for your account.\n", count)
result, err := s3Client.ListBuckets(ctx, &s3.ListBucketsInput{})
if err != nil {
var ae smithy.APIError
if errors.As(err, &ae) && ae.ErrorCode() == "AccessDenied" {
fmt.Println("You don't have permission to list buckets for this account.")
} else {
fmt.Printf("Couldn't list buckets for your account. Here's why: %v\n", err)
}
return
}
if len(result.Buckets) == 0 {
fmt.Println("You don't have any buckets!")
} else {
if count > len(result.Buckets) {
count = len(result.Buckets)
}
for _, bucket := range result.Buckets[:count] {
fmt.Printf("\t%v\n", *bucket.Name)
}
}
}
```
+ 如需 API 詳細資訊，請參閱*《適用於 Go 的 AWS SDK API 參考》*中的 [ListBuckets](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/s3#Client.ListBuckets)。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/s3#code-examples)中設定和執行。
```
import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.s3.S3Client;
import software.amazon.awssdk.services.s3.model.Bucket;
import software.amazon.awssdk.services.s3.model.ListBucketsResponse;
import software.amazon.awssdk.services.s3.model.S3Exception;
import java.util.List;
/**
* Before running this Java V2 code example, set up your development
* environment, including your credentials.
*
* For more information, see the following documentation topic:
*
* https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/get-started.html
*/
public class HelloS3 {
public static void main(String[] args) {
Region region = Region.US_EAST_1;
S3Client s3 = S3Client.builder()
.region(region)
.build();
listBuckets(s3);
}
/**
* Lists all the S3 buckets associated with the provided AWS S3 client.
*
* @param s3 the S3Client instance used to interact with the AWS S3 service
*/
public static void listBuckets(S3Client s3) {
try {
ListBucketsResponse response = s3.listBuckets();
List bucketList = response.buckets();
bucketList.forEach(bucket -> {
System.out.println("Bucket Name: " + bucket.name());
});
} catch (S3Exception e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
}
}
```
+ 如需 API 詳細資訊，請參閱*《AWS SDK for Java 2.x API 參考》*中的 [ListBuckets](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/ListBuckets)。
------
#### [ JavaScript ]
**適用於 JavaScript (v3) 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/s3#code-examples)中設定和執行。
```
import {
paginateListBuckets,
S3Client,
S3ServiceException,
} from "@aws-sdk/client-s3";
/**
* List the S3 buckets in your configured AWS account.
*/
export const helloS3 = async () => {
// When no region or credentials are provided, the SDK will use the
// region and credentials from the local AWS config.
const client = new S3Client({});
try {
/**
* @type { import("@aws-sdk/client-s3").Bucket[] }
*/
const buckets = [];
for await (const page of paginateListBuckets({ client }, {})) {
buckets.push(...page.Buckets);
}
console.log("Buckets: ");
console.log(buckets.map((bucket) => bucket.Name).join("\n"));
return buckets;
} catch (caught) {
// ListBuckets does not throw any modeled errors. Any error caught
// here will be something generic like `AccessDenied`.
if (caught instanceof S3ServiceException) {
console.error(`${caught.name}: ${caught.message}`);
} else {
// Something besides S3 failed.
throw caught;
}
}
};
```
+ 如需 API 詳細資訊，請參閱*《適用於 JavaScript 的 AWS SDK API 參考》*中的 [ListBuckets](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/s3/command/ListBucketsCommand)。
------
#### [ PHP ]
**適用於 PHP 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code/s3#code-examples)中設定和執行。
```
use Aws\S3\S3Client;
$client = new S3Client(['region' => 'us-west-2']);
$results = $client->listBuckets();
var_dump($results);
```
+ 如需 API 詳細資訊，請參閱*《適用於 PHP 的 AWS SDK API 參考》*中的 [ListBuckets](https://docs.aws.amazon.com/goto/SdkForPHPV3/s3-2006-03-01/ListBuckets)。
------
#### [ Python ]
**適用於 Python 的 SDK (Boto3)**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/s3#code-examples)中設定和執行。
```
import boto3
def hello_s3():
"""
Use the AWS SDK for Python (Boto3) to create an Amazon Simple Storage Service
(Amazon S3) client and list the buckets in your account.
This example uses the default settings specified in your shared credentials
and config files.
"""
# Create an S3 client.
s3_client = boto3.client("s3")
print("Hello, Amazon S3! Let's list your buckets:")
# Create a paginator for the list_buckets operation.
paginator = s3_client.get_paginator("list_buckets")
# Use the paginator to get a list of all buckets.
response_iterator = paginator.paginate(
PaginationConfig={
"PageSize": 50, # Adjust PageSize as needed.
"StartingToken": None,
}
)
# Iterate through the pages of the response.
buckets_found = False
for page in response_iterator:
if "Buckets" in page and page["Buckets"]:
buckets_found = True
for bucket in page["Buckets"]:
print(f"\t{bucket['Name']}")
if not buckets_found:
print("No buckets found!")
if __name__ == "__main__":
hello_s3()
```
+ 如需 API 詳細資訊，請參閱*《適用於 Python (Boto3) 的AWS SDK API 參考》*中的 [ListBuckets](https://docs.aws.amazon.com/goto/boto3/s3-2006-03-01/ListBuckets)。
------
#### [ Ruby ]
**SDK for Ruby**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/ruby/example_code/s3#code-examples)中設定和執行。
```
# frozen_string_literal: true
# S3Manager is a class responsible for managing S3 operations
# such as listing all S3 buckets in the current AWS account.
class S3Manager
def initialize(client)
@client = client
@logger = Logger.new($stdout)
end
# Lists and prints all S3 buckets in the current AWS account.
def list_buckets
@logger.info('Here are the buckets in your account:')
response = @client.list_buckets
if response.buckets.empty?
@logger.info("You don't have any S3 buckets yet.")
else
response.buckets.each do |bucket|
@logger.info("- #{bucket.name}")
end
end
rescue Aws::Errors::ServiceError => e
@logger.error("Encountered an error while listing buckets: #{e.message}")
end
end
if $PROGRAM_NAME == __FILE__
s3_client = Aws::S3::Client.new
manager = S3Manager.new(s3_client)
manager.list_buckets
end
```
+ 如需 API 詳細資訊，請參閱*《適用於 Ruby 的 AWS SDK API 參考》*中的 [ListBuckets](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/ListBuckets)。
------
#### [ Rust ]
**適用於 Rust 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/rustv1/examples/s3#code-examples)中設定和執行。
```
/// S3 Hello World Example using the AWS SDK for Rust.
///
/// This example lists the objects in a bucket, uploads an object to that bucket,
/// and then retrieves the object and prints some S3 information about the object.
/// This shows a number of S3 features, including how to use built-in paginators
/// for large data sets.
///
/// # Arguments
///
/// * `client` - an S3 client configured appropriately for the environment.
/// * `bucket` - the bucket name that the object will be uploaded to. Must be present in the region the `client` is configured to use.
/// * `filename` - a reference to a path that will be read and uploaded to S3.
/// * `key` - the string key that the object will be uploaded as inside the bucket.
async fn list_bucket_and_upload_object(
client: &aws_sdk_s3::Client,
bucket: &str,
filepath: &Path,
key: &str,
) -> Result<(), S3ExampleError> {
// List the buckets in this account
let mut objects = client
.list_objects_v2()
.bucket(bucket)
.into_paginator()
.send();
println!("key\tetag\tlast_modified\tstorage_class");
while let Some(Ok(object)) = objects.next().await {
for item in object.contents() {
println!(
"{}\t{}\t{}\t{}",
item.key().unwrap_or_default(),
item.e_tag().unwrap_or_default(),
item.last_modified()
.map(|lm| format!("{lm}"))
.unwrap_or_default(),
item.storage_class()
.map(|sc| format!("{sc}"))
.unwrap_or_default()
);
}
}
// Prepare a ByteStream around the file, and upload the object using that ByteStream.
let body = aws_sdk_s3::primitives::ByteStream::from_path(filepath)
.await
.map_err(|err| {
S3ExampleError::new(format!(
"Failed to create bytestream for {filepath:?} ({err:?})"
))
})?;
let resp = client
.put_object()
.bucket(bucket)
.key(key)
.body(body)
.send()
.await?;
println!(
"Upload success. Version: {:?}",
resp.version_id()
.expect("S3 Object upload missing version ID")
);
// Retrieve the just-uploaded object.
let resp = client.get_object().bucket(bucket).key(key).send().await?;
println!("etag: {}", resp.e_tag().unwrap_or("(missing)"));
println!("version: {}", resp.version_id().unwrap_or("(missing)"));
Ok(())
}
```
S3ExampleError 公用程式。
```
/// S3ExampleError provides a From impl to extract
/// client-specific error details. This serves as a consistent backup to handling
/// specific service errors, depending on what is needed by the scenario.
/// It is used throughout the code examples for the AWS SDK for Rust.
#[derive(Debug)]
pub struct S3ExampleError(String);
impl S3ExampleError {
pub fn new(value: impl Into) -> Self {
S3ExampleError(value.into())
}
pub fn add_message(self, message: impl Into) -> Self {
S3ExampleError(format!("{}: {}", message.into(), self.0))
}
}
impl From for S3ExampleError {
fn from(value: T) -> Self {
S3ExampleError(format!(
"{}: {}",
value
.code()
.map(String::from)
.unwrap_or("unknown code".into()),
value
.message()
.map(String::from)
.unwrap_or("missing reason".into()),
))
}
}
impl std::error::Error for S3ExampleError {}
impl std::fmt::Display for S3ExampleError {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
write!(f, "{}", self.0)
}
}
```
+ 如需 API 詳細資訊，請參閱*《適用於 Rust 的AWS SDK API 參考》*中的 [ListBuckets](https://docs.rs/aws-sdk-s3/latest/aws_sdk_s3/client/struct.Client.html#method.list_buckets)。
------
# 使用 AWS SDK 了解 Amazon S3 的基本概念
下列程式碼範例示範如何：
+ 建立儲存貯體並上傳檔案到該儲存貯體。
+ 從儲存貯體下載物件。
+ 將物件複製至儲存貯體中的子文件夾。
+ 列出儲存貯體中的物件。
+ 刪除儲存貯體物件和該儲存貯體。
------
#### [ .NET ]
**適用於 .NET 的 SDK (v4)**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv4/S3#code-examples)中設定和執行。
執行展示 Amazon S3 功能的互動式情境。
```
public class S3_Basics
{
public static bool IsInteractive = true;
public static string BucketName = null!;
public static string TempFilePath = null!;
public static S3Wrapper _s3Wrapper = null!;
public static ILogger _logger = null!;
public static async Task Main(string[] args)
{
// Set up dependency injection for the Amazon service.
using var host = Host.CreateDefaultBuilder(args)
.ConfigureServices((_, services) =>
services.AddAWSService()
.AddTransient()
.AddLogging(builder => builder.AddConsole()))
.Build();
_logger = LoggerFactory.Create(builder => builder.AddConsole())
.CreateLogger();
_s3Wrapper = host.Services.GetRequiredService();
var sepBar = new string('-', 45);
Console.WriteLine(sepBar);
Console.WriteLine("Amazon Simple Storage Service (Amazon S3) basic");
Console.WriteLine("procedures. This application will:");
Console.WriteLine("\n\t1. Create a bucket");
Console.WriteLine("\n\t2. Upload an object to the new bucket");
Console.WriteLine("\n\t3. Copy the uploaded object to a folder in the bucket");
Console.WriteLine("\n\t4. List the items in the new bucket");
Console.WriteLine("\n\t5. Delete all the items in the bucket");
Console.WriteLine("\n\t6. Delete the bucket");
Console.WriteLine(sepBar);
await RunScenario(_s3Wrapper, _logger);
Console.WriteLine(sepBar);
Console.WriteLine("The Amazon S3 scenario has successfully completed.");
Console.WriteLine(sepBar);
}
///
/// Run the S3 Basics scenario with injected dependencies.
///
/// The S3 wrapper instance.
/// The logger instance.
/// A Task object.
public static async Task RunScenario(S3Wrapper s3Wrapper, ILogger scenarioLogger)
{
string bucketName = BucketName;
string filePath = TempFilePath;
string keyName = string.Empty;
var sepBar = new string('-', 45);
try
{
// Create a bucket.
Console.WriteLine($"\n{sepBar}");
Console.WriteLine("\nCreate a new Amazon S3 bucket.\n");
Console.WriteLine(sepBar);
if (IsInteractive)
{
Console.Write("Please enter a name for the new bucket: ");
bucketName = Console.ReadLine();
}
else
{
Console.WriteLine($"Using bucket name: {bucketName}");
}
var success = await s3Wrapper.CreateBucketAsync(bucketName);
if (success)
{
Console.WriteLine($"Successfully created bucket: {bucketName}.\n");
}
else
{
Console.WriteLine($"Could not create bucket: {bucketName}.\n");
}
Console.WriteLine(sepBar);
Console.WriteLine("Upload a file to the new bucket.");
Console.WriteLine(sepBar);
if (IsInteractive)
{
// Get the local path and filename for the file to upload.
while (string.IsNullOrEmpty(filePath))
{
Console.Write("Please enter the path and filename of the file to upload: ");
filePath = Console.ReadLine();
// Confirm that the file exists on the local computer.
if (!File.Exists(filePath))
{
Console.WriteLine($"Couldn't find {filePath}. Try again.\n");
filePath = string.Empty;
}
}
}
else
{
// Use the public variable if set, otherwise create a temp file
if (!string.IsNullOrEmpty(TempFilePath))
{
filePath = TempFilePath;
Console.WriteLine($"Using provided test file: {filePath}");
}
else
{
// Create a temporary test file for non-interactive mode
filePath = Path.GetTempFileName();
var testContent = "This is a test file for S3 basics scenario.\nGenerated on: " + DateTime.UtcNow.ToString("yyyy-MM-dd HH:mm:ss UTC");
await File.WriteAllTextAsync(filePath, testContent);
Console.WriteLine($"Created temporary test file: {filePath}");
}
}
// Get the file name from the full path.
keyName = Path.GetFileName(filePath);
success = await s3Wrapper.UploadFileAsync(bucketName, keyName, filePath);
if (success)
{
Console.WriteLine($"Successfully uploaded {keyName} from {filePath} to {bucketName}.\n");
}
else
{
Console.WriteLine($"Could not upload {keyName}.\n");
}
// Set up download path
string downloadPath = string.Empty;
if (IsInteractive)
{
// Now get a new location where we can save the file.
while (string.IsNullOrEmpty(downloadPath))
{
// First get the path to which the file will be downloaded.
Console.Write("Please enter the path where the file will be downloaded: ");
downloadPath = Console.ReadLine();
// Confirm that the file doesn't already exist on the local computer.
if (File.Exists($"{downloadPath}\\{keyName}"))
{
Console.WriteLine($"Sorry, the file already exists in that location.\n");
downloadPath = string.Empty;
}
}
}
else
{
downloadPath = Path.GetTempPath();
var downloadFile = Path.Combine(downloadPath, keyName);
if (File.Exists(downloadFile))
{
File.Delete(downloadFile);
}
Console.WriteLine($"Using download path: {downloadPath}");
}
// Download an object from a bucket.
success = await s3Wrapper.DownloadObjectFromBucketAsync(bucketName, keyName, downloadPath);
if (success)
{
Console.WriteLine($"Successfully downloaded {keyName}.\n");
}
else
{
Console.WriteLine($"Sorry, could not download {keyName}.\n");
}
// Copy the object to a different folder in the bucket.
string folderName = string.Empty;
if (IsInteractive)
{
while (string.IsNullOrEmpty(folderName))
{
Console.Write("Please enter the name of the folder to copy your object to: ");
folderName = Console.ReadLine();
}
}
else
{
folderName = "test-folder";
Console.WriteLine($"Using folder name: {folderName}");
}
await s3Wrapper.CopyObjectInBucketAsync(bucketName, keyName, folderName);
// List the objects in the bucket.
await s3Wrapper.ListBucketContentsAsync(bucketName);
// Delete the contents of the bucket.
if (IsInteractive)
{
Console.WriteLine("Press when you are ready to delete the bucket contents.");
_ = Console.ReadLine();
}
var deleteContentsSuccess = await s3Wrapper.DeleteBucketContentsAsync(bucketName);
if (deleteContentsSuccess)
{
Console.WriteLine($"Successfully deleted contents of {bucketName}.\n");
}
else
{
Console.WriteLine($"Sorry, could not delete contents of {bucketName}.\n");
}
if (IsInteractive)
{
// Deleting the bucket too quickly after separately deleting its contents can
// cause an error that the bucket isn't empty. To delete contents and bucket in one
// operation, use AmazonS3Util.DeleteS3BucketWithObjectsAsync
Console.WriteLine("Press when you are ready to delete the bucket.");
_ = Console.ReadLine();
}
else
{
// Add a small delay for non-interactive mode to ensure objects are fully deleted.
Console.WriteLine("Waiting a moment for objects to be fully deleted...");
await Task.Delay(2000);
}
// Delete the bucket.
var deleteSuccess = await s3Wrapper.DeleteBucketAsync(bucketName);
if (deleteSuccess)
{
Console.WriteLine($"Successfully deleted {bucketName}.\n");
}
else
{
Console.WriteLine($"Sorry, could not delete {bucketName}.\n");
}
// Clean up temporary files in non-interactive mode
if (!IsInteractive)
{
try
{
if (File.Exists(filePath))
{
File.Delete(filePath);
Console.WriteLine("Cleaned up temporary test file.");
}
var downloadFile = Path.Combine(downloadPath, keyName);
if (File.Exists(downloadFile))
{
File.Delete(downloadFile);
Console.WriteLine("Cleaned up downloaded test file.");
}
}
catch (Exception ex)
{
scenarioLogger.LogWarning(ex, "Failed to clean up temporary files.");
}
}
}
catch (Exception ex)
{
scenarioLogger.LogError(ex, "An error occurred during the S3 scenario execution.");
// Clean up on error - delete bucket if it exists
try
{
if (!string.IsNullOrEmpty(bucketName))
{
await s3Wrapper.DeleteBucketContentsAsync(bucketName);
await s3Wrapper.DeleteBucketAsync(bucketName);
}
}
catch (Exception cleanupEx)
{
scenarioLogger.LogError(cleanupEx, "Error during cleanup.");
}
// Clean up temporary files in non-interactive mode
if (!IsInteractive)
{
try
{
if (!string.IsNullOrEmpty(filePath) && File.Exists(filePath))
{
File.Delete(filePath);
}
}
catch (Exception fileCleanupEx)
{
scenarioLogger.LogWarning(fileCleanupEx, "Failed to clean up temporary files during error handling.");
}
}
throw;
}
}
}
```
Amazon S3 SDK 方法的包裝函式類別。
```
using Amazon.S3;
using Amazon.S3.Model;
namespace S3_Actions;
///
/// This class contains all of the methods for working with Amazon Simple
/// Storage Service (Amazon S3) buckets.
///
public class S3Wrapper
{
private readonly IAmazonS3 _amazonS3;
///
/// Initializes a new instance of the class.
///
/// An initialized Amazon S3 client object.
public S3Wrapper(IAmazonS3 amazonS3)
{
_amazonS3 = amazonS3;
}
///
/// Shows how to create a new Amazon S3 bucket.
///
/// The name of the bucket to create.
/// A boolean value representing the success or failure of
/// the bucket creation process.
public async Task CreateBucketAsync(string bucketName)
{
try
{
var request = new PutBucketRequest
{
BucketName = bucketName,
UseClientRegion = true,
};
var response = await _amazonS3.PutBucketAsync(request);
return response.HttpStatusCode == System.Net.HttpStatusCode.OK;
}
catch (AmazonS3Exception ex)
{
Console.WriteLine($"Error creating bucket: '{ex.Message}'");
return false;
}
}
///
/// Shows how to upload a file from the local computer to an Amazon S3
/// bucket.
///
/// The Amazon S3 bucket to which the object
/// will be uploaded.
/// The object to upload.
/// The path, including file name, of the object
/// on the local computer to upload.
/// A boolean value indicating the success or failure of the
/// upload procedure.
public async Task UploadFileAsync(
string bucketName,
string objectName,
string filePath)
{
try
{
var request = new PutObjectRequest
{
BucketName = bucketName,
Key = objectName,
FilePath = filePath,
};
var response = await _amazonS3.PutObjectAsync(request);
return response.HttpStatusCode == System.Net.HttpStatusCode.OK;
}
catch (AmazonS3Exception ex)
{
Console.WriteLine($"Error uploading {objectName}: {ex.Message}");
return false;
}
}
///
/// Shows how to download an object from an Amazon S3 bucket to the
/// local computer.
///
/// The name of the bucket where the object is
/// currently stored.
/// The name of the object to download.
/// The path, including filename, where the
/// downloaded object will be stored.
/// A boolean value indicating the success or failure of the
/// download process.
public async Task DownloadObjectFromBucketAsync(
string bucketName,
string objectName,
string filePath)
{
var request = new GetObjectRequest
{
BucketName = bucketName,
Key = objectName,
};
using GetObjectResponse response = await _amazonS3.GetObjectAsync(request);
try
{
// Save object to local file
await response.WriteResponseStreamToFileAsync($"{filePath}\\{objectName}", true, CancellationToken.None);
return response.HttpStatusCode == System.Net.HttpStatusCode.OK;
}
catch (AmazonS3Exception ex)
{
Console.WriteLine($"Error saving {objectName}: {ex.Message}");
return false;
}
}
///
/// Copies an object in an Amazon S3 bucket to a folder within the
/// same bucket.
///
/// The name of the Amazon S3 bucket where the
/// object to copy is located.
/// The object to be copied.
/// The folder to which the object will
/// be copied.
/// A boolean value that indicates the success or failure of
/// the copy operation.
public async Task CopyObjectInBucketAsync(
string bucketName,
string objectName,
string folderName)
{
try
{
var request = new CopyObjectRequest
{
SourceBucket = bucketName,
SourceKey = objectName,
DestinationBucket = bucketName,
DestinationKey = $"{folderName}\\{objectName}",
};
var response = await _amazonS3.CopyObjectAsync(request);
return response.HttpStatusCode == System.Net.HttpStatusCode.OK;
}
catch (AmazonS3Exception ex)
{
Console.WriteLine($"Error copying object: '{ex.Message}'");
return false;
}
}
///
/// Shows how to list the objects in an Amazon S3 bucket.
///
/// The name of the bucket for which to list.
/// True to print out the list.
/// The collection of objects.
public async Task?> ListBucketContentsAsync(string bucketName, bool printList = true)
{
try
{
var request = new ListObjectsV2Request
{
BucketName = bucketName,
MaxKeys = 5,
};
if (printList)
{
Console.WriteLine("--------------------------------------");
Console.WriteLine($"Listing the contents of {bucketName}:");
Console.WriteLine("--------------------------------------");
}
var listObjectsV2Paginator = _amazonS3.Paginators.ListObjectsV2(new ListObjectsV2Request
{
BucketName = bucketName,
});
var s3Objects = new List();
await foreach (var response in listObjectsV2Paginator.Responses)
{
if (response.S3Objects != null)
{
s3Objects.AddRange(response.S3Objects);
}
}
if (printList)
{
Console.WriteLine($"Number of Objects: {s3Objects.Count}");
foreach (var entry in s3Objects)
{
Console.WriteLine($"Key = {entry.Key} Size = {entry.Size}");
}
}
return s3Objects;
}
catch (AmazonS3Exception ex)
{
Console.WriteLine($"Error encountered on server. Message:'{ex.Message}' getting list of objects.");
return null;
}
}
///
/// Delete all of the objects stored in an existing Amazon S3 bucket.
///
/// The name of the bucket from which the
/// contents will be deleted.
/// A boolean value that represents the success or failure of
/// deleting all of the objects in the bucket.
public async Task DeleteBucketContentsAsync(string bucketName)
{
// Iterate over the contents of the bucket and delete all objects.
try
{
// Delete all objects in the bucket.
var deleteList = await ListBucketContentsAsync(bucketName, false);
if (deleteList != null && deleteList.Any())
{
await _amazonS3.DeleteObjectsAsync(new DeleteObjectsRequest()
{
BucketName = bucketName,
Objects = deleteList.Select(o => new KeyVersion { Key = o.Key }).ToList(),
});
}
return true;
}
catch (AmazonS3Exception ex)
{
Console.WriteLine($"Error deleting objects: {ex.Message}");
return false;
}
}
///
/// Shows how to delete an Amazon S3 bucket.
///
/// The name of the Amazon S3 bucket to delete.
/// A boolean value that represents the success or failure of
/// the delete operation.
public async Task DeleteBucketAsync(string bucketName)
{
try
{
var request = new DeleteBucketRequest { BucketName = bucketName, };
await _amazonS3.DeleteBucketAsync(request);
return true;
}
catch (AmazonS3Exception ex)
{
Console.WriteLine($"Error deleting bucket: {ex.Message}");
return false;
}
}
}
```
+ 如需 API 詳細資訊，請參閱*《適用於 .NET 的 AWS SDK API 參考》*中的下列主題。
+ [CopyObject](https://docs.aws.amazon.com/goto/DotNetSDKV4/s3-2006-03-01/CopyObject)
+ [CreateBucket](https://docs.aws.amazon.com/goto/DotNetSDKV4/s3-2006-03-01/CreateBucket)
+ [DeleteBucket](https://docs.aws.amazon.com/goto/DotNetSDKV4/s3-2006-03-01/DeleteBucket)
+ [DeleteObjects](https://docs.aws.amazon.com/goto/DotNetSDKV4/s3-2006-03-01/DeleteObjects)
+ [GetObject](https://docs.aws.amazon.com/goto/DotNetSDKV4/s3-2006-03-01/GetObject)
+ [ListObjectsV2](https://docs.aws.amazon.com/goto/DotNetSDKV4/s3-2006-03-01/ListObjectsV2)
+ [PutObject](https://docs.aws.amazon.com/goto/DotNetSDKV4/s3-2006-03-01/PutObject)
------
#### [ Bash ]
**AWS CLI 使用 Bash 指令碼**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/aws-cli/bash-linux/s3#code-examples)中設定和執行。
```
###############################################################################
# function s3_getting_started
#
# This function creates, copies, and deletes S3 buckets and objects.
#
# Returns:
# 0 - If successful.
# 1 - If an error occurred.
###############################################################################
function s3_getting_started() {
{
if [ "$BUCKET_OPERATIONS_SOURCED" != "True" ]; then
cd bucket-lifecycle-operations || exit
source ./bucket_operations.sh
cd ..
fi
}
echo_repeat "*" 88
echo "Welcome to the Amazon S3 getting started demo."
echo_repeat "*" 88
echo "A unique bucket will be created by appending a Universally Unique Identifier to a bucket name prefix."
echo -n "Enter a prefix for the S3 bucket that will be used in this demo: "
get_input
bucket_name_prefix=$get_input_result
local bucket_name
bucket_name=$(generate_random_name "$bucket_name_prefix")
local region_code
region_code=$(aws configure get region)
if create_bucket -b "$bucket_name" -r "$region_code"; then
echo "Created demo bucket named $bucket_name"
else
errecho "The bucket failed to create. This demo will exit."
return 1
fi
local file_name
while [ -z "$file_name" ]; do
echo -n "Enter a file you want to upload to your bucket: "
get_input
file_name=$get_input_result
if [ ! -f "$file_name" ]; then
echo "Could not find file $file_name. Are you sure it exists?"
file_name=""
fi
done
local key
key="$(basename "$file_name")"
local result=0
if copy_file_to_bucket "$bucket_name" "$file_name" "$key"; then
echo "Uploaded file $file_name into bucket $bucket_name with key $key."
else
result=1
fi
local destination_file
destination_file="$file_name.download"
if yes_no_input "Would you like to download $key to the file $destination_file? (y/n) "; then
if download_object_from_bucket "$bucket_name" "$destination_file" "$key"; then
echo "Downloaded $key in the bucket $bucket_name to the file $destination_file."
else
result=1
fi
fi
if yes_no_input "Would you like to copy $key a new object key in your bucket? (y/n) "; then
local to_key
to_key="demo/$key"
if copy_item_in_bucket "$bucket_name" "$key" "$to_key"; then
echo "Copied $key in the bucket $bucket_name to the $to_key."
else
result=1
fi
fi
local bucket_items
bucket_items=$(list_items_in_bucket "$bucket_name")
# shellcheck disable=SC2181
if [[ $? -ne 0 ]]; then
result=1
fi
echo "Your bucket contains the following items."
echo -e "Name\t\tSize"
echo "$bucket_items"
if yes_no_input "Delete the bucket, $bucket_name, as well as the objects in it? (y/n) "; then
bucket_items=$(echo "$bucket_items" | cut -f 1)
if delete_items_in_bucket "$bucket_name" "$bucket_items"; then
echo "The following items were deleted from the bucket $bucket_name"
echo "$bucket_items"
else
result=1
fi
if delete_bucket "$bucket_name"; then
echo "Deleted the bucket $bucket_name"
else
result=1
fi
fi
return $result
}
```
此案例中使用的 Amazon S3 函數。
```
###############################################################################
# function create-bucket
#
# This function creates the specified bucket in the specified AWS Region, unless
# it already exists.
#
# Parameters:
# -b bucket_name -- The name of the bucket to create.
# -r region_code -- The code for an AWS Region in which to
# create the bucket.
#
# Returns:
# The URL of the bucket that was created.
# And:
# 0 - If successful.
# 1 - If it fails.
###############################################################################
function create_bucket() {
local bucket_name region_code response
local option OPTARG # Required to use getopts command in a function.
# bashsupport disable=BP5008
function usage() {
echo "function create_bucket"
echo "Creates an Amazon S3 bucket. You must supply a bucket name:"
echo " -b bucket_name The name of the bucket. It must be globally unique."
echo " [-r region_code] The code for an AWS Region in which the bucket is created."
echo ""
}
# Retrieve the calling parameters.
while getopts "b:r:h" option; do
case "${option}" in
b) bucket_name="${OPTARG}" ;;
r) region_code="${OPTARG}" ;;
h)
usage
return 0
;;
\?)
echo "Invalid parameter"
usage
return 1
;;
esac
done
if [[ -z "$bucket_name" ]]; then
errecho "ERROR: You must provide a bucket name with the -b parameter."
usage
return 1
fi
local bucket_config_arg
# A location constraint for "us-east-1" returns an error.
if [[ -n "$region_code" ]] && [[ "$region_code" != "us-east-1" ]]; then
bucket_config_arg="--create-bucket-configuration LocationConstraint=$region_code"
fi
iecho "Parameters:\n"
iecho " Bucket name: $bucket_name"
iecho " Region code: $region_code"
iecho ""
# If the bucket already exists, we don't want to try to create it.
if (bucket_exists "$bucket_name"); then
errecho "ERROR: A bucket with that name already exists. Try again."
return 1
fi
# shellcheck disable=SC2086
response=$(aws s3api create-bucket \
--bucket "$bucket_name" \
$bucket_config_arg)
# shellcheck disable=SC2181
if [[ ${?} -ne 0 ]]; then
errecho "ERROR: AWS reports create-bucket operation failed.\n$response"
return 1
fi
}
###############################################################################
# function copy_file_to_bucket
#
# This function creates a file in the specified bucket.
#
# Parameters:
# $1 - The name of the bucket to copy the file to.
# $2 - The path and file name of the local file to copy to the bucket.
# $3 - The key (name) to call the copy of the file in the bucket.
#
# Returns:
# 0 - If successful.
# 1 - If it fails.
###############################################################################
function copy_file_to_bucket() {
local response bucket_name source_file destination_file_name
bucket_name=$1
source_file=$2
destination_file_name=$3
response=$(aws s3api put-object \
--bucket "$bucket_name" \
--body "$source_file" \
--key "$destination_file_name")
# shellcheck disable=SC2181
if [[ ${?} -ne 0 ]]; then
errecho "ERROR: AWS reports put-object operation failed.\n$response"
return 1
fi
}
###############################################################################
# function download_object_from_bucket
#
# This function downloads an object in a bucket to a file.
#
# Parameters:
# $1 - The name of the bucket to download the object from.
# $2 - The path and file name to store the downloaded bucket.
# $3 - The key (name) of the object in the bucket.
#
# Returns:
# 0 - If successful.
# 1 - If it fails.
###############################################################################
function download_object_from_bucket() {
local bucket_name=$1
local destination_file_name=$2
local object_name=$3
local response
response=$(aws s3api get-object \
--bucket "$bucket_name" \
--key "$object_name" \
"$destination_file_name")
# shellcheck disable=SC2181
if [[ ${?} -ne 0 ]]; then
errecho "ERROR: AWS reports put-object operation failed.\n$response"
return 1
fi
}
###############################################################################
# function copy_item_in_bucket
#
# This function creates a copy of the specified file in the same bucket.
#
# Parameters:
# $1 - The name of the bucket to copy the file from and to.
# $2 - The key of the source file to copy.
# $3 - The key of the destination file.
#
# Returns:
# 0 - If successful.
# 1 - If it fails.
###############################################################################
function copy_item_in_bucket() {
local bucket_name=$1
local source_key=$2
local destination_key=$3
local response
response=$(aws s3api copy-object \
--bucket "$bucket_name" \
--copy-source "$bucket_name/$source_key" \
--key "$destination_key")
# shellcheck disable=SC2181
if [[ $? -ne 0 ]]; then
errecho "ERROR: AWS reports s3api copy-object operation failed.\n$response"
return 1
fi
}
###############################################################################
# function list_items_in_bucket
#
# This function displays a list of the files in the bucket with each file's
# size. The function uses the --query parameter to retrieve only the key and
# size fields from the Contents collection.
#
# Parameters:
# $1 - The name of the bucket.
#
# Returns:
# The list of files in text format.
# And:
# 0 - If successful.
# 1 - If it fails.
###############################################################################
function list_items_in_bucket() {
local bucket_name=$1
local response
response=$(aws s3api list-objects \
--bucket "$bucket_name" \
--output text \
--query 'Contents[].{Key: Key, Size: Size}')
# shellcheck disable=SC2181
if [[ ${?} -eq 0 ]]; then
echo "$response"
else
errecho "ERROR: AWS reports s3api list-objects operation failed.\n$response"
return 1
fi
}
###############################################################################
# function delete_items_in_bucket
#
# This function deletes the specified list of keys from the specified bucket.
#
# Parameters:
# $1 - The name of the bucket.
# $2 - A list of keys in the bucket to delete.
# Returns:
# 0 - If successful.
# 1 - If it fails.
###############################################################################
function delete_items_in_bucket() {
local bucket_name=$1
local keys=$2
local response
# Create the JSON for the items to delete.
local delete_items
delete_items="{\"Objects\":["
for key in $keys; do
delete_items="$delete_items{\"Key\": \"$key\"},"
done
delete_items=${delete_items%?} # Remove the final comma.
delete_items="$delete_items]}"
response=$(aws s3api delete-objects \
--bucket "$bucket_name" \
--delete "$delete_items")
# shellcheck disable=SC2181
if [[ $? -ne 0 ]]; then
errecho "ERROR: AWS reports s3api delete-object operation failed.\n$response"
return 1
fi
}
###############################################################################
# function delete_bucket
#
# This function deletes the specified bucket.
#
# Parameters:
# $1 - The name of the bucket.
# Returns:
# 0 - If successful.
# 1 - If it fails.
###############################################################################
function delete_bucket() {
local bucket_name=$1
local response
response=$(aws s3api delete-bucket \
--bucket "$bucket_name")
# shellcheck disable=SC2181
if [[ $? -ne 0 ]]; then
errecho "ERROR: AWS reports s3api delete-bucket failed.\n$response"
return 1
fi
}
```
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的下列主題。
+ [CopyObject](https://docs.aws.amazon.com/goto/aws-cli/s3-2006-03-01/CopyObject)
+ [CreateBucket](https://docs.aws.amazon.com/goto/aws-cli/s3-2006-03-01/CreateBucket)
+ [DeleteBucket](https://docs.aws.amazon.com/goto/aws-cli/s3-2006-03-01/DeleteBucket)
+ [DeleteObjects](https://docs.aws.amazon.com/goto/aws-cli/s3-2006-03-01/DeleteObjects)
+ [GetObject](https://docs.aws.amazon.com/goto/aws-cli/s3-2006-03-01/GetObject)
+ [ListObjectsV2](https://docs.aws.amazon.com/goto/aws-cli/s3-2006-03-01/ListObjectsV2)
+ [PutObject](https://docs.aws.amazon.com/goto/aws-cli/s3-2006-03-01/PutObject)
------
#### [ C\$1\$1 ]
**適用於 C\$1\$1 的開發套件**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/s3#code-examples)中設定和執行。
```
#include
#include
#include
#include
#include
#include
#include
#include
#include
#include
#include
#include
#include
#include
#include
#include
#include "s3_examples.h"
namespace AwsDoc {
namespace S3 {
//! Delete an S3 bucket.
/*!
\param bucketName: The S3 bucket's name.
\param client: An S3 client.
\return bool: Function succeeded.
*/
static bool
deleteBucket(const Aws::String &bucketName, Aws::S3::S3Client &client);
//! Delete an object in an S3 bucket.
/*!
\param bucketName: The S3 bucket's name.
\param key: The key for the object in the S3 bucket.
\param client: An S3 client.
\return bool: Function succeeded.
*/
static bool
deleteObjectFromBucket(const Aws::String &bucketName, const Aws::String &key,
Aws::S3::S3Client &client);
}
}
//! Scenario to create, copy, and delete S3 buckets and objects.
/*!
\param bucketNamePrefix: A prefix for a bucket name.
\param uploadFilePath: Path to file to upload to an Amazon S3 bucket.
\param saveFilePath: Path for saving a downloaded S3 object.
\param clientConfig: Aws client configuration.
\return bool: Function succeeded.
*/
bool AwsDoc::S3::S3_GettingStartedScenario(const Aws::String &bucketNamePrefix,
const Aws::String &uploadFilePath,
const Aws::String &saveFilePath,
const Aws::Client::ClientConfiguration &clientConfig) {
Aws::S3::S3Client client(clientConfig);
// Create a unique bucket name which is only temporary and will be deleted.
// Format: + "-" + lowercase UUID.
Aws::String uuid = Aws::Utils::UUID::RandomUUID();
Aws::String bucketName = bucketNamePrefix +
Aws::Utils::StringUtils::ToLower(uuid.c_str());
// 1. Create a bucket.
{
Aws::S3::Model::CreateBucketRequest request;
request.SetBucket(bucketName);
if (clientConfig.region != Aws::Region::US_EAST_1) {
Aws::S3::Model::CreateBucketConfiguration createBucketConfiguration;
createBucketConfiguration.WithLocationConstraint(
Aws::S3::Model::BucketLocationConstraintMapper::GetBucketLocationConstraintForName(
clientConfig.region));
request.WithCreateBucketConfiguration(createBucketConfiguration);
}
Aws::S3::Model::CreateBucketOutcome outcome = client.CreateBucket(request);
if (!outcome.IsSuccess()) {
const Aws::S3::S3Error &err = outcome.GetError();
std::cerr << "Error: createBucket: " <<
err.GetExceptionName() << ": " << err.GetMessage() << std::endl;
return false;
} else {
std::cout << "Created the bucket, '" << bucketName <<
"', in the region, '" << clientConfig.region << "'." << std::endl;
}
}
// 2. Upload a local file to the bucket.
Aws::String key = "key-for-test";
{
Aws::S3::Model::PutObjectRequest request;
request.SetBucket(bucketName);
request.SetKey(key);
std::shared_ptr input_data =
Aws::MakeShared("SampleAllocationTag",
uploadFilePath,
std::ios_base::in |
std::ios_base::binary);
if (!input_data->is_open()) {
std::cerr << "Error: unable to open file, '" << uploadFilePath << "'."
<< std::endl;
AwsDoc::S3::deleteBucket(bucketName, client);
return false;
}
request.SetBody(input_data);
Aws::S3::Model::PutObjectOutcome outcome =
client.PutObject(request);
if (!outcome.IsSuccess()) {
std::cerr << "Error: putObject: " <<
outcome.GetError().GetMessage() << std::endl;
AwsDoc::S3::deleteObjectFromBucket(bucketName, key, client);
AwsDoc::S3::deleteBucket(bucketName, client);
return false;
} else {
std::cout << "Added the object with the key, '" << key
<< "', to the bucket, '"
<< bucketName << "'." << std::endl;
}
}
// 3. Download the object to a local file.
{
Aws::S3::Model::GetObjectRequest request;
request.SetBucket(bucketName);
request.SetKey(key);
Aws::S3::Model::GetObjectOutcome outcome =
client.GetObject(request);
if (!outcome.IsSuccess()) {
const Aws::S3::S3Error &err = outcome.GetError();
std::cerr << "Error: getObject: " <<
err.GetExceptionName() << ": " << err.GetMessage() << std::endl;
} else {
std::cout << "Downloaded the object with the key, '" << key
<< "', in the bucket, '"
<< bucketName << "'." << std::endl;
Aws::IOStream &ioStream = outcome.GetResultWithOwnership().
GetBody();
Aws::OFStream outStream(saveFilePath,
std::ios_base::out | std::ios_base::binary);
if (!outStream.is_open()) {
std::cout << "Error: unable to open file, '" << saveFilePath << "'."
<< std::endl;
} else {
outStream << ioStream.rdbuf();
std::cout << "Wrote the downloaded object to the file '"
<< saveFilePath << "'." << std::endl;
}
}
}
// 4. Copy the object to a different "folder" in the bucket.
Aws::String copiedToKey = "test-folder/" + key;
{
Aws::S3::Model::CopyObjectRequest request;
request.WithBucket(bucketName)
.WithKey(copiedToKey)
.WithCopySource(bucketName + "/" + key);
Aws::S3::Model::CopyObjectOutcome outcome =
client.CopyObject(request);
if (!outcome.IsSuccess()) {
std::cerr << "Error: copyObject: " <<
outcome.GetError().GetMessage() << std::endl;
} else {
std::cout << "Copied the object with the key, '" << key
<< "', to the key, '" << copiedToKey
<< ", in the bucket, '" << bucketName << "'." << std::endl;
}
}
// 5. List objects in the bucket.
{
Aws::S3::Model::ListObjectsV2Request request;
request.WithBucket(bucketName);
Aws::String continuationToken;
Aws::Vector allObjects;
do {
if (!continuationToken.empty()) {
request.SetContinuationToken(continuationToken);
}
Aws::S3::Model::ListObjectsV2Outcome outcome = client.ListObjectsV2(
request);
if (!outcome.IsSuccess()) {
std::cerr << "Error: ListObjects: " <<
outcome.GetError().GetMessage() << std::endl;
break;
} else {
Aws::Vector objects =
outcome.GetResult().GetContents();
allObjects.insert(allObjects.end(), objects.begin(), objects.end());
continuationToken = outcome.GetResult().GetContinuationToken();
}
} while (!continuationToken.empty());
std::cout << allObjects.size() << " objects in the bucket, '" << bucketName
<< "':" << std::endl;
for (Aws::S3::Model::Object &object: allObjects) {
std::cout << " '" << object.GetKey() << "'" << std::endl;
}
}
// 6. Delete all objects in the bucket.
// All objects in the bucket must be deleted before deleting the bucket.
AwsDoc::S3::deleteObjectFromBucket(bucketName, copiedToKey, client);
AwsDoc::S3::deleteObjectFromBucket(bucketName, key, client);
// 7. Delete the bucket.
return AwsDoc::S3::deleteBucket(bucketName, client);
}
bool AwsDoc::S3::deleteObjectFromBucket(const Aws::String &bucketName,
const Aws::String &key,
Aws::S3::S3Client &client) {
Aws::S3::Model::DeleteObjectRequest request;
request.SetBucket(bucketName);
request.SetKey(key);
Aws::S3::Model::DeleteObjectOutcome outcome =
client.DeleteObject(request);
if (!outcome.IsSuccess()) {
std::cerr << "Error: deleteObject: " <<
outcome.GetError().GetMessage() << std::endl;
} else {
std::cout << "Deleted the object with the key, '" << key
<< "', from the bucket, '"
<< bucketName << "'." << std::endl;
}
return outcome.IsSuccess();
}
bool
AwsDoc::S3::deleteBucket(const Aws::String &bucketName, Aws::S3::S3Client &client) {
Aws::S3::Model::DeleteBucketRequest request;
request.SetBucket(bucketName);
Aws::S3::Model::DeleteBucketOutcome outcome =
client.DeleteBucket(request);
if (!outcome.IsSuccess()) {
const Aws::S3::S3Error &err = outcome.GetError();
std::cerr << "Error: deleteBucket: " <<
err.GetExceptionName() << ": " << err.GetMessage() << std::endl;
} else {
std::cout << "Deleted the bucket, '" << bucketName << "'." << std::endl;
}
return outcome.IsSuccess();
}
```
+ 如需 API 詳細資訊，請參閱《*適用於 C\$1\$1 的 AWS SDK API 參考*》中的下列主題。
+ [CopyObject](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/CopyObject)
+ [CreateBucket](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/CreateBucket)
+ [DeleteBucket](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/DeleteBucket)
+ [DeleteObjects](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/DeleteObjects)
+ [GetObject](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/GetObject)
+ [ListObjectsV2](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/ListObjectsV2)
+ [PutObject](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/PutObject)
------
#### [ Go ]
**SDK for Go V2**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/gov2/s3#code-examples)中設定和執行。
定義包裝案例所使用之儲存貯體和物件動作的結構。
```
import (
"bytes"
"context"
"errors"
"fmt"
"io"
"log"
"os"
"time"
"github.com/aws/aws-sdk-go-v2/aws"
"github.com/aws/aws-sdk-go-v2/feature/s3/manager"
"github.com/aws/aws-sdk-go-v2/service/s3"
"github.com/aws/aws-sdk-go-v2/service/s3/types"
"github.com/aws/smithy-go"
)
// BucketBasics encapsulates the Amazon Simple Storage Service (Amazon S3) actions
// used in the examples.
// It contains S3Client, an Amazon S3 service client that is used to perform bucket
// and object actions.
type BucketBasics struct {
S3Client *s3.Client
}
// ListBuckets lists the buckets in the current account.
func (basics BucketBasics) ListBuckets(ctx context.Context) ([]types.Bucket, error) {
var err error
var output *s3.ListBucketsOutput
var buckets []types.Bucket
bucketPaginator := s3.NewListBucketsPaginator(basics.S3Client, &s3.ListBucketsInput{})
for bucketPaginator.HasMorePages() {
output, err = bucketPaginator.NextPage(ctx)
if err != nil {
var apiErr smithy.APIError
if errors.As(err, &apiErr) && apiErr.ErrorCode() == "AccessDenied" {
fmt.Println("You don't have permission to list buckets for this account.")
err = apiErr
} else {
log.Printf("Couldn't list buckets for your account. Here's why: %v\n", err)
}
break
} else {
buckets = append(buckets, output.Buckets...)
}
}
return buckets, err
}
// BucketExists checks whether a bucket exists in the current account.
func (basics BucketBasics) BucketExists(ctx context.Context, bucketName string) (bool, error) {
_, err := basics.S3Client.HeadBucket(ctx, &s3.HeadBucketInput{
Bucket: aws.String(bucketName),
})
exists := true
if err != nil {
var apiError smithy.APIError
if errors.As(err, &apiError) {
switch apiError.(type) {
case *types.NotFound:
log.Printf("Bucket %v is available.\n", bucketName)
exists = false
err = nil
default:
log.Printf("Either you don't have access to bucket %v or another error occurred. "+
"Here's what happened: %v\n", bucketName, err)
}
}
} else {
log.Printf("Bucket %v exists and you already own it.", bucketName)
}
return exists, err
}
// CreateBucket creates a bucket with the specified name in the specified Region.
func (basics BucketBasics) CreateBucket(ctx context.Context, name string, region string) error {
_, err := basics.S3Client.CreateBucket(ctx, &s3.CreateBucketInput{
Bucket: aws.String(name),
CreateBucketConfiguration: &types.CreateBucketConfiguration{
LocationConstraint: types.BucketLocationConstraint(region),
},
})
if err != nil {
var owned *types.BucketAlreadyOwnedByYou
var exists *types.BucketAlreadyExists
if errors.As(err, &owned) {
log.Printf("You already own bucket %s.\n", name)
err = owned
} else if errors.As(err, &exists) {
log.Printf("Bucket %s already exists.\n", name)
err = exists
}
} else {
err = s3.NewBucketExistsWaiter(basics.S3Client).Wait(
ctx, &s3.HeadBucketInput{Bucket: aws.String(name)}, time.Minute)
if err != nil {
log.Printf("Failed attempt to wait for bucket %s to exist.\n", name)
}
}
return err
}
// UploadFile reads from a file and puts the data into an object in a bucket.
func (basics BucketBasics) UploadFile(ctx context.Context, bucketName string, objectKey string, fileName string) error {
file, err := os.Open(fileName)
if err != nil {
log.Printf("Couldn't open file %v to upload. Here's why: %v\n", fileName, err)
} else {
defer file.Close()
_, err = basics.S3Client.PutObject(ctx, &s3.PutObjectInput{
Bucket: aws.String(bucketName),
Key: aws.String(objectKey),
Body: file,
})
if err != nil {
var apiErr smithy.APIError
if errors.As(err, &apiErr) && apiErr.ErrorCode() == "EntityTooLarge" {
log.Printf("Error while uploading object to %s. The object is too large.\n"+
"To upload objects larger than 5GB, use the S3 console (160GB max)\n"+
"or the multipart upload API (5TB max).", bucketName)
} else {
log.Printf("Couldn't upload file %v to %v:%v. Here's why: %v\n",
fileName, bucketName, objectKey, err)
}
} else {
err = s3.NewObjectExistsWaiter(basics.S3Client).Wait(
ctx, &s3.HeadObjectInput{Bucket: aws.String(bucketName), Key: aws.String(objectKey)}, time.Minute)
if err != nil {
log.Printf("Failed attempt to wait for object %s to exist.\n", objectKey)
}
}
}
return err
}
// UploadLargeObject uses an upload manager to upload data to an object in a bucket.
// The upload manager breaks large data into parts and uploads the parts concurrently.
func (basics BucketBasics) UploadLargeObject(ctx context.Context, bucketName string, objectKey string, largeObject []byte) error {
largeBuffer := bytes.NewReader(largeObject)
var partMiBs int64 = 10
uploader := manager.NewUploader(basics.S3Client, func(u *manager.Uploader) {
u.PartSize = partMiBs * 1024 * 1024
})
_, err := uploader.Upload(ctx, &s3.PutObjectInput{
Bucket: aws.String(bucketName),
Key: aws.String(objectKey),
Body: largeBuffer,
})
if err != nil {
var apiErr smithy.APIError
if errors.As(err, &apiErr) && apiErr.ErrorCode() == "EntityTooLarge" {
log.Printf("Error while uploading object to %s. The object is too large.\n"+
"The maximum size for a multipart upload is 5TB.", bucketName)
} else {
log.Printf("Couldn't upload large object to %v:%v. Here's why: %v\n",
bucketName, objectKey, err)
}
} else {
err = s3.NewObjectExistsWaiter(basics.S3Client).Wait(
ctx, &s3.HeadObjectInput{Bucket: aws.String(bucketName), Key: aws.String(objectKey)}, time.Minute)
if err != nil {
log.Printf("Failed attempt to wait for object %s to exist.\n", objectKey)
}
}
return err
}
// DownloadFile gets an object from a bucket and stores it in a local file.
func (basics BucketBasics) DownloadFile(ctx context.Context, bucketName string, objectKey string, fileName string) error {
result, err := basics.S3Client.GetObject(ctx, &s3.GetObjectInput{
Bucket: aws.String(bucketName),
Key: aws.String(objectKey),
})
if err != nil {
var noKey *types.NoSuchKey
if errors.As(err, &noKey) {
log.Printf("Can't get object %s from bucket %s. No such key exists.\n", objectKey, bucketName)
err = noKey
} else {
log.Printf("Couldn't get object %v:%v. Here's why: %v\n", bucketName, objectKey, err)
}
return err
}
defer result.Body.Close()
file, err := os.Create(fileName)
if err != nil {
log.Printf("Couldn't create file %v. Here's why: %v\n", fileName, err)
return err
}
defer file.Close()
body, err := io.ReadAll(result.Body)
if err != nil {
log.Printf("Couldn't read object body from %v. Here's why: %v\n", objectKey, err)
}
_, err = file.Write(body)
return err
}
// DownloadLargeObject uses a download manager to download an object from a bucket.
// The download manager gets the data in parts and writes them to a buffer until all of
// the data has been downloaded.
func (basics BucketBasics) DownloadLargeObject(ctx context.Context, bucketName string, objectKey string) ([]byte, error) {
var partMiBs int64 = 10
downloader := manager.NewDownloader(basics.S3Client, func(d *manager.Downloader) {
d.PartSize = partMiBs * 1024 * 1024
})
buffer := manager.NewWriteAtBuffer([]byte{})
_, err := downloader.Download(ctx, buffer, &s3.GetObjectInput{
Bucket: aws.String(bucketName),
Key: aws.String(objectKey),
})
if err != nil {
log.Printf("Couldn't download large object from %v:%v. Here's why: %v\n",
bucketName, objectKey, err)
}
return buffer.Bytes(), err
}
// CopyToFolder copies an object in a bucket to a subfolder in the same bucket.
func (basics BucketBasics) CopyToFolder(ctx context.Context, bucketName string, objectKey string, folderName string) error {
objectDest := fmt.Sprintf("%v/%v", folderName, objectKey)
_, err := basics.S3Client.CopyObject(ctx, &s3.CopyObjectInput{
Bucket: aws.String(bucketName),
CopySource: aws.String(fmt.Sprintf("%v/%v", bucketName, objectKey)),
Key: aws.String(objectDest),
})
if err != nil {
var notActive *types.ObjectNotInActiveTierError
if errors.As(err, ¬Active) {
log.Printf("Couldn't copy object %s from %s because the object isn't in the active tier.\n",
objectKey, bucketName)
err = notActive
}
} else {
err = s3.NewObjectExistsWaiter(basics.S3Client).Wait(
ctx, &s3.HeadObjectInput{Bucket: aws.String(bucketName), Key: aws.String(objectDest)}, time.Minute)
if err != nil {
log.Printf("Failed attempt to wait for object %s to exist.\n", objectDest)
}
}
return err
}
// CopyToBucket copies an object in a bucket to another bucket.
func (basics BucketBasics) CopyToBucket(ctx context.Context, sourceBucket string, destinationBucket string, objectKey string) error {
_, err := basics.S3Client.CopyObject(ctx, &s3.CopyObjectInput{
Bucket: aws.String(destinationBucket),
CopySource: aws.String(fmt.Sprintf("%v/%v", sourceBucket, objectKey)),
Key: aws.String(objectKey),
})
if err != nil {
var notActive *types.ObjectNotInActiveTierError
if errors.As(err, ¬Active) {
log.Printf("Couldn't copy object %s from %s because the object isn't in the active tier.\n",
objectKey, sourceBucket)
err = notActive
}
} else {
err = s3.NewObjectExistsWaiter(basics.S3Client).Wait(
ctx, &s3.HeadObjectInput{Bucket: aws.String(destinationBucket), Key: aws.String(objectKey)}, time.Minute)
if err != nil {
log.Printf("Failed attempt to wait for object %s to exist.\n", objectKey)
}
}
return err
}
// ListObjects lists the objects in a bucket.
func (basics BucketBasics) ListObjects(ctx context.Context, bucketName string) ([]types.Object, error) {
var err error
var output *s3.ListObjectsV2Output
input := &s3.ListObjectsV2Input{
Bucket: aws.String(bucketName),
}
var objects []types.Object
objectPaginator := s3.NewListObjectsV2Paginator(basics.S3Client, input)
for objectPaginator.HasMorePages() {
output, err = objectPaginator.NextPage(ctx)
if err != nil {
var noBucket *types.NoSuchBucket
if errors.As(err, &noBucket) {
log.Printf("Bucket %s does not exist.\n", bucketName)
err = noBucket
}
break
} else {
objects = append(objects, output.Contents...)
}
}
return objects, err
}
// DeleteObjects deletes a list of objects from a bucket.
func (basics BucketBasics) DeleteObjects(ctx context.Context, bucketName string, objectKeys []string) error {
var objectIds []types.ObjectIdentifier
for _, key := range objectKeys {
objectIds = append(objectIds, types.ObjectIdentifier{Key: aws.String(key)})
}
output, err := basics.S3Client.DeleteObjects(ctx, &s3.DeleteObjectsInput{
Bucket: aws.String(bucketName),
Delete: &types.Delete{Objects: objectIds, Quiet: aws.Bool(true)},
})
if err != nil || len(output.Errors) > 0 {
log.Printf("Error deleting objects from bucket %s.\n", bucketName)
if err != nil {
var noBucket *types.NoSuchBucket
if errors.As(err, &noBucket) {
log.Printf("Bucket %s does not exist.\n", bucketName)
err = noBucket
}
} else if len(output.Errors) > 0 {
for _, outErr := range output.Errors {
log.Printf("%s: %s\n", *outErr.Key, *outErr.Message)
}
err = fmt.Errorf("%s", *output.Errors[0].Message)
}
} else {
for _, delObjs := range output.Deleted {
err = s3.NewObjectNotExistsWaiter(basics.S3Client).Wait(
ctx, &s3.HeadObjectInput{Bucket: aws.String(bucketName), Key: delObjs.Key}, time.Minute)
if err != nil {
log.Printf("Failed attempt to wait for object %s to be deleted.\n", *delObjs.Key)
} else {
log.Printf("Deleted %s.\n", *delObjs.Key)
}
}
}
return err
}
// DeleteBucket deletes a bucket. The bucket must be empty or an error is returned.
func (basics BucketBasics) DeleteBucket(ctx context.Context, bucketName string) error {
_, err := basics.S3Client.DeleteBucket(ctx, &s3.DeleteBucketInput{
Bucket: aws.String(bucketName)})
if err != nil {
var noBucket *types.NoSuchBucket
if errors.As(err, &noBucket) {
log.Printf("Bucket %s does not exist.\n", bucketName)
err = noBucket
} else {
log.Printf("Couldn't delete bucket %v. Here's why: %v\n", bucketName, err)
}
} else {
err = s3.NewBucketNotExistsWaiter(basics.S3Client).Wait(
ctx, &s3.HeadBucketInput{Bucket: aws.String(bucketName)}, time.Minute)
if err != nil {
log.Printf("Failed attempt to wait for bucket %s to be deleted.\n", bucketName)
} else {
log.Printf("Deleted %s.\n", bucketName)
}
}
return err
}
```
執行互動式情境，示範如何使用 S3 儲存貯體和物件。
```
import (
"context"
"fmt"
"log"
"os"
"strings"
"github.com/aws/aws-sdk-go-v2/aws"
"github.com/aws/aws-sdk-go-v2/service/s3"
"github.com/awsdocs/aws-doc-sdk-examples/gov2/demotools"
"github.com/awsdocs/aws-doc-sdk-examples/gov2/s3/actions"
)
// RunGetStartedScenario is an interactive example that shows you how to use Amazon
// Simple Storage Service (Amazon S3) to create an S3 bucket and use it to store objects.
//
// 1. Create a bucket.
// 2. Upload a local file to the bucket.
// 3. Download an object to a local file.
// 4. Copy an object to a different folder in the bucket.
// 5. List objects in the bucket.
// 6. Delete all objects in the bucket.
// 7. Delete the bucket.
//
// This example creates an Amazon S3 service client from the specified sdkConfig so that
// you can replace it with a mocked or stubbed config for unit testing.
//
// It uses a questioner from the `demotools` package to get input during the example.
// This package can be found in the ..\..\demotools folder of this repo.
func RunGetStartedScenario(ctx context.Context, sdkConfig aws.Config, questioner demotools.IQuestioner) {
defer func() {
if r := recover(); r != nil {
log.Println("Something went wrong with the demo.")
_, isMock := questioner.(*demotools.MockQuestioner)
if isMock || questioner.AskBool("Do you want to see the full error message (y/n)?", "y") {
log.Println(r)
}
}
}()
log.Println(strings.Repeat("-", 88))
log.Println("Welcome to the Amazon S3 getting started demo.")
log.Println(strings.Repeat("-", 88))
s3Client := s3.NewFromConfig(sdkConfig)
bucketBasics := actions.BucketBasics{S3Client: s3Client}
count := 10
log.Printf("Let's list up to %v buckets for your account:", count)
buckets, err := bucketBasics.ListBuckets(ctx)
if err != nil {
panic(err)
}
if len(buckets) == 0 {
log.Println("You don't have any buckets!")
} else {
if count > len(buckets) {
count = len(buckets)
}
for _, bucket := range buckets[:count] {
log.Printf("\t%v\n", *bucket.Name)
}
}
bucketName := questioner.Ask("Let's create a bucket. Enter a name for your bucket:",
demotools.NotEmpty{})
bucketExists, err := bucketBasics.BucketExists(ctx, bucketName)
if err != nil {
panic(err)
}
if !bucketExists {
err = bucketBasics.CreateBucket(ctx, bucketName, sdkConfig.Region)
if err != nil {
panic(err)
} else {
log.Println("Bucket created.")
}
}
log.Println(strings.Repeat("-", 88))
fmt.Println("Let's upload a file to your bucket.")
smallFile := questioner.Ask("Enter the path to a file you want to upload:",
demotools.NotEmpty{})
const smallKey = "doc-example-key"
err = bucketBasics.UploadFile(ctx, bucketName, smallKey, smallFile)
if err != nil {
panic(err)
}
log.Printf("Uploaded %v as %v.\n", smallFile, smallKey)
log.Println(strings.Repeat("-", 88))
log.Printf("Let's download %v to a file.", smallKey)
downloadFileName := questioner.Ask("Enter a name for the downloaded file:", demotools.NotEmpty{})
err = bucketBasics.DownloadFile(ctx, bucketName, smallKey, downloadFileName)
if err != nil {
panic(err)
}
log.Printf("File %v downloaded.", downloadFileName)
log.Println(strings.Repeat("-", 88))
log.Printf("Let's copy %v to a folder in the same bucket.", smallKey)
folderName := questioner.Ask("Enter a folder name: ", demotools.NotEmpty{})
err = bucketBasics.CopyToFolder(ctx, bucketName, smallKey, folderName)
if err != nil {
panic(err)
}
log.Printf("Copied %v to %v/%v.\n", smallKey, folderName, smallKey)
log.Println(strings.Repeat("-", 88))
log.Println("Let's list the objects in your bucket.")
questioner.Ask("Press Enter when you're ready.")
objects, err := bucketBasics.ListObjects(ctx, bucketName)
if err != nil {
panic(err)
}
log.Printf("Found %v objects.\n", len(objects))
var objKeys []string
for _, object := range objects {
objKeys = append(objKeys, *object.Key)
log.Printf("\t%v\n", *object.Key)
}
log.Println(strings.Repeat("-", 88))
if questioner.AskBool("Do you want to delete your bucket and all of its "+
"contents? (y/n)", "y") {
log.Println("Deleting objects.")
err = bucketBasics.DeleteObjects(ctx, bucketName, objKeys)
if err != nil {
panic(err)
}
log.Println("Deleting bucket.")
err = bucketBasics.DeleteBucket(ctx, bucketName)
if err != nil {
panic(err)
}
log.Printf("Deleting downloaded file %v.\n", downloadFileName)
err = os.Remove(downloadFileName)
if err != nil {
panic(err)
}
} else {
log.Println("Okay. Don't forget to delete objects from your bucket to avoid charges.")
}
log.Println(strings.Repeat("-", 88))
log.Println("Thanks for watching!")
log.Println(strings.Repeat("-", 88))
}
```
+ 如需 API 詳細資訊，請參閱*《適用於 Go 的 AWS SDK API 參考》*中的下列主題。
+ [CopyObject](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/s3#Client.CopyObject)
+ [CreateBucket](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/s3#Client.CreateBucket)
+ [DeleteBucket](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/s3#Client.DeleteBucket)
+ [DeleteObjects](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/s3#Client.DeleteObjects)
+ [GetObject](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/s3#Client.GetObject)
+ [ListObjectsV2](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/s3#Client.ListObjectsV2)
+ [PutObject](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/s3#Client.PutObject)
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/s3#code-examples)中設定和執行。
案例範例。
```
import java.io.IOException;
import java.util.Scanner;
import java.util.UUID;
import java.util.concurrent.CompletableFuture;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import software.amazon.awssdk.services.s3.model.PutObjectResponse;
import software.amazon.awssdk.services.s3.model.S3Exception;
/**
* Before running this Java V2 code example, set up your development
* environment, including your credentials.
*
* For more information, see the following documentation topic:
*
* https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/get-started.html
*
* This Java code example performs the following tasks:
*
* 1. Creates an Amazon S3 bucket.
* 2. Uploads an object to the bucket.
* 3. Downloads the object to another local file.
* 4. Uploads an object using multipart upload.
* 5. List all objects located in the Amazon S3 bucket.
* 6. Copies the object to another Amazon S3 bucket.
* 7. Copy the object to another Amazon S3 bucket using multi copy.
* 8. Deletes the object from the Amazon S3 bucket.
* 9. Deletes the Amazon S3 bucket.
*/
public class S3Scenario {
public static Scanner scanner = new Scanner(System.in);
static S3Actions s3Actions = new S3Actions();
public static final String DASHES = new String(new char[80]).replace("\0", "-");
private static final Logger logger = LoggerFactory.getLogger(S3Scenario.class);
public static void main(String[] args) throws IOException {
final String usage = """
Usage:
Where:
bucketName - The name of the S3 bucket.
key - The unique identifier for the object stored in the S3 bucket.
objectPath - The full file path of the object within the S3 bucket (e.g., "documents/reports/annual_report.pdf").
savePath - The local file path where the object will be downloaded and saved (e.g., "C:/Users/username/Downloads/annual_report.pdf").
toBucket - The name of the S3 bucket to which the object will be copied.
""";
if (args.length != 5) {
logger.info(usage);
return;
}
String bucketName = args[0];
String key = args[1];
String objectPath = args[2];
String savePath = args[3];
String toBucket = args[4];
logger.info(DASHES);
logger.info("Welcome to the Amazon Simple Storage Service (S3) example scenario.");
logger.info("""
Amazon S3 is a highly scalable and durable object storage
service provided by Amazon Web Services (AWS). It is designed to store and retrieve
any amount of data, from anywhere on the web, at any time.
The `S3AsyncClient` interface in the AWS SDK for Java 2.x provides a set of methods to
programmatically interact with the Amazon S3 (Simple Storage Service) service. This allows
developers to automate the management and manipulation of S3 buckets and objects as
part of their application deployment pipelines. With S3, teams can focus on building
and deploying their applications without having to worry about the underlying storage
infrastructure required to host and manage large amounts of data.
This scenario walks you through how to perform key operations for this service.
Let's get started...
""");
waitForInputToContinue(scanner);
logger.info(DASHES);
try {
// Run the methods that belong to this scenario.
runScenario(bucketName, key, objectPath, savePath, toBucket);
} catch (Throwable rt) {
Throwable cause = rt.getCause();
if (cause instanceof S3Exception kmsEx) {
logger.info("KMS error occurred: Error message: {}, Error code {}", kmsEx.getMessage(), kmsEx.awsErrorDetails().errorCode());
} else {
logger.info("An unexpected error occurred: " + rt.getMessage());
}
}
}
private static void runScenario(String bucketName, String key, String objectPath, String savePath, String toBucket) throws Throwable {
logger.info(DASHES);
logger.info("1. Create an Amazon S3 bucket.");
try {
CompletableFuture future = s3Actions.createBucketAsync(bucketName);
future.join();
waitForInputToContinue(scanner);
} catch (RuntimeException rt) {
Throwable cause = rt.getCause();
if (cause instanceof S3Exception s3Ex) {
logger.info("S3 error occurred: Error message: {}, Error code {}", s3Ex.getMessage(), s3Ex.awsErrorDetails().errorCode());
} else {
logger.info("An unexpected error occurred: " + rt.getMessage());
}
throw cause;
}
logger.info(DASHES);
logger.info(DASHES);
logger.info("2. Upload a local file to the Amazon S3 bucket.");
waitForInputToContinue(scanner);
try {
CompletableFuture future = s3Actions.uploadLocalFileAsync(bucketName, key, objectPath);
future.join();
logger.info("File uploaded successfully to {}/{}", bucketName, key);
} catch (RuntimeException rt) {
Throwable cause = rt.getCause();
if (cause instanceof S3Exception s3Ex) {
logger.info("S3 error occurred: Error message: {}, Error code {}", s3Ex.getMessage(), s3Ex.awsErrorDetails().errorCode());
} else {
logger.info("An unexpected error occurred: " + rt.getMessage());
}
throw cause;
}
waitForInputToContinue(scanner);
logger.info(DASHES);
logger.info(DASHES);
logger.info("3. Download the object to another local file.");
waitForInputToContinue(scanner);
try {
CompletableFuture future = s3Actions.getObjectBytesAsync(bucketName, key, savePath);
future.join();
logger.info("Successfully obtained bytes from S3 object and wrote to file {}", savePath);
} catch (RuntimeException rt) {
Throwable cause = rt.getCause();
if (cause instanceof S3Exception s3Ex) {
logger.info("S3 error occurred: Error message: {}, Error code {}", s3Ex.getMessage(), s3Ex.awsErrorDetails().errorCode());
} else {
logger.info("An unexpected error occurred: " + rt.getMessage());
}
throw cause;
}
waitForInputToContinue(scanner);
logger.info(DASHES);
logger.info(DASHES);
logger.info("4. Perform a multipart upload.");
waitForInputToContinue(scanner);
String multipartKey = "multiPartKey";
try {
// Call the multipartUpload method
CompletableFuture future = s3Actions.multipartUpload(bucketName, multipartKey);
future.join();
logger.info("Multipart upload completed successfully for bucket '{}' and key '{}'", bucketName, multipartKey);
} catch (RuntimeException rt) {
Throwable cause = rt.getCause();
if (cause instanceof S3Exception s3Ex) {
logger.info("S3 error occurred: Error message: {}, Error code {}", s3Ex.getMessage(), s3Ex.awsErrorDetails().errorCode());
} else {
logger.info("An unexpected error occurred: " + rt.getMessage());
}
throw cause;
}
waitForInputToContinue(scanner);
logger.info(DASHES);
logger.info(DASHES);
logger.info("5. List all objects located in the Amazon S3 bucket.");
waitForInputToContinue(scanner);
try {
CompletableFuture future = s3Actions.listAllObjectsAsync(bucketName);
future.join();
logger.info("Object listing completed successfully.");
} catch (RuntimeException rt) {
Throwable cause = rt.getCause();
if (cause instanceof S3Exception s3Ex) {
logger.info("S3 error occurred: Error message: {}, Error code {}", s3Ex.getMessage(), s3Ex.awsErrorDetails().errorCode());
} else {
logger.info("An unexpected error occurred: " + rt.getMessage());
}
throw cause;
}
waitForInputToContinue(scanner);
logger.info(DASHES);
logger.info(DASHES);
logger.info("6. Copy the object to another Amazon S3 bucket.");
waitForInputToContinue(scanner);
try {
CompletableFuture future = s3Actions.copyBucketObjectAsync(bucketName, key, toBucket);
String result = future.join();
logger.info("Copy operation result: {}", result);
} catch (RuntimeException rt) {
Throwable cause = rt.getCause();
if (cause instanceof S3Exception s3Ex) {
logger.info("S3 error occurred: Error message: {}, Error code {}", s3Ex.getMessage(), s3Ex.awsErrorDetails().errorCode());
} else {
logger.info("An unexpected error occurred: " + rt.getMessage());
}
throw cause;
}
waitForInputToContinue(scanner);
logger.info(DASHES);
logger.info(DASHES);
logger.info("7. Copy the object to another Amazon S3 bucket using multi copy.");
waitForInputToContinue(scanner);
try {
CompletableFuture future = s3Actions.performMultiCopy(toBucket, bucketName, key);
String result = future.join();
logger.info("Copy operation result: {}", result);
} catch (RuntimeException rt) {
Throwable cause = rt.getCause();
if (cause instanceof S3Exception s3Ex) {
logger.info("KMS error occurred: Error message: {}, Error code {}", s3Ex.getMessage(), s3Ex.awsErrorDetails().errorCode());
} else {
logger.info("An unexpected error occurred: " + rt.getMessage());
}
}
waitForInputToContinue(scanner);
logger.info(DASHES);
logger.info(DASHES);
logger.info("8. Delete objects from the Amazon S3 bucket.");
waitForInputToContinue(scanner);
try {
CompletableFuture future = s3Actions.deleteObjectFromBucketAsync(bucketName, key);
future.join();
} catch (RuntimeException rt) {
Throwable cause = rt.getCause();
if (cause instanceof S3Exception s3Ex) {
logger.info("S3 error occurred: Error message: {}, Error code {}", s3Ex.getMessage(), s3Ex.awsErrorDetails().errorCode());
} else {
logger.info("An unexpected error occurred: " + rt.getMessage());
}
throw cause;
}
try {
CompletableFuture future = s3Actions.deleteObjectFromBucketAsync(bucketName, "multiPartKey");
future.join();
} catch (RuntimeException rt) {
Throwable cause = rt.getCause();
if (cause instanceof S3Exception s3Ex) {
logger.info("S3 error occurred: Error message: {}, Error code {}", s3Ex.getMessage(), s3Ex.awsErrorDetails().errorCode());
} else {
logger.info("An unexpected error occurred: " + rt.getMessage());
}
throw cause;
}
waitForInputToContinue(scanner);
logger.info(DASHES);
logger.info(DASHES);
logger.info("9. Delete the Amazon S3 bucket.");
waitForInputToContinue(scanner);
try {
CompletableFuture future = s3Actions.deleteBucketAsync(bucketName);
future.join();
} catch (RuntimeException rt) {
Throwable cause = rt.getCause();
if (cause instanceof S3Exception s3Ex) {
logger.info("S3 error occurred: Error message: {}, Error code {}", s3Ex.getMessage(), s3Ex.awsErrorDetails().errorCode());
} else {
logger.info("An unexpected error occurred: " + rt.getMessage());
}
throw cause;
}
waitForInputToContinue(scanner);
logger.info(DASHES);
logger.info(DASHES);
logger.info("You successfully completed the Amazon S3 scenario.");
logger.info(DASHES);
}
private static void waitForInputToContinue(Scanner scanner) {
while (true) {
logger.info("");
logger.info("Enter 'c' followed by to continue:");
String input = scanner.nextLine();
if (input.trim().equalsIgnoreCase("c")) {
logger.info("Continuing with the program...");
logger.info("");
break;
} else {
// Handle invalid input.
logger.info("Invalid input. Please try again.");
}
}
}
}
```
包含操作的包裝函式類別。
```
public class S3Actions {
private static final Logger logger = LoggerFactory.getLogger(S3Actions.class);
private static S3AsyncClient s3AsyncClient;
public static S3AsyncClient getAsyncClient() {
if (s3AsyncClient == null) {
/*
The `NettyNioAsyncHttpClient` class is part of the AWS SDK for Java, version 2,
and it is designed to provide a high-performance, asynchronous HTTP client for interacting with AWS services.
It uses the Netty framework to handle the underlying network communication and the Java NIO API to
provide a non-blocking, event-driven approach to HTTP requests and responses.
*/
SdkAsyncHttpClient httpClient = NettyNioAsyncHttpClient.builder()
.maxConcurrency(50) // Adjust as needed.
.connectionTimeout(Duration.ofSeconds(60)) // Set the connection timeout.
.readTimeout(Duration.ofSeconds(60)) // Set the read timeout.
.writeTimeout(Duration.ofSeconds(60)) // Set the write timeout.
.build();
ClientOverrideConfiguration overrideConfig = ClientOverrideConfiguration.builder()
.apiCallTimeout(Duration.ofMinutes(2)) // Set the overall API call timeout.
.apiCallAttemptTimeout(Duration.ofSeconds(90)) // Set the individual call attempt timeout.
.retryStrategy(RetryMode.STANDARD)
.build();
s3AsyncClient = S3AsyncClient.builder()
.region(Region.US_EAST_1)
.httpClient(httpClient)
.overrideConfiguration(overrideConfig)
.build();
}
return s3AsyncClient;
}
/**
* Creates an S3 bucket asynchronously.
*
* @param bucketName the name of the S3 bucket to create
* @return a {@link CompletableFuture} that completes when the bucket is created and ready
* @throws RuntimeException if there is a failure while creating the bucket
*/
public CompletableFuture createBucketAsync(String bucketName) {
CreateBucketRequest bucketRequest = CreateBucketRequest.builder()
.bucket(bucketName)
.build();
CompletableFuture response = getAsyncClient().createBucket(bucketRequest);
return response.thenCompose(resp -> {
S3AsyncWaiter s3Waiter = getAsyncClient().waiter();
HeadBucketRequest bucketRequestWait = HeadBucketRequest.builder()
.bucket(bucketName)
.build();
CompletableFuture> waiterResponseFuture =
s3Waiter.waitUntilBucketExists(bucketRequestWait);
return waiterResponseFuture.thenAccept(waiterResponse -> {
waiterResponse.matched().response().ifPresent(headBucketResponse -> {
logger.info(bucketName + " is ready");
});
});
}).whenComplete((resp, ex) -> {
if (ex != null) {
throw new RuntimeException("Failed to create bucket", ex);
}
});
}
/**
* Uploads a local file to an AWS S3 bucket asynchronously.
*
* @param bucketName the name of the S3 bucket to upload the file to
* @param key the key (object name) to use for the uploaded file
* @param objectPath the local file path of the file to be uploaded
* @return a {@link CompletableFuture} that completes with the {@link PutObjectResponse} when the upload is successful, or throws a {@link RuntimeException} if the upload fails
*/
public CompletableFuture uploadLocalFileAsync(String bucketName, String key, String objectPath) {
PutObjectRequest objectRequest = PutObjectRequest.builder()
.bucket(bucketName)
.key(key)
.build();
CompletableFuture response = getAsyncClient().putObject(objectRequest, AsyncRequestBody.fromFile(Paths.get(objectPath)));
return response.whenComplete((resp, ex) -> {
if (ex != null) {
throw new RuntimeException("Failed to upload file", ex);
}
});
}
/**
* Asynchronously retrieves the bytes of an object from an Amazon S3 bucket and writes them to a local file.
*
* @param bucketName the name of the S3 bucket containing the object
* @param keyName the key (or name) of the S3 object to retrieve
* @param path the local file path where the object's bytes will be written
* @return a {@link CompletableFuture} that completes when the object bytes have been written to the local file
*/
public CompletableFuture getObjectBytesAsync(String bucketName, String keyName, String path) {
GetObjectRequest objectRequest = GetObjectRequest.builder()
.key(keyName)
.bucket(bucketName)
.build();
CompletableFuture> response = getAsyncClient().getObject(objectRequest, AsyncResponseTransformer.toBytes());
return response.thenAccept(objectBytes -> {
try {
byte[] data = objectBytes.asByteArray();
Path filePath = Paths.get(path);
Files.write(filePath, data);
logger.info("Successfully obtained bytes from an S3 object");
} catch (IOException ex) {
throw new RuntimeException("Failed to write data to file", ex);
}
}).whenComplete((resp, ex) -> {
if (ex != null) {
throw new RuntimeException("Failed to get object bytes from S3", ex);
}
});
}
/**
* Asynchronously lists all objects in the specified S3 bucket.
*
* @param bucketName the name of the S3 bucket to list objects for
* @return a {@link CompletableFuture} that completes when all objects have been listed
*/
public CompletableFuture listAllObjectsAsync(String bucketName) {
ListObjectsV2Request initialRequest = ListObjectsV2Request.builder()
.bucket(bucketName)
.maxKeys(1)
.build();
ListObjectsV2Publisher paginator = getAsyncClient().listObjectsV2Paginator(initialRequest);
return paginator.subscribe(response -> {
response.contents().forEach(s3Object -> {
logger.info("Object key: " + s3Object.key());
});
}).thenRun(() -> {
logger.info("Successfully listed all objects in the bucket: " + bucketName);
}).exceptionally(ex -> {
throw new RuntimeException("Failed to list objects", ex);
});
}
/**
* Asynchronously copies an object from one S3 bucket to another.
*
* @param fromBucket the name of the source S3 bucket
* @param objectKey the key (name) of the object to be copied
* @param toBucket the name of the destination S3 bucket
* @return a {@link CompletableFuture} that completes with the copy result as a {@link String}
* @throws RuntimeException if the URL could not be encoded or an S3 exception occurred during the copy
*/
public CompletableFuture copyBucketObjectAsync(String fromBucket, String objectKey, String toBucket) {
CopyObjectRequest copyReq = CopyObjectRequest.builder()
.sourceBucket(fromBucket)
.sourceKey(objectKey)
.destinationBucket(toBucket)
.destinationKey(objectKey)
.build();
CompletableFuture response = getAsyncClient().copyObject(copyReq);
response.whenComplete((copyRes, ex) -> {
if (copyRes != null) {
logger.info("The " + objectKey + " was copied to " + toBucket);
} else {
throw new RuntimeException("An S3 exception occurred during copy", ex);
}
});
return response.thenApply(CopyObjectResponse::copyObjectResult)
.thenApply(Object::toString);
}
/**
* Performs a multipart upload to an Amazon S3 bucket.
*
* @param bucketName the name of the S3 bucket to upload the file to
* @param key the key (name) of the file to be uploaded
* @return a {@link CompletableFuture} that completes when the multipart upload is successful
*/
public CompletableFuture multipartUpload(String bucketName, String key) {
int mB = 1024 * 1024;
CreateMultipartUploadRequest createMultipartUploadRequest = CreateMultipartUploadRequest.builder()
.bucket(bucketName)
.key(key)
.build();
return getAsyncClient().createMultipartUpload(createMultipartUploadRequest)
.thenCompose(createResponse -> {
String uploadId = createResponse.uploadId();
System.out.println("Upload ID: " + uploadId);
// Upload part 1.
UploadPartRequest uploadPartRequest1 = UploadPartRequest.builder()
.bucket(bucketName)
.key(key)
.uploadId(uploadId)
.partNumber(1)
.contentLength((long) (5 * mB)) // Specify the content length
.build();
CompletableFuture part1Future = getAsyncClient().uploadPart(uploadPartRequest1,
AsyncRequestBody.fromByteBuffer(getRandomByteBuffer(5 * mB)))
.thenApply(uploadPartResponse -> CompletedPart.builder()
.partNumber(1)
.eTag(uploadPartResponse.eTag())
.build());
// Upload part 2.
UploadPartRequest uploadPartRequest2 = UploadPartRequest.builder()
.bucket(bucketName)
.key(key)
.uploadId(uploadId)
.partNumber(2)
.contentLength((long) (3 * mB))
.build();
CompletableFuture part2Future = getAsyncClient().uploadPart(uploadPartRequest2,
AsyncRequestBody.fromByteBuffer(getRandomByteBuffer(3 * mB)))
.thenApply(uploadPartResponse -> CompletedPart.builder()
.partNumber(2)
.eTag(uploadPartResponse.eTag())
.build());
// Combine the results of both parts.
return CompletableFuture.allOf(part1Future, part2Future)
.thenCompose(v -> {
CompletedPart part1 = part1Future.join();
CompletedPart part2 = part2Future.join();
CompletedMultipartUpload completedMultipartUpload = CompletedMultipartUpload.builder()
.parts(part1, part2)
.build();
CompleteMultipartUploadRequest completeMultipartUploadRequest = CompleteMultipartUploadRequest.builder()
.bucket(bucketName)
.key(key)
.uploadId(uploadId)
.multipartUpload(completedMultipartUpload)
.build();
// Complete the multipart upload
return getAsyncClient().completeMultipartUpload(completeMultipartUploadRequest);
});
})
.thenAccept(response -> System.out.println("Multipart upload completed successfully"))
.exceptionally(ex -> {
System.err.println("Failed to complete multipart upload: " + ex.getMessage());
throw new RuntimeException(ex);
});
}
/**
* Deletes an object from an S3 bucket asynchronously.
*
* @param bucketName the name of the S3 bucket
* @param key the key (file name) of the object to be deleted
* @return a {@link CompletableFuture} that completes when the object has been deleted
*/
public CompletableFuture deleteObjectFromBucketAsync(String bucketName, String key) {
DeleteObjectRequest deleteObjectRequest = DeleteObjectRequest.builder()
.bucket(bucketName)
.key(key)
.build();
CompletableFuture response = getAsyncClient().deleteObject(deleteObjectRequest);
response.whenComplete((deleteRes, ex) -> {
if (deleteRes != null) {
logger.info(key + " was deleted");
} else {
throw new RuntimeException("An S3 exception occurred during delete", ex);
}
});
return response.thenApply(r -> null);
}
/**
* Deletes an S3 bucket asynchronously.
*
* @param bucket the name of the bucket to be deleted
* @return a {@link CompletableFuture} that completes when the bucket deletion is successful, or throws a {@link RuntimeException}
* if an error occurs during the deletion process
*/
public CompletableFuture deleteBucketAsync(String bucket) {
DeleteBucketRequest deleteBucketRequest = DeleteBucketRequest.builder()
.bucket(bucket)
.build();
CompletableFuture response = getAsyncClient().deleteBucket(deleteBucketRequest);
response.whenComplete((deleteRes, ex) -> {
if (deleteRes != null) {
logger.info(bucket + " was deleted.");
} else {
throw new RuntimeException("An S3 exception occurred during bucket deletion", ex);
}
});
return response.thenApply(r -> null);
}
public CompletableFuture performMultiCopy(String toBucket, String bucketName, String key) {
CreateMultipartUploadRequest createMultipartUploadRequest = CreateMultipartUploadRequest.builder()
.bucket(toBucket)
.key(key)
.build();
getAsyncClient().createMultipartUpload(createMultipartUploadRequest)
.thenApply(createMultipartUploadResponse -> {
String uploadId = createMultipartUploadResponse.uploadId();
System.out.println("Upload ID: " + uploadId);
UploadPartCopyRequest uploadPartCopyRequest = UploadPartCopyRequest.builder()
.sourceBucket(bucketName)
.destinationBucket(toBucket)
.sourceKey(key)
.destinationKey(key)
.uploadId(uploadId) // Use the valid uploadId.
.partNumber(1) // Ensure the part number is correct.
.copySourceRange("bytes=0-1023") // Adjust range as needed
.build();
return getAsyncClient().uploadPartCopy(uploadPartCopyRequest);
})
.thenCompose(uploadPartCopyFuture -> uploadPartCopyFuture)
.whenComplete((uploadPartCopyResponse, exception) -> {
if (exception != null) {
// Handle any exceptions.
logger.error("Error during upload part copy: " + exception.getMessage());
} else {
// Successfully completed the upload part copy.
System.out.println("Upload Part Copy completed successfully. ETag: " + uploadPartCopyResponse.copyPartResult().eTag());
}
});
return null;
}
private static ByteBuffer getRandomByteBuffer(int size) {
ByteBuffer buffer = ByteBuffer.allocate(size);
for (int i = 0; i < size; i++) {
buffer.put((byte) (Math.random() * 256));
}
buffer.flip();
return buffer;
}
}
```
+ 如需 API 詳細資訊，請參閱*《AWS SDK for Java 2.x API 參考》*中的下列主題。
+ [CopyObject](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/CopyObject)
+ [CreateBucket](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/CreateBucket)
+ [DeleteBucket](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/DeleteBucket)
+ [DeleteObjects](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/DeleteObjects)
+ [GetObject](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/GetObject)
+ [ListObjectsV2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/ListObjectsV2)
+ [PutObject](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/PutObject)
------
#### [ JavaScript ]
**適用於 JavaScript (v3) 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/s3#code-examples)中設定和執行。
首先，匯入所有必要模組。
```
// Used to check if currently running file is this file.
import { fileURLToPath } from "node:url";
import { readdirSync, readFileSync, writeFileSync } from "node:fs";
// Local helper utils.
import { dirnameFromMetaUrl } from "@aws-doc-sdk-examples/lib/utils/util-fs.js";
import { Prompter } from "@aws-doc-sdk-examples/lib/prompter.js";
import { wrapText } from "@aws-doc-sdk-examples/lib/utils/util-string.js";
import {
S3Client,
CreateBucketCommand,
PutObjectCommand,
ListObjectsCommand,
CopyObjectCommand,
GetObjectCommand,
DeleteObjectsCommand,
DeleteBucketCommand,
} from "@aws-sdk/client-s3";
```
前面的匯入動作參考了一些協助公用程式。這些公用程式是本節開頭連結的 GitHub 儲存庫的本機公用程式。如需相關內容，請參閱下列公用程式的實作方式。
```
export const dirnameFromMetaUrl = (metaUrl) =>
fileURLToPath(new URL(".", metaUrl));
import { select, input, confirm, checkbox, password } from "@inquirer/prompts";
export class Prompter {
/**
* @param {{ message: string, choices: { name: string, value: string }[]}} options
*/
select(options) {
return select(options);
}
/**
* @param {{ message: string }} options
*/
input(options) {
return input(options);
}
/**
* @param {{ message: string }} options
*/
password(options) {
return password({ ...options, mask: true });
}
/**
* @param {string} prompt
*/
checkContinue = async (prompt = "") => {
const prefix = prompt && `${prompt} `;
const ok = await this.confirm({
message: `${prefix}Continue?`,
});
if (!ok) throw new Error("Exiting...");
};
/**
* @param {{ message: string }} options
*/
confirm(options) {
return confirm(options);
}
/**
* @param {{ message: string, choices: { name: string, value: string }[]}} options
*/
checkbox(options) {
return checkbox(options);
}
}
export const wrapText = (text, char = "=") => {
const rule = char.repeat(80);
return `${rule}\n ${text}\n${rule}\n`;
};
```
物件存放在「儲存貯體」中。接下來，來定義一個建立新儲存貯體的函數。
```
export const createBucket = async () => {
const bucketName = await prompter.input({
message: "Enter a bucket name. Bucket names must be globally unique:",
});
const command = new CreateBucketCommand({ Bucket: bucketName });
await s3Client.send(command);
console.log("Bucket created successfully.\n");
return bucketName;
};
```
儲存貯體包含「物件」。此功能會將儲存庫的內容做為物件上傳至您的儲存貯體。
```
export const uploadFilesToBucket = async ({ bucketName, folderPath }) => {
console.log(`Uploading files from ${folderPath}\n`);
const keys = readdirSync(folderPath);
const files = keys.map((key) => {
const filePath = `${folderPath}/${key}`;
const fileContent = readFileSync(filePath);
return {
Key: key,
Body: fileContent,
};
});
for (const file of files) {
await s3Client.send(
new PutObjectCommand({
Bucket: bucketName,
Body: file.Body,
Key: file.Key,
}),
);
console.log(`${file.Key} uploaded successfully.`);
}
};
```
上傳物件之後，請檢查確認已正確上傳物件。您可以為此使用 ListObjects。您將使用「金鑰」屬性，但在回應中也有其他有用的屬性。
```
export const listFilesInBucket = async ({ bucketName }) => {
const command = new ListObjectsCommand({ Bucket: bucketName });
const { Contents } = await s3Client.send(command);
const contentsList = Contents.map((c) => ` • ${c.Key}`).join("\n");
console.log("\nHere's a list of files in the bucket:");
console.log(`${contentsList}\n`);
};
```
有時您可能想從儲存貯體複製物件到另一個儲存貯體。為此使用 CopyObject 命令。
```
export const copyFileFromBucket = async ({ destinationBucket }) => {
const proceed = await prompter.confirm({
message: "Would you like to copy an object from another bucket?",
});
if (!proceed) {
return;
}
const copy = async () => {
try {
const sourceBucket = await prompter.input({
message: "Enter source bucket name:",
});
const sourceKey = await prompter.input({
message: "Enter source key:",
});
const destinationKey = await prompter.input({
message: "Enter destination key:",
});
const command = new CopyObjectCommand({
Bucket: destinationBucket,
CopySource: `${sourceBucket}/${sourceKey}`,
Key: destinationKey,
});
await s3Client.send(command);
await copyFileFromBucket({ destinationBucket });
} catch (err) {
console.error("Copy error.");
console.error(err);
const retryAnswer = await prompter.confirm({ message: "Try again?" });
if (retryAnswer) {
await copy();
}
}
};
await copy();
};
```
沒有從儲存貯體中取得多個物件的 SDK 方法。反之，您會建立一份待下載的物件清單，並重複執行這些物件。
```
export const downloadFilesFromBucket = async ({ bucketName }) => {
const { Contents } = await s3Client.send(
new ListObjectsCommand({ Bucket: bucketName }),
);
const path = await prompter.input({
message: "Enter destination path for files:",
});
for (const content of Contents) {
const obj = await s3Client.send(
new GetObjectCommand({ Bucket: bucketName, Key: content.Key }),
);
writeFileSync(
`${path}/${content.Key}`,
await obj.Body.transformToByteArray(),
);
}
console.log("Files downloaded successfully.\n");
};
```
該清除資源了。儲存貯體在刪除之前必須先清空。這兩個函數會清空並刪除儲存貯體。
```
export const emptyBucket = async ({ bucketName }) => {
const listObjectsCommand = new ListObjectsCommand({ Bucket: bucketName });
const { Contents } = await s3Client.send(listObjectsCommand);
const keys = Contents.map((c) => c.Key);
const deleteObjectsCommand = new DeleteObjectsCommand({
Bucket: bucketName,
Delete: { Objects: keys.map((key) => ({ Key: key })) },
});
await s3Client.send(deleteObjectsCommand);
console.log(`${bucketName} emptied successfully.\n`);
};
export const deleteBucket = async ({ bucketName }) => {
const command = new DeleteBucketCommand({ Bucket: bucketName });
await s3Client.send(command);
console.log(`${bucketName} deleted successfully.\n`);
};
```
「主要」函數會將所有內容放在一起。若你直接執行這個檔案，主要函數將受到叫用。
```
const main = async () => {
const OBJECT_DIRECTORY = `${dirnameFromMetaUrl(
import.meta.url,
)}../../../../resources/sample_files/.sample_media`;
try {
console.log(wrapText("Welcome to the Amazon S3 getting started example."));
console.log("Let's create a bucket.");
const bucketName = await createBucket();
await prompter.confirm({ message: continueMessage });
console.log(wrapText("File upload."));
console.log(
"I have some default files ready to go. You can edit the source code to provide your own.",
);
await uploadFilesToBucket({
bucketName,
folderPath: OBJECT_DIRECTORY,
});
await listFilesInBucket({ bucketName });
await prompter.confirm({ message: continueMessage });
console.log(wrapText("Copy files."));
await copyFileFromBucket({ destinationBucket: bucketName });
await listFilesInBucket({ bucketName });
await prompter.confirm({ message: continueMessage });
console.log(wrapText("Download files."));
await downloadFilesFromBucket({ bucketName });
console.log(wrapText("Clean up."));
await emptyBucket({ bucketName });
await deleteBucket({ bucketName });
} catch (err) {
console.error(err);
}
};
```
+ 如需 API 詳細資訊，請參閱*《適用於 JavaScript 的 AWS SDK API 參考》*中的下列主題。
+ [CopyObject](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/s3/command/CopyObjectCommand)
+ [CreateBucket](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/s3/command/CreateBucketCommand)
+ [DeleteBucket](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/s3/command/DeleteBucketCommand)
+ [DeleteObjects](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/s3/command/DeleteObjectsCommand)
+ [GetObject](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/s3/command/GetObjectCommand)
+ [ListObjectsV2](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/s3/command/ListObjectsV2Command)
+ [PutObject](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/s3/command/PutObjectCommand)
------
#### [ Kotlin ]
**適用於 Kotlin 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/s3#code-examples)中設定和執行。
```
suspend fun main(args: Array) {
val usage = """
Usage:
Where:
bucketName - The Amazon S3 bucket to create.
key - The key to use.
objectPath - The path where the file is located (for example, C:/AWS/book2.pdf).
savePath - The path where the file is saved after it's downloaded (for example, C:/AWS/book2.pdf).
toBucket - An Amazon S3 bucket to where an object is copied to (for example, C:/AWS/book2.pdf).
"""
if (args.size != 4) {
println(usage)
exitProcess(1)
}
val bucketName = args[0]
val key = args[1]
val objectPath = args[2]
val savePath = args[3]
val toBucket = args[4]
// Create an Amazon S3 bucket.
createBucket(bucketName)
// Update a local file to the Amazon S3 bucket.
putObject(bucketName, key, objectPath)
// Download the object to another local file.
getObjectFromMrap(bucketName, key, savePath)
// List all objects located in the Amazon S3 bucket.
listBucketObs(bucketName)
// Copy the object to another Amazon S3 bucket
copyBucketOb(bucketName, key, toBucket)
// Delete the object from the Amazon S3 bucket.
deleteBucketObs(bucketName, key)
// Delete the Amazon S3 bucket.
deleteBucket(bucketName)
println("All Amazon S3 operations were successfully performed")
}
suspend fun createBucket(bucketName: String) {
val request =
CreateBucketRequest {
bucket = bucketName
}
S3Client.fromEnvironment { region = "us-east-1" }.use { s3 ->
s3.createBucket(request)
println("$bucketName is ready")
}
}
suspend fun putObject(
bucketName: String,
objectKey: String,
objectPath: String,
) {
val metadataVal = mutableMapOf()
metadataVal["myVal"] = "test"
val request =
PutObjectRequest {
bucket = bucketName
key = objectKey
metadata = metadataVal
this.body = Paths.get(objectPath).asByteStream()
}
S3Client.fromEnvironment { region = "us-east-1" }.use { s3 ->
val response = s3.putObject(request)
println("Tag information is ${response.eTag}")
}
}
suspend fun getObjectFromMrap(
bucketName: String,
keyName: String,
path: String,
) {
val request =
GetObjectRequest {
key = keyName
bucket = bucketName
}
S3Client.fromEnvironment { region = "us-east-1" }.use { s3 ->
s3.getObject(request) { resp ->
val myFile = File(path)
resp.body?.writeToFile(myFile)
println("Successfully read $keyName from $bucketName")
}
}
}
suspend fun listBucketObs(bucketName: String) {
val request =
ListObjectsRequest {
bucket = bucketName
}
S3Client.fromEnvironment { region = "us-east-1" }.use { s3 ->
val response = s3.listObjects(request)
response.contents?.forEach { myObject ->
println("The name of the key is ${myObject.key}")
println("The owner is ${myObject.owner}")
}
}
}
suspend fun copyBucketOb(
fromBucket: String,
objectKey: String,
toBucket: String,
) {
var encodedUrl = ""
try {
encodedUrl = URLEncoder.encode("$fromBucket/$objectKey", StandardCharsets.UTF_8.toString())
} catch (e: UnsupportedEncodingException) {
println("URL could not be encoded: " + e.message)
}
val request =
CopyObjectRequest {
copySource = encodedUrl
bucket = toBucket
key = objectKey
}
S3Client.fromEnvironment { region = "us-east-1" }.use { s3 ->
s3.copyObject(request)
}
}
suspend fun deleteBucketObs(
bucketName: String,
objectName: String,
) {
val objectId =
ObjectIdentifier {
key = objectName
}
val delOb =
Delete {
objects = listOf(objectId)
}
val request =
DeleteObjectsRequest {
bucket = bucketName
delete = delOb
}
S3Client.fromEnvironment { region = "us-east-1" }.use { s3 ->
s3.deleteObjects(request)
println("$objectName was deleted from $bucketName")
}
}
suspend fun deleteBucket(bucketName: String?) {
val request =
DeleteBucketRequest {
bucket = bucketName
}
S3Client.fromEnvironment { region = "us-east-1" }.use { s3 ->
s3.deleteBucket(request)
println("The $bucketName was successfully deleted!")
}
}
```
+ 如需 API 詳細資訊，請參閱*《適用於 Kotlin 的AWS SDK API 參考》*中的下列主題。
+ [CopyObject](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [CreateBucket](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [DeleteBucket](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [DeleteObjects](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [GetObject](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [ListObjectsV2](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
+ [PutObject](https://sdk.amazonaws.com/kotlin/api/latest/index.html)
------
#### [ PHP ]
**適用於 PHP 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code/s3#code-examples)中設定和執行。
```
echo("\n");
echo("--------------------------------------\n");
print("Welcome to the Amazon S3 getting started demo using PHP!\n");
echo("--------------------------------------\n");
$region = 'us-west-2';
$this->s3client = new S3Client([
'region' => $region,
]);
/* Inline declaration example
$s3client = new Aws\S3\S3Client(['region' => 'us-west-2']);
*/
$this->bucketName = "amzn-s3-demo-bucket-" . uniqid();
try {
$this->s3client->createBucket([
'Bucket' => $this->bucketName,
'CreateBucketConfiguration' => ['LocationConstraint' => $region],
]);
echo "Created bucket named: $this->bucketName \n";
} catch (Exception $exception) {
echo "Failed to create bucket $this->bucketName with error: " . $exception->getMessage();
exit("Please fix error with bucket creation before continuing.");
}
$fileName = __DIR__ . "/local-file-" . uniqid();
try {
$this->s3client->putObject([
'Bucket' => $this->bucketName,
'Key' => $fileName,
'SourceFile' => __DIR__ . '/testfile.txt'
]);
echo "Uploaded $fileName to $this->bucketName.\n";
} catch (Exception $exception) {
echo "Failed to upload $fileName with error: " . $exception->getMessage();
exit("Please fix error with file upload before continuing.");
}
try {
$file = $this->s3client->getObject([
'Bucket' => $this->bucketName,
'Key' => $fileName,
]);
$body = $file->get('Body');
$body->rewind();
echo "Downloaded the file and it begins with: {$body->read(26)}.\n";
} catch (Exception $exception) {
echo "Failed to download $fileName from $this->bucketName with error: " . $exception->getMessage();
exit("Please fix error with file downloading before continuing.");
}
try {
$folder = "copied-folder";
$this->s3client->copyObject([
'Bucket' => $this->bucketName,
'CopySource' => "$this->bucketName/$fileName",
'Key' => "$folder/$fileName-copy",
]);
echo "Copied $fileName to $folder/$fileName-copy.\n";
} catch (Exception $exception) {
echo "Failed to copy $fileName with error: " . $exception->getMessage();
exit("Please fix error with object copying before continuing.");
}
try {
$contents = $this->s3client->listObjectsV2([
'Bucket' => $this->bucketName,
]);
echo "The contents of your bucket are: \n";
foreach ($contents['Contents'] as $content) {
echo $content['Key'] . "\n";
}
} catch (Exception $exception) {
echo "Failed to list objects in $this->bucketName with error: " . $exception->getMessage();
exit("Please fix error with listing objects before continuing.");
}
try {
$objects = [];
foreach ($contents['Contents'] as $content) {
$objects[] = [
'Key' => $content['Key'],
];
}
$this->s3client->deleteObjects([
'Bucket' => $this->bucketName,
'Delete' => [
'Objects' => $objects,
],
]);
$check = $this->s3client->listObjectsV2([
'Bucket' => $this->bucketName,
]);
if (isset($check['Contents']) && count($check['Contents']) > 0) {
throw new Exception("Bucket wasn't empty.");
}
echo "Deleted all objects and folders from $this->bucketName.\n";
} catch (Exception $exception) {
echo "Failed to delete $fileName from $this->bucketName with error: " . $exception->getMessage();
exit("Please fix error with object deletion before continuing.");
}
try {
$this->s3client->deleteBucket([
'Bucket' => $this->bucketName,
]);
echo "Deleted bucket $this->bucketName.\n";
} catch (Exception $exception) {
echo "Failed to delete $this->bucketName with error: " . $exception->getMessage();
exit("Please fix error with bucket deletion before continuing.");
}
echo "Successfully ran the Amazon S3 with PHP demo.\n";
```
+ 如需 API 詳細資訊，請參閱《*適用於 PHP 的 AWS SDK API 參考*》中的下列主題。
+ [CopyObject](https://docs.aws.amazon.com/goto/SdkForPHPV3/s3-2006-03-01/CopyObject)
+ [CreateBucket](https://docs.aws.amazon.com/goto/SdkForPHPV3/s3-2006-03-01/CreateBucket)
+ [DeleteBucket](https://docs.aws.amazon.com/goto/SdkForPHPV3/s3-2006-03-01/DeleteBucket)
+ [DeleteObjects](https://docs.aws.amazon.com/goto/SdkForPHPV3/s3-2006-03-01/DeleteObjects)
+ [GetObject](https://docs.aws.amazon.com/goto/SdkForPHPV3/s3-2006-03-01/GetObject)
+ [ListObjectsV2](https://docs.aws.amazon.com/goto/SdkForPHPV3/s3-2006-03-01/ListObjectsV2)
+ [PutObject](https://docs.aws.amazon.com/goto/SdkForPHPV3/s3-2006-03-01/PutObject)
------
#### [ Python ]
**適用於 Python 的 SDK (Boto3)**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/s3/s3_basics#code-examples)中設定和執行。
```
import io
import os
import uuid
import boto3
from boto3.s3.transfer import S3UploadFailedError
from botocore.exceptions import ClientError
def do_scenario(s3_resource):
print("-" * 88)
print("Welcome to the Amazon S3 getting started demo!")
print("-" * 88)
bucket_name = f"amzn-s3-demo-bucket-{uuid.uuid4()}"
bucket = s3_resource.Bucket(bucket_name)
try:
bucket.create(
CreateBucketConfiguration={
"LocationConstraint": s3_resource.meta.client.meta.region_name
}
)
print(f"Created demo bucket named {bucket.name}.")
except ClientError as err:
print(f"Tried and failed to create demo bucket {bucket_name}.")
print(f"\t{err.response['Error']['Code']}:{err.response['Error']['Message']}")
print(f"\nCan't continue the demo without a bucket!")
return
file_name = None
while file_name is None:
file_name = input("\nEnter a file you want to upload to your bucket: ")
if not os.path.exists(file_name):
print(f"Couldn't find file {file_name}. Are you sure it exists?")
file_name = None
obj = bucket.Object(os.path.basename(file_name))
try:
obj.upload_file(file_name)
print(
f"Uploaded file {file_name} into bucket {bucket.name} with key {obj.key}."
)
except S3UploadFailedError as err:
print(f"Couldn't upload file {file_name} to {bucket.name}.")
print(f"\t{err}")
answer = input(f"\nDo you want to download {obj.key} into memory (y/n)? ")
if answer.lower() == "y":
data = io.BytesIO()
try:
obj.download_fileobj(data)
data.seek(0)
print(f"Got your object. Here are the first 20 bytes:\n")
print(f"\t{data.read(20)}")
except ClientError as err:
print(f"Couldn't download {obj.key}.")
print(
f"\t{err.response['Error']['Code']}:{err.response['Error']['Message']}"
)
answer = input(
f"\nDo you want to copy {obj.key} to a subfolder in your bucket (y/n)? "
)
if answer.lower() == "y":
dest_obj = bucket.Object(f"demo-folder/{obj.key}")
try:
dest_obj.copy({"Bucket": bucket.name, "Key": obj.key})
print(f"Copied {obj.key} to {dest_obj.key}.")
except ClientError as err:
print(f"Couldn't copy {obj.key} to {dest_obj.key}.")
print(
f"\t{err.response['Error']['Code']}:{err.response['Error']['Message']}"
)
print("\nYour bucket contains the following objects:")
try:
for o in bucket.objects.all():
print(f"\t{o.key}")
except ClientError as err:
print(f"Couldn't list the objects in bucket {bucket.name}.")
print(f"\t{err.response['Error']['Code']}:{err.response['Error']['Message']}")
answer = input(
"\nDo you want to delete all of the objects as well as the bucket (y/n)? "
)
if answer.lower() == "y":
try:
bucket.objects.delete()
bucket.delete()
print(f"Emptied and deleted bucket {bucket.name}.\n")
except ClientError as err:
print(f"Couldn't empty and delete bucket {bucket.name}.")
print(
f"\t{err.response['Error']['Code']}:{err.response['Error']['Message']}"
)
print("Thanks for watching!")
print("-" * 88)
if __name__ == "__main__":
do_scenario(boto3.resource("s3"))
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Python (Boto3) API 參考》**中的下列主題。
+ [CopyObject](https://docs.aws.amazon.com/goto/boto3/s3-2006-03-01/CopyObject)
+ [CreateBucket](https://docs.aws.amazon.com/goto/boto3/s3-2006-03-01/CreateBucket)
+ [DeleteBucket](https://docs.aws.amazon.com/goto/boto3/s3-2006-03-01/DeleteBucket)
+ [DeleteObjects](https://docs.aws.amazon.com/goto/boto3/s3-2006-03-01/DeleteObjects)
+ [GetObject](https://docs.aws.amazon.com/goto/boto3/s3-2006-03-01/GetObject)
+ [ListObjectsV2](https://docs.aws.amazon.com/goto/boto3/s3-2006-03-01/ListObjectsV2)
+ [PutObject](https://docs.aws.amazon.com/goto/boto3/s3-2006-03-01/PutObject)
------
#### [ Ruby ]
**SDK for Ruby**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/ruby/example_code/s3#code-examples)中設定和執行。
```
require 'aws-sdk-s3'
# Wraps the getting started scenario actions.
class ScenarioGettingStarted
attr_reader :s3_resource
# @param s3_resource [Aws::S3::Resource] An Amazon S3 resource.
def initialize(s3_resource)
@s3_resource = s3_resource
end
# Creates a bucket with a random name in the currently configured account and
# AWS Region.
#
# @return [Aws::S3::Bucket] The newly created bucket.
def create_bucket
bucket = @s3_resource.create_bucket(
bucket: "amzn-s3-demo-bucket-#{Random.uuid}",
create_bucket_configuration: {
location_constraint: 'us-east-1' # NOTE: only certain regions permitted
}
)
puts("Created demo bucket named #{bucket.name}.")
rescue Aws::Errors::ServiceError => e
puts('Tried and failed to create demo bucket.')
puts("\t#{e.code}: #{e.message}")
puts("\nCan't continue the demo without a bucket!")
raise
else
bucket
end
# Requests a file name from the user.
#
# @return The name of the file.
def create_file
File.open('demo.txt', w) { |f| f.write('This is a demo file.') }
end
# Uploads a file to an Amazon S3 bucket.
#
# @param bucket [Aws::S3::Bucket] The bucket object representing the upload destination
# @return [Aws::S3::Object] The Amazon S3 object that contains the uploaded file.
def upload_file(bucket)
File.open('demo.txt', 'w+') { |f| f.write('This is a demo file.') }
s3_object = bucket.object(File.basename('demo.txt'))
s3_object.upload_file('demo.txt')
puts("Uploaded file demo.txt into bucket #{bucket.name} with key #{s3_object.key}.")
rescue Aws::Errors::ServiceError => e
puts("Couldn't upload file demo.txt to #{bucket.name}.")
puts("\t#{e.code}: #{e.message}")
raise
else
s3_object
end
# Downloads an Amazon S3 object to a file.
#
# @param s3_object [Aws::S3::Object] The object to download.
def download_file(s3_object)
puts("\nDo you want to download #{s3_object.key} to a local file (y/n)? ")
answer = gets.chomp.downcase
if answer == 'y'
puts('Enter a name for the downloaded file: ')
file_name = gets.chomp
s3_object.download_file(file_name)
puts("Object #{s3_object.key} successfully downloaded to #{file_name}.")
end
rescue Aws::Errors::ServiceError => e
puts("Couldn't download #{s3_object.key}.")
puts("\t#{e.code}: #{e.message}")
raise
end
# Copies an Amazon S3 object to a subfolder within the same bucket.
#
# @param source_object [Aws::S3::Object] The source object to copy.
# @return [Aws::S3::Object, nil] The destination object.
def copy_object(source_object)
dest_object = nil
puts("\nDo you want to copy #{source_object.key} to a subfolder in your bucket (y/n)? ")
answer = gets.chomp.downcase
if answer == 'y'
dest_object = source_object.bucket.object("demo-folder/#{source_object.key}")
dest_object.copy_from(source_object)
puts("Copied #{source_object.key} to #{dest_object.key}.")
end
rescue Aws::Errors::ServiceError => e
puts("Couldn't copy #{source_object.key}.")
puts("\t#{e.code}: #{e.message}")
raise
else
dest_object
end
# Lists the objects in an Amazon S3 bucket.
#
# @param bucket [Aws::S3::Bucket] The bucket to query.
def list_objects(bucket)
puts("\nYour bucket contains the following objects:")
bucket.objects.each do |obj|
puts("\t#{obj.key}")
end
rescue Aws::Errors::ServiceError => e
puts("Couldn't list the objects in bucket #{bucket.name}.")
puts("\t#{e.code}: #{e.message}")
raise
end
# Deletes the objects in an Amazon S3 bucket and deletes the bucket.
#
# @param bucket [Aws::S3::Bucket] The bucket to empty and delete.
def delete_bucket(bucket)
puts("\nDo you want to delete all of the objects as well as the bucket (y/n)? ")
answer = gets.chomp.downcase
if answer == 'y'
bucket.objects.batch_delete!
bucket.delete
puts("Emptied and deleted bucket #{bucket.name}.\n")
end
rescue Aws::Errors::ServiceError => e
puts("Couldn't empty and delete bucket #{bucket.name}.")
puts("\t#{e.code}: #{e.message}")
raise
end
end
# Runs the Amazon S3 getting started scenario.
def run_scenario(scenario)
puts('-' * 88)
puts('Welcome to the Amazon S3 getting started demo!')
puts('-' * 88)
bucket = scenario.create_bucket
s3_object = scenario.upload_file(bucket)
scenario.download_file(s3_object)
scenario.copy_object(s3_object)
scenario.list_objects(bucket)
scenario.delete_bucket(bucket)
puts('Thanks for watching!')
puts('-' * 88)
rescue Aws::Errors::ServiceError
puts('Something went wrong with the demo!')
end
run_scenario(ScenarioGettingStarted.new(Aws::S3::Resource.new)) if $PROGRAM_NAME == __FILE__
```
+ 如需 API 詳細資訊，請參閱《*適用於 Ruby 的 AWS SDK API 參考*》中的下列主題。
+ [CopyObject](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/CopyObject)
+ [CreateBucket](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/CreateBucket)
+ [DeleteBucket](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/DeleteBucket)
+ [DeleteObjects](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/DeleteObjects)
+ [GetObject](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/GetObject)
+ [ListObjectsV2](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/ListObjectsV2)
+ [PutObject](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/PutObject)
------
#### [ Rust ]
**適用於 Rust 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/rustv1/examples/s3#code-examples)中設定和執行。
案例中執行的二進制文件的程式碼。
```
#![allow(clippy::result_large_err)]
//! Purpose
//! Shows how to use the AWS SDK for Rust to get started using
//! Amazon Simple Storage Service (Amazon S3). Create a bucket, move objects into and out of it,
//! and delete all resources at the end of the demo.
//!
//! This example follows the steps in "Getting started with Amazon S3" in the Amazon S3
//! user guide.
//! - https://docs.aws.amazon.com/AmazonS3/latest/userguide/GetStartedWithS3.html
use aws_config::meta::region::RegionProviderChain;
use aws_sdk_s3::{config::Region, Client};
use s3_code_examples::error::S3ExampleError;
use uuid::Uuid;
#[tokio::main]
async fn main() -> Result<(), S3ExampleError> {
let region_provider = RegionProviderChain::first_try(Region::new("us-west-2"));
let region = region_provider.region().await.unwrap();
let shared_config = aws_config::from_env().region(region_provider).load().await;
let client = Client::new(&shared_config);
let bucket_name = format!("amzn-s3-demo-bucket-{}", Uuid::new_v4());
let file_name = "s3/testfile.txt".to_string();
let key = "test file key name".to_string();
let target_key = "target_key".to_string();
if let Err(e) = run_s3_operations(region, client, bucket_name, file_name, key, target_key).await
{
eprintln!("{:?}", e);
};
Ok(())
}
async fn run_s3_operations(
region: Region,
client: Client,
bucket_name: String,
file_name: String,
key: String,
target_key: String,
) -> Result<(), S3ExampleError> {
s3_code_examples::create_bucket(&client, &bucket_name, ®ion).await?;
let run_example: Result<(), S3ExampleError> = (async {
s3_code_examples::upload_object(&client, &bucket_name, &file_name, &key).await?;
let _object = s3_code_examples::download_object(&client, &bucket_name, &key).await;
s3_code_examples::copy_object(&client, &bucket_name, &bucket_name, &key, &target_key)
.await?;
s3_code_examples::list_objects(&client, &bucket_name).await?;
s3_code_examples::clear_bucket(&client, &bucket_name).await?;
Ok(())
})
.await;
if let Err(err) = run_example {
eprintln!("Failed to complete getting-started example: {err:?}");
}
s3_code_examples::delete_bucket(&client, &bucket_name).await?;
Ok(())
}
```
案例使用的常見動作。
```
pub async fn create_bucket(
client: &aws_sdk_s3::Client,
bucket_name: &str,
region: &aws_config::Region,
) -> Result, S3ExampleError> {
let constraint = aws_sdk_s3::types::BucketLocationConstraint::from(region.to_string().as_str());
let cfg = aws_sdk_s3::types::CreateBucketConfiguration::builder()
.location_constraint(constraint)
.build();
let create = client
.create_bucket()
.create_bucket_configuration(cfg)
.bucket(bucket_name)
.send()
.await;
// BucketAlreadyExists and BucketAlreadyOwnedByYou are not problems for this task.
create.map(Some).or_else(|err| {
if err
.as_service_error()
.map(|se| se.is_bucket_already_exists() || se.is_bucket_already_owned_by_you())
== Some(true)
{
Ok(None)
} else {
Err(S3ExampleError::from(err))
}
})
}
pub async fn upload_object(
client: &aws_sdk_s3::Client,
bucket_name: &str,
file_name: &str,
key: &str,
) -> Result {
let body = aws_sdk_s3::primitives::ByteStream::from_path(std::path::Path::new(file_name)).await;
client
.put_object()
.bucket(bucket_name)
.key(key)
.body(body.unwrap())
.send()
.await
.map_err(S3ExampleError::from)
}
pub async fn download_object(
client: &aws_sdk_s3::Client,
bucket_name: &str,
key: &str,
) -> Result {
client
.get_object()
.bucket(bucket_name)
.key(key)
.send()
.await
.map_err(S3ExampleError::from)
}
/// Copy an object from one bucket to another.
pub async fn copy_object(
client: &aws_sdk_s3::Client,
source_bucket: &str,
destination_bucket: &str,
source_object: &str,
destination_object: &str,
) -> Result<(), S3ExampleError> {
let source_key = format!("{source_bucket}/{source_object}");
let response = client
.copy_object()
.copy_source(&source_key)
.bucket(destination_bucket)
.key(destination_object)
.send()
.await?;
println!(
"Copied from {source_key} to {destination_bucket}/{destination_object} with etag {}",
response
.copy_object_result
.unwrap_or_else(|| aws_sdk_s3::types::CopyObjectResult::builder().build())
.e_tag()
.unwrap_or("missing")
);
Ok(())
}
pub async fn list_objects(client: &aws_sdk_s3::Client, bucket: &str) -> Result<(), S3ExampleError> {
let mut response = client
.list_objects_v2()
.bucket(bucket.to_owned())
.max_keys(10) // In this example, go 10 at a time.
.into_paginator()
.send();
while let Some(result) = response.next().await {
match result {
Ok(output) => {
for object in output.contents() {
println!(" - {}", object.key().unwrap_or("Unknown"));
}
}
Err(err) => {
eprintln!("{err:?}")
}
}
}
Ok(())
}
/// Given a bucket, remove all objects in the bucket, and then ensure no objects
/// remain in the bucket.
pub async fn clear_bucket(
client: &aws_sdk_s3::Client,
bucket_name: &str,
) -> Result, S3ExampleError> {
let objects = client.list_objects_v2().bucket(bucket_name).send().await?;
// delete_objects no longer needs to be mutable.
let objects_to_delete: Vec = objects
.contents()
.iter()
.filter_map(|obj| obj.key())
.map(String::from)
.collect();
if objects_to_delete.is_empty() {
return Ok(vec![]);
}
let return_keys = objects_to_delete.clone();
delete_objects(client, bucket_name, objects_to_delete).await?;
let objects = client.list_objects_v2().bucket(bucket_name).send().await?;
eprintln!("{objects:?}");
match objects.key_count {
Some(0) => Ok(return_keys),
_ => Err(S3ExampleError::new(
"There were still objects left in the bucket.",
)),
}
}
pub async fn delete_bucket(
client: &aws_sdk_s3::Client,
bucket_name: &str,
) -> Result<(), S3ExampleError> {
let resp = client.delete_bucket().bucket(bucket_name).send().await;
match resp {
Ok(_) => Ok(()),
Err(err) => {
if err
.as_service_error()
.and_then(aws_sdk_s3::error::ProvideErrorMetadata::code)
== Some("NoSuchBucket")
{
Ok(())
} else {
Err(S3ExampleError::from(err))
}
}
}
}
```
+ 如需 API 詳細資訊，請參閱*《適用於 Rust 的AWS SDK API 參考》*中的下列主題。
+ [CopyObject](https://docs.rs/aws-sdk-s3/latest/aws_sdk_s3/client/struct.Client.html#method.copy_object)
+ [CreateBucket](https://docs.rs/aws-sdk-s3/latest/aws_sdk_s3/client/struct.Client.html#method.create_bucket)
+ [DeleteBucket](https://docs.rs/aws-sdk-s3/latest/aws_sdk_s3/client/struct.Client.html#method.delete_bucket)
+ [DeleteObjects](https://docs.rs/aws-sdk-s3/latest/aws_sdk_s3/client/struct.Client.html#method.delete_objects)
+ [GetObject](https://docs.rs/aws-sdk-s3/latest/aws_sdk_s3/client/struct.Client.html#method.get_object)
+ [ListObjectsV2](https://docs.rs/aws-sdk-s3/latest/aws_sdk_s3/client/struct.Client.html#method.list_objects_v2)
+ [PutObject](https://docs.rs/aws-sdk-s3/latest/aws_sdk_s3/client/struct.Client.html#method.put_object)
------
#### [ SAP ABAP ]
**適用於 SAP ABAP 的開發套件**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/s3#code-examples)中設定和執行。
```
DATA(lo_session) = /aws1/cl_rt_session_aws=>create( cv_pfl ).
DATA(lo_s3) = /aws1/cl_s3_factory=>create( lo_session ).
" Create an Amazon Simple Storage Service (Amazon S3) bucket. "
TRY.
" determine our region from our session
DATA(lv_region) = CONV /aws1/s3_bucketlocationcnstrnt( lo_session->get_region( ) ).
DATA lo_constraint TYPE REF TO /aws1/cl_s3_createbucketconf.
" When in the us-east-1 region, you must not specify a constraint
" In all other regions, specify the region as the constraint
IF lv_region = 'us-east-1'.
CLEAR lo_constraint.
ELSE.
lo_constraint = NEW /aws1/cl_s3_createbucketconf( lv_region ).
ENDIF.
lo_s3->createbucket(
iv_bucket = iv_bucket_name
io_createbucketconfiguration = lo_constraint ).
MESSAGE 'S3 bucket created.' TYPE 'I'.
CATCH /aws1/cx_s3_bucketalrdyexists.
MESSAGE 'Bucket name already exists.' TYPE 'E'.
CATCH /aws1/cx_s3_bktalrdyownedbyyou.
MESSAGE 'Bucket already exists and is owned by you.' TYPE 'E'.
ENDTRY.
"Upload an object to an S3 bucket."
TRY.
"Get contents of file from application server."
DATA lv_file_content TYPE xstring.
OPEN DATASET iv_key FOR INPUT IN BINARY MODE.
READ DATASET iv_key INTO lv_file_content.
CLOSE DATASET iv_key.
lo_s3->putobject(
iv_bucket = iv_bucket_name
iv_key = iv_key
iv_body = lv_file_content ).
MESSAGE 'Object uploaded to S3 bucket.' TYPE 'I'.
CATCH /aws1/cx_s3_nosuchbucket.
MESSAGE 'Bucket does not exist.' TYPE 'E'.
ENDTRY.
" Get an object from a bucket. "
TRY.
DATA(lo_result) = lo_s3->getobject(
iv_bucket = iv_bucket_name
iv_key = iv_key ).
DATA(lv_object_data) = lo_result->get_body( ).
MESSAGE 'Object retrieved from S3 bucket.' TYPE 'I'.
CATCH /aws1/cx_s3_nosuchbucket.
MESSAGE 'Bucket does not exist.' TYPE 'E'.
CATCH /aws1/cx_s3_nosuchkey.
MESSAGE 'Object key does not exist.' TYPE 'E'.
ENDTRY.
" Copy an object to a subfolder in a bucket. "
TRY.
lo_s3->copyobject(
iv_bucket = iv_bucket_name
iv_key = |{ iv_copy_to_folder }/{ iv_key }|
iv_copysource = |{ iv_bucket_name }/{ iv_key }| ).
MESSAGE 'Object copied to a subfolder.' TYPE 'I'.
CATCH /aws1/cx_s3_nosuchbucket.
MESSAGE 'Bucket does not exist.' TYPE 'E'.
CATCH /aws1/cx_s3_nosuchkey.
MESSAGE 'Object key does not exist.' TYPE 'E'.
ENDTRY.
" List objects in the bucket. "
TRY.
DATA(lo_list) = lo_s3->listobjects(
iv_bucket = iv_bucket_name ).
MESSAGE 'Retrieved list of objects in S3 bucket.' TYPE 'I'.
CATCH /aws1/cx_s3_nosuchbucket.
MESSAGE 'Bucket does not exist.' TYPE 'E'.
ENDTRY.
DATA text TYPE string VALUE 'Object List - '.
DATA lv_object_key TYPE /aws1/s3_objectkey.
LOOP AT lo_list->get_contents( ) INTO DATA(lo_object).
lv_object_key = lo_object->get_key( ).
CONCATENATE lv_object_key ', ' INTO text.
ENDLOOP.
MESSAGE text TYPE'I'.
" Delete the objects in a bucket. "
TRY.
lo_s3->deleteobject(
iv_bucket = iv_bucket_name
iv_key = iv_key ).
lo_s3->deleteobject(
iv_bucket = iv_bucket_name
iv_key = |{ iv_copy_to_folder }/{ iv_key }| ).
MESSAGE 'Objects deleted from S3 bucket.' TYPE 'I'.
CATCH /aws1/cx_s3_nosuchbucket.
MESSAGE 'Bucket does not exist.' TYPE 'E'.
ENDTRY.
" Delete the bucket. "
TRY.
lo_s3->deletebucket(
iv_bucket = iv_bucket_name ).
MESSAGE 'Deleted S3 bucket.' TYPE 'I'.
CATCH /aws1/cx_s3_nosuchbucket.
MESSAGE 'Bucket does not exist.' TYPE 'E'.
ENDTRY.
```
+ 如需 API 詳細資訊，請參閱《適用於 SAP ABAP 的AWS SDK API 參考》**中的下列主題。
+ [CopyObject](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)
+ [CreateBucket](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)
+ [DeleteBucket](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)
+ [DeleteObjects](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)
+ [GetObject](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)
+ [ListObjectsV2](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)
+ [PutObject](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)
------
#### [ Swift ]
**適用於 Swift 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/swift/example_code/s3/basics#code-examples)中設定和執行。
```
import AWSS3
import Foundation
import AWSS3
import Smithy
import ClientRuntime
/// A class containing all the code that interacts with the AWS SDK for Swift.
public class ServiceHandler {
let configuration: S3Client.S3ClientConfiguration
let client: S3Client
enum HandlerError: Error {
case getObjectBody(String)
case readGetObjectBody(String)
case missingContents(String)
}
/// Initialize and return a new ``ServiceHandler`` object, which is used to drive the AWS calls
/// used for the example.
///
/// - Returns: A new ``ServiceHandler`` object, ready to be called to
/// execute AWS operations.
public init() async throws {
do {
configuration = try await S3Client.S3ClientConfiguration()
// configuration.region = "us-east-2" // Uncomment this to set the region programmatically.
client = S3Client(config: configuration)
}
catch {
print("ERROR: ", dump(error, name: "Initializing S3 client"))
throw error
}
}
/// Create a new user given the specified name.
///
/// - Parameters:
/// - name: Name of the bucket to create.
/// Throws an exception if an error occurs.
public func createBucket(name: String) async throws {
var input = CreateBucketInput(
bucket: name
)
// For regions other than "us-east-1", you must set the locationConstraint in the createBucketConfiguration.
// For more information, see LocationConstraint in the S3 API guide.
// https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html#API_CreateBucket_RequestBody
if let region = configuration.region {
if region != "us-east-1" {
input.createBucketConfiguration = S3ClientTypes.CreateBucketConfiguration(locationConstraint: S3ClientTypes.BucketLocationConstraint(rawValue: region))
}
}
do {
_ = try await client.createBucket(input: input)
}
catch let error as BucketAlreadyOwnedByYou {
print("The bucket '\(name)' already exists and is owned by you. You may wish to ignore this exception.")
throw error
}
catch {
print("ERROR: ", dump(error, name: "Creating a bucket"))
throw error
}
}
/// Delete a bucket.
/// - Parameter name: Name of the bucket to delete.
public func deleteBucket(name: String) async throws {
let input = DeleteBucketInput(
bucket: name
)
do {
_ = try await client.deleteBucket(input: input)
}
catch {
print("ERROR: ", dump(error, name: "Deleting a bucket"))
throw error
}
}
/// Upload a file from local storage to the bucket.
/// - Parameters:
/// - bucket: Name of the bucket to upload the file to.
/// - key: Name of the file to create.
/// - file: Path name of the file to upload.
public func uploadFile(bucket: String, key: String, file: String) async throws {
let fileUrl = URL(fileURLWithPath: file)
do {
let fileData = try Data(contentsOf: fileUrl)
let dataStream = ByteStream.data(fileData)
let input = PutObjectInput(
body: dataStream,
bucket: bucket,
key: key
)
_ = try await client.putObject(input: input)
}
catch {
print("ERROR: ", dump(error, name: "Putting an object."))
throw error
}
}
/// Create a file in the specified bucket with the given name. The new
/// file's contents are uploaded from a `Data` object.
///
/// - Parameters:
/// - bucket: Name of the bucket to create a file in.
/// - key: Name of the file to create.
/// - data: A `Data` object to write into the new file.
public func createFile(bucket: String, key: String, withData data: Data) async throws {
let dataStream = ByteStream.data(data)
let input = PutObjectInput(
body: dataStream,
bucket: bucket,
key: key
)
do {
_ = try await client.putObject(input: input)
}
catch {
print("ERROR: ", dump(error, name: "Putting an object."))
throw error
}
}
/// Download the named file to the given directory on the local device.
///
/// - Parameters:
/// - bucket: Name of the bucket that contains the file to be copied.
/// - key: The name of the file to copy from the bucket.
/// - to: The path of the directory on the local device where you want to
/// download the file.
public func downloadFile(bucket: String, key: String, to: String) async throws {
let fileUrl = URL(fileURLWithPath: to).appendingPathComponent(key)
let input = GetObjectInput(
bucket: bucket,
key: key
)
do {
let output = try await client.getObject(input: input)
guard let body = output.body else {
throw HandlerError.getObjectBody("GetObjectInput missing body.")
}
guard let data = try await body.readData() else {
throw HandlerError.readGetObjectBody("GetObjectInput unable to read data.")
}
try data.write(to: fileUrl)
}
catch {
print("ERROR: ", dump(error, name: "Downloading a file."))
throw error
}
}
/// Read the specified file from the given S3 bucket into a Swift
/// `Data` object.
///
/// - Parameters:
/// - bucket: Name of the bucket containing the file to read.
/// - key: Name of the file within the bucket to read.
///
/// - Returns: A `Data` object containing the complete file data.
public func readFile(bucket: String, key: String) async throws -> Data {
let input = GetObjectInput(
bucket: bucket,
key: key
)
do {
let output = try await client.getObject(input: input)
guard let body = output.body else {
throw HandlerError.getObjectBody("GetObjectInput missing body.")
}
guard let data = try await body.readData() else {
throw HandlerError.readGetObjectBody("GetObjectInput unable to read data.")
}
return data
}
catch {
print("ERROR: ", dump(error, name: "Reading a file."))
throw error
}
}
/// Copy a file from one bucket to another.
///
/// - Parameters:
/// - sourceBucket: Name of the bucket containing the source file.
/// - name: Name of the source file.
/// - destBucket: Name of the bucket to copy the file into.
public func copyFile(from sourceBucket: String, name: String, to destBucket: String) async throws {
let srcUrl = ("\(sourceBucket)/\(name)").addingPercentEncoding(withAllowedCharacters: .urlPathAllowed)
let input = CopyObjectInput(
bucket: destBucket,
copySource: srcUrl,
key: name
)
do {
_ = try await client.copyObject(input: input)
}
catch {
print("ERROR: ", dump(error, name: "Copying an object."))
throw error
}
}
/// Deletes the specified file from Amazon S3.
///
/// - Parameters:
/// - bucket: Name of the bucket containing the file to delete.
/// - key: Name of the file to delete.
///
public func deleteFile(bucket: String, key: String) async throws {
let input = DeleteObjectInput(
bucket: bucket,
key: key
)
do {
_ = try await client.deleteObject(input: input)
}
catch {
print("ERROR: ", dump(error, name: "Deleting a file."))
throw error
}
}
/// Returns an array of strings, each naming one file in the
/// specified bucket.
///
/// - Parameter bucket: Name of the bucket to get a file listing for.
/// - Returns: An array of `String` objects, each giving the name of
/// one file contained in the bucket.
public func listBucketFiles(bucket: String) async throws -> [String] {
do {
let input = ListObjectsV2Input(
bucket: bucket
)
// Use "Paginated" to get all the objects.
// This lets the SDK handle the 'continuationToken' in "ListObjectsV2Output".
let output = client.listObjectsV2Paginated(input: input)
var names: [String] = []
for try await page in output {
guard let objList = page.contents else {
print("ERROR: listObjectsV2Paginated returned nil contents.")
continue
}
for obj in objList {
if let objName = obj.key {
names.append(objName)
}
}
}
return names
}
catch {
print("ERROR: ", dump(error, name: "Listing objects."))
throw error
}
}
}
```
```
import AWSS3
import Foundation
import ServiceHandler
import ArgumentParser
/// The command-line arguments and options available for this
/// example command.
struct ExampleCommand: ParsableCommand {
@Argument(help: "Name of the S3 bucket to create")
var bucketName: String
@Argument(help: "Pathname of the file to upload to the S3 bucket")
var uploadSource: String
@Argument(help: "The name (key) to give the file in the S3 bucket")
var objName: String
@Argument(help: "S3 bucket to copy the object to")
var destBucket: String
@Argument(help: "Directory where you want to download the file from the S3 bucket")
var downloadDir: String
static var configuration = CommandConfiguration(
commandName: "s3-basics",
abstract: "Demonstrates a series of basic AWS S3 functions.",
discussion: """
Performs the following Amazon S3 commands:
* `CreateBucket`
* `PutObject`
* `GetObject`
* `CopyObject`
* `ListObjects`
* `DeleteObjects`
* `DeleteBucket`
"""
)
/// Called by ``main()`` to do the actual running of the AWS
/// example.
func runAsync() async throws {
let serviceHandler = try await ServiceHandler()
// 1. Create the bucket.
print("Creating the bucket \(bucketName)...")
try await serviceHandler.createBucket(name: bucketName)
// 2. Upload a file to the bucket.
print("Uploading the file \(uploadSource)...")
try await serviceHandler.uploadFile(bucket: bucketName, key: objName, file: uploadSource)
// 3. Download the file.
print("Downloading the file \(objName) to \(downloadDir)...")
try await serviceHandler.downloadFile(bucket: bucketName, key: objName, to: downloadDir)
// 4. Copy the file to another bucket.
print("Copying the file to the bucket \(destBucket)...")
try await serviceHandler.copyFile(from: bucketName, name: objName, to: destBucket)
// 5. List the contents of the bucket.
print("Getting a list of the files in the bucket \(bucketName)")
let fileList = try await serviceHandler.listBucketFiles(bucket: bucketName)
let numFiles = fileList.count
if numFiles != 0 {
print("\(numFiles) file\((numFiles > 1) ? "s" : "") in bucket \(bucketName):")
for name in fileList {
print(" \(name)")
}
} else {
print("No files found in bucket \(bucketName)")
}
// 6. Delete the objects from the bucket.
print("Deleting the file \(objName) from the bucket \(bucketName)...")
try await serviceHandler.deleteFile(bucket: bucketName, key: objName)
print("Deleting the file \(objName) from the bucket \(destBucket)...")
try await serviceHandler.deleteFile(bucket: destBucket, key: objName)
// 7. Delete the bucket.
print("Deleting the bucket \(bucketName)...")
try await serviceHandler.deleteBucket(name: bucketName)
print("Done.")
}
}
//
// Main program entry point.
//
@main
struct Main {
static func main() async {
let args = Array(CommandLine.arguments.dropFirst())
do {
let command = try ExampleCommand.parse(args)
try await command.runAsync()
} catch {
ExampleCommand.exit(withError: error)
}
}
}
```
+ 如需 API 詳細資訊，請參閱*《適用於 Swift 的AWS SDK API 參考》*中的下列主題。
+ [CopyObject](https://sdk.amazonaws.com/swift/api/awss3/latest/documentation/awss3/s3client/copyobject(input:))
+ [CreateBucket](https://sdk.amazonaws.com/swift/api/awss3/latest/documentation/awss3/s3client/createbucket(input:))
+ [DeleteBucket](https://sdk.amazonaws.com/swift/api/awss3/latest/documentation/awss3/s3client/deletebucket(input:))
+ [DeleteObjects](https://sdk.amazonaws.com/swift/api/awss3/latest/documentation/awss3/s3client/deleteobjects(input:))
+ [GetObject](https://sdk.amazonaws.com/swift/api/awss3/latest/documentation/awss3/s3client/getobject(input:))
+ [ListObjectsV2](https://sdk.amazonaws.com/swift/api/awss3/latest/documentation/awss3/s3client/listobjectsv2(input:))
+ [PutObject](https://sdk.amazonaws.com/swift/api/awss3/latest/documentation/awss3/s3client/putobject(input:))
------
# Amazon S3 AWS SDKs的動作
下列程式碼範例示範如何使用 AWS SDKs 執行個別 Amazon S3 動作。每個範例均包含 GitHub 的連結，您可以在連結中找到設定和執行程式碼的相關說明。
這些摘錄會呼叫 Amazon S3 API，是必須在內容中執行之大型程式的程式碼摘錄。您可以在 [Amazon S3 AWS SDKs案例](s3_code_examples_scenarios.md) 中查看內容中的動作。
下列範例僅包含最常使用的動作。如需完整的列表，請參閱 [Amazon Simple Storage Service API 參考資料](https://docs.aws.amazon.com/AmazonS3/latest/API/Welcome.html)。
**Topics**
+ [`AbortMultipartUpload`](s3_example_s3_AbortMultipartUpload_section.md)
+ [`CompleteMultipartUpload`](s3_example_s3_CompleteMultipartUpload_section.md)
+ [`CopyObject`](s3_example_s3_CopyObject_section.md)
+ [`CreateBucket`](s3_example_s3_CreateBucket_section.md)
+ [`CreateMultiRegionAccessPoint`](s3_example_s3_CreateMultiRegionAccessPoint_section.md)
+ [`CreateMultipartUpload`](s3_example_s3_CreateMultipartUpload_section.md)
+ [`CreatePresignedPost`](s3_example_s3_CreatePresignedPost_section.md)
+ [`DeleteBucket`](s3_example_s3_DeleteBucket_section.md)
+ [`DeleteBucketAnalyticsConfiguration`](s3_example_s3_DeleteBucketAnalyticsConfiguration_section.md)
+ [`DeleteBucketCors`](s3_example_s3_DeleteBucketCors_section.md)
+ [`DeleteBucketEncryption`](s3_example_s3_DeleteBucketEncryption_section.md)
+ [`DeleteBucketInventoryConfiguration`](s3_example_s3_DeleteBucketInventoryConfiguration_section.md)
+ [`DeleteBucketLifecycle`](s3_example_s3_DeleteBucketLifecycle_section.md)
+ [`DeleteBucketMetricsConfiguration`](s3_example_s3_DeleteBucketMetricsConfiguration_section.md)
+ [`DeleteBucketPolicy`](s3_example_s3_DeleteBucketPolicy_section.md)
+ [`DeleteBucketReplication`](s3_example_s3_DeleteBucketReplication_section.md)
+ [`DeleteBucketTagging`](s3_example_s3_DeleteBucketTagging_section.md)
+ [`DeleteBucketWebsite`](s3_example_s3_DeleteBucketWebsite_section.md)
+ [`DeleteObject`](s3_example_s3_DeleteObject_section.md)
+ [`DeleteObjectTagging`](s3_example_s3_DeleteObjectTagging_section.md)
+ [`DeleteObjects`](s3_example_s3_DeleteObjects_section.md)
+ [`DeletePublicAccessBlock`](s3_example_s3_DeletePublicAccessBlock_section.md)
+ [`GetBucketAccelerateConfiguration`](s3_example_s3_GetBucketAccelerateConfiguration_section.md)
+ [`GetBucketAcl`](s3_example_s3_GetBucketAcl_section.md)
+ [`GetBucketAnalyticsConfiguration`](s3_example_s3_GetBucketAnalyticsConfiguration_section.md)
+ [`GetBucketCors`](s3_example_s3_GetBucketCors_section.md)
+ [`GetBucketEncryption`](s3_example_s3_GetBucketEncryption_section.md)
+ [`GetBucketInventoryConfiguration`](s3_example_s3_GetBucketInventoryConfiguration_section.md)
+ [`GetBucketLifecycleConfiguration`](s3_example_s3_GetBucketLifecycleConfiguration_section.md)
+ [`GetBucketLocation`](s3_example_s3_GetBucketLocation_section.md)
+ [`GetBucketLogging`](s3_example_s3_GetBucketLogging_section.md)
+ [`GetBucketMetricsConfiguration`](s3_example_s3_GetBucketMetricsConfiguration_section.md)
+ [`GetBucketNotification`](s3_example_s3_GetBucketNotification_section.md)
+ [`GetBucketPolicy`](s3_example_s3_GetBucketPolicy_section.md)
+ [`GetBucketPolicyStatus`](s3_example_s3_GetBucketPolicyStatus_section.md)
+ [`GetBucketReplication`](s3_example_s3_GetBucketReplication_section.md)
+ [`GetBucketRequestPayment`](s3_example_s3_GetBucketRequestPayment_section.md)
+ [`GetBucketTagging`](s3_example_s3_GetBucketTagging_section.md)
+ [`GetBucketVersioning`](s3_example_s3_GetBucketVersioning_section.md)
+ [`GetBucketWebsite`](s3_example_s3_GetBucketWebsite_section.md)
+ [`GetObject`](s3_example_s3_GetObject_section.md)
+ [`GetObjectAcl`](s3_example_s3_GetObjectAcl_section.md)
+ [`GetObjectAttributes`](s3_example_s3_GetObjectAttributes_section.md)
+ [`GetObjectLegalHold`](s3_example_s3_GetObjectLegalHold_section.md)
+ [`GetObjectLockConfiguration`](s3_example_s3_GetObjectLockConfiguration_section.md)
+ [`GetObjectRetention`](s3_example_s3_GetObjectRetention_section.md)
+ [`GetObjectTagging`](s3_example_s3_GetObjectTagging_section.md)
+ [`GetPublicAccessBlock`](s3_example_s3_GetPublicAccessBlock_section.md)
+ [`HeadBucket`](s3_example_s3_HeadBucket_section.md)
+ [`HeadObject`](s3_example_s3_HeadObject_section.md)
+ [`ListBucketAnalyticsConfigurations`](s3_example_s3_ListBucketAnalyticsConfigurations_section.md)
+ [`ListBucketInventoryConfigurations`](s3_example_s3_ListBucketInventoryConfigurations_section.md)
+ [`ListBuckets`](s3_example_s3_ListBuckets_section.md)
+ [`ListMultipartUploads`](s3_example_s3_ListMultipartUploads_section.md)
+ [`ListObjectVersions`](s3_example_s3_ListObjectVersions_section.md)
+ [`ListObjects`](s3_example_s3_ListObjects_section.md)
+ [`ListObjectsV2`](s3_example_s3_ListObjectsV2_section.md)
+ [`PutBucketAccelerateConfiguration`](s3_example_s3_PutBucketAccelerateConfiguration_section.md)
+ [`PutBucketAcl`](s3_example_s3_PutBucketAcl_section.md)
+ [`PutBucketCors`](s3_example_s3_PutBucketCors_section.md)
+ [`PutBucketEncryption`](s3_example_s3_PutBucketEncryption_section.md)
+ [`PutBucketLifecycleConfiguration`](s3_example_s3_PutBucketLifecycleConfiguration_section.md)
+ [`PutBucketLogging`](s3_example_s3_PutBucketLogging_section.md)
+ [`PutBucketNotification`](s3_example_s3_PutBucketNotification_section.md)
+ [`PutBucketNotificationConfiguration`](s3_example_s3_PutBucketNotificationConfiguration_section.md)
+ [`PutBucketPolicy`](s3_example_s3_PutBucketPolicy_section.md)
+ [`PutBucketReplication`](s3_example_s3_PutBucketReplication_section.md)
+ [`PutBucketRequestPayment`](s3_example_s3_PutBucketRequestPayment_section.md)
+ [`PutBucketTagging`](s3_example_s3_PutBucketTagging_section.md)
+ [`PutBucketVersioning`](s3_example_s3_PutBucketVersioning_section.md)
+ [`PutBucketWebsite`](s3_example_s3_PutBucketWebsite_section.md)
+ [`PutObject`](s3_example_s3_PutObject_section.md)
+ [`PutObjectAcl`](s3_example_s3_PutObjectAcl_section.md)
+ [`PutObjectLegalHold`](s3_example_s3_PutObjectLegalHold_section.md)
+ [`PutObjectLockConfiguration`](s3_example_s3_PutObjectLockConfiguration_section.md)
+ [`PutObjectRetention`](s3_example_s3_PutObjectRetention_section.md)
+ [`RestoreObject`](s3_example_s3_RestoreObject_section.md)
+ [`SelectObjectContent`](s3_example_s3_SelectObjectContent_section.md)
+ [`UploadPart`](s3_example_s3_UploadPart_section.md)
+ [`UploadPartCopy`](s3_example_s3_UploadPartCopy_section.md)
# `AbortMultipartUpload` 搭配 AWS SDK 或 CLI 使用
下列程式碼範例示範如何使用 `AbortMultipartUpload`。
動作範例是大型程式的程式碼摘錄，必須在內容中執行。您可以在下列程式碼範例的內容中看到此動作：
+ [刪除未完成的分段上傳](s3_example_s3_Scenario_AbortMultipartUpload_section.md)
+ [使用 Amazon S3 物件完整性](s3_example_s3_Scenario_ObjectIntegrity_section.md)
------
#### [ C\$1\$1 ]
**適用於 C\$1\$1 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/s3#code-examples)中設定和執行。
```
//! Abort a multipart upload to an S3 bucket.
/*!
\param bucket: The name of the S3 bucket where the object will be uploaded.
\param key: The unique identifier (key) for the object within the S3 bucket.
\param uploadID: An upload ID string.
\param client: The S3 client instance used to perform the upload operation.
\return bool: Function succeeded.
*/
bool AwsDoc::S3::abortMultipartUpload(const Aws::String &bucket,
const Aws::String &key,
const Aws::String &uploadID,
const Aws::S3::S3Client &client) {
Aws::S3::Model::AbortMultipartUploadRequest request;
request.SetBucket(bucket);
request.SetKey(key);
request.SetUploadId(uploadID);
Aws::S3::Model::AbortMultipartUploadOutcome outcome =
client.AbortMultipartUpload(request);
if (outcome.IsSuccess()) {
std::cout << "Multipart upload aborted." << std::endl;
} else {
std::cerr << "Error aborting multipart upload: " << outcome.GetError().GetMessage() << std::endl;
}
return outcome.IsSuccess();
}
```
+ 如需 API 詳細資訊，請參閱《適用於 C\$1\$1 的 AWS SDK API 參考》**中 [AbortMultipartUpload](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/AbortMultipartUpload)。
------
#### [ CLI ]
**AWS CLI**
**中止指定的分段上傳**
下列 `abort-multipart-upload` 命令會中止儲存貯體 `amzn-s3-demo-bucket` 中金鑰 `multipart/01` 的分段上傳。
```
aws s3api abort-multipart-upload \
--bucket amzn-s3-demo-bucket \
--key multipart/01 \
--upload-id dfRtDYU0WWCCcH43C3WFbkRONycyCpTJJvxu2i5GYkZljF.Yxwh6XG7WfS2vC4to6HiV6Yjlx.cph0gtNBtJ8P3URCSbB7rjxI5iEwVDmgaXZOGgkk5nVTW16HOQ5l0R
```
此命令所需的上傳 ID 是由 `create-multipart-upload` 輸出，也可以使用 `list-multipart-uploads` 擷取。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中 [AbortMultipartUpload](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3api/abort-multipart-upload.html)。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/s3#code-examples)中設定和執行。
```
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import software.amazon.awssdk.core.exception.SdkException;
import software.amazon.awssdk.core.sync.RequestBody;
import software.amazon.awssdk.services.s3.S3Client;
import software.amazon.awssdk.services.s3.model.AbortMultipartUploadRequest;
import software.amazon.awssdk.services.s3.model.AbortMultipartUploadResponse;
import software.amazon.awssdk.services.s3.model.CompletedMultipartUpload;
import software.amazon.awssdk.services.s3.model.CompletedPart;
import software.amazon.awssdk.services.s3.model.CreateMultipartUploadResponse;
import software.amazon.awssdk.services.s3.model.LifecycleRule;
import software.amazon.awssdk.services.s3.model.ListMultipartUploadsRequest;
import software.amazon.awssdk.services.s3.model.ListMultipartUploadsResponse;
import software.amazon.awssdk.services.s3.model.MultipartUpload;
import software.amazon.awssdk.services.s3.model.PutBucketLifecycleConfigurationResponse;
import software.amazon.awssdk.services.s3.model.S3Exception;
import software.amazon.awssdk.services.s3.model.UploadPartRequest;
import software.amazon.awssdk.services.s3.model.UploadPartResponse;
import software.amazon.awssdk.services.s3.waiters.S3Waiter;
import software.amazon.awssdk.services.sts.StsClient;
import software.amazon.awssdk.utils.builder.SdkBuilder;
import java.io.IOException;
import java.io.RandomAccessFile;
import java.net.URISyntaxException;
import java.net.URL;
import java.nio.ByteBuffer;
import java.time.Duration;
import java.time.Instant;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import java.util.Objects;
import java.util.UUID;
import static software.amazon.awssdk.transfer.s3.SizeConstant.KB;
/**
* Before running this Java V2 code example, set up your development
* environment, including your credentials.
*
* For more information, see the following documentation topic:
*
* https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/get-started.html
*/
public class AbortMultipartUploadExamples {
static final String bucketName = "amzn-s3-demo-bucket" + UUID.randomUUID(); // Change bucket name.
static final String key = UUID.randomUUID().toString();
static final String classPathFilePath = "/multipartUploadFiles/s3-userguide.pdf";
static final String filePath = getFullFilePath(classPathFilePath);
static final S3Client s3Client = S3Client.create();
private static final Logger logger = LoggerFactory.getLogger(AbortMultipartUploadExamples.class);
private static String accountId = getAccountId();
public static void main(String[] args) {
doAbortIncompleteMultipartUploadsFromList();
doAbortMultipartUploadUsingUploadId();
doAbortIncompleteMultipartUploadsOlderThan();
doAbortMultipartUploadsUsingLifecycleConfig();
}
// A wrapper method that sets up the multipart upload environment for abortIncompleteMultipartUploadsFromList().
public static void doAbortIncompleteMultipartUploadsFromList() {
createBucket();
initiateAndInterruptMultiPartUpload("uploadThread");
abortIncompleteMultipartUploadsFromList();
deleteResources();
}
/**
* Aborts all incomplete multipart uploads from the specified S3 bucket.
*
* This method retrieves a list of all incomplete multipart uploads in the specified S3 bucket,
* and then aborts each of those uploads.
*/
public static void abortIncompleteMultipartUploadsFromList() {
ListMultipartUploadsRequest listMultipartUploadsRequest = ListMultipartUploadsRequest.builder()
.bucket(bucketName)
.build();
ListMultipartUploadsResponse response = s3Client.listMultipartUploads(listMultipartUploadsRequest);
List uploads = response.uploads();
AbortMultipartUploadRequest abortMultipartUploadRequest;
for (MultipartUpload upload : uploads) {
abortMultipartUploadRequest = AbortMultipartUploadRequest.builder()
.bucket(bucketName)
.key(upload.key())
.expectedBucketOwner(accountId)
.uploadId(upload.uploadId())
.build();
AbortMultipartUploadResponse abortMultipartUploadResponse = s3Client.abortMultipartUpload(abortMultipartUploadRequest);
if (abortMultipartUploadResponse.sdkHttpResponse().isSuccessful()) {
logger.info("Upload ID [{}] to bucket [{}] successfully aborted.", upload.uploadId(), bucketName);
}
}
}
// A wrapper method that sets up the multipart upload environment for abortIncompleteMultipartUploadsOlderThan().
static void doAbortIncompleteMultipartUploadsOlderThan() {
createBucket();
Instant secondUploadInstant = initiateAndInterruptTwoUploads();
abortIncompleteMultipartUploadsOlderThan(secondUploadInstant);
deleteResources();
}
static void abortIncompleteMultipartUploadsOlderThan(Instant pointInTime) {
ListMultipartUploadsRequest listMultipartUploadsRequest = ListMultipartUploadsRequest.builder()
.bucket(bucketName)
.build();
ListMultipartUploadsResponse response = s3Client.listMultipartUploads(listMultipartUploadsRequest);
List uploads = response.uploads();
AbortMultipartUploadRequest abortMultipartUploadRequest;
for (MultipartUpload upload : uploads) {
logger.info("Found multipartUpload with upload ID [{}], initiated [{}]", upload.uploadId(), upload.initiated());
if (upload.initiated().isBefore(pointInTime)) {
abortMultipartUploadRequest = AbortMultipartUploadRequest.builder()
.bucket(bucketName)
.key(upload.key())
.expectedBucketOwner(accountId)
.uploadId(upload.uploadId())
.build();
AbortMultipartUploadResponse abortMultipartUploadResponse = s3Client.abortMultipartUpload(abortMultipartUploadRequest);
if (abortMultipartUploadResponse.sdkHttpResponse().isSuccessful()) {
logger.info("Upload ID [{}] to bucket [{}] successfully aborted.", upload.uploadId(), bucketName);
}
}
}
}
// A wrapper method that sets up the multipart upload environment for abortMultipartUploadUsingUploadId().
static void doAbortMultipartUploadUsingUploadId() {
createBucket();
try {
abortMultipartUploadUsingUploadId();
} catch (S3Exception e) {
logger.error(e.getMessage());
} finally {
deleteResources();
}
}
static void abortMultipartUploadUsingUploadId() {
String uploadId = startUploadReturningUploadId();
AbortMultipartUploadResponse response = s3Client.abortMultipartUpload(b -> b
.uploadId(uploadId)
.bucket(bucketName)
.key(key));
if (response.sdkHttpResponse().isSuccessful()) {
logger.info("Upload ID [{}] to bucket [{}] successfully aborted.", uploadId, bucketName);
}
}
// A wrapper method that sets up the multipart upload environment for abortMultipartUploadsUsingLifecycleConfig().
static void doAbortMultipartUploadsUsingLifecycleConfig() {
createBucket();
try {
abortMultipartUploadsUsingLifecycleConfig();
} catch (S3Exception e) {
logger.error(e.getMessage());
} finally {
deleteResources();
}
}
static void abortMultipartUploadsUsingLifecycleConfig() {
Collection lifeCycleRules = List.of(LifecycleRule.builder()
.abortIncompleteMultipartUpload(b -> b.
daysAfterInitiation(7))
.status("Enabled")
.filter(SdkBuilder::build) // Filter element is required.
.build());
// If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
PutBucketLifecycleConfigurationResponse response = s3Client.putBucketLifecycleConfiguration(b -> b
.bucket(bucketName)
.lifecycleConfiguration(b1 -> b1.rules(lifeCycleRules)));
if (response.sdkHttpResponse().isSuccessful()) {
logger.info("Rule to abort incomplete multipart uploads added to bucket.");
} else {
logger.error("Unsuccessfully applied rule. HTTP status code is [{}]", response.sdkHttpResponse().statusCode());
}
}
/************************
Multipart upload methods
***********************/
static void initiateAndInterruptMultiPartUpload(String threadName) {
Runnable upload = () -> {
try {
AbortMultipartUploadExamples.doMultipartUpload();
} catch (SdkException e) {
logger.error(e.getMessage());
}
};
Thread uploadThread = new Thread(upload, threadName);
uploadThread.start();
try {
Thread.sleep(Duration.ofSeconds(1).toMillis()); // Give the multipart upload time to register.
} catch (InterruptedException e) {
logger.error(e.getMessage());
}
uploadThread.interrupt();
}
static Instant initiateAndInterruptTwoUploads() {
Instant firstUploadInstant = Instant.now();
initiateAndInterruptMultiPartUpload("uploadThread1");
try {
Thread.sleep(Duration.ofSeconds(5).toMillis());
} catch (InterruptedException e) {
logger.error(e.getMessage());
}
Instant secondUploadInstant = Instant.now();
initiateAndInterruptMultiPartUpload("uploadThread2");
return secondUploadInstant;
}
static void doMultipartUpload() {
String uploadId = step1CreateMultipartUpload();
List completedParts = step2UploadParts(uploadId);
step3CompleteMultipartUpload(uploadId, completedParts);
}
static String step1CreateMultipartUpload() {
CreateMultipartUploadResponse createMultipartUploadResponse = s3Client.createMultipartUpload(b -> b
.bucket(bucketName)
.key(key));
return createMultipartUploadResponse.uploadId();
}
static List step2UploadParts(String uploadId) {
int partNumber = 1;
List completedParts = new ArrayList<>();
ByteBuffer bb = ByteBuffer.allocate(Long.valueOf(1024 * KB).intValue());
try (RandomAccessFile file = new RandomAccessFile(filePath, "r")) {
long fileSize = file.length();
long position = 0;
while (position < fileSize) {
file.seek(position);
long read = file.getChannel().read(bb);
bb.flip(); // Swap position and limit before reading from the buffer.
UploadPartRequest uploadPartRequest = UploadPartRequest.builder()
.bucket(bucketName)
.key(key)
.uploadId(uploadId)
.partNumber(partNumber)
.build();
UploadPartResponse partResponse = s3Client.uploadPart(
uploadPartRequest,
RequestBody.fromByteBuffer(bb));
CompletedPart part = CompletedPart.builder()
.partNumber(partNumber)
.eTag(partResponse.eTag())
.build();
completedParts.add(part);
logger.info("Part {} upload", partNumber);
bb.clear();
position += read;
partNumber++;
}
} catch (IOException | S3Exception e) {
logger.error(e.getMessage());
return null;
}
return completedParts;
}
static void step3CompleteMultipartUpload(String uploadId, List completedParts) {
s3Client.completeMultipartUpload(b -> b
.bucket(bucketName)
.key(key)
.uploadId(uploadId)
.multipartUpload(CompletedMultipartUpload.builder().parts(completedParts).build()));
}
static String startUploadReturningUploadId() {
String uploadId = step1CreateMultipartUpload();
doMultipartUploadWithUploadId(uploadId);
return uploadId;
}
static void doMultipartUploadWithUploadId(String uploadId) {
new Thread(() -> {
try {
List completedParts = step2UploadParts(uploadId);
step3CompleteMultipartUpload(uploadId, completedParts);
} catch (SdkException e) {
logger.error(e.getMessage());
}
}, "upload thread").start();
try {
Thread.sleep(Duration.ofSeconds(2L).toMillis());
} catch (InterruptedException e) {
logger.error(e.getMessage());
System.exit(1);
}
}
/*************************
Resource handling methods
************************/
static void createBucket() {
logger.info("Creating bucket: [{}]", bucketName);
s3Client.createBucket(b -> b.bucket(bucketName));
try (S3Waiter s3Waiter = s3Client.waiter()) {
s3Waiter.waitUntilBucketExists(b -> b.bucket(bucketName));
}
logger.info("Bucket created.");
}
static void deleteResources() {
logger.info("Deleting resources ...");
s3Client.deleteObject(b -> b.bucket(bucketName).key(key));
s3Client.deleteBucket(b -> b.bucket(bucketName));
try (S3Waiter s3Waiter = s3Client.waiter()) {
s3Waiter.waitUntilBucketNotExists(b -> b.bucket(bucketName));
}
logger.info("Resources deleted.");
}
private static String getAccountId() {
try (StsClient stsClient = StsClient.create()) {
return stsClient.getCallerIdentity().account();
}
}
static String getFullFilePath(String filePath) {
URL uploadDirectoryURL = PerformMultiPartUpload.class.getResource(filePath);
String fullFilePath;
try {
fullFilePath = Objects.requireNonNull(uploadDirectoryURL).toURI().getPath();
} catch (URISyntaxException e) {
throw new RuntimeException(e);
}
return fullFilePath;
}
}
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Java 2.x API 參考》**中 [AbortMultipartUpload](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/AbortMultipartUpload)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此命令中止 5 天前建立的分段上傳。**
```
Remove-S3MultipartUpload -BucketName amzn-s3-demo-bucket -DaysBefore 5
```
**範例 2：此命令中止 2014 年 1 月 2 日之前建立的分段上傳。**
```
Remove-S3MultipartUpload -BucketName amzn-s3-demo-bucket -InitiatedDate "Thursday, January 02, 2014"
```
**範例 3：此命令中止 2014 年 1 月 2 日 10:45:37 之前建立的分段上傳。**
```
Remove-S3MultipartUpload -BucketName amzn-s3-demo-bucket -InitiatedDate "2014/01/02 10:45:37"
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中 [AbortMultipartUpload](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此命令中止 5 天前建立的分段上傳。**
```
Remove-S3MultipartUpload -BucketName amzn-s3-demo-bucket -DaysBefore 5
```
**範例 2：此命令中止 2014 年 1 月 2 日之前建立的分段上傳。**
```
Remove-S3MultipartUpload -BucketName amzn-s3-demo-bucket -InitiatedDate "Thursday, January 02, 2014"
```
**範例 3：此命令中止 2014 年 1 月 2 日 10:45:37 之前建立的分段上傳。**
```
Remove-S3MultipartUpload -BucketName amzn-s3-demo-bucket -InitiatedDate "2014/01/02 10:45:37"
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中 [AbortMultipartUpload](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# `CompleteMultipartUpload` 搭配 AWS SDK 或 CLI 使用
下列程式碼範例示範如何使用 `CompleteMultipartUpload`。
動作範例是大型程式的程式碼摘錄，必須在內容中執行。您可以在下列程式碼範例的內容中看到此動作：
+ [執行分段複製](s3_example_s3_MultipartCopy_section.md)
+ [使用檢查總和](s3_example_s3_Scenario_UseChecksums_section.md)
+ [使用 Amazon S3 物件完整性](s3_example_s3_Scenario_ObjectIntegrity_section.md)
------
#### [ C\$1\$1 ]
**適用於 C\$1\$1 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/s3#code-examples)中設定和執行。
```
//! Complete a multipart upload to an S3 bucket.
/*!
\param bucket: The name of the S3 bucket where the object will be uploaded.
\param key: The unique identifier (key) for the object within the S3 bucket.
\param uploadID: An upload ID string.
\param parts: A vector of CompleteParts.
\param client: The S3 client instance used to perform the upload operation.
\return CompleteMultipartUploadOutcome: The request outcome.
*/
Aws::S3::Model::CompleteMultipartUploadOutcome AwsDoc::S3::completeMultipartUpload(const Aws::String &bucket,
const Aws::String &key,
const Aws::String &uploadID,
const Aws::Vector &parts,
const Aws::S3::S3Client &client) {
Aws::S3::Model::CompletedMultipartUpload completedMultipartUpload;
completedMultipartUpload.SetParts(parts);
Aws::S3::Model::CompleteMultipartUploadRequest request;
request.SetBucket(bucket);
request.SetKey(key);
request.SetUploadId(uploadID);
request.SetMultipartUpload(completedMultipartUpload);
Aws::S3::Model::CompleteMultipartUploadOutcome outcome =
client.CompleteMultipartUpload(request);
if (!outcome.IsSuccess()) {
std::cerr << "Error completing multipart upload: " << outcome.GetError().GetMessage() << std::endl;
}
return outcome;
}
```
+ 如需 API 詳細資訊，請參閱《適用於 C\$1\$1 的 AWS SDK API 參考》**中的 [CompleteMultipartUpload](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/CompleteMultipartUpload)。
------
#### [ CLI ]
**AWS CLI**
下列命令會完成儲存貯體 `amzn-s3-demo-bucket` 中金鑰 `multipart/01` 的分段上傳：
```
aws s3api complete-multipart-upload --multipart-upload file://mpustruct --bucket amzn-s3-demo-bucket --key 'multipart/01' --upload-id dfRtDYU0WWCCcH43C3WFbkRONycyCpTJJvxu2i5GYkZljF.Yxwh6XG7WfS2vC4to6HiV6Yjlx.cph0gtNBtJ8P3URCSbB7rjxI5iEwVDmgaXZOGgkk5nVTW16HOQ5l0R
```
此命令所需的上傳 ID 是由 `create-multipart-upload` 輸出，也可以使用 `list-multipart-uploads` 擷取。
上述命令中的分段上傳選項採用 JSON 結構，該結構描述了應重新組合成完整檔案的分段上傳的各個部分。在此範例中，`file://` 字首用於從本機資料夾中名為 `mpustruct` 的檔案載入 JSON 結構。
mpustruct：
```
{
"Parts": [
{
"ETag": "e868e0f4719e394144ef36531ee6824c",
"PartNumber": 1
},
{
"ETag": "6bb2b12753d66fe86da4998aa33fffb0",
"PartNumber": 2
},
{
"ETag": "d0a0112e841abec9c9ec83406f0159c8",
"PartNumber": 3
}
]
}
```
每次使用 `upload-part` 命令上傳各部分時，都會輸出每個部分的 ETag 值，也可以透過呼叫 `list-parts` 或計算每個部分的 MD5 檢查總和來擷取。
輸出：
```
{
"ETag": "\"3944a9f7a4faab7f78788ff6210f63f0-3\"",
"Bucket": "amzn-s3-demo-bucket",
"Location": "https://amzn-s3-demo-bucket.s3.amazonaws.com/multipart%2F01",
"Key": "multipart/01"
}
```
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [CompleteMultipartUpload](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3api/complete-multipart-upload.html)。
------
#### [ Rust ]
**適用於 Rust 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/rustv1/examples/s3#code-examples)中設定和執行。
```
// upload_parts: Vec
let completed_multipart_upload: CompletedMultipartUpload = CompletedMultipartUpload::builder()
.set_parts(Some(upload_parts))
.build();
let _complete_multipart_upload_res = client
.complete_multipart_upload()
.bucket(&bucket_name)
.key(&key)
.multipart_upload(completed_multipart_upload)
.upload_id(upload_id)
.send()
.await?;
```
```
// Create a multipart upload. Use UploadPart and CompleteMultipartUpload to
// upload the file.
let multipart_upload_res: CreateMultipartUploadOutput = client
.create_multipart_upload()
.bucket(&bucket_name)
.key(&key)
.send()
.await?;
let upload_id = multipart_upload_res.upload_id().ok_or(S3ExampleError::new(
"Missing upload_id after CreateMultipartUpload",
))?;
```
```
let mut upload_parts: Vec = Vec::new();
for chunk_index in 0..chunk_count {
let this_chunk = if chunk_count - 1 == chunk_index {
size_of_last_chunk
} else {
CHUNK_SIZE
};
let stream = ByteStream::read_from()
.path(path)
.offset(chunk_index * CHUNK_SIZE)
.length(Length::Exact(this_chunk))
.build()
.await
.unwrap();
// Chunk index needs to start at 0, but part numbers start at 1.
let part_number = (chunk_index as i32) + 1;
let upload_part_res = client
.upload_part()
.key(&key)
.bucket(&bucket_name)
.upload_id(upload_id)
.body(stream)
.part_number(part_number)
.send()
.await?;
upload_parts.push(
CompletedPart::builder()
.e_tag(upload_part_res.e_tag.unwrap_or_default())
.part_number(part_number)
.build(),
);
}
```
+ 如需 API 詳細資訊，請參閱《適用於 Rust 的AWS SDK API 參考》**中的 [CompleteMultipartUpload](https://docs.rs/aws-sdk-s3/latest/aws_sdk_s3/client/struct.Client.html#method.complete_multipart_upload)。
------
# `CopyObject` 搭配 AWS SDK 或 CLI 使用
下列程式碼範例示範如何使用 `CopyObject`。
動作範例是大型程式的程式碼摘錄，必須在內容中執行。您可以在下列程式碼範例的內容中看到此動作：
+ [了解基本概念](s3_example_s3_Scenario_GettingStarted_section.md)
+ [開始使用加密](s3_example_s3_Encryption_section.md)
+ [開始使用 S3](s3_example_s3_GettingStarted_section.md)
+ [提出條件式請求](s3_example_s3_Scenario_ConditionalRequests_section.md)
------
#### [ .NET ]
**適用於 .NET 的 SDK (v4)**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv4/S3#code-examples)中設定和執行。
```
///
/// Copies an object in an Amazon S3 bucket to a folder within the
/// same bucket.
///
/// The name of the Amazon S3 bucket where the
/// object to copy is located.
/// The object to be copied.
/// The folder to which the object will
/// be copied.
/// A boolean value that indicates the success or failure of
/// the copy operation.
public async Task CopyObjectInBucketAsync(
string bucketName,
string objectName,
string folderName)
{
try
{
var request = new CopyObjectRequest
{
SourceBucket = bucketName,
SourceKey = objectName,
DestinationBucket = bucketName,
DestinationKey = $"{folderName}\\{objectName}",
};
var response = await _amazonS3.CopyObjectAsync(request);
return response.HttpStatusCode == System.Net.HttpStatusCode.OK;
}
catch (AmazonS3Exception ex)
{
Console.WriteLine($"Error copying object: '{ex.Message}'");
return false;
}
}
```
+ 如需 API 詳細資訊，請參閱*《適用於 .NET 的 AWS SDK API 參考》*中的 [CopyObject](https://docs.aws.amazon.com/goto/DotNetSDKV4/s3-2006-03-01/CopyObject)。
**適用於 .NET 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/S3#code-examples)中設定和執行。
使用條件式請求複製物件。
```
///
/// Copies an object from one Amazon S3 bucket to another with a conditional request.
///
/// The key of the source object to copy.
/// The key of the destination object.
/// The source bucket of the object.
/// The destination bucket of the object.
/// The type of condition to apply, e.g. 'CopySourceIfMatch', 'CopySourceIfNoneMatch', 'CopySourceIfModifiedSince', 'CopySourceIfUnmodifiedSince'.
/// The value to use for the condition for dates.
/// The value to use for the condition for etags.
/// True if the conditional copy is successful, False otherwise.
public async Task CopyObjectConditional(string sourceKey, string destKey, string sourceBucket, string destBucket,
S3ConditionType conditionType, DateTime? conditionDateValue = null, string? etagConditionalValue = null)
{
try
{
var copyObjectRequest = new CopyObjectRequest
{
DestinationBucket = destBucket,
DestinationKey = destKey,
SourceBucket = sourceBucket,
SourceKey = sourceKey
};
switch (conditionType)
{
case S3ConditionType.IfMatch:
copyObjectRequest.ETagToMatch = etagConditionalValue;
break;
case S3ConditionType.IfNoneMatch:
copyObjectRequest.ETagToNotMatch = etagConditionalValue;
break;
case S3ConditionType.IfModifiedSince:
copyObjectRequest.ModifiedSinceDateUtc = conditionDateValue.GetValueOrDefault();
break;
case S3ConditionType.IfUnmodifiedSince:
copyObjectRequest.UnmodifiedSinceDateUtc = conditionDateValue.GetValueOrDefault();
break;
default:
throw new ArgumentOutOfRangeException(nameof(conditionType), conditionType, null);
}
await _amazonS3.CopyObjectAsync(copyObjectRequest);
_logger.LogInformation($"Conditional copy successful for key {destKey} in bucket {destBucket}.");
return true;
}
catch (AmazonS3Exception e)
{
if (e.ErrorCode == "PreconditionFailed")
{
_logger.LogError("Conditional copy failed: Precondition failed");
}
else if (e.ErrorCode == "304")
{
_logger.LogError("Conditional copy failed: Object not modified");
}
else
{
_logger.LogError($"Unexpected error: {e.ErrorCode}");
throw;
}
return false;
}
}
```
+ 如需 API 詳細資訊，請參閱*《適用於 .NET 的 AWS SDK API 參考》*中的 [CopyObject](https://docs.aws.amazon.com/goto/DotNetSDKV3/s3-2006-03-01/CopyObject)。
------
#### [ Bash ]
**AWS CLI 使用 Bash 指令碼**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/aws-cli/bash-linux/s3#code-examples)中設定和執行。
```
###############################################################################
# function errecho
#
# This function outputs everything sent to it to STDERR (standard error output).
###############################################################################
function errecho() {
printf "%s\n" "$*" 1>&2
}
###############################################################################
# function copy_item_in_bucket
#
# This function creates a copy of the specified file in the same bucket.
#
# Parameters:
# $1 - The name of the bucket to copy the file from and to.
# $2 - The key of the source file to copy.
# $3 - The key of the destination file.
#
# Returns:
# 0 - If successful.
# 1 - If it fails.
###############################################################################
function copy_item_in_bucket() {
local bucket_name=$1
local source_key=$2
local destination_key=$3
local response
response=$(aws s3api copy-object \
--bucket "$bucket_name" \
--copy-source "$bucket_name/$source_key" \
--key "$destination_key")
# shellcheck disable=SC2181
if [[ $? -ne 0 ]]; then
errecho "ERROR: AWS reports s3api copy-object operation failed.\n$response"
return 1
fi
}
```
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [CopyObject](https://docs.aws.amazon.com/goto/aws-cli/s3-2006-03-01/CopyObject)。
------
#### [ C\$1\$1 ]
**適用於 C\$1\$1 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/s3#code-examples)中設定和執行。
```
bool AwsDoc::S3::copyObject(const Aws::String &objectKey, const Aws::String &fromBucket, const Aws::String &toBucket,
const Aws::S3::S3ClientConfiguration &clientConfig) {
Aws::S3::S3Client client(clientConfig);
Aws::S3::Model::CopyObjectRequest request;
request.WithCopySource(fromBucket + "/" + objectKey)
.WithKey(objectKey)
.WithBucket(toBucket);
Aws::S3::Model::CopyObjectOutcome outcome = client.CopyObject(request);
if (!outcome.IsSuccess()) {
const Aws::S3::S3Error &err = outcome.GetError();
std::cerr << "Error: copyObject: " <<
err.GetExceptionName() << ": " << err.GetMessage() << std::endl;
} else {
std::cout << "Successfully copied " << objectKey << " from " << fromBucket <<
" to " << toBucket << "." << std::endl;
}
return outcome.IsSuccess();
}
```
+ 如需 API 詳細資訊，請參閱*《適用於 C\$1\$1 的 AWS SDK API 參考》*中的 [CopyObject](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/CopyObject)。
------
#### [ CLI ]
**AWS CLI**
下列命令會將物件從 `bucket-1` 複製到 `bucket-2`：
```
aws s3api copy-object --copy-source bucket-1/test.txt --key test.txt --bucket bucket-2
```
輸出：
```
{
"CopyObjectResult": {
"LastModified": "2015-11-10T01:07:25.000Z",
"ETag": "\"589c8b79c230a6ecd5a7e1d040a9a030\""
},
"VersionId": "YdnYvTCVDqRRFA.NFJjy36p0hxifMlkA"
}
```
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [CopyObject](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3api/copy-object.html)。
------
#### [ Go ]
**SDK for Go V2**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/gov2/s3#code-examples)中設定和執行。
```
import (
"bytes"
"context"
"errors"
"fmt"
"io"
"log"
"os"
"time"
"github.com/aws/aws-sdk-go-v2/aws"
"github.com/aws/aws-sdk-go-v2/feature/s3/manager"
"github.com/aws/aws-sdk-go-v2/service/s3"
"github.com/aws/aws-sdk-go-v2/service/s3/types"
"github.com/aws/smithy-go"
)
// BucketBasics encapsulates the Amazon Simple Storage Service (Amazon S3) actions
// used in the examples.
// It contains S3Client, an Amazon S3 service client that is used to perform bucket
// and object actions.
type BucketBasics struct {
S3Client *s3.Client
}
// CopyToBucket copies an object in a bucket to another bucket.
func (basics BucketBasics) CopyToBucket(ctx context.Context, sourceBucket string, destinationBucket string, objectKey string) error {
_, err := basics.S3Client.CopyObject(ctx, &s3.CopyObjectInput{
Bucket: aws.String(destinationBucket),
CopySource: aws.String(fmt.Sprintf("%v/%v", sourceBucket, objectKey)),
Key: aws.String(objectKey),
})
if err != nil {
var notActive *types.ObjectNotInActiveTierError
if errors.As(err, ¬Active) {
log.Printf("Couldn't copy object %s from %s because the object isn't in the active tier.\n",
objectKey, sourceBucket)
err = notActive
}
} else {
err = s3.NewObjectExistsWaiter(basics.S3Client).Wait(
ctx, &s3.HeadObjectInput{Bucket: aws.String(destinationBucket), Key: aws.String(objectKey)}, time.Minute)
if err != nil {
log.Printf("Failed attempt to wait for object %s to exist.\n", objectKey)
}
}
return err
}
```
+ 如需 API 詳細資訊，請參閱*《適用於 Go 的 AWS SDK API 參考》*中的 [CopyObject](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/s3#Client.CopyObject)。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/s3#code-examples)中設定和執行。
使用 [S3Client](https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/s3/S3Client.html) 複製物件。
```
/**
* Asynchronously copies an object from one S3 bucket to another.
*
* @param fromBucket the name of the source S3 bucket
* @param objectKey the key (name) of the object to be copied
* @param toBucket the name of the destination S3 bucket
* @return a {@link CompletableFuture} that completes with the copy result as a {@link String}
* @throws RuntimeException if the URL could not be encoded or an S3 exception occurred during the copy
*/
public CompletableFuture copyBucketObjectAsync(String fromBucket, String objectKey, String toBucket) {
CopyObjectRequest copyReq = CopyObjectRequest.builder()
.sourceBucket(fromBucket)
.sourceKey(objectKey)
.destinationBucket(toBucket)
.destinationKey(objectKey)
.build();
CompletableFuture response = getAsyncClient().copyObject(copyReq);
response.whenComplete((copyRes, ex) -> {
if (copyRes != null) {
logger.info("The " + objectKey + " was copied to " + toBucket);
} else {
throw new RuntimeException("An S3 exception occurred during copy", ex);
}
});
return response.thenApply(CopyObjectResponse::copyObjectResult)
.thenApply(Object::toString);
}
```
使用 [S3TransferManager](https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/transfer/s3/S3TransferManager.html) 將物件從一個儲存貯體[複製](https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/transfer/s3/S3TransferManager.html#copy(software.amazon.awssdk.transfer.s3.CopyRequest))到另一個儲存貯體。檢視[完整檔案](https://github.com/awsdocs/aws-doc-sdk-examples/blob/main/javav2/example_code/s3/src/main/java/com/example/s3/transfermanager/ObjectCopy.java)並[測試](https://github.com/awsdocs/aws-doc-sdk-examples/blob/main/javav2/example_code/s3/src/test/java/TransferManagerTest.java)。
```
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import software.amazon.awssdk.core.sync.RequestBody;
import software.amazon.awssdk.services.s3.model.CopyObjectRequest;
import software.amazon.awssdk.transfer.s3.S3TransferManager;
import software.amazon.awssdk.transfer.s3.model.CompletedCopy;
import software.amazon.awssdk.transfer.s3.model.Copy;
import software.amazon.awssdk.transfer.s3.model.CopyRequest;
import java.util.UUID;
public String copyObject(S3TransferManager transferManager, String bucketName,
String key, String destinationBucket, String destinationKey) {
CopyObjectRequest copyObjectRequest = CopyObjectRequest.builder()
.sourceBucket(bucketName)
.sourceKey(key)
.destinationBucket(destinationBucket)
.destinationKey(destinationKey)
.build();
CopyRequest copyRequest = CopyRequest.builder()
.copyObjectRequest(copyObjectRequest)
.build();
Copy copy = transferManager.copy(copyRequest);
CompletedCopy completedCopy = copy.completionFuture().join();
return completedCopy.response().copyObjectResult().eTag();
}
```
+ 如需 API 詳細資訊，請參閱*《AWS SDK for Java 2.x API 參考》*中的 [CopyObject](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/CopyObject)。
------
#### [ JavaScript ]
**適用於 JavaScript (v3) 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/s3#code-examples)中設定和執行。
複製物件
```
import {
S3Client,
CopyObjectCommand,
ObjectNotInActiveTierError,
waitUntilObjectExists,
} from "@aws-sdk/client-s3";
/**
* Copy an S3 object from one bucket to another.
*
* @param {{
* sourceBucket: string,
* sourceKey: string,
* destinationBucket: string,
* destinationKey: string }} config
*/
export const main = async ({
sourceBucket,
sourceKey,
destinationBucket,
destinationKey,
}) => {
const client = new S3Client({});
try {
await client.send(
new CopyObjectCommand({
CopySource: `${sourceBucket}/${sourceKey}`,
Bucket: destinationBucket,
Key: destinationKey,
}),
);
await waitUntilObjectExists(
{ client },
{ Bucket: destinationBucket, Key: destinationKey },
);
console.log(
`Successfully copied ${sourceBucket}/${sourceKey} to ${destinationBucket}/${destinationKey}`,
);
} catch (caught) {
if (caught instanceof ObjectNotInActiveTierError) {
console.error(
`Could not copy ${sourceKey} from ${sourceBucket}. Object is not in the active tier.`,
);
} else {
throw caught;
}
}
};
```
如果物件的 ETag 與提供的 ETag 不相符，則複製該物件。
```
import {
CopyObjectCommand,
NoSuchKey,
S3Client,
S3ServiceException,
} from "@aws-sdk/client-s3";
// Optionally edit the default key name of the copied object in 'object_name.json'
import data from "../scenarios/conditional-requests/object_name.json" assert {
type: "json",
};
/**
* Get a single object from a specified S3 bucket.
* @param {{ sourceBucketName: string, sourceKeyName: string, destinationBucketName: string, eTag: string }}
*/
export const main = async ({
sourceBucketName,
sourceKeyName,
destinationBucketName,
eTag,
}) => {
const client = new S3Client({});
const name = data.name;
try {
const response = await client.send(
new CopyObjectCommand({
CopySource: `${sourceBucketName}/${sourceKeyName}`,
Bucket: destinationBucketName,
Key: `${name}${sourceKeyName}`,
CopySourceIfMatch: eTag,
}),
);
console.log("Successfully copied object to bucket.");
} catch (caught) {
if (caught instanceof NoSuchKey) {
console.error(
`Error from S3 while copying object "${sourceKeyName}" from "${sourceBucketName}". No such key exists.`,
);
} else if (caught instanceof S3ServiceException) {
console.error(
`Unable to copy object "${sourceKeyName}" to bucket "${sourceBucketName}": ${caught.name}: ${caught.message}`,
);
} else {
throw caught;
}
}
};
// Call function if run directly
import { parseArgs } from "node:util";
import {
isMain,
validateArgs,
} from "@aws-doc-sdk-examples/lib/utils/util-node.js";
const loadArgs = () => {
const options = {
sourceBucketName: {
type: "string",
required: true,
},
sourceKeyName: {
type: "string",
required: true,
},
destinationBucketName: {
type: "string",
required: true,
},
eTag: {
type: "string",
required: true,
},
};
const results = parseArgs({ options });
const { errors } = validateArgs({ options }, results);
return { errors, results };
};
if (isMain(import.meta.url)) {
const { errors, results } = loadArgs();
if (!errors) {
main(results.values);
} else {
console.error(errors.join("\n"));
}
}
```
如果物件的 ETag 與提供的 ETag 不相符，則複製該物件。
```
import {
CopyObjectCommand,
NoSuchKey,
S3Client,
S3ServiceException,
} from "@aws-sdk/client-s3";
// Optionally edit the default key name of the copied object in 'object_name.json'
import data from "../scenarios/conditional-requests/object_name.json" assert {
type: "json",
};
/**
* Get a single object from a specified S3 bucket.
* @param {{ sourceBucketName: string, sourceKeyName: string, destinationBucketName: string, eTag: string }}
*/
export const main = async ({
sourceBucketName,
sourceKeyName,
destinationBucketName,
eTag,
}) => {
const client = new S3Client({});
const name = data.name;
try {
const response = await client.send(
new CopyObjectCommand({
CopySource: `${sourceBucketName}/${sourceKeyName}`,
Bucket: destinationBucketName,
Key: `${name}${sourceKeyName}`,
CopySourceIfNoneMatch: eTag,
}),
);
console.log("Successfully copied object to bucket.");
} catch (caught) {
if (caught instanceof NoSuchKey) {
console.error(
`Error from S3 while copying object "${sourceKeyName}" from "${sourceBucketName}". No such key exists.`,
);
} else if (caught instanceof S3ServiceException) {
console.error(
`Unable to copy object "${sourceKeyName}" to bucket "${sourceBucketName}": ${caught.name}: ${caught.message}`,
);
} else {
throw caught;
}
}
};
// Call function if run directly
import { parseArgs } from "node:util";
import {
isMain,
validateArgs,
} from "@aws-doc-sdk-examples/lib/utils/util-node.js";
const loadArgs = () => {
const options = {
sourceBucketName: {
type: "string",
required: true,
},
sourceKeyName: {
type: "string",
required: true,
},
destinationBucketName: {
type: "string",
required: true,
},
eTag: {
type: "string",
required: true,
},
};
const results = parseArgs({ options });
const { errors } = validateArgs({ options }, results);
return { errors, results };
};
if (isMain(import.meta.url)) {
const { errors, results } = loadArgs();
if (!errors) {
main(results.values);
} else {
console.error(errors.join("\n"));
}
}
```
在給定的時間範圍內建立或修改物件的情況下，複製該物件。
```
import {
CopyObjectCommand,
NoSuchKey,
S3Client,
S3ServiceException,
} from "@aws-sdk/client-s3";
// Optionally edit the default key name of the copied object in 'object_name.json'
import data from "../scenarios/conditional-requests/object_name.json" assert {
type: "json",
};
/**
* Get a single object from a specified S3 bucket.
* @param {{ sourceBucketName: string, sourceKeyName: string, destinationBucketName: string }}
*/
export const main = async ({
sourceBucketName,
sourceKeyName,
destinationBucketName,
}) => {
const date = new Date();
date.setDate(date.getDate() - 1);
const name = data.name;
const client = new S3Client({});
const copySource = `${sourceBucketName}/${sourceKeyName}`;
const copiedKey = name + sourceKeyName;
try {
const response = await client.send(
new CopyObjectCommand({
CopySource: copySource,
Bucket: destinationBucketName,
Key: copiedKey,
CopySourceIfModifiedSince: date,
}),
);
console.log("Successfully copied object to bucket.");
} catch (caught) {
if (caught instanceof NoSuchKey) {
console.error(
`Error from S3 while copying object "${sourceKeyName}" from "${sourceBucketName}". No such key exists.`,
);
} else if (caught instanceof S3ServiceException) {
console.error(
`Error from S3 while copying object from ${sourceBucketName}. ${caught.name}: ${caught.message}`,
);
} else {
throw caught;
}
}
};
// Call function if run directly
import { parseArgs } from "node:util";
import {
isMain,
validateArgs,
} from "@aws-doc-sdk-examples/lib/utils/util-node.js";
const loadArgs = () => {
const options = {
sourceBucketName: {
type: "string",
required: true,
},
sourceKeyName: {
type: "string",
required: true,
},
destinationBucketName: {
type: "string",
required: true,
},
};
const results = parseArgs({ options });
const { errors } = validateArgs({ options }, results);
return { errors, results };
};
if (isMain(import.meta.url)) {
const { errors, results } = loadArgs();
if (!errors) {
main(results.values);
} else {
console.error(errors.join("\n"));
}
}
```
在給定的時間範圍內未建立或修改物件的情況下，複製該物件。
```
import {
CopyObjectCommand,
NoSuchKey,
S3Client,
S3ServiceException,
} from "@aws-sdk/client-s3";
// Optionally edit the default key name of the copied object in 'object_name.json'
import data from "../scenarios/conditional-requests/object_name.json" assert {
type: "json",
};
/**
* Get a single object from a specified S3 bucket.
* @param {{ sourceBucketName: string, sourceKeyName: string, destinationBucketName: string }}
*/
export const main = async ({
sourceBucketName,
sourceKeyName,
destinationBucketName,
}) => {
const date = new Date();
date.setDate(date.getDate() - 1);
const client = new S3Client({});
const name = data.name;
const copiedKey = name + sourceKeyName;
const copySource = `${sourceBucketName}/${sourceKeyName}`;
try {
const response = await client.send(
new CopyObjectCommand({
CopySource: copySource,
Bucket: destinationBucketName,
Key: copiedKey,
CopySourceIfUnmodifiedSince: date,
}),
);
console.log("Successfully copied object to bucket.");
} catch (caught) {
if (caught instanceof NoSuchKey) {
console.error(
`Error from S3 while copying object "${sourceKeyName}" from "${sourceBucketName}". No such key exists.`,
);
} else if (caught instanceof S3ServiceException) {
console.error(
`Error from S3 while copying object from ${sourceBucketName}. ${caught.name}: ${caught.message}`,
);
} else {
throw caught;
}
}
};
// Call function if run directly
import { parseArgs } from "node:util";
import {
isMain,
validateArgs,
} from "@aws-doc-sdk-examples/lib/utils/util-node.js";
const loadArgs = () => {
const options = {
sourceBucketName: {
type: "string",
required: true,
},
sourceKeyName: {
type: "string",
required: true,
},
destinationBucketName: {
type: "string",
required: true,
},
};
const results = parseArgs({ options });
const { errors } = validateArgs({ options }, results);
return { errors, results };
};
if (isMain(import.meta.url)) {
const { errors, results } = loadArgs();
if (!errors) {
main(results.values);
} else {
console.error(errors.join("\n"));
}
}
```
+ 如需 API 詳細資訊，請參閱*《適用於 JavaScript 的 AWS SDK API 參考》*中的 [CopyObject](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/s3/command/CopyObjectCommand)。
------
#### [ Kotlin ]
**適用於 Kotlin 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/s3#code-examples)中設定和執行。
```
suspend fun copyBucketObject(
fromBucket: String,
objectKey: String,
toBucket: String,
) {
var encodedUrl = ""
try {
encodedUrl = URLEncoder.encode("$fromBucket/$objectKey", StandardCharsets.UTF_8.toString())
} catch (e: UnsupportedEncodingException) {
println("URL could not be encoded: " + e.message)
}
val request =
CopyObjectRequest {
copySource = encodedUrl
bucket = toBucket
key = objectKey
}
S3Client.fromEnvironment { region = "us-east-1" }.use { s3 ->
s3.copyObject(request)
}
}
```
+ 如需 API 詳細資訊，請參閱*《適用於 Kotlin 的AWS SDK API 參考》*中的 [CopyObject](https://sdk.amazonaws.com/kotlin/api/latest/index.html)。
------
#### [ PHP ]
**適用於 PHP 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code/s3#code-examples)中設定和執行。
簡單複製物件。
```
$s3client = new Aws\S3\S3Client(['region' => 'us-west-2']);
try {
$folder = "copied-folder";
$this->s3client->copyObject([
'Bucket' => $this->bucketName,
'CopySource' => "$this->bucketName/$fileName",
'Key' => "$folder/$fileName-copy",
]);
echo "Copied $fileName to $folder/$fileName-copy.\n";
} catch (Exception $exception) {
echo "Failed to copy $fileName with error: " . $exception->getMessage();
exit("Please fix error with object copying before continuing.");
}
```
+ 如需 API 詳細資訊，請參閱*《適用於 PHP 的 AWS SDK API 參考》*中的 [CopyObject](https://docs.aws.amazon.com/goto/SdkForPHPV3/s3-2006-03-01/CopyObject)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此命令會將物件"sample.txt" 從儲存貯體 "test-files" 複製到相同的儲存貯體，但具有新索引鍵 "sample-copy.txt"。**
```
Copy-S3Object -BucketName amzn-s3-demo-bucket -Key sample.txt -DestinationKey sample-copy.txt
```
**範例 2：此命令會將物件"sample.txt" 從儲存貯體 "test-files" 複製到儲存貯體 "backup-files"，索引鍵為 "sample-copy.txt"。**
```
Copy-S3Object -BucketName amzn-s3-demo-source-bucket -Key sample.txt -DestinationKey sample-copy.txt -DestinationBucket amzn-s3-demo-destination-bucket
```
**範例 3：此命令會將物件"sample.txt" 從儲存貯體 "test-files" 下載至名為 "local-sample.txt" 的本機檔案。**
```
Copy-S3Object -BucketName amzn-s3-demo-bucket -Key sample.txt -LocalFile local-sample.txt
```
**範例 4：將單一物件下載至指定的檔案。下載的檔案位於 c:\$1downloads\$1data\$1archive.zip**
```
Copy-S3Object -BucketName amzn-s3-demo-bucket -Key data/archive.zip -LocalFolder c:\downloads
```
**範例 5：將符合指定索引鍵字首的所有物件下載至本機資料夾。相對索引鍵階層會保留為整體下載位置中的子資料夾。**
```
Copy-S3Object -BucketName amzn-s3-demo-bucket -KeyPrefix data -LocalFolder c:\downloads
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [CopyObject](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此命令會將物件"sample.txt" 從儲存貯體 "test-files" 複製到相同的儲存貯體，但具有新索引鍵 "sample-copy.txt"。**
```
Copy-S3Object -BucketName amzn-s3-demo-bucket -Key sample.txt -DestinationKey sample-copy.txt
```
**範例 2：此命令會將物件"sample.txt" 從儲存貯體 "test-files" 複製到儲存貯體 "backup-files"，索引鍵為 "sample-copy.txt"。**
```
Copy-S3Object -BucketName amzn-s3-demo-source-bucket -Key sample.txt -DestinationKey sample-copy.txt -DestinationBucket amzn-s3-demo-destination-bucket
```
**範例 3：此命令會將物件"sample.txt" 從儲存貯體 "test-files" 下載至名為 "local-sample.txt" 的本機檔案。**
```
Copy-S3Object -BucketName amzn-s3-demo-bucket -Key sample.txt -LocalFile local-sample.txt
```
**範例 4：將單一物件下載至指定的檔案。下載的檔案位於 c:\$1downloads\$1data\$1archive.zip**
```
Copy-S3Object -BucketName amzn-s3-demo-bucket -Key data/archive.zip -LocalFolder c:\downloads
```
**範例 5：將符合指定索引鍵字首的所有物件下載至本機資料夾。相對索引鍵階層會保留為整體下載位置中的子資料夾。**
```
Copy-S3Object -BucketName amzn-s3-demo-bucket -KeyPrefix data -LocalFolder c:\downloads
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [CopyObject](https://docs.aws.amazon.com/powershell/v5/reference)。
------
#### [ Python ]
**適用於 Python 的 SDK (Boto3)**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/s3/s3_basics#code-examples)中設定和執行。
```
class ObjectWrapper:
"""Encapsulates S3 object actions."""
def __init__(self, s3_object):
"""
:param s3_object: A Boto3 Object resource. This is a high-level resource in Boto3
that wraps object actions in a class-like structure.
"""
self.object = s3_object
self.key = self.object.key
def copy(self, dest_object):
"""
Copies the object to another bucket.
:param dest_object: The destination object initialized with a bucket and key.
This is a Boto3 Object resource.
"""
try:
dest_object.copy_from(
CopySource={"Bucket": self.object.bucket_name, "Key": self.object.key}
)
dest_object.wait_until_exists()
logger.info(
"Copied object from %s:%s to %s:%s.",
self.object.bucket_name,
self.object.key,
dest_object.bucket_name,
dest_object.key,
)
except ClientError:
logger.exception(
"Couldn't copy object from %s/%s to %s/%s.",
self.object.bucket_name,
self.object.key,
dest_object.bucket_name,
dest_object.key,
)
raise
```
使用條件式請求複製物件。
```
class S3ConditionalRequests:
"""Encapsulates S3 conditional request operations."""
def __init__(self, s3_client):
self.s3 = s3_client
@classmethod
def from_client(cls):
"""
Instantiates this class from a Boto3 client.
"""
s3_client = boto3.client("s3")
return cls(s3_client)
def copy_object_conditional(
self,
source_key: str,
dest_key: str,
source_bucket: str,
dest_bucket: str,
condition_type: str,
condition_value: str,
):
"""
Copies an object from one Amazon S3 bucket to another with a conditional request.
:param source_key: The key of the source object to copy.
:param dest_key: The key of the destination object.
:param source_bucket: The source bucket of the object.
:param dest_bucket: The destination bucket of the object.
:param condition_type: The type of condition to apply, e.g.
'CopySourceIfMatch', 'CopySourceIfNoneMatch', 'CopySourceIfModifiedSince', 'CopySourceIfUnmodifiedSince'.
:param condition_value: The value to use for the condition.
"""
try:
self.s3.copy_object(
Bucket=dest_bucket,
Key=dest_key,
CopySource={"Bucket": source_bucket, "Key": source_key},
**{condition_type: condition_value},
)
print(
f"\tConditional copy successful for key {dest_key} in bucket {dest_bucket}."
)
except ClientError as e:
error_code = e.response["Error"]["Code"]
if error_code == "PreconditionFailed":
print("\tConditional copy failed: Precondition failed")
elif error_code == "304": # Not modified error code.
print("\tConditional copy failed: Object not modified")
else:
logger.error(f"Unexpected error: {error_code}")
raise
```
+ 如需 API 詳細資訊，請參閱*《適用於 Python (Boto3) 的AWS SDK API 參考》*中的 [CopyObject](https://docs.aws.amazon.com/goto/boto3/s3-2006-03-01/CopyObject)。
------
#### [ Ruby ]
**SDK for Ruby**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/ruby/example_code/s3#code-examples)中設定和執行。
複製物件
```
require 'aws-sdk-s3'
# Wraps Amazon S3 object actions.
class ObjectCopyWrapper
attr_reader :source_object
# @param source_object [Aws::S3::Object] An existing Amazon S3 object. This is used as the source object for
# copy actions.
def initialize(source_object)
@source_object = source_object
end
# Copy the source object to the specified target bucket and rename it with the target key.
#
# @param target_bucket [Aws::S3::Bucket] An existing Amazon S3 bucket where the object is copied.
# @param target_object_key [String] The key to give the copy of the object.
# @return [Aws::S3::Object, nil] The copied object when successful; otherwise, nil.
def copy_object(target_bucket, target_object_key)
@source_object.copy_to(bucket: target_bucket.name, key: target_object_key)
target_bucket.object(target_object_key)
rescue Aws::Errors::ServiceError => e
puts "Couldn't copy #{@source_object.key} to #{target_object_key}. Here's why: #{e.message}"
end
end
# Example usage:
def run_demo
source_bucket_name = "amzn-s3-demo-bucket1"
source_key = "my-source-file.txt"
target_bucket_name = "amzn-s3-demo-bucket2"
target_key = "my-target-file.txt"
source_bucket = Aws::S3::Bucket.new(source_bucket_name)
wrapper = ObjectCopyWrapper.new(source_bucket.object(source_key))
target_bucket = Aws::S3::Bucket.new(target_bucket_name)
target_object = wrapper.copy_object(target_bucket, target_key)
return unless target_object
puts "Copied #{source_key} from #{source_bucket_name} to #{target_object.bucket_name}:#{target_object.key}."
end
run_demo if $PROGRAM_NAME == __FILE__
```
複製物件，然後將伺服器端加密新增至目標物件。
```
require 'aws-sdk-s3'
# Wraps Amazon S3 object actions.
class ObjectCopyEncryptWrapper
attr_reader :source_object
# @param source_object [Aws::S3::Object] An existing Amazon S3 object. This is used as the source object for
# copy actions.
def initialize(source_object)
@source_object = source_object
end
# Copy the source object to the specified target bucket, rename it with the target key, and encrypt it.
#
# @param target_bucket [Aws::S3::Bucket] An existing Amazon S3 bucket where the object is copied.
# @param target_object_key [String] The key to give the copy of the object.
# @return [Aws::S3::Object, nil] The copied object when successful; otherwise, nil.
def copy_object(target_bucket, target_object_key, encryption)
@source_object.copy_to(bucket: target_bucket.name, key: target_object_key, server_side_encryption: encryption)
target_bucket.object(target_object_key)
rescue Aws::Errors::ServiceError => e
puts "Couldn't copy #{@source_object.key} to #{target_object_key}. Here's why: #{e.message}"
end
end
# Example usage:
def run_demo
source_bucket_name = "amzn-s3-demo-bucket1"
source_key = "my-source-file.txt"
target_bucket_name = "amzn-s3-demo-bucket2"
target_key = "my-target-file.txt"
target_encryption = "AES256"
source_bucket = Aws::S3::Bucket.new(source_bucket_name)
wrapper = ObjectCopyEncryptWrapper.new(source_bucket.object(source_key))
target_bucket = Aws::S3::Bucket.new(target_bucket_name)
target_object = wrapper.copy_object(target_bucket, target_key, target_encryption)
return unless target_object
puts "Copied #{source_key} from #{source_bucket_name} to #{target_object.bucket_name}:#{target_object.key} and "\
"encrypted the target with #{target_object.server_side_encryption} encryption."
end
run_demo if $PROGRAM_NAME == __FILE__
```
+ 如需 API 詳細資訊，請參閱*《適用於 Ruby 的 AWS SDK API 參考》*中的 [CopyObject](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/CopyObject)。
------
#### [ Rust ]
**適用於 Rust 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/rustv1/examples/s3#code-examples)中設定和執行。
```
/// Copy an object from one bucket to another.
pub async fn copy_object(
client: &aws_sdk_s3::Client,
source_bucket: &str,
destination_bucket: &str,
source_object: &str,
destination_object: &str,
) -> Result<(), S3ExampleError> {
let source_key = format!("{source_bucket}/{source_object}");
let response = client
.copy_object()
.copy_source(&source_key)
.bucket(destination_bucket)
.key(destination_object)
.send()
.await?;
println!(
"Copied from {source_key} to {destination_bucket}/{destination_object} with etag {}",
response
.copy_object_result
.unwrap_or_else(|| aws_sdk_s3::types::CopyObjectResult::builder().build())
.e_tag()
.unwrap_or("missing")
);
Ok(())
}
```
+ 如需 API 詳細資訊，請參閱 *《適用於 Rust 的AWS SDK API 參考》*中的 [CopyObject](https://docs.rs/aws-sdk-s3/latest/aws_sdk_s3/client/struct.Client.html#method.copy_object)。
------
#### [ SAP ABAP ]
**適用於 SAP ABAP 的開發套件**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/s3#code-examples)中設定和執行。
```
TRY.
lo_s3->copyobject(
iv_bucket = iv_dest_bucket
iv_key = iv_dest_object
iv_copysource = |{ iv_src_bucket }/{ iv_src_object }| ).
MESSAGE 'Object copied to another bucket.' TYPE 'I'.
CATCH /aws1/cx_s3_nosuchbucket.
MESSAGE 'Bucket does not exist.' TYPE 'E'.
CATCH /aws1/cx_s3_nosuchkey.
MESSAGE 'Object key does not exist.' TYPE 'E'.
ENDTRY.
```
+ 如需 API 詳細資訊，請參閱《適用於 SAP ABAP 的AWS SDK API 參考》**中的 [CopyObject](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)。
------
#### [ Swift ]
**適用於 Swift 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/swift/example_code/s3/basics#code-examples)中設定和執行。
```
import AWSS3
public func copyFile(from sourceBucket: String, name: String, to destBucket: String) async throws {
let srcUrl = ("\(sourceBucket)/\(name)").addingPercentEncoding(withAllowedCharacters: .urlPathAllowed)
let input = CopyObjectInput(
bucket: destBucket,
copySource: srcUrl,
key: name
)
do {
_ = try await client.copyObject(input: input)
}
catch {
print("ERROR: ", dump(error, name: "Copying an object."))
throw error
}
}
```
+ 如需 API 詳細資訊，請參閱《*適用於 Swift 的AWS SDK API 參考*》中的[CopyObject](https://sdk.amazonaws.com/swift/api/awss3/latest/documentation/awss3/s3client/copyobject(input:))。
------
# `CreateBucket` 搭配 AWS SDK 或 CLI 使用
下列程式碼範例示範如何使用 `CreateBucket`。
動作範例是大型程式的程式碼摘錄，必須在內容中執行。您可以在下列程式碼範例的內容中看到此動作：
+ [了解基本概念](s3_example_s3_Scenario_GettingStarted_section.md)
+ [開始使用 S3](s3_example_s3_GettingStarted_section.md)
+ [使用 S3 管理大型訊息](s3_example_sqs_Scenario_SqsExtendedClient_section.md)
+ [使用版本化物件](s3_example_s3_Scenario_ObjectVersioningUsage_section.md)
------
#### [ .NET ]
**適用於 .NET 的 SDK (v4)**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv4/S3#code-examples)中設定和執行。
```
///
/// Shows how to create a new Amazon S3 bucket.
///
/// The name of the bucket to create.
/// A boolean value representing the success or failure of
/// the bucket creation process.
public async Task CreateBucketAsync(string bucketName)
{
try
{
var request = new PutBucketRequest
{
BucketName = bucketName,
UseClientRegion = true,
};
var response = await _amazonS3.PutBucketAsync(request);
return response.HttpStatusCode == System.Net.HttpStatusCode.OK;
}
catch (AmazonS3Exception ex)
{
Console.WriteLine($"Error creating bucket: '{ex.Message}'");
return false;
}
}
```
+ 如需 API 詳細資訊，請參閱*《適用於 .NET 的 AWS SDK API 參考》*中的 [CreateBucket](https://docs.aws.amazon.com/goto/DotNetSDKV4/s3-2006-03-01/CreateBucket)。
**適用於 .NET 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/S3#code-examples)中設定和執行。
建立已啟用物件鎖定的儲存貯體。
```
///
/// Create a new Amazon S3 bucket with object lock actions.
///
/// The name of the bucket to create.
/// True to enable object lock on the bucket.
/// True if successful.
public async Task CreateBucketWithObjectLock(string bucketName, bool enableObjectLock)
{
Console.WriteLine($"\tCreating bucket {bucketName} with object lock {enableObjectLock}.");
try
{
var request = new PutBucketRequest
{
BucketName = bucketName,
UseClientRegion = true,
ObjectLockEnabledForBucket = enableObjectLock,
};
var response = await _amazonS3.PutBucketAsync(request);
return response.HttpStatusCode == System.Net.HttpStatusCode.OK;
}
catch (AmazonS3Exception ex)
{
Console.WriteLine($"Error creating bucket: '{ex.Message}'");
return false;
}
}
```
+ 如需 API 詳細資訊，請參閱*《適用於 .NET 的 AWS SDK API 參考》*中的 [CreateBucket](https://docs.aws.amazon.com/goto/DotNetSDKV3/s3-2006-03-01/CreateBucket)。
------
#### [ Bash ]
**AWS CLI 使用 Bash 指令碼**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/aws-cli/bash-linux/s3#code-examples)中設定和執行。
```
###############################################################################
# function iecho
#
# This function enables the script to display the specified text only if
# the global variable $VERBOSE is set to true.
###############################################################################
function iecho() {
if [[ $VERBOSE == true ]]; then
echo "$@"
fi
}
###############################################################################
# function errecho
#
# This function outputs everything sent to it to STDERR (standard error output).
###############################################################################
function errecho() {
printf "%s\n" "$*" 1>&2
}
###############################################################################
# function create-bucket
#
# This function creates the specified bucket in the specified AWS Region, unless
# it already exists.
#
# Parameters:
# -b bucket_name -- The name of the bucket to create.
# -r region_code -- The code for an AWS Region in which to
# create the bucket.
#
# Returns:
# The URL of the bucket that was created.
# And:
# 0 - If successful.
# 1 - If it fails.
###############################################################################
function create_bucket() {
local bucket_name region_code response
local option OPTARG # Required to use getopts command in a function.
# bashsupport disable=BP5008
function usage() {
echo "function create_bucket"
echo "Creates an Amazon S3 bucket. You must supply a bucket name:"
echo " -b bucket_name The name of the bucket. It must be globally unique."
echo " [-r region_code] The code for an AWS Region in which the bucket is created."
echo ""
}
# Retrieve the calling parameters.
while getopts "b:r:h" option; do
case "${option}" in
b) bucket_name="${OPTARG}" ;;
r) region_code="${OPTARG}" ;;
h)
usage
return 0
;;
\?)
echo "Invalid parameter"
usage
return 1
;;
esac
done
if [[ -z "$bucket_name" ]]; then
errecho "ERROR: You must provide a bucket name with the -b parameter."
usage
return 1
fi
local bucket_config_arg
# A location constraint for "us-east-1" returns an error.
if [[ -n "$region_code" ]] && [[ "$region_code" != "us-east-1" ]]; then
bucket_config_arg="--create-bucket-configuration LocationConstraint=$region_code"
fi
iecho "Parameters:\n"
iecho " Bucket name: $bucket_name"
iecho " Region code: $region_code"
iecho ""
# If the bucket already exists, we don't want to try to create it.
if (bucket_exists "$bucket_name"); then
errecho "ERROR: A bucket with that name already exists. Try again."
return 1
fi
# shellcheck disable=SC2086
response=$(aws s3api create-bucket \
--bucket "$bucket_name" \
$bucket_config_arg)
# shellcheck disable=SC2181
if [[ ${?} -ne 0 ]]; then
errecho "ERROR: AWS reports create-bucket operation failed.\n$response"
return 1
fi
}
```
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [CreateBucket](https://docs.aws.amazon.com/goto/aws-cli/s3-2006-03-01/CreateBucket)。
------
#### [ C\$1\$1 ]
**適用於 C\$1\$1 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/s3#code-examples)中設定和執行。
```
bool AwsDoc::S3::createBucket(const Aws::String &bucketName,
const Aws::S3::S3ClientConfiguration &clientConfig) {
Aws::S3::S3Client client(clientConfig);
Aws::S3::Model::CreateBucketRequest request;
request.SetBucket(bucketName);
if (clientConfig.region != "us-east-1") {
Aws::S3::Model::CreateBucketConfiguration createBucketConfig;
createBucketConfig.SetLocationConstraint(
Aws::S3::Model::BucketLocationConstraintMapper::GetBucketLocationConstraintForName(
clientConfig.region));
request.SetCreateBucketConfiguration(createBucketConfig);
}
Aws::S3::Model::CreateBucketOutcome outcome = client.CreateBucket(request);
if (!outcome.IsSuccess()) {
auto err = outcome.GetError();
std::cerr << "Error: createBucket: " <<
err.GetExceptionName() << ": " << err.GetMessage() << std::endl;
} else {
std::cout << "Created bucket " << bucketName <<
" in the specified AWS Region." << std::endl;
}
return outcome.IsSuccess();
}
```
+ 如需 API 詳細資訊，請參閱*《適用於 C\$1\$1 的 AWS SDK API 參考》*中的 [CreateBucket](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/CreateBucket)。
------
#### [ CLI ]
**AWS CLI**
**範例 1：建立儲存貯體**
以下 `create-bucket` 範例會建立名為 `amzn-s3-demo-bucket` 的儲存貯體：
```
aws s3api create-bucket \
--bucket amzn-s3-demo-bucket \
--region us-east-1
```
輸出：
```
{
"Location": "/amzn-s3-demo-bucket"
}
```
如需詳細資訊，請參閱《Amazon S3 使用者指南》**中的[建立儲存貯體](https://docs.aws.amazon.com/AmazonS3/latest/userguide/create-bucket-overview.html)。
**範例 2：在擁有者強制執行的情況下建立儲存貯體**
下列 `create-bucket` 範例會建立名為 `amzn-s3-demo-bucket` 的儲存貯體，而該儲存貯體則會使用 S3 物件擁有權的儲存貯體擁有者強制執行的設定。
```
aws s3api create-bucket \
--bucket amzn-s3-demo-bucket \
--region us-east-1 \
--object-ownership BucketOwnerEnforced
```
輸出：
```
{
"Location": "/amzn-s3-demo-bucket"
}
```
如需詳細資訊，請參閱《Amazon S3 使用者指南》**中的[控制物件的所有權並停用 ACL](https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html)。
**範例 3：在 ``us-east-1`` 區域外建立儲存貯體**
下列 `create-bucket` 範例會在 `eu-west-1` 區域中建立名為 `amzn-s3-demo-bucket` 的儲存貯體。`us-east-1` 以外的區域需要指定適當的 `LocationConstraint`，才能在所需區域中建立儲存貯體。
```
aws s3api create-bucket \
--bucket amzn-s3-demo-bucket \
--region eu-west-1 \
--create-bucket-configuration LocationConstraint=eu-west-1
```
輸出：
```
{
"Location": "http://amzn-s3-demo-bucket.s3.amazonaws.com/"
}
```
如需詳細資訊，請參閱《Amazon S3 使用者指南》**中的[建立儲存貯體](https://docs.aws.amazon.com/AmazonS3/latest/userguide/create-bucket-overview.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [CreateBucket](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3api/create-bucket.html)。
------
#### [ Go ]
**SDK for Go V2**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/gov2/s3#code-examples)中設定和執行。
使用預設組態建立儲存貯體。
```
import (
"bytes"
"context"
"errors"
"fmt"
"io"
"log"
"os"
"time"
"github.com/aws/aws-sdk-go-v2/aws"
"github.com/aws/aws-sdk-go-v2/feature/s3/manager"
"github.com/aws/aws-sdk-go-v2/service/s3"
"github.com/aws/aws-sdk-go-v2/service/s3/types"
"github.com/aws/smithy-go"
)
// BucketBasics encapsulates the Amazon Simple Storage Service (Amazon S3) actions
// used in the examples.
// It contains S3Client, an Amazon S3 service client that is used to perform bucket
// and object actions.
type BucketBasics struct {
S3Client *s3.Client
}
// CreateBucket creates a bucket with the specified name in the specified Region.
func (basics BucketBasics) CreateBucket(ctx context.Context, name string, region string) error {
_, err := basics.S3Client.CreateBucket(ctx, &s3.CreateBucketInput{
Bucket: aws.String(name),
CreateBucketConfiguration: &types.CreateBucketConfiguration{
LocationConstraint: types.BucketLocationConstraint(region),
},
})
if err != nil {
var owned *types.BucketAlreadyOwnedByYou
var exists *types.BucketAlreadyExists
if errors.As(err, &owned) {
log.Printf("You already own bucket %s.\n", name)
err = owned
} else if errors.As(err, &exists) {
log.Printf("Bucket %s already exists.\n", name)
err = exists
}
} else {
err = s3.NewBucketExistsWaiter(basics.S3Client).Wait(
ctx, &s3.HeadBucketInput{Bucket: aws.String(name)}, time.Minute)
if err != nil {
log.Printf("Failed attempt to wait for bucket %s to exist.\n", name)
}
}
return err
}
```
建立具有物件鎖定的儲存貯體，並等待其出現。
```
import (
"bytes"
"context"
"errors"
"fmt"
"log"
"time"
"github.com/aws/aws-sdk-go-v2/aws"
"github.com/aws/aws-sdk-go-v2/feature/s3/manager"
"github.com/aws/aws-sdk-go-v2/service/s3"
"github.com/aws/aws-sdk-go-v2/service/s3/types"
"github.com/aws/smithy-go"
)
// S3Actions wraps S3 service actions.
type S3Actions struct {
S3Client *s3.Client
S3Manager *manager.Uploader
}
// CreateBucketWithLock creates a new S3 bucket with optional object locking enabled
// and waits for the bucket to exist before returning.
func (actor S3Actions) CreateBucketWithLock(ctx context.Context, bucket string, region string, enableObjectLock bool) (string, error) {
input := &s3.CreateBucketInput{
Bucket: aws.String(bucket),
CreateBucketConfiguration: &types.CreateBucketConfiguration{
LocationConstraint: types.BucketLocationConstraint(region),
},
}
if enableObjectLock {
input.ObjectLockEnabledForBucket = aws.Bool(true)
}
_, err := actor.S3Client.CreateBucket(ctx, input)
if err != nil {
var owned *types.BucketAlreadyOwnedByYou
var exists *types.BucketAlreadyExists
if errors.As(err, &owned) {
log.Printf("You already own bucket %s.\n", bucket)
err = owned
} else if errors.As(err, &exists) {
log.Printf("Bucket %s already exists.\n", bucket)
err = exists
}
} else {
err = s3.NewBucketExistsWaiter(actor.S3Client).Wait(
ctx, &s3.HeadBucketInput{Bucket: aws.String(bucket)}, time.Minute)
if err != nil {
log.Printf("Failed attempt to wait for bucket %s to exist.\n", bucket)
}
}
return bucket, err
}
```
+ 如需 API 詳細資訊，請參閱*《適用於 Go 的 AWS SDK API 參考》*中的 [CreateBucket](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/s3#Client.CreateBucket)。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/s3#code-examples)中設定和執行。
建立儲存貯體。
```
/**
* Creates an S3 bucket asynchronously.
*
* @param bucketName the name of the S3 bucket to create
* @return a {@link CompletableFuture} that completes when the bucket is created and ready
* @throws RuntimeException if there is a failure while creating the bucket
*/
public CompletableFuture createBucketAsync(String bucketName) {
CreateBucketRequest bucketRequest = CreateBucketRequest.builder()
.bucket(bucketName)
.build();
CompletableFuture response = getAsyncClient().createBucket(bucketRequest);
return response.thenCompose(resp -> {
S3AsyncWaiter s3Waiter = getAsyncClient().waiter();
HeadBucketRequest bucketRequestWait = HeadBucketRequest.builder()
.bucket(bucketName)
.build();
CompletableFuture> waiterResponseFuture =
s3Waiter.waitUntilBucketExists(bucketRequestWait);
return waiterResponseFuture.thenAccept(waiterResponse -> {
waiterResponse.matched().response().ifPresent(headBucketResponse -> {
logger.info(bucketName + " is ready");
});
});
}).whenComplete((resp, ex) -> {
if (ex != null) {
throw new RuntimeException("Failed to create bucket", ex);
}
});
}
```
建立已啟用物件鎖定的儲存貯體。
```
// Create a new Amazon S3 bucket with object lock options.
public void createBucketWithLockOptions(boolean enableObjectLock, String bucketName) {
S3Waiter s3Waiter = getClient().waiter();
CreateBucketRequest bucketRequest = CreateBucketRequest.builder()
.bucket(bucketName)
.objectLockEnabledForBucket(enableObjectLock)
.build();
getClient().createBucket(bucketRequest);
HeadBucketRequest bucketRequestWait = HeadBucketRequest.builder()
.bucket(bucketName)
.build();
// Wait until the bucket is created and print out the response.
s3Waiter.waitUntilBucketExists(bucketRequestWait);
System.out.println(bucketName + " is ready");
}
```
+ 如需 API 詳細資訊，請參閱*《AWS SDK for Java 2.x API 參考》*中的 [CreateBucket](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/CreateBucket)。
------
#### [ JavaScript ]
**適用於 JavaScript (v3) 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/s3#code-examples)中設定和執行。
建立儲存貯體。
```
import {
BucketAlreadyExists,
BucketAlreadyOwnedByYou,
CreateBucketCommand,
S3Client,
waitUntilBucketExists,
} from "@aws-sdk/client-s3";
/**
* Create an Amazon S3 bucket.
* @param {{ bucketName: string }} config
*/
export const main = async ({ bucketName }) => {
const client = new S3Client({});
try {
const { Location } = await client.send(
new CreateBucketCommand({
// The name of the bucket. Bucket names are unique and have several other constraints.
// See https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html
Bucket: bucketName,
}),
);
await waitUntilBucketExists({ client }, { Bucket: bucketName });
console.log(`Bucket created with location ${Location}`);
} catch (caught) {
if (caught instanceof BucketAlreadyExists) {
console.error(
`The bucket "${bucketName}" already exists in another AWS account. Bucket names must be globally unique.`,
);
}
// WARNING: If you try to create a bucket in the North Virginia region,
// and you already own a bucket in that region with the same name, this
// error will not be thrown. Instead, the call will return successfully
// and the ACL on that bucket will be reset.
else if (caught instanceof BucketAlreadyOwnedByYou) {
console.error(
`The bucket "${bucketName}" already exists in this AWS account.`,
);
} else {
throw caught;
}
}
};
```
+ 如需詳細資訊，請參閱《[適用於 JavaScript 的 AWS SDK 開發人員指南](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/s3-example-creating-buckets.html#s3-example-creating-buckets-new-bucket-2)》。
+ 如需 API 詳細資訊，請參閱*《適用於 JavaScript 的 AWS SDK API 參考》*中的 [CreateBucket](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/s3/command/CreateBucketCommand)。
------
#### [ Kotlin ]
**適用於 Kotlin 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/s3#code-examples)中設定和執行。
```
suspend fun createNewBucket(bucketName: String) {
val request =
CreateBucketRequest {
bucket = bucketName
}
S3Client.fromEnvironment { region = "us-east-1" }.use { s3 ->
s3.createBucket(request)
println("$bucketName is ready")
}
}
```
+ 如需 API 詳細資訊，請參閱*《適用於 Kotlin 的AWS SDK API 參考》*中的 [CreateBucket](https://sdk.amazonaws.com/kotlin/api/latest/index.html)。
------
#### [ PHP ]
**適用於 PHP 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code/s3#code-examples)中設定和執行。
建立儲存貯體。
```
$s3client = new Aws\S3\S3Client(['region' => 'us-west-2']);
try {
$this->s3client->createBucket([
'Bucket' => $this->bucketName,
'CreateBucketConfiguration' => ['LocationConstraint' => $region],
]);
echo "Created bucket named: $this->bucketName \n";
} catch (Exception $exception) {
echo "Failed to create bucket $this->bucketName with error: " . $exception->getMessage();
exit("Please fix error with bucket creation before continuing.");
}
```
+ 如需 API 詳細資訊，請參閱*《適用於 PHP 的 AWS SDK API 參考》*中的 [CreateBucket](https://docs.aws.amazon.com/goto/SdkForPHPV3/s3-2006-03-01/CreateBucket)。
------
#### [ Python ]
**適用於 Python 的 SDK (Boto3)**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/s3/s3_basics#code-examples)中設定和執行。
使用預設設定建立儲存貯體。
```
class BucketWrapper:
"""Encapsulates S3 bucket actions."""
def __init__(self, bucket):
"""
:param bucket: A Boto3 Bucket resource. This is a high-level resource in Boto3
that wraps bucket actions in a class-like structure.
"""
self.bucket = bucket
self.name = bucket.name
def create(self, region_override=None):
"""
Create an Amazon S3 bucket in the default Region for the account or in the
specified Region.
:param region_override: The Region in which to create the bucket. If this is
not specified, the Region configured in your shared
credentials is used.
"""
if region_override is not None:
region = region_override
else:
region = self.bucket.meta.client.meta.region_name
try:
self.bucket.create(CreateBucketConfiguration={"LocationConstraint": region})
self.bucket.wait_until_exists()
logger.info("Created bucket '%s' in region=%s", self.bucket.name, region)
except ClientError as error:
logger.exception(
"Couldn't create bucket named '%s' in region=%s.",
self.bucket.name,
region,
)
raise error
```
透過生命週期組態建立版本控制儲存貯體。
```
def create_versioned_bucket(bucket_name, prefix):
"""
Creates an Amazon S3 bucket, enables it for versioning, and configures a lifecycle
that expires noncurrent object versions after 7 days.
Adding a lifecycle configuration to a versioned bucket is a best practice.
It helps prevent objects in the bucket from accumulating a large number of
noncurrent versions, which can slow down request performance.
Usage is shown in the usage_demo_single_object function at the end of this module.
:param bucket_name: The name of the bucket to create.
:param prefix: Identifies which objects are automatically expired under the
configured lifecycle rules.
:return: The newly created bucket.
"""
try:
bucket = s3.create_bucket(
Bucket=bucket_name,
CreateBucketConfiguration={
"LocationConstraint": s3.meta.client.meta.region_name
},
)
logger.info("Created bucket %s.", bucket.name)
except ClientError as error:
if error.response["Error"]["Code"] == "BucketAlreadyOwnedByYou":
logger.warning("Bucket %s already exists! Using it.", bucket_name)
bucket = s3.Bucket(bucket_name)
else:
logger.exception("Couldn't create bucket %s.", bucket_name)
raise
try:
bucket.Versioning().enable()
logger.info("Enabled versioning on bucket %s.", bucket.name)
except ClientError:
logger.exception("Couldn't enable versioning on bucket %s.", bucket.name)
raise
try:
expiration = 7
bucket.LifecycleConfiguration().put(
LifecycleConfiguration={
"Rules": [
{
"Status": "Enabled",
"Prefix": prefix,
"NoncurrentVersionExpiration": {"NoncurrentDays": expiration},
}
]
}
)
logger.info(
"Configured lifecycle to expire noncurrent versions after %s days "
"on bucket %s.",
expiration,
bucket.name,
)
except ClientError as error:
logger.warning(
"Couldn't configure lifecycle on bucket %s because %s. "
"Continuing anyway.",
bucket.name,
error,
)
return bucket
```
+ 如需 API 詳細資訊，請參閱*《適用於 Python (Boto3) 的AWS SDK API 參考》*中的 [CreateBucket](https://docs.aws.amazon.com/goto/boto3/s3-2006-03-01/CreateBucket)。
------
#### [ Ruby ]
**SDK for Ruby**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/ruby/example_code/s3#code-examples)中設定和執行。
```
require 'aws-sdk-s3'
# Wraps Amazon S3 bucket actions.
class BucketCreateWrapper
attr_reader :bucket
# @param bucket [Aws::S3::Bucket] An Amazon S3 bucket initialized with a name. This is a client-side object until
# create is called.
def initialize(bucket)
@bucket = bucket
end
# Creates an Amazon S3 bucket in the specified AWS Region.
#
# @param region [String] The Region where the bucket is created.
# @return [Boolean] True when the bucket is created; otherwise, false.
def create?(region)
@bucket.create(create_bucket_configuration: { location_constraint: region })
true
rescue Aws::Errors::ServiceError => e
puts "Couldn't create bucket. Here's why: #{e.message}"
false
end
# Gets the Region where the bucket is located.
#
# @return [String] The location of the bucket.
def location
if @bucket.nil?
'None. You must create a bucket before you can get its location!'
else
@bucket.client.get_bucket_location(bucket: @bucket.name).location_constraint
end
rescue Aws::Errors::ServiceError => e
"Couldn't get the location of #{@bucket.name}. Here's why: #{e.message}"
end
end
# Example usage:
def run_demo
region = "us-west-2"
wrapper = BucketCreateWrapper.new(Aws::S3::Bucket.new("amzn-s3-demo-bucket-#{Random.uuid}"))
return unless wrapper.create?(region)
puts "Created bucket #{wrapper.bucket.name}."
puts "Your bucket's region is: #{wrapper.location}"
end
run_demo if $PROGRAM_NAME == __FILE__
```
+ 如需 API 詳細資訊，請參閱*《適用於 Ruby 的 AWS SDK API 參考》*中的 [CreateBucket](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/CreateBucket)。
------
#### [ Rust ]
**適用於 Rust 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/rustv1/examples/s3#code-examples)中設定和執行。
```
pub async fn create_bucket(
client: &aws_sdk_s3::Client,
bucket_name: &str,
region: &aws_config::Region,
) -> Result, S3ExampleError> {
let constraint = aws_sdk_s3::types::BucketLocationConstraint::from(region.to_string().as_str());
let cfg = aws_sdk_s3::types::CreateBucketConfiguration::builder()
.location_constraint(constraint)
.build();
let create = client
.create_bucket()
.create_bucket_configuration(cfg)
.bucket(bucket_name)
.send()
.await;
// BucketAlreadyExists and BucketAlreadyOwnedByYou are not problems for this task.
create.map(Some).or_else(|err| {
if err
.as_service_error()
.map(|se| se.is_bucket_already_exists() || se.is_bucket_already_owned_by_you())
== Some(true)
{
Ok(None)
} else {
Err(S3ExampleError::from(err))
}
})
}
```
+ 如需 API 詳細資訊，請參閱 *《適用於 Rust 的AWS SDK API 參考》*中的 [CreateBucket](https://docs.rs/aws-sdk-s3/latest/aws_sdk_s3/client/struct.Client.html#method.create_bucket)。
------
#### [ SAP ABAP ]
**適用於 SAP ABAP 的開發套件**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/s3#code-examples)中設定和執行。
```
TRY.
" determine our region from our session
DATA(lv_region) = CONV /aws1/s3_bucketlocationcnstrnt( lo_session->get_region( ) ).
DATA lo_constraint TYPE REF TO /aws1/cl_s3_createbucketconf.
" When in the us-east-1 region, you must not specify a constraint
" In all other regions, specify the region as the constraint
IF lv_region = 'us-east-1'.
CLEAR lo_constraint.
ELSE.
lo_constraint = NEW /aws1/cl_s3_createbucketconf( lv_region ).
ENDIF.
lo_s3->createbucket(
iv_bucket = iv_bucket_name
io_createbucketconfiguration = lo_constraint ).
MESSAGE 'S3 bucket created.' TYPE 'I'.
CATCH /aws1/cx_s3_bucketalrdyexists.
MESSAGE 'Bucket name already exists.' TYPE 'E'.
CATCH /aws1/cx_s3_bktalrdyownedbyyou.
MESSAGE 'Bucket already exists and is owned by you.' TYPE 'E'.
ENDTRY.
```
+ 如需 API 詳細資訊，請參閱《適用於 SAP ABAP 的AWS SDK API 參考》**中的 [CreateBucket](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)。
------
#### [ Swift ]
**適用於 Swift 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/swift/example_code/s3/basics#code-examples)中設定和執行。
```
import AWSS3
public func createBucket(name: String) async throws {
var input = CreateBucketInput(
bucket: name
)
// For regions other than "us-east-1", you must set the locationConstraint in the createBucketConfiguration.
// For more information, see LocationConstraint in the S3 API guide.
// https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html#API_CreateBucket_RequestBody
if let region = configuration.region {
if region != "us-east-1" {
input.createBucketConfiguration = S3ClientTypes.CreateBucketConfiguration(locationConstraint: S3ClientTypes.BucketLocationConstraint(rawValue: region))
}
}
do {
_ = try await client.createBucket(input: input)
}
catch let error as BucketAlreadyOwnedByYou {
print("The bucket '\(name)' already exists and is owned by you. You may wish to ignore this exception.")
throw error
}
catch {
print("ERROR: ", dump(error, name: "Creating a bucket"))
throw error
}
}
```
+ 如需 API 詳細資訊，請參閱 *《適用於 Swift 的AWS SDK API 參考》*中的 [CreateBucket](https://sdk.amazonaws.com/swift/api/awss3/latest/documentation/awss3/s3client/createbucket(input:))。
------
# `CreateMultiRegionAccessPoint` 搭配 AWS SDK 使用
以下程式碼範例顯示如何使用 `CreateMultiRegionAccessPoint`。
------
#### [ Kotlin ]
**適用於 Kotlin 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/s3#code-examples)中設定和執行。
設定 S3 控制用戶端，將請求傳送至 us-west-2 區域。
```
suspend fun createS3ControlClient(): S3ControlClient {
// Configure your S3ControlClient to send requests to US West (Oregon).
val s3Control = S3ControlClient.fromEnvironment {
region = "us-west-2"
}
return s3Control
}
```
建立多區域存取點。
```
suspend fun createMrap(
s3Control: S3ControlClient,
accountIdParam: String,
bucketName1: String,
bucketName2: String,
mrapName: String,
): String {
println("Creating MRAP ...")
val createMrapResponse: CreateMultiRegionAccessPointResponse =
s3Control.createMultiRegionAccessPoint {
accountId = accountIdParam
clientToken = UUID.randomUUID().toString()
details {
name = mrapName
regions = listOf(
Region {
bucket = bucketName1
},
Region {
bucket = bucketName2
},
)
}
}
val requestToken: String? = createMrapResponse.requestTokenArn
// Use the request token to check for the status of the CreateMultiRegionAccessPoint operation.
if (requestToken != null) {
waitForSucceededStatus(s3Control, requestToken, accountIdParam)
println("MRAP created")
}
val getMrapResponse =
s3Control.getMultiRegionAccessPoint(
input = GetMultiRegionAccessPointRequest {
accountId = accountIdParam
name = mrapName
},
)
val mrapAlias = getMrapResponse.accessPoint?.alias
return "arn:aws:s3::$accountIdParam:accesspoint/$mrapAlias"
}
```
等待多區域存取點變成可用。
```
suspend fun waitForSucceededStatus(
s3Control: S3ControlClient,
requestToken: String,
accountIdParam: String,
timeBetweenChecks: Duration = 1.minutes,
) {
var describeResponse: DescribeMultiRegionAccessPointOperationResponse
describeResponse = s3Control.describeMultiRegionAccessPointOperation(
input = DescribeMultiRegionAccessPointOperationRequest {
accountId = accountIdParam
requestTokenArn = requestToken
},
)
var status: String? = describeResponse.asyncOperation?.requestStatus
while (status != "SUCCEEDED") {
delay(timeBetweenChecks)
describeResponse = s3Control.describeMultiRegionAccessPointOperation(
input = DescribeMultiRegionAccessPointOperationRequest {
accountId = accountIdParam
requestTokenArn = requestToken
},
)
status = describeResponse.asyncOperation?.requestStatus
println(status)
}
}
```
+ 如需詳細資訊，請參閱[適用於 Kotlin 的AWS SDK 開發人員指南](https://docs.aws.amazon.com/sdk-for-kotlin/latest/developer-guide/use-services-s3-mrap.html)。
+ 如需 API 詳細資訊，請參閱《適用於 Kotlin 的AWS SDK API 參考》**中的 [CreateMultiRegionAccessPoint](https://sdk.amazonaws.com/kotlin/api/latest/index.html)。
------
# `CreateMultipartUpload` 搭配 AWS SDK 或 CLI 使用
下列程式碼範例示範如何使用 `CreateMultipartUpload`。
動作範例是大型程式的程式碼摘錄，必須在內容中執行。您可以在下列程式碼範例的內容中看到此動作：
+ [執行分段複製](s3_example_s3_MultipartCopy_section.md)
+ [使用檢查總和](s3_example_s3_Scenario_UseChecksums_section.md)
+ [使用 Amazon S3 物件完整性](s3_example_s3_Scenario_ObjectIntegrity_section.md)
------
#### [ C\$1\$1 ]
**適用於 C\$1\$1 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/s3#code-examples)中設定和執行。
```
//! Create a multipart upload.
/*!
\param bucket: The name of the S3 bucket where the object will be uploaded.
\param key: The unique identifier (key) for the object within the S3 bucket.
\param client: The S3 client instance used to perform the upload operation.
\return Aws::String: Upload ID or empty string if failed.
*/
Aws::String
AwsDoc::S3::createMultipartUpload(const Aws::String &bucket, const Aws::String &key,
Aws::S3::Model::ChecksumAlgorithm checksumAlgorithm,
const Aws::S3::S3Client &client) {
Aws::S3::Model::CreateMultipartUploadRequest request;
request.SetBucket(bucket);
request.SetKey(key);
if (checksumAlgorithm != Aws::S3::Model::ChecksumAlgorithm::NOT_SET) {
request.SetChecksumAlgorithm(checksumAlgorithm);
}
Aws::S3::Model::CreateMultipartUploadOutcome outcome =
client.CreateMultipartUpload(request);
Aws::String uploadID;
if (outcome.IsSuccess()) {
uploadID = outcome.GetResult().GetUploadId();
} else {
std::cerr << "Error creating multipart upload: " << outcome.GetError().GetMessage() << std::endl;
}
return uploadID;
}
```
+ 如需 API 詳細資訊，請參閱《*適用於 C\$1\$1 的 AWS SDK API 參考*》中的 [CreateMultipartUpload](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/CreateMultipartUpload)。
------
#### [ CLI ]
**AWS CLI**
下列命令會使用金鑰 `multipart/01` 在儲存貯體 `amzn-s3-demo-bucket` 中建立分段上傳：
```
aws s3api create-multipart-upload --bucket amzn-s3-demo-bucket --key 'multipart/01'
```
輸出：
```
{
"Bucket": "amzn-s3-demo-bucket",
"UploadId": "dfRtDYU0WWCCcH43C3WFbkRONycyCpTJJvxu2i5GYkZljF.Yxwh6XG7WfS2vC4to6HiV6Yjlx.cph0gtNBtJ8P3URCSbB7rjxI5iEwVDmgaXZOGgkk5nVTW16HOQ5l0R",
"Key": "multipart/01"
}
```
完成的檔案會在儲存貯體 `amzn-s3-demo-bucket` 中名為 `multipart` 的資料夾中命名為 `01`。儲存要與 `upload-part` 命令搭配使用的上傳 ID、金鑰和儲存貯體名稱。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [CreateMultipartUpload](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3api/create-multipart-upload.html)。
------
#### [ Rust ]
**適用於 Rust 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/rustv1/examples/s3#code-examples)中設定和執行。
```
// Create a multipart upload. Use UploadPart and CompleteMultipartUpload to
// upload the file.
let multipart_upload_res: CreateMultipartUploadOutput = client
.create_multipart_upload()
.bucket(&bucket_name)
.key(&key)
.send()
.await?;
let upload_id = multipart_upload_res.upload_id().ok_or(S3ExampleError::new(
"Missing upload_id after CreateMultipartUpload",
))?;
```
```
let mut upload_parts: Vec = Vec::new();
for chunk_index in 0..chunk_count {
let this_chunk = if chunk_count - 1 == chunk_index {
size_of_last_chunk
} else {
CHUNK_SIZE
};
let stream = ByteStream::read_from()
.path(path)
.offset(chunk_index * CHUNK_SIZE)
.length(Length::Exact(this_chunk))
.build()
.await
.unwrap();
// Chunk index needs to start at 0, but part numbers start at 1.
let part_number = (chunk_index as i32) + 1;
let upload_part_res = client
.upload_part()
.key(&key)
.bucket(&bucket_name)
.upload_id(upload_id)
.body(stream)
.part_number(part_number)
.send()
.await?;
upload_parts.push(
CompletedPart::builder()
.e_tag(upload_part_res.e_tag.unwrap_or_default())
.part_number(part_number)
.build(),
);
}
```
```
// upload_parts: Vec
let completed_multipart_upload: CompletedMultipartUpload = CompletedMultipartUpload::builder()
.set_parts(Some(upload_parts))
.build();
let _complete_multipart_upload_res = client
.complete_multipart_upload()
.bucket(&bucket_name)
.key(&key)
.multipart_upload(completed_multipart_upload)
.upload_id(upload_id)
.send()
.await?;
```
+ 如需 API 詳細資訊，請參閱《適用於 Rust 的AWS SDK API 參考》**中的 [CreateMultipartUpload](https://docs.rs/aws-sdk-s3/latest/aws_sdk_s3/client/struct.Client.html#method.create_multipart_upload)。
------
# `CreatePresignedPost` 搭配 AWS SDK 使用
以下程式碼範例顯示如何使用 `CreatePresignedPost`。
------
#### [ .NET ]
**適用於 .NET 的 SDK (v4)**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv4/S3#code-examples)中設定和執行。
建立預先簽章的 POST URL。
```
///
/// Create a presigned POST URL with conditions.
///
/// The Amazon S3 client.
/// The name of the bucket.
/// The object key (path) where the uploaded file will be stored.
/// When the presigned URL expires.
/// Dictionary of fields to add to the form.
/// List of conditions to apply.
/// A CreatePresignedPostResponse object with URL and form fields.
public async Task CreatePresignedPostAsync(
IAmazonS3 s3Client,
string bucketName,
string objectKey,
DateTime expires,
Dictionary? fields = null,
List? conditions = null)
{
var request = new CreatePresignedPostRequest
{
BucketName = bucketName,
Key = objectKey,
Expires = expires
};
// Add custom fields if provided
if (fields != null)
{
foreach (var field in fields)
{
request.Fields.Add(field.Key, field.Value);
}
}
// Add conditions if provided
if (conditions != null)
{
foreach (var condition in conditions)
{
request.Conditions.Add(condition);
}
}
return await s3Client.CreatePresignedPostAsync(request);
}
```
+ 如需 API 詳細資訊，請參閱《*適用於 .NET 的 AWS SDK API 參考*》中的 [CreatePresignedPost](https://docs.aws.amazon.com/goto/DotNetSDKV4/s3-2006-03-01/CreatePresignedPost)。
------
# `DeleteBucket` 搭配 AWS SDK 或 CLI 使用
下列程式碼範例示範如何使用 `DeleteBucket`。
動作範例是大型程式的程式碼摘錄，必須在內容中執行。您可以在下列程式碼範例的內容中看到此動作：
+ [了解基本概念](s3_example_s3_Scenario_GettingStarted_section.md)
+ [開始使用 S3](s3_example_s3_GettingStarted_section.md)
------
#### [ .NET ]
**適用於 .NET 的 SDK (v4)**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv4/S3#code-examples)中設定和執行。
```
///
/// Shows how to delete an Amazon S3 bucket.
///
/// The name of the Amazon S3 bucket to delete.
/// A boolean value that represents the success or failure of
/// the delete operation.
public async Task DeleteBucketAsync(string bucketName)
{
try
{
var request = new DeleteBucketRequest { BucketName = bucketName, };
await _amazonS3.DeleteBucketAsync(request);
return true;
}
catch (AmazonS3Exception ex)
{
Console.WriteLine($"Error deleting bucket: {ex.Message}");
return false;
}
}
```
+ 如需 API 詳細資訊，請參閱*《適用於 .NET 的 AWS SDK API 參考》*中的 [DeleteBucket](https://docs.aws.amazon.com/goto/DotNetSDKV4/s3-2006-03-01/DeleteBucket)。
------
#### [ Bash ]
**AWS CLI 使用 Bash 指令碼**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/aws-cli/bash-linux/s3#code-examples)中設定和執行。
```
###############################################################################
# function errecho
#
# This function outputs everything sent to it to STDERR (standard error output).
###############################################################################
function errecho() {
printf "%s\n" "$*" 1>&2
}
###############################################################################
# function delete_bucket
#
# This function deletes the specified bucket.
#
# Parameters:
# $1 - The name of the bucket.
# Returns:
# 0 - If successful.
# 1 - If it fails.
###############################################################################
function delete_bucket() {
local bucket_name=$1
local response
response=$(aws s3api delete-bucket \
--bucket "$bucket_name")
# shellcheck disable=SC2181
if [[ $? -ne 0 ]]; then
errecho "ERROR: AWS reports s3api delete-bucket failed.\n$response"
return 1
fi
}
```
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DeleteBucket](https://docs.aws.amazon.com/goto/aws-cli/s3-2006-03-01/DeleteBucket)。
------
#### [ C\$1\$1 ]
**適用於 C\$1\$1 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/s3#code-examples)中設定和執行。
```
bool AwsDoc::S3::deleteBucket(const Aws::String &bucketName,
const Aws::S3::S3ClientConfiguration &clientConfig) {
Aws::S3::S3Client client(clientConfig);
Aws::S3::Model::DeleteBucketRequest request;
request.SetBucket(bucketName);
Aws::S3::Model::DeleteBucketOutcome outcome =
client.DeleteBucket(request);
if (!outcome.IsSuccess()) {
const Aws::S3::S3Error &err = outcome.GetError();
std::cerr << "Error: deleteBucket: " <<
err.GetExceptionName() << ": " << err.GetMessage() << std::endl;
} else {
std::cout << "The bucket was deleted" << std::endl;
}
return outcome.IsSuccess();
}
```
+ 如需 API 詳細資訊，請參閱*《適用於 C\$1\$1 的 AWS SDK API 參考》*中的 [DeleteBucket](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/DeleteBucket)。
------
#### [ CLI ]
**AWS CLI**
以下命令會刪除一個名為 `amzn-s3-demo-bucket` 的儲存貯體：
```
aws s3api delete-bucket --bucket amzn-s3-demo-bucket --region us-east-1
```
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DeleteBucket](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3api/delete-bucket.html)。
------
#### [ Go ]
**SDK for Go V2**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/gov2/s3#code-examples)中設定和執行。
```
import (
"bytes"
"context"
"errors"
"fmt"
"io"
"log"
"os"
"time"
"github.com/aws/aws-sdk-go-v2/aws"
"github.com/aws/aws-sdk-go-v2/feature/s3/manager"
"github.com/aws/aws-sdk-go-v2/service/s3"
"github.com/aws/aws-sdk-go-v2/service/s3/types"
"github.com/aws/smithy-go"
)
// BucketBasics encapsulates the Amazon Simple Storage Service (Amazon S3) actions
// used in the examples.
// It contains S3Client, an Amazon S3 service client that is used to perform bucket
// and object actions.
type BucketBasics struct {
S3Client *s3.Client
}
// DeleteBucket deletes a bucket. The bucket must be empty or an error is returned.
func (basics BucketBasics) DeleteBucket(ctx context.Context, bucketName string) error {
_, err := basics.S3Client.DeleteBucket(ctx, &s3.DeleteBucketInput{
Bucket: aws.String(bucketName)})
if err != nil {
var noBucket *types.NoSuchBucket
if errors.As(err, &noBucket) {
log.Printf("Bucket %s does not exist.\n", bucketName)
err = noBucket
} else {
log.Printf("Couldn't delete bucket %v. Here's why: %v\n", bucketName, err)
}
} else {
err = s3.NewBucketNotExistsWaiter(basics.S3Client).Wait(
ctx, &s3.HeadBucketInput{Bucket: aws.String(bucketName)}, time.Minute)
if err != nil {
log.Printf("Failed attempt to wait for bucket %s to be deleted.\n", bucketName)
} else {
log.Printf("Deleted %s.\n", bucketName)
}
}
return err
}
```
+ 如需 API 詳細資訊，請參閱*《適用於 Go 的 AWS SDK API 參考》*中的 [DeleteBucket](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/s3#Client.DeleteBucket)。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/s3#code-examples)中設定和執行。
```
/**
* Deletes an S3 bucket asynchronously.
*
* @param bucket the name of the bucket to be deleted
* @return a {@link CompletableFuture} that completes when the bucket deletion is successful, or throws a {@link RuntimeException}
* if an error occurs during the deletion process
*/
public CompletableFuture deleteBucketAsync(String bucket) {
DeleteBucketRequest deleteBucketRequest = DeleteBucketRequest.builder()
.bucket(bucket)
.build();
CompletableFuture response = getAsyncClient().deleteBucket(deleteBucketRequest);
response.whenComplete((deleteRes, ex) -> {
if (deleteRes != null) {
logger.info(bucket + " was deleted.");
} else {
throw new RuntimeException("An S3 exception occurred during bucket deletion", ex);
}
});
return response.thenApply(r -> null);
}
```
+ 如需 API 詳細資訊，請參閱*《AWS SDK for Java 2.x API 參考》*中的 [DeleteBucket](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/DeleteBucket)。
------
#### [ JavaScript ]
**適用於 JavaScript (v3) 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/s3#code-examples)中設定和執行。
刪除儲存貯體。
```
import {
DeleteBucketCommand,
S3Client,
S3ServiceException,
} from "@aws-sdk/client-s3";
/**
* Delete an Amazon S3 bucket.
* @param {{ bucketName: string }}
*/
export const main = async ({ bucketName }) => {
const client = new S3Client({});
const command = new DeleteBucketCommand({
Bucket: bucketName,
});
try {
await client.send(command);
console.log("Bucket was deleted.");
} catch (caught) {
if (
caught instanceof S3ServiceException &&
caught.name === "NoSuchBucket"
) {
console.error(
`Error from S3 while deleting bucket. The bucket doesn't exist.`,
);
} else if (caught instanceof S3ServiceException) {
console.error(
`Error from S3 while deleting the bucket. ${caught.name}: ${caught.message}`,
);
} else {
throw caught;
}
}
};
```
+ 如需詳細資訊，請參閱《[適用於 JavaScript 的 AWS SDK 開發人員指南](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/s3-example-creating-buckets.html#s3-example-deleting-buckets)》。
+ 如需 API 詳細資訊，請參閱*《適用於 JavaScript 的 AWS SDK API 參考》*中的 [DeleteBucket](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/s3/command/DeleteBucketCommand)。
------
#### [ PHP ]
**適用於 PHP 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code/s3#code-examples)中設定和執行。
刪除空的儲存貯體。
```
$s3client = new Aws\S3\S3Client(['region' => 'us-west-2']);
try {
$this->s3client->deleteBucket([
'Bucket' => $this->bucketName,
]);
echo "Deleted bucket $this->bucketName.\n";
} catch (Exception $exception) {
echo "Failed to delete $this->bucketName with error: " . $exception->getMessage();
exit("Please fix error with bucket deletion before continuing.");
}
```
+ 如需 API 詳細資訊，請參閱*《適用於 PHP 的 AWS SDK API 參考》*中的 [DeleteBucket](https://docs.aws.amazon.com/goto/SdkForPHPV3/s3-2006-03-01/DeleteBucket)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此命令會從儲存貯體 'test-files' 移除所有物件和物件版本，然後刪除儲存貯體。繼續之前，此命令會先提示確認。新增 - 強制切換以隱藏確認。請注意，不是空的儲存貯體無法刪除。**
```
Remove-S3Bucket -BucketName amzn-s3-demo-bucket -DeleteBucketContent
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [DeleteBucket](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此命令會從儲存貯體 'test-files' 移除所有物件和物件版本，然後刪除儲存貯體。繼續之前，此命令會先提示確認。新增 - 強制切換以隱藏確認。請注意，不是空的儲存貯體無法刪除。**
```
Remove-S3Bucket -BucketName amzn-s3-demo-bucket -DeleteBucketContent
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [DeleteBucket](https://docs.aws.amazon.com/powershell/v5/reference)。
------
#### [ Python ]
**適用於 Python 的 SDK (Boto3)**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/s3/s3_basics#code-examples)中設定和執行。
```
class BucketWrapper:
"""Encapsulates S3 bucket actions."""
def __init__(self, bucket):
"""
:param bucket: A Boto3 Bucket resource. This is a high-level resource in Boto3
that wraps bucket actions in a class-like structure.
"""
self.bucket = bucket
self.name = bucket.name
def delete(self):
"""
Delete the bucket. The bucket must be empty or an error is raised.
"""
try:
self.bucket.delete()
self.bucket.wait_until_not_exists()
logger.info("Bucket %s successfully deleted.", self.bucket.name)
except ClientError:
logger.exception("Couldn't delete bucket %s.", self.bucket.name)
raise
```
+ 如需 API 詳細資訊，請參閱*《適用於 Python (Boto3) 的AWS SDK API 參考》*中的 [DeleteBucket](https://docs.aws.amazon.com/goto/boto3/s3-2006-03-01/DeleteBucket)。
------
#### [ Ruby ]
**SDK for Ruby**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/ruby/example_code/s3#code-examples)中設定和執行。
```
# Deletes the objects in an Amazon S3 bucket and deletes the bucket.
#
# @param bucket [Aws::S3::Bucket] The bucket to empty and delete.
def delete_bucket(bucket)
puts("\nDo you want to delete all of the objects as well as the bucket (y/n)? ")
answer = gets.chomp.downcase
if answer == 'y'
bucket.objects.batch_delete!
bucket.delete
puts("Emptied and deleted bucket #{bucket.name}.\n")
end
rescue Aws::Errors::ServiceError => e
puts("Couldn't empty and delete bucket #{bucket.name}.")
puts("\t#{e.code}: #{e.message}")
raise
end
```
+ 如需 API 詳細資訊，請參閱*《適用於 Ruby 的 AWS SDK API 參考》*中的 [DeleteBucket](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/DeleteBucket)。
------
#### [ Rust ]
**適用於 Rust 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/rustv1/examples/s3#code-examples)中設定和執行。
```
pub async fn delete_bucket(
client: &aws_sdk_s3::Client,
bucket_name: &str,
) -> Result<(), S3ExampleError> {
let resp = client.delete_bucket().bucket(bucket_name).send().await;
match resp {
Ok(_) => Ok(()),
Err(err) => {
if err
.as_service_error()
.and_then(aws_sdk_s3::error::ProvideErrorMetadata::code)
== Some("NoSuchBucket")
{
Ok(())
} else {
Err(S3ExampleError::from(err))
}
}
}
}
```
+ 如需 API 詳細資訊，請參閱*《適用於 Rust 的AWS SDK API 參考》*中的 [DeleteBucket](https://docs.rs/aws-sdk-s3/latest/aws_sdk_s3/client/struct.Client.html#method.delete_bucket)。
------
#### [ SAP ABAP ]
**適用於 SAP ABAP 的開發套件**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/s3#code-examples)中設定和執行。
```
TRY.
lo_s3->deletebucket(
iv_bucket = iv_bucket_name ).
MESSAGE 'Deleted S3 bucket.' TYPE 'I'.
CATCH /aws1/cx_s3_nosuchbucket.
MESSAGE 'Bucket does not exist.' TYPE 'E'.
ENDTRY.
```
+ 如需 API 詳細資訊，請參閱《適用於 SAP ABAP 的AWS SDK API 參考》**中的 [DeleteBucket](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)。
------
#### [ Swift ]
**適用於 Swift 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/swift/example_code/s3/basics#code-examples)中設定和執行。
```
import AWSS3
public func deleteBucket(name: String) async throws {
let input = DeleteBucketInput(
bucket: name
)
do {
_ = try await client.deleteBucket(input: input)
}
catch {
print("ERROR: ", dump(error, name: "Deleting a bucket"))
throw error
}
}
```
+ 如需 API 詳細資訊，請參閱*《適用於 Swift 的AWS SDK API 參考》*中的 [DeleteBucket](https://sdk.amazonaws.com/swift/api/awss3/latest/documentation/awss3/s3client/deletebucket(input:))。
------
# 搭配使用 `DeleteBucketAnalyticsConfiguration` 與 CLI
下列程式碼範例示範如何使用 `DeleteBucketAnalyticsConfiguration`。
------
#### [ CLI ]
**AWS CLI**
**刪除儲存貯體的分析組態**
下列 `delete-bucket-analytics-configuration` 範例會移除指定儲存貯體和 ID 的分析組態。
```
aws s3api delete-bucket-analytics-configuration \
--bucket amzn-s3-demo-bucket \
--id 1
```
此命令不會產生輸出。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DeleteBucketAnalyticsConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3api/delete-bucket-analytics-configuration.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1： 命令會移除給定 S3 儲存貯體中名為 'testfilter' 的分析篩選條件。**
```
Remove-S3BucketAnalyticsConfiguration -BucketName 'amzn-s3-demo-bucket' -AnalyticsId 'testfilter'
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [DeleteBucketAnalyticsConfiguration](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1： 命令會移除給定 S3 儲存貯體中名為 'testfilter' 的分析篩選條件。**
```
Remove-S3BucketAnalyticsConfiguration -BucketName 'amzn-s3-demo-bucket' -AnalyticsId 'testfilter'
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [DeleteBucketAnalyticsConfiguration](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# `DeleteBucketCors` 搭配 AWS SDK 或 CLI 使用
下列程式碼範例示範如何使用 `DeleteBucketCors`。
------
#### [ .NET ]
**適用於 .NET 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/S3#code-examples)中設定和執行。
```
///
/// Deletes a CORS configuration from an Amazon S3 bucket.
///
/// The initialized Amazon S3 client object used
/// to delete the CORS configuration from the bucket.
private static async Task DeleteCORSConfigurationAsync(AmazonS3Client client)
{
DeleteCORSConfigurationRequest request = new DeleteCORSConfigurationRequest()
{
BucketName = BucketName,
};
await client.DeleteCORSConfigurationAsync(request);
}
```
+ 如需 API 詳細資訊，請參閱*《適用於 .NET 的 AWS SDK API 參考》*中的 [DeleteBucketCors](https://docs.aws.amazon.com/goto/DotNetSDKV3/s3-2006-03-01/DeleteBucketCors)。
------
#### [ CLI ]
**AWS CLI**
下列命令會從名為 `amzn-s3-demo-bucket` 的儲存貯體中刪除跨來源資源共享組態：
```
aws s3api delete-bucket-cors --bucket amzn-s3-demo-bucket
```
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DeleteBucketCors](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3api/delete-bucket-cors.html)。
------
#### [ Python ]
**適用於 Python 的 SDK (Boto3)**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/s3/s3_basics#code-examples)中設定和執行。
```
class BucketWrapper:
"""Encapsulates S3 bucket actions."""
def __init__(self, bucket):
"""
:param bucket: A Boto3 Bucket resource. This is a high-level resource in Boto3
that wraps bucket actions in a class-like structure.
"""
self.bucket = bucket
self.name = bucket.name
def delete_cors(self):
"""
Delete the CORS rules from the bucket.
:param bucket_name: The name of the bucket to update.
"""
try:
self.bucket.Cors().delete()
logger.info("Deleted CORS from bucket '%s'.", self.bucket.name)
except ClientError:
logger.exception("Couldn't delete CORS from bucket '%s'.", self.bucket.name)
raise
```
+ 如需 API 詳細資訊，請參閱*《適用於 Python (Boto3) 的AWS SDK API 參考》*中的 [DeleteBucketCors](https://docs.aws.amazon.com/goto/boto3/s3-2006-03-01/DeleteBucketCors)。
------
#### [ Ruby ]
**SDK for Ruby**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/ruby/example_code/s3#code-examples)中設定和執行。
```
require 'aws-sdk-s3'
# Wraps Amazon S3 bucket CORS configuration.
class BucketCorsWrapper
attr_reader :bucket_cors
# @param bucket_cors [Aws::S3::BucketCors] A bucket CORS object configured with an existing bucket.
def initialize(bucket_cors)
@bucket_cors = bucket_cors
end
# Deletes the CORS configuration of a bucket.
#
# @return [Boolean] True if the CORS rules were deleted; otherwise, false.
def delete_cors
@bucket_cors.delete
true
rescue Aws::Errors::ServiceError => e
puts "Couldn't delete CORS rules for #{@bucket_cors.bucket.name}. Here's why: #{e.message}"
false
end
end
```
+ 如需 API 詳細資訊，請參閱*《適用於 Ruby 的 AWS SDK API 參考》*中的 [DeleteBucketCors](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/DeleteBucketCors)。
------
#### [ SAP ABAP ]
**適用於 SAP ABAP 的開發套件**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/s3#code-examples)中設定和執行。
```
TRY.
lo_s3->deletebucketcors(
iv_bucket = iv_bucket_name ).
MESSAGE 'Bucket CORS configuration deleted.' TYPE 'I'.
CATCH /aws1/cx_s3_nosuchbucket.
MESSAGE 'Bucket does not exist.' TYPE 'E'.
ENDTRY.
```
+ 如需 API 詳細資訊，請參閱《適用於 *AWS SAP ABAP 的 SDK API 參考*》中的 [DeleteBucketCors](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)。
------
# 搭配使用 `DeleteBucketEncryption` 與 CLI
下列程式碼範例示範如何使用 `DeleteBucketEncryption`。
------
#### [ CLI ]
**AWS CLI**
**刪除儲存貯體的伺服器端加密組態**
下列 `delete-bucket-encryption` 範例會刪除指定儲存貯體的伺服器端加密組態。
```
aws s3api delete-bucket-encryption \
--bucket amzn-s3-demo-bucket
```
此命令不會產生輸出。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DeleteBucketEncryption](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3api/delete-bucket-encryption.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：這會停用針對提供的 S3 儲存貯體啟用的加密。**
```
Remove-S3BucketEncryption -BucketName 'amzn-s3-demo-bucket'
```
**輸出：**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-S3BucketEncryption (DeleteBucketEncryption)" on target "s3casetestbucket".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [DeleteBucketEncryption](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：這會停用針對提供的 S3 儲存貯體啟用的加密。**
```
Remove-S3BucketEncryption -BucketName 'amzn-s3-demo-bucket'
```
**輸出：**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-S3BucketEncryption (DeleteBucketEncryption)" on target "s3casetestbucket".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [DeleteBucketEncryption](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `DeleteBucketInventoryConfiguration` 與 CLI
下列程式碼範例示範如何使用 `DeleteBucketInventoryConfiguration`。
------
#### [ CLI ]
**AWS CLI**
**刪除儲存貯體的庫存組態**
下列 `delete-bucket-inventory-configuration` 範例會刪除具有指定儲存貯體 ID `1` 的庫存組態。
```
aws s3api delete-bucket-inventory-configuration \
--bucket amzn-s3-demo-bucket \
--id 1
```
此命令不會產生輸出。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DeleteBucketInventoryConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3api/delete-bucket-inventory-configuration.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此命令會移除與給定 S3 儲存貯體對應之名為 'testInventoryName' 的庫存。**
```
Remove-S3BucketInventoryConfiguration -BucketName 'amzn-s3-demo-bucket' -InventoryId 'testInventoryName'
```
**輸出：**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-S3BucketInventoryConfiguration (DeleteBucketInventoryConfiguration)" on target "amzn-s3-demo-bucket".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [DeleteBucketInventoryConfiguration](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此命令會移除與給定 S3 儲存貯體對應之名為 'testInventoryName' 的庫存。**
```
Remove-S3BucketInventoryConfiguration -BucketName 'amzn-s3-demo-bucket' -InventoryId 'testInventoryName'
```
**輸出：**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-S3BucketInventoryConfiguration (DeleteBucketInventoryConfiguration)" on target "amzn-s3-demo-bucket".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [DeleteBucketInventoryConfiguration](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# `DeleteBucketLifecycle` 搭配 AWS SDK 或 CLI 使用
下列程式碼範例示範如何使用 `DeleteBucketLifecycle`。
------
#### [ .NET ]
**適用於 .NET 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/S3#code-examples)中設定和執行。
```
///
/// This method removes the Lifecycle configuration from the named
/// S3 bucket.
///
/// The S3 client object used to call
/// the RemoveLifecycleConfigAsync method.
/// A string representing the name of the
/// S3 bucket from which the configuration will be removed.
public static async Task RemoveLifecycleConfigAsync(IAmazonS3 client, string bucketName)
{
var request = new DeleteLifecycleConfigurationRequest()
{
BucketName = bucketName,
};
await client.DeleteLifecycleConfigurationAsync(request);
}
```
+ 如需 API 詳細資訊，請參閱《適用於 .NET 的 AWS SDK API 參考》**中的 [DeleteBucketLifecycle](https://docs.aws.amazon.com/goto/DotNetSDKV3/s3-2006-03-01/DeleteBucketLifecycle)。
------
#### [ CLI ]
**AWS CLI**
下列命令會從名為 `amzn-s3-demo-bucket` 的儲存貯體中刪除生命週期組態：
```
aws s3api delete-bucket-lifecycle --bucket amzn-s3-demo-bucket
```
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DeleteBucketLifecycle](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3api/delete-bucket-lifecycle.html)。
------
#### [ Python ]
**適用於 Python 的 SDK (Boto3)**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/s3/s3_basics#code-examples)中設定和執行。
```
class BucketWrapper:
"""Encapsulates S3 bucket actions."""
def __init__(self, bucket):
"""
:param bucket: A Boto3 Bucket resource. This is a high-level resource in Boto3
that wraps bucket actions in a class-like structure.
"""
self.bucket = bucket
self.name = bucket.name
def delete_lifecycle_configuration(self):
"""
Remove the lifecycle configuration from the specified bucket.
"""
try:
self.bucket.LifecycleConfiguration().delete()
logger.info(
"Deleted lifecycle configuration for bucket '%s'.", self.bucket.name
)
except ClientError:
logger.exception(
"Couldn't delete lifecycle configuration for bucket '%s'.",
self.bucket.name,
)
raise
```
+ 如需 API 詳細資訊，請參閱*《適用於 Python (Boto3) 的AWS SDK API 參考》*中的 [DeleteBucketLifecycle](https://docs.aws.amazon.com/goto/boto3/s3-2006-03-01/DeleteBucketLifecycle)。
------
#### [ SAP ABAP ]
**適用於 SAP ABAP 的開發套件**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/s3#code-examples)中設定和執行。
```
TRY.
lo_s3->deletebucketlifecycle(
iv_bucket = iv_bucket_name ).
MESSAGE 'Bucket lifecycle configuration deleted.' TYPE 'I'.
CATCH /aws1/cx_s3_nosuchbucket.
MESSAGE 'Bucket does not exist.' TYPE 'E'.
ENDTRY.
```
+ 如需 API 詳細資訊，請參閱《適用於 *AWS SAP ABAP 的 SDK API 參考*》中的 [DeleteBucketLifecycle](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)。
------
# 搭配使用 `DeleteBucketMetricsConfiguration` 與 CLI
下列程式碼範例示範如何使用 `DeleteBucketMetricsConfiguration`。
------
#### [ CLI ]
**AWS CLI**
**刪除儲存貯體的指標組態**
下列 `delete-bucket-metrics-configuration` 範例會移除指定儲存貯體和 ID 的指標組態。
```
aws s3api delete-bucket-metrics-configuration \
--bucket amzn-s3-demo-bucket \
--id 123
```
此命令不會產生輸出。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DeleteBucketMetricsConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3api/delete-bucket-metrics-configuration.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1： 命令會移除給定 S3 儲存貯體中名為 'testmetrics' 的指標篩選條件。**
```
Remove-S3BucketMetricsConfiguration -BucketName 'amzn-s3-demo-bucket' -MetricsId 'testmetrics'
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [DeleteBucketMetricsConfiguration](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1： 命令會移除給定 S3 儲存貯體中名為 'testmetrics' 的指標篩選條件。**
```
Remove-S3BucketMetricsConfiguration -BucketName 'amzn-s3-demo-bucket' -MetricsId 'testmetrics'
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [DeleteBucketMetricsConfiguration](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# `DeleteBucketPolicy` 搭配 AWS SDK 或 CLI 使用
下列程式碼範例示範如何使用 `DeleteBucketPolicy`。
------
#### [ C\$1\$1 ]
**適用於 C\$1\$1 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/s3#code-examples)中設定和執行。
```
bool AwsDoc::S3::deleteBucketPolicy(const Aws::String &bucketName,
const Aws::S3::S3ClientConfiguration &clientConfig) {
Aws::S3::S3Client client(clientConfig);
Aws::S3::Model::DeleteBucketPolicyRequest request;
request.SetBucket(bucketName);
Aws::S3::Model::DeleteBucketPolicyOutcome outcome = client.DeleteBucketPolicy(request);
if (!outcome.IsSuccess()) {
const Aws::S3::S3Error &err = outcome.GetError();
std::cerr << "Error: deleteBucketPolicy: " <<
err.GetExceptionName() << ": " << err.GetMessage() << std::endl;
} else {
std::cout << "Policy was deleted from the bucket." << std::endl;
}
return outcome.IsSuccess();
}
```
+ 如需 API 詳細資訊，請參閱*《適用於 C\$1\$1 的 AWS SDK API 參考》*中的 [DeleteBucketPolicy](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/DeleteBucketPolicy)。
------
#### [ CLI ]
**AWS CLI**
下列命令會從名為 `amzn-s3-demo-bucket` 的儲存貯體中刪除儲存貯體政策：
```
aws s3api delete-bucket-policy --bucket amzn-s3-demo-bucket
```
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DeleteBucketPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3api/delete-bucket-policy.html)。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/s3#code-examples)中設定和執行。
```
import software.amazon.awssdk.services.s3.model.S3Exception;
import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.s3.S3Client;
import software.amazon.awssdk.services.s3.model.DeleteBucketPolicyRequest;
/**
* Before running this Java V2 code example, set up your development
* environment, including your credentials.
*
* For more information, see the following documentation topic:
*
* https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/get-started.html
*/
public class DeleteBucketPolicy {
public static void main(String[] args) {
final String usage = """
Usage:
Where:
bucketName - The Amazon S3 bucket to delete the policy from (for example, bucket1).""";
if (args.length != 1) {
System.out.println(usage);
System.exit(1);
}
String bucketName = args[0];
System.out.format("Deleting policy from bucket: \"%s\"\n\n", bucketName);
Region region = Region.US_EAST_1;
S3Client s3 = S3Client.builder()
.region(region)
.build();
deleteS3BucketPolicy(s3, bucketName);
s3.close();
}
/**
* Deletes the S3 bucket policy for the specified bucket.
*
* @param s3 the {@link S3Client} instance to use for the operation
* @param bucketName the name of the S3 bucket for which the policy should be deleted
*
* @throws S3Exception if there is an error deleting the bucket policy
*/
public static void deleteS3BucketPolicy(S3Client s3, String bucketName) {
DeleteBucketPolicyRequest delReq = DeleteBucketPolicyRequest.builder()
.bucket(bucketName)
.build();
try {
s3.deleteBucketPolicy(delReq);
System.out.println("Done!");
} catch (S3Exception e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
}
}
```
+ 如需 API 詳細資訊，請參閱*《AWS SDK for Java 2.x API 參考》*中的 [DeleteBucketPolicy](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/DeleteBucketPolicy)。
------
#### [ JavaScript ]
**適用於 JavaScript (v3) 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/s3#code-examples)中設定和執行。
刪除儲存貯體政策。
```
import {
DeleteBucketPolicyCommand,
S3Client,
S3ServiceException,
} from "@aws-sdk/client-s3";
/**
* Remove the policy from an Amazon S3 bucket.
* @param {{ bucketName: string }}
*/
export const main = async ({ bucketName }) => {
const client = new S3Client({});
try {
await client.send(
new DeleteBucketPolicyCommand({
Bucket: bucketName,
}),
);
console.log(`Bucket policy deleted from "${bucketName}".`);
} catch (caught) {
if (
caught instanceof S3ServiceException &&
caught.name === "NoSuchBucket"
) {
console.error(
`Error from S3 while deleting policy from ${bucketName}. The bucket doesn't exist.`,
);
} else if (caught instanceof S3ServiceException) {
console.error(
`Error from S3 while deleting policy from ${bucketName}. ${caught.name}: ${caught.message}`,
);
} else {
throw caught;
}
}
};
```
+ 如需詳細資訊，請參閱《[適用於 JavaScript 的 AWS SDK 開發人員指南](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/s3-example-bucket-policies.html#s3-example-bucket-policies-delete-policy)》。
+ 如需 API 詳細資訊，請參閱*《適用於 JavaScript 的 AWS SDK API 參考》*中的 [DeleteBucketPolicy](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/s3/command/DeleteBucketPolicyCommand)。
------
#### [ Kotlin ]
**適用於 Kotlin 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/s3#code-examples)中設定和執行。
```
suspend fun deleteS3BucketPolicy(bucketName: String?) {
val request =
DeleteBucketPolicyRequest {
bucket = bucketName
}
S3Client.fromEnvironment { region = "us-east-1" }.use { s3 ->
s3.deleteBucketPolicy(request)
println("Done!")
}
}
```
+ 如需 API 詳細資訊，請參閱*《適用於 Kotlin 的AWS SDK API 參考》*中的 [DeleteBucketPolicy](https://sdk.amazonaws.com/kotlin/api/latest/index.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1： 命令會移除與給定 S3 儲存貯體相關聯的儲存貯體政策。**
```
Remove-S3BucketPolicy -BucketName 'amzn-s3-demo-bucket'
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [DeleteBucketPolicy](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1： 命令會移除與給定 S3 儲存貯體相關聯的儲存貯體政策。**
```
Remove-S3BucketPolicy -BucketName 'amzn-s3-demo-bucket'
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [DeleteBucketPolicy](https://docs.aws.amazon.com/powershell/v5/reference)。
------
#### [ Python ]
**適用於 Python 的 SDK (Boto3)**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/s3/s3_basics#code-examples)中設定和執行。
```
class BucketWrapper:
"""Encapsulates S3 bucket actions."""
def __init__(self, bucket):
"""
:param bucket: A Boto3 Bucket resource. This is a high-level resource in Boto3
that wraps bucket actions in a class-like structure.
"""
self.bucket = bucket
self.name = bucket.name
def delete_policy(self):
"""
Delete the security policy from the bucket.
"""
try:
self.bucket.Policy().delete()
logger.info("Deleted policy for bucket '%s'.", self.bucket.name)
except ClientError:
logger.exception(
"Couldn't delete policy for bucket '%s'.", self.bucket.name
)
raise
```
+ 如需 API 詳細資訊，請參閱*《適用於 Python (Boto3) 的AWS SDK API 參考》*中的 [DeleteBucketPolicy](https://docs.aws.amazon.com/goto/boto3/s3-2006-03-01/DeleteBucketPolicy)。
------
#### [ Ruby ]
**SDK for Ruby**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/ruby/example_code/s3#code-examples)中設定和執行。
```
# Wraps an Amazon S3 bucket policy.
class BucketPolicyWrapper
attr_reader :bucket_policy
# @param bucket_policy [Aws::S3::BucketPolicy] A bucket policy object configured with an existing bucket.
def initialize(bucket_policy)
@bucket_policy = bucket_policy
end
def delete_policy
@bucket_policy.delete
true
rescue Aws::Errors::ServiceError => e
puts "Couldn't delete the policy from #{@bucket_policy.bucket.name}. Here's why: #{e.message}"
false
end
end
```
+ 如需 API 詳細資訊，請參閱*《適用於 Ruby 的 AWS SDK API 參考》*中的 [DeleteBucketPolicy](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/DeleteBucketPolicy)。
------
#### [ SAP ABAP ]
**適用於 SAP ABAP 的開發套件**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/s3#code-examples)中設定和執行。
```
TRY.
lo_s3->deletebucketpolicy(
iv_bucket = iv_bucket_name ).
MESSAGE 'Bucket policy deleted.' TYPE 'I'.
CATCH /aws1/cx_s3_nosuchbucket.
MESSAGE 'Bucket does not exist.' TYPE 'E'.
ENDTRY.
```
+ 如需 API 詳細資訊，請參閱《適用於 *AWS SAP ABAP 的 SDK API 參考*》中的 [DeleteBucketPolicy](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)。
------
# 搭配使用 `DeleteBucketReplication` 與 CLI
下列程式碼範例示範如何使用 `DeleteBucketReplication`。
------
#### [ CLI ]
**AWS CLI**
下列命令會從名為 `amzn-s3-demo-bucket` 的儲存貯體中刪除複寫組態：
```
aws s3api delete-bucket-replication --bucket amzn-s3-demo-bucket
```
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DeleteBucketReplication](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3api/delete-bucket-replication.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：刪除與名為 'amzn-s3-demo-bucket' 的儲存貯體相關聯的複寫組態。請注意，此操作需要 s3：DeleteReplicationConfiguration 動作的許可權。在繼續操作之前，系統會提示您確認 - 若要隱藏確認，請使用 -Force 切換變數。**
```
Remove-S3BucketReplication -BucketName amzn-s3-demo-bucket
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [DeleteBucketReplication](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：刪除與名為 'amzn-s3-demo-bucket' 的儲存貯體相關聯的複寫組態。請注意，此操作需要 s3：DeleteReplicationConfiguration 動作的許可權。在繼續操作之前，系統會提示您確認 - 若要隱藏確認，請使用 -Force 切換變數。**
```
Remove-S3BucketReplication -BucketName amzn-s3-demo-bucket
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [DeleteBucketReplication](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `DeleteBucketTagging` 與 CLI
下列程式碼範例示範如何使用 `DeleteBucketTagging`。
------
#### [ CLI ]
**AWS CLI**
下列命令會從名為 `amzn-s3-demo-bucket` 的儲存貯體中刪除標記組態：
```
aws s3api delete-bucket-tagging --bucket amzn-s3-demo-bucket
```
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DeleteBucketTagging](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3api/delete-bucket-tagging.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此命令會移除與給定 S3 儲存貯體相關聯的所有標籤。**
```
Remove-S3BucketTagging -BucketName 'amzn-s3-demo-bucket'
```
**輸出：**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-S3BucketTagging (DeleteBucketTagging)" on target "amzn-s3-demo-bucket".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [DeleteBucketTagging](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此命令會移除與給定 S3 儲存貯體相關聯的所有標籤。**
```
Remove-S3BucketTagging -BucketName 'amzn-s3-demo-bucket'
```
**輸出：**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-S3BucketTagging (DeleteBucketTagging)" on target "amzn-s3-demo-bucket".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [DeleteBucketTagging](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# `DeleteBucketWebsite` 搭配 AWS SDK 或 CLI 使用
下列程式碼範例示範如何使用 `DeleteBucketWebsite`。
------
#### [ C\$1\$1 ]
**適用於 C\$1\$1 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/s3#code-examples)中設定和執行。
```
bool AwsDoc::S3::deleteBucketWebsite(const Aws::String &bucketName,
const Aws::S3::S3ClientConfiguration &clientConfig) {
Aws::S3::S3Client client(clientConfig);
Aws::S3::Model::DeleteBucketWebsiteRequest request;
request.SetBucket(bucketName);
Aws::S3::Model::DeleteBucketWebsiteOutcome outcome =
client.DeleteBucketWebsite(request);
if (!outcome.IsSuccess()) {
auto err = outcome.GetError();
std::cerr << "Error: deleteBucketWebsite: " <<
err.GetExceptionName() << ": " << err.GetMessage() << std::endl;
} else {
std::cout << "Website configuration was removed." << std::endl;
}
return outcome.IsSuccess();
}
```
+ 如需 API 詳細資訊，請參閱*《適用於 C\$1\$1 的 AWS SDK API 參考》*中的 [DeleteBucketWebsite](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/DeleteBucketWebsite)。
------
#### [ CLI ]
**AWS CLI**
下列命令會從名為 `amzn-s3-demo-bucket` 的儲存貯體中刪除網站組態：
```
aws s3api delete-bucket-website --bucket amzn-s3-demo-bucket
```
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DeleteBucketWebsite](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3api/delete-bucket-website.html)。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/s3#code-examples)中設定和執行。
```
import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.s3.S3Client;
import software.amazon.awssdk.services.s3.model.DeleteBucketWebsiteRequest;
import software.amazon.awssdk.services.s3.model.S3Exception;
/**
* Before running this Java V2 code example, set up your development
* environment, including your credentials.
*
* For more information, see the following documentation topic:
*
* https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/get-started.html
*/
public class DeleteWebsiteConfiguration {
public static void main(String[] args) {
final String usage = """
Usage:
Where:
bucketName - The Amazon S3 bucket to delete the website configuration from.
""";
if (args.length != 1) {
System.out.println(usage);
System.exit(1);
}
String bucketName = args[0];
System.out.format("Deleting website configuration for Amazon S3 bucket: %s\n", bucketName);
Region region = Region.US_EAST_1;
S3Client s3 = S3Client.builder()
.region(region)
.build();
deleteBucketWebsiteConfig(s3, bucketName);
System.out.println("Done!");
s3.close();
}
/**
* Deletes the website configuration for an Amazon S3 bucket.
*
* @param s3 The {@link S3Client} instance used to interact with Amazon S3.
* @param bucketName The name of the S3 bucket for which the website configuration should be deleted.
* @throws S3Exception If an error occurs while deleting the website configuration.
*/
public static void deleteBucketWebsiteConfig(S3Client s3, String bucketName) {
DeleteBucketWebsiteRequest delReq = DeleteBucketWebsiteRequest.builder()
.bucket(bucketName)
.build();
try {
s3.deleteBucketWebsite(delReq);
} catch (S3Exception e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.out.println("Failed to delete website configuration!");
System.exit(1);
}
}
}
```
+ 如需 API 詳細資訊，請參閱*《AWS SDK for Java 2.x API 參考》*中的 [DeleteBucketWebsite](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/DeleteBucketWebsite)。
------
#### [ JavaScript ]
**適用於 JavaScript (v3) 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/s3#code-examples)中設定和執行。
從儲存貯體刪除網站組態
```
import {
DeleteBucketWebsiteCommand,
S3Client,
S3ServiceException,
} from "@aws-sdk/client-s3";
/**
* Remove the website configuration for a bucket.
* @param {{ bucketName: string }}
*/
export const main = async ({ bucketName }) => {
const client = new S3Client({});
try {
await client.send(
new DeleteBucketWebsiteCommand({
Bucket: bucketName,
}),
);
// The response code will be successful for both removed configurations and
// configurations that did not exist in the first place.
console.log(
`The bucket "${bucketName}" is not longer configured as a website, or it never was.`,
);
} catch (caught) {
if (
caught instanceof S3ServiceException &&
caught.name === "NoSuchBucket"
) {
console.error(
`Error from S3 while removing website configuration from ${bucketName}. The bucket doesn't exist.`,
);
} else if (caught instanceof S3ServiceException) {
console.error(
`Error from S3 while removing website configuration from ${bucketName}. ${caught.name}: ${caught.message}`,
);
} else {
throw caught;
}
}
};
```
+ 如需詳細資訊，請參閱《[適用於 JavaScript 的 AWS SDK 開發人員指南](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/s3-example-static-web-host.html#s3-example-static-web-host-delete-website)》。
+ 如需 API 詳細資訊，請參閱*《適用於 JavaScript 的 AWS SDK API 參考》*中的 [DeleteBucketWebsite](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/s3/command/DeleteBucketWebsiteCommand)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此命令會停用給定 S3 儲存貯體的靜態網站託管屬性。**
```
Remove-S3BucketWebsite -BucketName 'amzn-s3-demo-bucket'
```
**輸出：**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-S3BucketWebsite (DeleteBucketWebsite)" on target "amzn-s3-demo-bucket".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [DeleteBucketWebsite](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此命令會停用給定 S3 儲存貯體的靜態網站託管屬性。**
```
Remove-S3BucketWebsite -BucketName 'amzn-s3-demo-bucket'
```
**輸出：**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-S3BucketWebsite (DeleteBucketWebsite)" on target "amzn-s3-demo-bucket".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [DeleteBucketWebsite](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# `DeleteObject` 搭配 AWS SDK 或 CLI 使用
下列程式碼範例示範如何使用 `DeleteObject`。
動作範例是大型程式的程式碼摘錄，必須在內容中執行。您可以在下列程式碼範例的內容中看到此動作：
+ [使用 Amazon S3 物件完整性](s3_example_s3_Scenario_ObjectIntegrity_section.md)
+ [使用版本化物件](s3_example_s3_Scenario_ObjectVersioningUsage_section.md)
------
#### [ .NET ]
**適用於 .NET 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/S3#code-examples)中設定和執行。
刪除未進行版本控制之 S3 儲存貯體中的物件。
```
using System;
using System.Threading.Tasks;
using Amazon.S3;
using Amazon.S3.Model;
///
/// This example shows how to delete an object from a non-versioned Amazon
/// Simple Storage Service (Amazon S3) bucket.
///
public class DeleteObject
{
///
/// The Main method initializes the necessary variables and then calls
/// the DeleteObjectNonVersionedBucketAsync method to delete the object
/// named by the keyName parameter.
///
public static async Task Main()
{
const string bucketName = "amzn-s3-demo-bucket";
const string keyName = "testfile.txt";
// If the Amazon S3 bucket is located in an AWS Region other than the
// Region of the default account, define the AWS Region for the
// Amazon S3 bucket in your call to the AmazonS3Client constructor.
// For example RegionEndpoint.USWest2.
IAmazonS3 client = new AmazonS3Client();
await DeleteObjectNonVersionedBucketAsync(client, bucketName, keyName);
}
///
/// The DeleteObjectNonVersionedBucketAsync takes care of deleting the
/// desired object from the named bucket.
///
/// An initialized Amazon S3 client used to delete
/// an object from an Amazon S3 bucket.
/// The name of the bucket from which the
/// object will be deleted.
/// The name of the object to delete.
public static async Task DeleteObjectNonVersionedBucketAsync(IAmazonS3 client, string bucketName, string keyName)
{
try
{
var deleteObjectRequest = new DeleteObjectRequest
{
BucketName = bucketName,
Key = keyName,
};
Console.WriteLine($"Deleting object: {keyName}");
await client.DeleteObjectAsync(deleteObjectRequest);
Console.WriteLine($"Object: {keyName} deleted from {bucketName}.");
}
catch (AmazonS3Exception ex)
{
Console.WriteLine($"Error encountered on server. Message:'{ex.Message}' when deleting an object.");
}
}
}
```
刪除已進行版本控制之 S3 儲存貯體中的物件。
```
using System;
using System.Threading.Tasks;
using Amazon.S3;
using Amazon.S3.Model;
///
/// This example creates an object in an Amazon Simple Storage Service
/// (Amazon S3) bucket and then deletes the object version that was
/// created.
///
public class DeleteObjectVersion
{
public static async Task Main()
{
string bucketName = "amzn-s3-demo-bucket";
string keyName = "verstioned-object.txt";
// If the AWS Region of the default user is different from the AWS
// Region of the Amazon S3 bucket, pass the AWS Region of the
// bucket region to the Amazon S3 client object's constructor.
// Define it like this:
// RegionEndpoint bucketRegion = RegionEndpoint.USWest2;
IAmazonS3 client = new AmazonS3Client();
await CreateAndDeleteObjectVersionAsync(client, bucketName, keyName);
}
///
/// This method creates and then deletes a versioned object.
///
/// The initialized Amazon S3 client object used to
/// create and delete the object.
/// The name of the Amazon S3 bucket where the
/// object will be created and deleted.
/// The key name of the object to create.
public static async Task CreateAndDeleteObjectVersionAsync(IAmazonS3 client, string bucketName, string keyName)
{
try
{
// Add a sample object.
string versionID = await PutAnObject(client, bucketName, keyName);
// Delete the object by specifying an object key and a version ID.
DeleteObjectRequest request = new DeleteObjectRequest()
{
BucketName = bucketName,
Key = keyName,
VersionId = versionID,
};
Console.WriteLine("Deleting an object");
await client.DeleteObjectAsync(request);
}
catch (AmazonS3Exception ex)
{
Console.WriteLine($"Error: {ex.Message}");
}
}
///
/// This method is used to create the temporary Amazon S3 object.
///
/// The initialized Amazon S3 object which will be used
/// to create the temporary Amazon S3 object.
/// The name of the Amazon S3 bucket where the object
/// will be created.
/// The name of the Amazon S3 object co create.
/// The Version ID of the created object.
public static async Task PutAnObject(IAmazonS3 client, string bucketName, string objectKey)
{
PutObjectRequest request = new PutObjectRequest()
{
BucketName = bucketName,
Key = objectKey,
ContentBody = "This is the content body!",
};
PutObjectResponse response = await client.PutObjectAsync(request);
return response.VersionId;
}
}
```
+ 如需 API 詳細資訊，請參閱*《適用於 .NET 的 AWS SDK API 參考》*中的 [DeleteObject](https://docs.aws.amazon.com/goto/DotNetSDKV3/s3-2006-03-01/DeleteObject)。
------
#### [ Bash ]
**AWS CLI 使用 Bash 指令碼**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/aws-cli/bash-linux/s3#code-examples)中設定和執行。
```
###############################################################################
# function errecho
#
# This function outputs everything sent to it to STDERR (standard error output).
###############################################################################
function errecho() {
printf "%s\n" "$*" 1>&2
}
###############################################################################
# function delete_item_in_bucket
#
# This function deletes the specified file from the specified bucket.
#
# Parameters:
# $1 - The name of the bucket.
# $2 - The key (file name) in the bucket to delete.
# Returns:
# 0 - If successful.
# 1 - If it fails.
###############################################################################
function delete_item_in_bucket() {
local bucket_name=$1
local key=$2
local response
response=$(aws s3api delete-object \
--bucket "$bucket_name" \
--key "$key")
# shellcheck disable=SC2181
if [[ $? -ne 0 ]]; then
errecho "ERROR: AWS reports s3api delete-object operation failed.\n$response"
return 1
fi
}
```
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DeleteObject](https://docs.aws.amazon.com/goto/aws-cli/s3-2006-03-01/DeleteObject)。
------
#### [ C\$1\$1 ]
**適用於 C\$1\$1 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/s3#code-examples)中設定和執行。
```
bool AwsDoc::S3::deleteObject(const Aws::String &objectKey,
const Aws::String &fromBucket,
const Aws::S3::S3ClientConfiguration &clientConfig) {
Aws::S3::S3Client client(clientConfig);
Aws::S3::Model::DeleteObjectRequest request;
request.WithKey(objectKey)
.WithBucket(fromBucket);
Aws::S3::Model::DeleteObjectOutcome outcome =
client.DeleteObject(request);
if (!outcome.IsSuccess()) {
auto err = outcome.GetError();
std::cerr << "Error: deleteObject: " <<
err.GetExceptionName() << ": " << err.GetMessage() << std::endl;
} else {
std::cout << "Successfully deleted the object." << std::endl;
}
return outcome.IsSuccess();
}
```
+ 如需 API 詳細資訊，請參閱*《適用於 C\$1\$1 的 AWS SDK API 參考》*中的 [DeleteObject](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/DeleteObject)。
------
#### [ CLI ]
**AWS CLI**
下列命令會將名為 `test.txt` 的物件從名為 `amzn-s3-demo-bucket` 的儲存貯體中刪除。
```
aws s3api delete-object --bucket amzn-s3-demo-bucket --key test.txt
```
如果已啟用儲存貯體版本控制，輸出將包含刪除標記的版本 ID：
```
{
"VersionId": "9_gKg5vG56F.TTEUdwkxGpJ3tNDlWlGq",
"DeleteMarker": true
}
```
如需刪除物件的詳細資訊，請參閱《Amazon S3 開發人員指南》**中的「刪除物件」。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DeleteObject](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3api/delete-object.html)。
------
#### [ Go ]
**SDK for Go V2**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/gov2/workflows/s3_object_lock#code-examples)中設定和執行。
```
import (
"bytes"
"context"
"errors"
"fmt"
"log"
"time"
"github.com/aws/aws-sdk-go-v2/aws"
"github.com/aws/aws-sdk-go-v2/feature/s3/manager"
"github.com/aws/aws-sdk-go-v2/service/s3"
"github.com/aws/aws-sdk-go-v2/service/s3/types"
"github.com/aws/smithy-go"
)
// S3Actions wraps S3 service actions.
type S3Actions struct {
S3Client *s3.Client
S3Manager *manager.Uploader
}
// DeleteObject deletes an object from a bucket.
func (actor S3Actions) DeleteObject(ctx context.Context, bucket string, key string, versionId string, bypassGovernance bool) (bool, error) {
deleted := false
input := &s3.DeleteObjectInput{
Bucket: aws.String(bucket),
Key: aws.String(key),
}
if versionId != "" {
input.VersionId = aws.String(versionId)
}
if bypassGovernance {
input.BypassGovernanceRetention = aws.Bool(true)
}
_, err := actor.S3Client.DeleteObject(ctx, input)
if err != nil {
var noKey *types.NoSuchKey
var apiErr *smithy.GenericAPIError
if errors.As(err, &noKey) {
log.Printf("Object %s does not exist in %s.\n", key, bucket)
err = noKey
} else if errors.As(err, &apiErr) {
switch apiErr.ErrorCode() {
case "AccessDenied":
log.Printf("Access denied: cannot delete object %s from %s.\n", key, bucket)
err = nil
case "InvalidArgument":
if bypassGovernance {
log.Printf("You cannot specify bypass governance on a bucket without lock enabled.")
err = nil
}
}
}
} else {
err = s3.NewObjectNotExistsWaiter(actor.S3Client).Wait(
ctx, &s3.HeadObjectInput{Bucket: aws.String(bucket), Key: aws.String(key)}, time.Minute)
if err != nil {
log.Printf("Failed attempt to wait for object %s in bucket %s to be deleted.\n", key, bucket)
} else {
deleted = true
}
}
return deleted, err
}
```
+ 如需 API 詳細資訊，請參閱*《適用於 Go 的 AWS SDK API 參考》*中的 [DeleteObject](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/s3#Client.DeleteObject)。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/s3#code-examples)中設定和執行。
```
/**
* Deletes an object from an S3 bucket asynchronously.
*
* @param bucketName the name of the S3 bucket
* @param key the key (file name) of the object to be deleted
* @return a {@link CompletableFuture} that completes when the object has been deleted
*/
public CompletableFuture deleteObjectFromBucketAsync(String bucketName, String key) {
DeleteObjectRequest deleteObjectRequest = DeleteObjectRequest.builder()
.bucket(bucketName)
.key(key)
.build();
CompletableFuture response = getAsyncClient().deleteObject(deleteObjectRequest);
response.whenComplete((deleteRes, ex) -> {
if (deleteRes != null) {
logger.info(key + " was deleted");
} else {
throw new RuntimeException("An S3 exception occurred during delete", ex);
}
});
return response.thenApply(r -> null);
}
```
+ 如需 API 詳細資訊，請參閱*《AWS SDK for Java 2.x API 參考》*中的 [DeleteObject](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/DeleteObject)。
------
#### [ JavaScript ]
**適用於 JavaScript (v3) 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/s3#code-examples)中設定和執行。
刪除物件。
```
import {
DeleteObjectCommand,
S3Client,
S3ServiceException,
waitUntilObjectNotExists,
} from "@aws-sdk/client-s3";
/**
* Delete one object from an Amazon S3 bucket.
* @param {{ bucketName: string, key: string }}
*/
export const main = async ({ bucketName, key }) => {
const client = new S3Client({});
try {
await client.send(
new DeleteObjectCommand({
Bucket: bucketName,
Key: key,
}),
);
await waitUntilObjectNotExists(
{ client },
{ Bucket: bucketName, Key: key },
);
// A successful delete, or a delete for a non-existent object, both return
// a 204 response code.
console.log(
`The object "${key}" from bucket "${bucketName}" was deleted, or it didn't exist.`,
);
} catch (caught) {
if (
caught instanceof S3ServiceException &&
caught.name === "NoSuchBucket"
) {
console.error(
`Error from S3 while deleting object from ${bucketName}. The bucket doesn't exist.`,
);
} else if (caught instanceof S3ServiceException) {
console.error(
`Error from S3 while deleting object from ${bucketName}. ${caught.name}: ${caught.message}`,
);
} else {
throw caught;
}
}
};
```
+ 如需 API 詳細資訊，請參閱*《適用於 JavaScript 的 AWS SDK API 參考》*中的 [DeleteObject](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/s3/command/DeleteObjectCommand)。
------
#### [ PHP ]
**適用於 PHP 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code/s3#code-examples)中設定和執行。
```
public function deleteObject(string $bucketName, string $fileName, array $args = [])
{
$parameters = array_merge(['Bucket' => $bucketName, 'Key' => $fileName], $args);
try {
$this->client->deleteObject($parameters);
if ($this->verbose) {
echo "Deleted the object named: $fileName from $bucketName.\n";
}
} catch (AwsException $exception) {
if ($this->verbose) {
echo "Failed to delete $fileName from $bucketName with error: {$exception->getMessage()}\n";
echo "Please fix error with object deletion before continuing.";
}
throw $exception;
}
}
```
+ 如需 API 詳細資訊，請參閱*《適用於 PHP 的 AWS SDK API 參考》*中的 [DeleteObject](https://docs.aws.amazon.com/goto/SdkForPHPV3/s3-2006-03-01/DeleteObject)。
------
#### [ Python ]
**適用於 Python 的 SDK (Boto3)**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/s3/s3_basics#code-examples)中設定和執行。
刪除物件。
```
class ObjectWrapper:
"""Encapsulates S3 object actions."""
def __init__(self, s3_object):
"""
:param s3_object: A Boto3 Object resource. This is a high-level resource in Boto3
that wraps object actions in a class-like structure.
"""
self.object = s3_object
self.key = self.object.key
def delete(self):
"""
Deletes the object.
"""
try:
self.object.delete()
self.object.wait_until_not_exists()
logger.info(
"Deleted object '%s' from bucket '%s'.",
self.object.key,
self.object.bucket_name,
)
except ClientError:
logger.exception(
"Couldn't delete object '%s' from bucket '%s'.",
self.object.key,
self.object.bucket_name,
)
raise
```
透過刪除較新的物件版本，將物件還原至先前的版本。
```
def rollback_object(bucket, object_key, version_id):
"""
Rolls back an object to an earlier version by deleting all versions that
occurred after the specified rollback version.
Usage is shown in the usage_demo_single_object function at the end of this module.
:param bucket: The bucket that holds the object to roll back.
:param object_key: The object to roll back.
:param version_id: The version ID to roll back to.
"""
# Versions must be sorted by last_modified date because delete markers are
# at the end of the list even when they are interspersed in time.
versions = sorted(
bucket.object_versions.filter(Prefix=object_key),
key=attrgetter("last_modified"),
reverse=True,
)
logger.debug(
"Got versions:\n%s",
"\n".join(
[
f"\t{version.version_id}, last modified {version.last_modified}"
for version in versions
]
),
)
if version_id in [ver.version_id for ver in versions]:
print(f"Rolling back to version {version_id}")
for version in versions:
if version.version_id != version_id:
version.delete()
print(f"Deleted version {version.version_id}")
else:
break
print(f"Active version is now {bucket.Object(object_key).version_id}")
else:
raise KeyError(
f"{version_id} was not found in the list of versions for " f"{object_key}."
)
```
透過刪除物件啟用的刪除標記，恢復被刪除的物件。
```
def revive_object(bucket, object_key):
"""
Revives a versioned object that was deleted by removing the object's active
delete marker.
A versioned object presents as deleted when its latest version is a delete marker.
By removing the delete marker, we make the previous version the latest version
and the object then presents as *not* deleted.
Usage is shown in the usage_demo_single_object function at the end of this module.
:param bucket: The bucket that contains the object.
:param object_key: The object to revive.
"""
# Get the latest version for the object.
response = s3.meta.client.list_object_versions(
Bucket=bucket.name, Prefix=object_key, MaxKeys=1
)
if "DeleteMarkers" in response:
latest_version = response["DeleteMarkers"][0]
if latest_version["IsLatest"]:
logger.info(
"Object %s was indeed deleted on %s. Let's revive it.",
object_key,
latest_version["LastModified"],
)
obj = bucket.Object(object_key)
obj.Version(latest_version["VersionId"]).delete()
logger.info(
"Revived %s, active version is now %s with body '%s'",
object_key,
obj.version_id,
obj.get()["Body"].read(),
)
else:
logger.warning(
"Delete marker is not the latest version for %s!", object_key
)
elif "Versions" in response:
logger.warning("Got an active version for %s, nothing to do.", object_key)
else:
logger.error("Couldn't get any version info for %s.", object_key)
```
建立 Lambda 處理常式從 S3 物件中移除刪除標記。此處理常式可有效清除版本化的儲存貯體中無關的刪除標記。
```
import logging
from urllib import parse
import boto3
from botocore.exceptions import ClientError
logger = logging.getLogger(__name__)
logger.setLevel("INFO")
s3 = boto3.client("s3")
def lambda_handler(event, context):
"""
Removes a delete marker from the specified versioned object.
:param event: The S3 batch event that contains the ID of the delete marker
to remove.
:param context: Context about the event.
:return: A result structure that Amazon S3 uses to interpret the result of the
operation. When the result code is TemporaryFailure, S3 retries the
operation.
"""
# Parse job parameters from Amazon S3 batch operations
invocation_id = event["invocationId"]
invocation_schema_version = event["invocationSchemaVersion"]
results = []
result_code = None
result_string = None
task = event["tasks"][0]
task_id = task["taskId"]
try:
obj_key = parse.unquote_plus(task["s3Key"], encoding="utf-8")
obj_version_id = task["s3VersionId"]
bucket_name = task["s3BucketArn"].split(":")[-1]
logger.info(
"Got task: remove delete marker %s from object %s.", obj_version_id, obj_key
)
try:
# If this call does not raise an error, the object version is not a delete
# marker and should not be deleted.
response = s3.head_object(
Bucket=bucket_name, Key=obj_key, VersionId=obj_version_id
)
result_code = "PermanentFailure"
result_string = (
f"Object {obj_key}, ID {obj_version_id} is not " f"a delete marker."
)
logger.debug(response)
logger.warning(result_string)
except ClientError as error:
delete_marker = error.response["ResponseMetadata"]["HTTPHeaders"].get(
"x-amz-delete-marker", "false"
)
if delete_marker == "true":
logger.info(
"Object %s, version %s is a delete marker.", obj_key, obj_version_id
)
try:
s3.delete_object(
Bucket=bucket_name, Key=obj_key, VersionId=obj_version_id
)
result_code = "Succeeded"
result_string = (
f"Successfully removed delete marker "
f"{obj_version_id} from object {obj_key}."
)
logger.info(result_string)
except ClientError as error:
# Mark request timeout as a temporary failure so it will be retried.
if error.response["Error"]["Code"] == "RequestTimeout":
result_code = "TemporaryFailure"
result_string = (
f"Attempt to remove delete marker from "
f"object {obj_key} timed out."
)
logger.info(result_string)
else:
raise
else:
raise ValueError(
f"The x-amz-delete-marker header is either not "
f"present or is not 'true'."
)
except Exception as error:
# Mark all other exceptions as permanent failures.
result_code = "PermanentFailure"
result_string = str(error)
logger.exception(error)
finally:
results.append(
{
"taskId": task_id,
"resultCode": result_code,
"resultString": result_string,
}
)
return {
"invocationSchemaVersion": invocation_schema_version,
"treatMissingKeysAs": "PermanentFailure",
"invocationId": invocation_id,
"results": results,
}
```
+ 如需 API 詳細資訊，請參閱*《適用於 Python (Boto3) 的AWS SDK API 參考》*中的 [DeleteObject](https://docs.aws.amazon.com/goto/boto3/s3-2006-03-01/DeleteObject)。
------
#### [ Rust ]
**適用於 Rust 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/rustv1/examples/s3#code-examples)中設定和執行。
```
/// Delete an object from a bucket.
pub async fn remove_object(
client: &aws_sdk_s3::Client,
bucket: &str,
key: &str,
) -> Result<(), S3ExampleError> {
client
.delete_object()
.bucket(bucket)
.key(key)
.send()
.await?;
// There are no modeled errors to handle when deleting an object.
Ok(())
}
```
+ 如需 API 詳細資訊，請參閱*《適用於 Rust 的AWS SDK API 參考》*中的 [DeleteObject](https://docs.rs/aws-sdk-s3/latest/aws_sdk_s3/client/struct.Client.html#method.delete_object)。
------
#### [ SAP ABAP ]
**適用於 SAP ABAP 的開發套件**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/s3#code-examples)中設定和執行。
```
TRY.
lo_s3->deleteobject(
iv_bucket = iv_bucket_name
iv_key = iv_object_key ).
MESSAGE 'Object deleted from S3 bucket.' TYPE 'I'.
CATCH /aws1/cx_s3_nosuchbucket.
MESSAGE 'Bucket does not exist.' TYPE 'E'.
ENDTRY.
```
+ 如需 API 詳細資訊，請參閱《適用於 SAP ABAP 的AWS SDK API 參考》**中的 [DeleteObject](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)。
------
#### [ Swift ]
**適用於 Swift 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/swift/example_code/s3/basics#code-examples)中設定和執行。
```
import AWSS3
public func deleteFile(bucket: String, key: String) async throws {
let input = DeleteObjectInput(
bucket: bucket,
key: key
)
do {
_ = try await client.deleteObject(input: input)
}
catch {
print("ERROR: ", dump(error, name: "Deleting a file."))
throw error
}
}
```
+ 如需 API 詳細資訊，請參閱*《適用於 Swift 的AWS SDK API 參考》*中的 [DeleteObject](https://sdk.amazonaws.com/swift/api/awss3/latest/documentation/awss3/s3client/deleteobject(input:))。
------
# 搭配使用 `DeleteObjectTagging` 與 CLI
下列程式碼範例示範如何使用 `DeleteObjectTagging`。
------
#### [ CLI ]
**AWS CLI**
**刪除物件的標籤集**
下列 `delete-object-tagging` 範例會從物件 `doc1.rtf` 刪除具有指定索引鍵的標籤。
```
aws s3api delete-object-tagging \
--bucket amzn-s3-demo-bucket \
--key doc1.rtf
```
此命令不會產生輸出。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DeleteObjectTagging](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3api/delete-object-tagging.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此命令會移除與給定 S3 儲存貯體中具索引鍵 'testfile.txt' 之物件相關聯的所有標籤。**
```
Remove-S3ObjectTagSet -Key 'testfile.txt' -BucketName 'amzn-s3-demo-bucket' -Select '^Key'
```
**輸出：**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-S3ObjectTagSet (DeleteObjectTagging)" on target "testfile.txt".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
testfile.txt
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [DeleteObjectTagging](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此命令會移除與給定 S3 儲存貯體中具索引鍵 'testfile.txt' 之物件相關聯的所有標籤。**
```
Remove-S3ObjectTagSet -Key 'testfile.txt' -BucketName 'amzn-s3-demo-bucket' -Select '^Key'
```
**輸出：**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-S3ObjectTagSet (DeleteObjectTagging)" on target "testfile.txt".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
testfile.txt
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [DeleteObjectTagging](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# `DeleteObjects` 搭配 AWS SDK 或 CLI 使用
下列程式碼範例示範如何使用 `DeleteObjects`。
動作範例是大型程式的程式碼摘錄，必須在內容中執行。您可以在下列程式碼範例的內容中看到此動作：
+ [了解基本概念](s3_example_s3_Scenario_GettingStarted_section.md)
+ [刪除儲存貯體中的所有物件](s3_example_s3_Scenario_DeleteAllObjects_section.md)
+ [開始使用 S3](s3_example_s3_GettingStarted_section.md)
------
#### [ .NET ]
**適用於 .NET 的 SDK (v4)**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv4/S3#code-examples)中設定和執行。
```
///
/// Delete all of the objects stored in an existing Amazon S3 bucket.
///
/// The name of the bucket from which the
/// contents will be deleted.
/// A boolean value that represents the success or failure of
/// deleting all of the objects in the bucket.
public async Task DeleteBucketContentsAsync(string bucketName)
{
// Iterate over the contents of the bucket and delete all objects.
try
{
// Delete all objects in the bucket.
var deleteList = await ListBucketContentsAsync(bucketName, false);
if (deleteList != null && deleteList.Any())
{
await _amazonS3.DeleteObjectsAsync(new DeleteObjectsRequest()
{
BucketName = bucketName,
Objects = deleteList.Select(o => new KeyVersion { Key = o.Key }).ToList(),
});
}
return true;
}
catch (AmazonS3Exception ex)
{
Console.WriteLine($"Error deleting objects: {ex.Message}");
return false;
}
}
```
+ 如需 API 詳細資訊，請參閱*《適用於 .NET 的 AWS SDK API 參考》*中的 [DeleteObjects](https://docs.aws.amazon.com/goto/DotNetSDKV4/s3-2006-03-01/DeleteObjects)。
**適用於 .NET 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/S3#code-examples)中設定和執行。
刪除未進行版本控制之 S3 儲存貯體中的多個物件。
```
using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Amazon.S3;
using Amazon.S3.Model;
///
/// This example shows how to delete multiple objects from an Amazon Simple
/// Storage Service (Amazon S3) bucket.
///
public class DeleteMultipleObjects
{
///
/// The Main method initializes the Amazon S3 client and the name of
/// the bucket and then passes those values to MultiObjectDeleteAsync.
///
public static async Task Main()
{
const string bucketName = "amzn-s3-demo-bucket";
// If the Amazon S3 bucket from which you wish to delete objects is not
// located in the same AWS Region as the default user, define the
// AWS Region for the Amazon S3 bucket as a parameter to the client
// constructor.
IAmazonS3 s3Client = new AmazonS3Client();
await MultiObjectDeleteAsync(s3Client, bucketName);
}
///
/// This method uses the passed Amazon S3 client to first create and then
/// delete three files from the named bucket.
///
/// The initialized Amazon S3 client object used to call
/// Amazon S3 methods.
/// The name of the Amazon S3 bucket where objects
/// will be created and then deleted.
public static async Task MultiObjectDeleteAsync(IAmazonS3 client, string bucketName)
{
// Create three sample objects which we will then delete.
var keysAndVersions = await PutObjectsAsync(client, 3, bucketName);
// Now perform the multi-object delete, passing the key names and
// version IDs. Since we are working with a non-versioned bucket,
// the object keys collection includes null version IDs.
DeleteObjectsRequest multiObjectDeleteRequest = new DeleteObjectsRequest
{
BucketName = bucketName,
Objects = keysAndVersions,
};
// You can add a specific object key to the delete request using the
// AddKey method of the multiObjectDeleteRequest.
try
{
DeleteObjectsResponse response = await client.DeleteObjectsAsync(multiObjectDeleteRequest);
Console.WriteLine("Successfully deleted all the {0} items", response.DeletedObjects.Count);
}
catch (DeleteObjectsException e)
{
PrintDeletionErrorStatus(e);
}
}
///
/// Prints the list of errors raised by the call to DeleteObjectsAsync.
///
/// A collection of exceptions returned by the call to
/// DeleteObjectsAsync.
public static void PrintDeletionErrorStatus(DeleteObjectsException ex)
{
DeleteObjectsResponse errorResponse = ex.Response;
Console.WriteLine("x {0}", errorResponse.DeletedObjects.Count);
Console.WriteLine($"Successfully deleted {errorResponse.DeletedObjects.Count}.");
Console.WriteLine($"No. of objects failed to delete = {errorResponse.DeleteErrors.Count}");
Console.WriteLine("Printing error data...");
foreach (DeleteError deleteError in errorResponse.DeleteErrors)
{
Console.WriteLine($"Object Key: {deleteError.Key}\t{deleteError.Code}\t{deleteError.Message}");
}
}
///
/// This method creates simple text file objects that can be used in
/// the delete method.
///
/// The Amazon S3 client used to call PutObjectAsync.
/// The number of objects to create.
/// The name of the bucket where the objects
/// will be created.
/// A list of keys (object keys) and versions that the calling
/// method will use to delete the newly created files.
public static async Task> PutObjectsAsync(IAmazonS3 client, int number, string bucketName)
{
List keys = new List();
for (int i = 0; i < number; i++)
{
string key = "ExampleObject-" + new System.Random().Next();
PutObjectRequest request = new PutObjectRequest
{
BucketName = bucketName,
Key = key,
ContentBody = "This is the content body!",
};
PutObjectResponse response = await client.PutObjectAsync(request);
// For non-versioned bucket operations, we only need the
// object key.
KeyVersion keyVersion = new KeyVersion
{
Key = key,
};
keys.Add(keyVersion);
}
return keys;
}
}
```
刪除已進行版本控制之 S3 儲存貯體中的多個物件。
```
using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Amazon.S3;
using Amazon.S3.Model;
///
/// This example shows how to delete objects in a version-enabled Amazon
/// Simple StorageService (Amazon S3) bucket.
///
public class DeleteMultipleObjects
{
public static async Task Main()
{
string bucketName = "amzn-s3-demo-bucket";
// If the AWS Region for your Amazon S3 bucket is different from
// the AWS Region of the default user, define the AWS Region for
// the Amazon S3 bucket and pass it to the client constructor
// like this:
// RegionEndpoint bucketRegion = RegionEndpoint.USWest2;
IAmazonS3 s3Client;
s3Client = new AmazonS3Client();
await DeleteMultipleObjectsFromVersionedBucketAsync(s3Client, bucketName);
}
///
/// This method removes multiple versions and objects from a
/// version-enabled Amazon S3 bucket.
///
/// The initialized Amazon S3 client object used to call
/// DeleteObjectVersionsAsync, DeleteObjectsAsync, and
/// RemoveDeleteMarkersAsync.
/// The name of the bucket from which to delete
/// objects.
public static async Task DeleteMultipleObjectsFromVersionedBucketAsync(IAmazonS3 client, string bucketName)
{
// Delete objects (specifying object version in the request).
await DeleteObjectVersionsAsync(client, bucketName);
// Delete objects (without specifying object version in the request).
var deletedObjects = await DeleteObjectsAsync(client, bucketName);
// Additional exercise - remove the delete markers Amazon S3 returned from
// the preceding response. This results in the objects reappearing
// in the bucket (you can verify the appearance/disappearance of
// objects in the console).
await RemoveDeleteMarkersAsync(client, bucketName, deletedObjects);
}
///
/// Creates and then deletes non-versioned Amazon S3 objects and then deletes
/// them again. The method returns a list of the Amazon S3 objects deleted.
///
/// The initialized Amazon S3 client object used to call
/// PubObjectsAsync and NonVersionedDeleteAsync.
/// The name of the bucket where the objects
/// will be created and then deleted.
/// A list of DeletedObjects.
public static async Task> DeleteObjectsAsync(IAmazonS3 client, string bucketName)
{
// Upload the sample objects.
var keysAndVersions2 = await PutObjectsAsync(client, bucketName, 3);
// Delete objects using only keys. Amazon S3 creates a delete marker and
// returns its version ID in the response.
List deletedObjects = await NonVersionedDeleteAsync(client, bucketName, keysAndVersions2);
return deletedObjects;
}
///
/// This method creates several temporary objects and then deletes them.
///
/// The S3 client.
/// Name of the bucket.
/// Async task.
public static async Task DeleteObjectVersionsAsync(IAmazonS3 client, string bucketName)
{
// Upload the sample objects.
var keysAndVersions1 = await PutObjectsAsync(client, bucketName, 3);
// Delete the specific object versions.
await VersionedDeleteAsync(client, bucketName, keysAndVersions1);
}
///
/// Displays the list of information about deleted files to the console.
///
/// Error information from the delete process.
private static void DisplayDeletionErrors(DeleteObjectsException e)
{
var errorResponse = e.Response;
Console.WriteLine($"No. of objects successfully deleted = {errorResponse.DeletedObjects.Count}");
Console.WriteLine($"No. of objects failed to delete = {errorResponse.DeleteErrors.Count}");
Console.WriteLine("Printing error data...");
foreach (var deleteError in errorResponse.DeleteErrors)
{
Console.WriteLine($"Object Key: {deleteError.Key}\t{deleteError.Code}\t{deleteError.Message}");
}
}
///
/// Delete multiple objects from a version-enabled bucket.
///
/// The initialized Amazon S3 client object used to call
/// DeleteObjectVersionsAsync, DeleteObjectsAsync, and
/// RemoveDeleteMarkersAsync.
/// The name of the bucket from which to delete
/// objects.
/// A list of key names for the objects to delete.
private static async Task VersionedDeleteAsync(IAmazonS3 client, string bucketName, List keys)
{
var multiObjectDeleteRequest = new DeleteObjectsRequest
{
BucketName = bucketName,
Objects = keys, // This includes the object keys and specific version IDs.
};
try
{
Console.WriteLine("Executing VersionedDelete...");
DeleteObjectsResponse response = await client.DeleteObjectsAsync(multiObjectDeleteRequest);
Console.WriteLine($"Successfully deleted all the {response.DeletedObjects.Count} items");
}
catch (DeleteObjectsException ex)
{
DisplayDeletionErrors(ex);
}
}
///
/// Deletes multiple objects from a non-versioned Amazon S3 bucket.
///
/// The initialized Amazon S3 client object used to call
/// DeleteObjectVersionsAsync, DeleteObjectsAsync, and
/// RemoveDeleteMarkersAsync.
/// The name of the bucket from which to delete
/// objects.
/// A list of key names for the objects to delete.
/// A list of the deleted objects.
private static async Task> NonVersionedDeleteAsync(IAmazonS3 client, string bucketName, List keys)
{
// Create a request that includes only the object key names.
DeleteObjectsRequest multiObjectDeleteRequest = new DeleteObjectsRequest();
multiObjectDeleteRequest.BucketName = bucketName;
foreach (var key in keys)
{
multiObjectDeleteRequest.AddKey(key.Key);
}
// Execute DeleteObjectsAsync.
// The DeleteObjectsAsync method adds a delete marker for each
// object deleted. You can verify that the objects were removed
// using the Amazon S3 console.
DeleteObjectsResponse response;
try
{
Console.WriteLine("Executing NonVersionedDelete...");
response = await client.DeleteObjectsAsync(multiObjectDeleteRequest);
Console.WriteLine("Successfully deleted all the {0} items", response.DeletedObjects.Count);
}
catch (DeleteObjectsException ex)
{
DisplayDeletionErrors(ex);
throw; // Some deletions failed. Investigate before continuing.
}
// This response contains the DeletedObjects list which we use to delete the delete markers.
return response.DeletedObjects;
}
///
/// Deletes the markers left after deleting the temporary objects.
///
/// The initialized Amazon S3 client object used to call
/// DeleteObjectVersionsAsync, DeleteObjectsAsync, and
/// RemoveDeleteMarkersAsync.
/// The name of the bucket from which to delete
/// objects.
/// A list of the objects that were deleted.
private static async Task RemoveDeleteMarkersAsync(IAmazonS3 client, string bucketName, List deletedObjects)
{
var keyVersionList = new List();
foreach (var deletedObject in deletedObjects)
{
KeyVersion keyVersion = new KeyVersion
{
Key = deletedObject.Key,
VersionId = deletedObject.DeleteMarkerVersionId,
};
keyVersionList.Add(keyVersion);
}
// Create another request to delete the delete markers.
var multiObjectDeleteRequest = new DeleteObjectsRequest
{
BucketName = bucketName,
Objects = keyVersionList,
};
// Now, delete the delete marker to bring your objects back to the bucket.
try
{
Console.WriteLine("Removing the delete markers .....");
var deleteObjectResponse = await client.DeleteObjectsAsync(multiObjectDeleteRequest);
Console.WriteLine($"Successfully deleted the {deleteObjectResponse.DeletedObjects.Count} delete markers");
}
catch (DeleteObjectsException ex)
{
DisplayDeletionErrors(ex);
}
}
///
/// Create temporary Amazon S3 objects to show how object deletion wors in an
/// Amazon S3 bucket with versioning enabled.
///
/// The initialized Amazon S3 client object used to call
/// PutObjectAsync to create temporary objects for the example.
/// A string representing the name of the S3
/// bucket where we will create the temporary objects.
/// The number of temporary objects to create.
/// A list of the KeyVersion objects.
private static async Task> PutObjectsAsync(IAmazonS3 client, string bucketName, int number)
{
var keys = new List();
for (var i = 0; i < number; i++)
{
string key = "ObjectToDelete-" + new System.Random().Next();
PutObjectRequest request = new PutObjectRequest
{
BucketName = bucketName,
Key = key,
ContentBody = "This is the content body!",
};
var response = await client.PutObjectAsync(request);
KeyVersion keyVersion = new KeyVersion
{
Key = key,
VersionId = response.VersionId,
};
keys.Add(keyVersion);
}
return keys;
}
}
```
+ 如需 API 詳細資訊，請參閱*《適用於 .NET 的 AWS SDK API 參考》*中的 [DeleteObjects](https://docs.aws.amazon.com/goto/DotNetSDKV3/s3-2006-03-01/DeleteObjects)。
------
#### [ Bash ]
**AWS CLI 使用 Bash 指令碼**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/aws-cli/bash-linux/s3#code-examples)中設定和執行。
```
###############################################################################
# function errecho
#
# This function outputs everything sent to it to STDERR (standard error output).
###############################################################################
function errecho() {
printf "%s\n" "$*" 1>&2
}
###############################################################################
# function delete_items_in_bucket
#
# This function deletes the specified list of keys from the specified bucket.
#
# Parameters:
# $1 - The name of the bucket.
# $2 - A list of keys in the bucket to delete.
# Returns:
# 0 - If successful.
# 1 - If it fails.
###############################################################################
function delete_items_in_bucket() {
local bucket_name=$1
local keys=$2
local response
# Create the JSON for the items to delete.
local delete_items
delete_items="{\"Objects\":["
for key in $keys; do
delete_items="$delete_items{\"Key\": \"$key\"},"
done
delete_items=${delete_items%?} # Remove the final comma.
delete_items="$delete_items]}"
response=$(aws s3api delete-objects \
--bucket "$bucket_name" \
--delete "$delete_items")
# shellcheck disable=SC2181
if [[ $? -ne 0 ]]; then
errecho "ERROR: AWS reports s3api delete-object operation failed.\n$response"
return 1
fi
}
```
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DeleteObjects](https://docs.aws.amazon.com/goto/aws-cli/s3-2006-03-01/DeleteObjects)。
------
#### [ C\$1\$1 ]
**適用於 C\$1\$1 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/s3#code-examples)中設定和執行。
```
bool AwsDoc::S3::deleteObjects(const std::vector &objectKeys,
const Aws::String &fromBucket,
const Aws::S3::S3ClientConfiguration &clientConfig) {
Aws::S3::S3Client client(clientConfig);
Aws::S3::Model::DeleteObjectsRequest request;
Aws::S3::Model::Delete deleteObject;
for (const Aws::String &objectKey: objectKeys) {
deleteObject.AddObjects(Aws::S3::Model::ObjectIdentifier().WithKey(objectKey));
}
request.SetDelete(deleteObject);
request.SetBucket(fromBucket);
Aws::S3::Model::DeleteObjectsOutcome outcome =
client.DeleteObjects(request);
if (!outcome.IsSuccess()) {
auto err = outcome.GetError();
std::cerr << "Error deleting objects. " <<
err.GetExceptionName() << ": " << err.GetMessage() << std::endl;
} else {
std::cout << "Successfully deleted the objects.";
for (size_t i = 0; i < objectKeys.size(); ++i) {
std::cout << objectKeys[i];
if (i < objectKeys.size() - 1) {
std::cout << ", ";
}
}
std::cout << " from bucket " << fromBucket << "." << std::endl;
}
return outcome.IsSuccess();
}
```
+ 如需 API 詳細資訊，請參閱*《適用於 C\$1\$1 的 AWS SDK API 參考》*中的 [DeleteObjects](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/DeleteObjects)。
------
#### [ CLI ]
**AWS CLI**
下列命令會將從名為 `amzn-s3-demo-bucket` 的儲存貯體中刪除物件。
```
aws s3api delete-objects --bucket amzn-s3-demo-bucket --delete file://delete.json
```
`delete.json` 是目前目錄中的 JSON 文件，其會指定要刪除的物件：
```
{
"Objects": [
{
"Key": "test1.txt"
}
],
"Quiet": false
}
```
輸出：
```
{
"Deleted": [
{
"DeleteMarkerVersionId": "mYAT5Mc6F7aeUL8SS7FAAqUPO1koHwzU",
"Key": "test1.txt",
"DeleteMarker": true
}
]
}
```
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DeleteObjects](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3api/delete-objects.html)。
------
#### [ Go ]
**SDK for Go V2**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/gov2/workflows/s3_object_lock#code-examples)中設定和執行。
```
import (
"bytes"
"context"
"errors"
"fmt"
"log"
"time"
"github.com/aws/aws-sdk-go-v2/aws"
"github.com/aws/aws-sdk-go-v2/feature/s3/manager"
"github.com/aws/aws-sdk-go-v2/service/s3"
"github.com/aws/aws-sdk-go-v2/service/s3/types"
"github.com/aws/smithy-go"
)
// S3Actions wraps S3 service actions.
type S3Actions struct {
S3Client *s3.Client
S3Manager *manager.Uploader
}
// DeleteObjects deletes a list of objects from a bucket.
func (actor S3Actions) DeleteObjects(ctx context.Context, bucket string, objects []types.ObjectIdentifier, bypassGovernance bool) error {
if len(objects) == 0 {
return nil
}
input := s3.DeleteObjectsInput{
Bucket: aws.String(bucket),
Delete: &types.Delete{
Objects: objects,
Quiet: aws.Bool(true),
},
}
if bypassGovernance {
input.BypassGovernanceRetention = aws.Bool(true)
}
delOut, err := actor.S3Client.DeleteObjects(ctx, &input)
if err != nil || len(delOut.Errors) > 0 {
log.Printf("Error deleting objects from bucket %s.\n", bucket)
if err != nil {
var noBucket *types.NoSuchBucket
if errors.As(err, &noBucket) {
log.Printf("Bucket %s does not exist.\n", bucket)
err = noBucket
}
} else if len(delOut.Errors) > 0 {
for _, outErr := range delOut.Errors {
log.Printf("%s: %s\n", *outErr.Key, *outErr.Message)
}
err = fmt.Errorf("%s", *delOut.Errors[0].Message)
}
} else {
for _, delObjs := range delOut.Deleted {
err = s3.NewObjectNotExistsWaiter(actor.S3Client).Wait(
ctx, &s3.HeadObjectInput{Bucket: aws.String(bucket), Key: delObjs.Key}, time.Minute)
if err != nil {
log.Printf("Failed attempt to wait for object %s to be deleted.\n", *delObjs.Key)
} else {
log.Printf("Deleted %s.\n", *delObjs.Key)
}
}
}
return err
}
```
+ 如需 API 詳細資訊，請參閱*《適用於 Go 的 AWS SDK API 參考》*中的 [DeleteObjects](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/s3#Client.DeleteObjects)。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/s3#code-examples)中設定和執行。
```
import software.amazon.awssdk.core.sync.RequestBody;
import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.s3.S3Client;
import software.amazon.awssdk.services.s3.model.PutObjectRequest;
import software.amazon.awssdk.services.s3.model.ObjectIdentifier;
import software.amazon.awssdk.services.s3.model.Delete;
import software.amazon.awssdk.services.s3.model.DeleteObjectsRequest;
import software.amazon.awssdk.services.s3.model.S3Exception;
import java.util.ArrayList;
/**
* Before running this Java V2 code example, set up your development
* environment, including your credentials.
*
* For more information, see the following documentation topic:
*
* https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/get-started.html
*/
public class DeleteMultiObjects {
public static void main(String[] args) {
final String usage = """
Usage:
Where:
bucketName - the Amazon S3 bucket name.
""";
if (args.length != 1) {
System.out.println(usage);
System.exit(1);
}
String bucketName = args[0];
Region region = Region.US_EAST_1;
S3Client s3 = S3Client.builder()
.region(region)
.build();
deleteBucketObjects(s3, bucketName);
s3.close();
}
/**
* Deletes multiple objects from an Amazon S3 bucket.
*
* @param s3 An Amazon S3 client object.
* @param bucketName The name of the Amazon S3 bucket to delete objects from.
*/
public static void deleteBucketObjects(S3Client s3, String bucketName) {
// Upload three sample objects to the specfied Amazon S3 bucket.
ArrayList keys = new ArrayList<>();
PutObjectRequest putOb;
ObjectIdentifier objectId;
for (int i = 0; i < 3; i++) {
String keyName = "delete object example " + i;
objectId = ObjectIdentifier.builder()
.key(keyName)
.build();
putOb = PutObjectRequest.builder()
.bucket(bucketName)
.key(keyName)
.build();
s3.putObject(putOb, RequestBody.fromString(keyName));
keys.add(objectId);
}
System.out.println(keys.size() + " objects successfully created.");
// Delete multiple objects in one request.
Delete del = Delete.builder()
.objects(keys)
.build();
try {
DeleteObjectsRequest multiObjectDeleteRequest = DeleteObjectsRequest.builder()
.bucket(bucketName)
.delete(del)
.build();
s3.deleteObjects(multiObjectDeleteRequest);
System.out.println("Multiple objects are deleted!");
} catch (S3Exception e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
}
}
```
+ 如需 API 詳細資訊，請參閱*《AWS SDK for Java 2.x API 參考》*中的 [DeleteObjects](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/DeleteObjects)。
------
#### [ JavaScript ]
**適用於 JavaScript (v3) 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/s3#code-examples)中設定和執行。
刪除多個物件。
```
import {
DeleteObjectsCommand,
S3Client,
S3ServiceException,
waitUntilObjectNotExists,
} from "@aws-sdk/client-s3";
/**
* Delete multiple objects from an S3 bucket.
* @param {{ bucketName: string, keys: string[] }}
*/
export const main = async ({ bucketName, keys }) => {
const client = new S3Client({});
try {
const { Deleted } = await client.send(
new DeleteObjectsCommand({
Bucket: bucketName,
Delete: {
Objects: keys.map((k) => ({ Key: k })),
},
}),
);
for (const key in keys) {
await waitUntilObjectNotExists(
{ client },
{ Bucket: bucketName, Key: key },
);
}
console.log(
`Successfully deleted ${Deleted.length} objects from S3 bucket. Deleted objects:`,
);
console.log(Deleted.map((d) => ` • ${d.Key}`).join("\n"));
} catch (caught) {
if (
caught instanceof S3ServiceException &&
caught.name === "NoSuchBucket"
) {
console.error(
`Error from S3 while deleting objects from ${bucketName}. The bucket doesn't exist.`,
);
} else if (caught instanceof S3ServiceException) {
console.error(
`Error from S3 while deleting objects from ${bucketName}. ${caught.name}: ${caught.message}`,
);
} else {
throw caught;
}
}
};
```
+ 如需 API 詳細資訊，請參閱*《適用於 JavaScript 的 AWS SDK API 參考》*中的 [DeleteObjects](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/s3/command/DeleteObjectsCommand)。
------
#### [ Kotlin ]
**適用於 Kotlin 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/s3#code-examples)中設定和執行。
```
suspend fun deleteBucketObjects(
bucketName: String,
objectName: String,
) {
val objectId =
ObjectIdentifier {
key = objectName
}
val delOb =
Delete {
objects = listOf(objectId)
}
val request =
DeleteObjectsRequest {
bucket = bucketName
delete = delOb
}
S3Client.fromEnvironment { region = "us-east-1" }.use { s3 ->
s3.deleteObjects(request)
println("$objectName was deleted from $bucketName")
}
}
```
+ 如需 API 詳細資訊，請參閱*《適用於 Kotlin 的AWS SDK API 參考》*中的 [DeleteObjects](https://sdk.amazonaws.com/kotlin/api/latest/index.html)。
------
#### [ PHP ]
**適用於 PHP 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code/s3#code-examples)中設定和執行。
刪除金鑰清單中一整組物件。
```
$s3client = new Aws\S3\S3Client(['region' => 'us-west-2']);
try {
$objects = [];
foreach ($contents['Contents'] as $content) {
$objects[] = [
'Key' => $content['Key'],
];
}
$this->s3client->deleteObjects([
'Bucket' => $this->bucketName,
'Delete' => [
'Objects' => $objects,
],
]);
$check = $this->s3client->listObjectsV2([
'Bucket' => $this->bucketName,
]);
if (isset($check['Contents']) && count($check['Contents']) > 0) {
throw new Exception("Bucket wasn't empty.");
}
echo "Deleted all objects and folders from $this->bucketName.\n";
} catch (Exception $exception) {
echo "Failed to delete $fileName from $this->bucketName with error: " . $exception->getMessage();
exit("Please fix error with object deletion before continuing.");
}
```
+ 如需 API 詳細資訊，請參閱*《適用於 PHP 的 AWS SDK API 參考》*中的 [DeleteObjects](https://docs.aws.amazon.com/goto/SdkForPHPV3/s3-2006-03-01/DeleteObjects)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此命令會從儲存貯體 "test-files" 中移除物件"sample.txt"。在執行命令之前，系統會提示您確認；若要隱藏提示，請使用 -Force 切換變數。**
```
Remove-S3Object -BucketName amzn-s3-demo-bucket -Key sample.txt
```
**範例 2：此命令會移除儲存貯體 "test-files" 中物件"sample.txt" 的指定版本，假設儲存貯體已設定為啟用物件版本。**
```
Remove-S3Object -BucketName amzn-s3-demo-bucket -Key sample.txt -VersionId HLbxnx6V9omT6AQYVpks8mmFKQcejpqt
```
**範例 3：此命令會將儲存貯體 "test-files" 中的物件"sample1.txt"、"sample2.txt" 和 "sample3.txt" 移除，以成為單一批次操作。無論是刪除成功或錯誤狀態，服務回應都會列出處理的所有索引鍵。若要僅取得無法由服務處理之索引鍵的錯誤，請新增 -ReportErrorsOnly 參數 (也可以使用別名 -Quiet 指定此參數。**
```
Remove-S3Object -BucketName amzn-s3-demo-bucket -KeyCollection @( "sample1.txt", "sample2.txt", "sample3.txt" )
```
**範例 4：此範例搭配 -KeyCollection 參數使用內嵌表達式，以取得要刪除之物件的索引鍵。Get-S3Object 會傳回 Amazon.S3.Model.S3Object 執行個體的集合，每個執行個體都有一個字串類型的索引鍵成員來識別物件。**
```
Remove-S3Object -bucketname "amzn-s3-demo-bucket" -KeyCollection (Get-S3Object "test-files" -KeyPrefix "prefix/subprefix" | select -ExpandProperty Key)
```
**範例 5：此範例會取得儲存貯體中具有索引鍵字首「字首/子字首」的所有物件，並將其刪除。請注意，一次只會處理一個傳入物件。對於大型集合，請考慮將集合傳遞至 Cmdlet 的 -InputObject (別名 -S3ObjectCollection) 參數，透過一次服務呼叫來批次執行刪除作業。**
```
Get-S3Object -BucketName "amzn-s3-demo-bucket" -KeyPrefix "prefix/subprefix" | Remove-S3Object -Force
```
**範例 6：此範例會將代表刪除標記的 Amazon.S3.Model.S3ObjectVersion 執行個體集合傳輸至 Cmdlet，以進行刪除。請注意，一次只會處理一個傳入物件。對於大型集合，請考慮將集合傳遞至 Cmdlet 的 -InputObject (別名 -S3ObjectCollection) 參數，透過一次服務呼叫來批次執行刪除作業。**
```
(Get-S3Version -BucketName "amzn-s3-demo-bucket").Versions | Where {$_.IsDeleteMarker -eq "True"} | Remove-S3Object -Force
```
**範例 7：此指令碼示範如何透過建構要與 -KeyAndVersionCollection 參數搭配使用的物件陣列，執行一組物件的批次刪除 (在此案例中為刪除標記)。**
```
$keyVersions = @()
$markers = (Get-S3Version -BucketName $BucketName).Versions | Where {$_.IsDeleteMarker -eq "True"}
foreach ($marker in $markers) { $keyVersions += @{ Key = $marker.Key; VersionId = $marker.VersionId } }
Remove-S3Object -BucketName $BucketName -KeyAndVersionCollection $keyVersions -Force
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [DeleteObjects](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此命令會從儲存貯體 "test-files" 中移除物件"sample.txt"。在執行命令之前，系統會提示您確認；若要隱藏提示，請使用 -Force 切換變數。**
```
Remove-S3Object -BucketName amzn-s3-demo-bucket -Key sample.txt
```
**範例 2：此命令會移除儲存貯體 "test-files" 中物件"sample.txt" 的指定版本，假設儲存貯體已設定為啟用物件版本。**
```
Remove-S3Object -BucketName amzn-s3-demo-bucket -Key sample.txt -VersionId HLbxnx6V9omT6AQYVpks8mmFKQcejpqt
```
**範例 3：此命令會將儲存貯體 "test-files" 中的物件"sample1.txt"、"sample2.txt" 和 "sample3.txt" 移除，以成為單一批次操作。無論是刪除成功或錯誤狀態，服務回應都會列出處理的所有索引鍵。若要僅取得無法由服務處理之索引鍵的錯誤，請新增 -ReportErrorsOnly 參數 (也可以使用別名 -Quiet 指定此參數。**
```
Remove-S3Object -BucketName amzn-s3-demo-bucket -KeyCollection @( "sample1.txt", "sample2.txt", "sample3.txt" )
```
**範例 4：此範例搭配 -KeyCollection 參數使用內嵌表達式，以取得要刪除之物件的索引鍵。Get-S3Object 會傳回 Amazon.S3.Model.S3Object 執行個體的集合，每個執行個體都有一個字串類型的索引鍵成員來識別物件。**
```
Remove-S3Object -bucketname "amzn-s3-demo-bucket" -KeyCollection (Get-S3Object "test-files" -KeyPrefix "prefix/subprefix" | select -ExpandProperty Key)
```
**範例 5：此範例會取得儲存貯體中具有索引鍵字首「字首/子字首」的所有物件，並將其刪除。請注意，一次只會處理一個傳入物件。對於大型集合，請考慮將集合傳遞至 Cmdlet 的 -InputObject (別名 -S3ObjectCollection) 參數，透過一次服務呼叫來批次執行刪除作業。**
```
Get-S3Object -BucketName "amzn-s3-demo-bucket" -KeyPrefix "prefix/subprefix" | Remove-S3Object -Force
```
**範例 6：此範例會將代表刪除標記的 Amazon.S3.Model.S3ObjectVersion 執行個體集合傳輸至 Cmdlet，以進行刪除。請注意，一次只會處理一個傳入物件。對於大型集合，請考慮將集合傳遞至 Cmdlet 的 -InputObject (別名 -S3ObjectCollection) 參數，透過一次服務呼叫來批次執行刪除作業。**
```
(Get-S3Version -BucketName "amzn-s3-demo-bucket").Versions | Where {$_.IsDeleteMarker -eq "True"} | Remove-S3Object -Force
```
**範例 7：此指令碼示範如何透過建構要與 -KeyAndVersionCollection 參數搭配使用的物件陣列，執行一組物件的批次刪除 (在此案例中為刪除標記)**。
```
$keyVersions = @()
$markers = (Get-S3Version -BucketName $BucketName).Versions | Where {$_.IsDeleteMarker -eq "True"}
foreach ($marker in $markers) { $keyVersions += @{ Key = $marker.Key; VersionId = $marker.VersionId } }
Remove-S3Object -BucketName $BucketName -KeyAndVersionCollection $keyVersions -Force
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [DeleteObjects](https://docs.aws.amazon.com/powershell/v5/reference)。
------
#### [ Python ]
**適用於 Python 的 SDK (Boto3)**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/s3/s3_basics#code-examples)中設定和執行。
使用物件金鑰清單刪除一整組物件。
```
class ObjectWrapper:
"""Encapsulates S3 object actions."""
def __init__(self, s3_object):
"""
:param s3_object: A Boto3 Object resource. This is a high-level resource in Boto3
that wraps object actions in a class-like structure.
"""
self.object = s3_object
self.key = self.object.key
@staticmethod
def delete_objects(bucket, object_keys):
"""
Removes a list of objects from a bucket.
This operation is done as a batch in a single request.
:param bucket: The bucket that contains the objects. This is a Boto3 Bucket
resource.
:param object_keys: The list of keys that identify the objects to remove.
:return: The response that contains data about which objects were deleted
and any that could not be deleted.
"""
try:
response = bucket.delete_objects(
Delete={"Objects": [{"Key": key} for key in object_keys]}
)
if "Deleted" in response:
logger.info(
"Deleted objects '%s' from bucket '%s'.",
[del_obj["Key"] for del_obj in response["Deleted"]],
bucket.name,
)
if "Errors" in response:
logger.warning(
"Could not delete objects '%s' from bucket '%s'.",
[
f"{del_obj['Key']}: {del_obj['Code']}"
for del_obj in response["Errors"]
],
bucket.name,
)
except ClientError:
logger.exception("Couldn't delete any objects from bucket %s.", bucket.name)
raise
else:
return response
```
刪除儲存貯體中的所有物件。
```
class ObjectWrapper:
"""Encapsulates S3 object actions."""
def __init__(self, s3_object):
"""
:param s3_object: A Boto3 Object resource. This is a high-level resource in Boto3
that wraps object actions in a class-like structure.
"""
self.object = s3_object
self.key = self.object.key
@staticmethod
def empty_bucket(bucket):
"""
Remove all objects from a bucket.
:param bucket: The bucket to empty. This is a Boto3 Bucket resource.
"""
try:
bucket.objects.delete()
logger.info("Emptied bucket '%s'.", bucket.name)
except ClientError:
logger.exception("Couldn't empty bucket '%s'.", bucket.name)
raise
```
會透過刪除其所有版本，永久刪除已建立版本的物件。
```
def permanently_delete_object(bucket, object_key):
"""
Permanently deletes a versioned object by deleting all of its versions.
Usage is shown in the usage_demo_single_object function at the end of this module.
:param bucket: The bucket that contains the object.
:param object_key: The object to delete.
"""
try:
bucket.object_versions.filter(Prefix=object_key).delete()
logger.info("Permanently deleted all versions of object %s.", object_key)
except ClientError:
logger.exception("Couldn't delete all versions of %s.", object_key)
raise
```
+ 如需 API 詳細資訊，請參閱*《適用於 Python (Boto3) 的AWS SDK API 參考》*中的 [DeleteObjects](https://docs.aws.amazon.com/goto/boto3/s3-2006-03-01/DeleteObjects)。
------
#### [ Ruby ]
**SDK for Ruby**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/ruby/example_code/s3#code-examples)中設定和執行。
```
# Deletes the objects in an Amazon S3 bucket and deletes the bucket.
#
# @param bucket [Aws::S3::Bucket] The bucket to empty and delete.
def delete_bucket(bucket)
puts("\nDo you want to delete all of the objects as well as the bucket (y/n)? ")
answer = gets.chomp.downcase
if answer == 'y'
bucket.objects.batch_delete!
bucket.delete
puts("Emptied and deleted bucket #{bucket.name}.\n")
end
rescue Aws::Errors::ServiceError => e
puts("Couldn't empty and delete bucket #{bucket.name}.")
puts("\t#{e.code}: #{e.message}")
raise
end
```
+ 如需 API 詳細資訊，請參閱*《適用於 Ruby 的 AWS SDK API 參考》*中的 [DeleteObjects](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/DeleteObjects)。
------
#### [ Rust ]
**適用於 Rust 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/rustv1/examples/s3#code-examples)中設定和執行。
```
/// Delete the objects in a bucket.
pub async fn delete_objects(
client: &aws_sdk_s3::Client,
bucket_name: &str,
objects_to_delete: Vec,
) -> Result<(), S3ExampleError> {
// Push into a mut vector to use `?` early return errors while building object keys.
let mut delete_object_ids: Vec = vec![];
for obj in objects_to_delete {
let obj_id = aws_sdk_s3::types::ObjectIdentifier::builder()
.key(obj)
.build()
.map_err(|err| {
S3ExampleError::new(format!("Failed to build key for delete_object: {err:?}"))
})?;
delete_object_ids.push(obj_id);
}
client
.delete_objects()
.bucket(bucket_name)
.delete(
aws_sdk_s3::types::Delete::builder()
.set_objects(Some(delete_object_ids))
.build()
.map_err(|err| {
S3ExampleError::new(format!("Failed to build delete_object input {err:?}"))
})?,
)
.send()
.await?;
Ok(())
}
```
+ 如需 API 詳細資訊，請參閱*《適用於 Rust 的AWS SDK API 參考》*中的 [DeleteObjects](https://docs.rs/aws-sdk-s3/latest/aws_sdk_s3/client/struct.Client.html#method.delete_objects)。
------
#### [ SAP ABAP ]
**適用於 SAP ABAP 的開發套件**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/s3#code-examples)中設定和執行。
```
TRY.
oo_result = lo_s3->deleteobjects( " oo_result is returned for testing purposes. "
iv_bucket = iv_bucket_name
io_delete = NEW /aws1/cl_s3_delete( it_objects = it_object_keys ) ).
MESSAGE 'Objects deleted from S3 bucket.' TYPE 'I'.
CATCH /aws1/cx_s3_nosuchbucket.
MESSAGE 'Bucket does not exist.' TYPE 'E'.
ENDTRY.
```
+ 如需 API 詳細資訊，請參閱《適用於 *AWS SAP ABAP 的 SDK API 參考*》中的 [DeleteObjects](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)。
------
#### [ Swift ]
**適用於 Swift 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/swift/example_code/s3/DeleteObjects#code-examples)中設定和執行。
```
import AWSS3
public func deleteObjects(bucket: String, keys: [String]) async throws {
let input = DeleteObjectsInput(
bucket: bucket,
delete: S3ClientTypes.Delete(
objects: keys.map { S3ClientTypes.ObjectIdentifier(key: $0) },
quiet: true
)
)
do {
_ = try await client.deleteObjects(input: input)
} catch {
print("ERROR: deleteObjects:", dump(error))
throw error
}
}
```
+ 如需 API 詳細資訊，請參閱*《適用於 Swift 的AWS SDK API 參考》*中的 [DeleteObjects](https://sdk.amazonaws.com/swift/api/awss3/latest/documentation/awss3/s3client/deleteobjects(input:))。
------
# 搭配使用 `DeletePublicAccessBlock` 與 CLI
下列程式碼範例示範如何使用 `DeletePublicAccessBlock`。
------
#### [ CLI ]
**AWS CLI**
**刪除儲存貯體的封鎖公開存取組態**
下列 `delete-public-access-block` 範例會移除指定儲存貯體上的封鎖公開存取組態。
```
aws s3api delete-public-access-block \
--bucket amzn-s3-demo-bucket
```
此命令不會產生輸出。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DeletePublicAccessBlock](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3api/delete-public-access-block.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此命令會關閉給定儲存貯體的封鎖公開存取設定。**
```
Remove-S3PublicAccessBlock -BucketName 'amzn-s3-demo-bucket' -Force -Select '^BucketName'
```
**輸出：**
```
amzn-s3-demo-bucket
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [DeletePublicAccessBlock](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此命令會關閉給定儲存貯體的封鎖公開存取設定。**
```
Remove-S3PublicAccessBlock -BucketName 'amzn-s3-demo-bucket' -Force -Select '^BucketName'
```
**輸出：**
```
amzn-s3-demo-bucket
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [DeletePublicAccessBlock](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `GetBucketAccelerateConfiguration` 與 CLI
下列程式碼範例示範如何使用 `GetBucketAccelerateConfiguration`。
------
#### [ CLI ]
**AWS CLI**
**擷取儲存貯體的加速組態**
下列 `get-bucket-accelerate-configuration` 範例會擷取指定儲存貯體的加速組態。
```
aws s3api get-bucket-accelerate-configuration \
--bucket amzn-s3-demo-bucket
```
輸出：
```
{
"Status": "Enabled"
}
```
+ 如需 API 詳細資訊，請參閱《*AWS CLI 命令參考*》中的 [GetBucketAccelerateConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3api/get-bucket-accelerate-configuration.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：如果為指定的儲存貯體啟用傳輸加速設定，此命令會傳回已啟用的值。**
```
Get-S3BucketAccelerateConfiguration -BucketName 'amzn-s3-demo-bucket'
```
**輸出：**
```
Value
-----
Enabled
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [GetBucketAccelerateConfiguration](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：如果為指定的儲存貯體啟用傳輸加速設定，此命令會傳回已啟用的值。**
```
Get-S3BucketAccelerateConfiguration -BucketName 'amzn-s3-demo-bucket'
```
**輸出：**
```
Value
-----
Enabled
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [GetBucketAccelerateConfiguration](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# `GetBucketAcl` 搭配 AWS SDK 或 CLI 使用
下列程式碼範例示範如何使用 `GetBucketAcl`。
動作範例是大型程式的程式碼摘錄，必須在內容中執行。您可以在下列程式碼範例的內容中看到此動作：
+ [檢查儲存貯體是否存在](s3_example_s3_Scenario_DoesBucketExist_section.md)
+ [管理存取控制清單 (ACL)](s3_example_s3_Scenario_ManageACLs_section.md)
------
#### [ .NET ]
**適用於 .NET 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/S3#code-examples)中設定和執行。
```
///
/// Get the access control list (ACL) for the new bucket.
///
/// The initialized client object used to get the
/// access control list (ACL) of the bucket.
/// The name of the newly created bucket.
/// An S3AccessControlList.
public static async Task GetACLForBucketAsync(IAmazonS3 client, string newBucketName)
{
// Retrieve bucket ACL to show that the ACL was properly applied to
// the new bucket.
GetACLResponse getACLResponse = await client.GetACLAsync(new GetACLRequest
{
BucketName = newBucketName,
});
return getACLResponse.AccessControlList;
}
```
+ 如需 API 詳細資訊，請參閱*《適用於 .NET 的 AWS SDK API 參考》*中的 [GetBucketAcl](https://docs.aws.amazon.com/goto/DotNetSDKV3/s3-2006-03-01/GetBucketAcl)。
------
#### [ C\$1\$1 ]
**適用於 C\$1\$1 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/s3#code-examples)中設定和執行。
```
bool AwsDoc::S3::getBucketAcl(const Aws::String &bucketName,
const Aws::S3::S3ClientConfiguration &clientConfig) {
Aws::S3::S3Client s3Client(clientConfig);
Aws::S3::Model::GetBucketAclRequest request;
request.SetBucket(bucketName);
Aws::S3::Model::GetBucketAclOutcome outcome =
s3Client.GetBucketAcl(request);
if (!outcome.IsSuccess()) {
const Aws::S3::S3Error &err = outcome.GetError();
std::cerr << "Error: getBucketAcl: "
<< err.GetExceptionName() << ": " << err.GetMessage() << std::endl;
} else {
Aws::Vector grants =
outcome.GetResult().GetGrants();
for (auto it = grants.begin(); it != grants.end(); it++) {
Aws::S3::Model::Grant grant = *it;
Aws::S3::Model::Grantee grantee = grant.GetGrantee();
std::cout << "For bucket " << bucketName << ": "
<< std::endl << std::endl;
if (grantee.TypeHasBeenSet()) {
std::cout << "Type: "
<< getGranteeTypeString(grantee.GetType()) << std::endl;
}
if (grantee.DisplayNameHasBeenSet()) {
std::cout << "Display name: "
<< grantee.GetDisplayName() << std::endl;
}
if (grantee.EmailAddressHasBeenSet()) {
std::cout << "Email address: "
<< grantee.GetEmailAddress() << std::endl;
}
if (grantee.IDHasBeenSet()) {
std::cout << "ID: "
<< grantee.GetID() << std::endl;
}
if (grantee.URIHasBeenSet()) {
std::cout << "URI: "
<< grantee.GetURI() << std::endl;
}
std::cout << "Permission: " <<
getPermissionString(grant.GetPermission()) <<
std::endl << std::endl;
}
}
return outcome.IsSuccess();
}
//! Routine which converts a built-in type enumeration to a human-readable string.
/*!
\param type: Type enumeration.
\return String: Human-readable string.
*/
Aws::String getGranteeTypeString(const Aws::S3::Model::Type &type) {
switch (type) {
case Aws::S3::Model::Type::AmazonCustomerByEmail:
return "Email address of an AWS account";
case Aws::S3::Model::Type::CanonicalUser:
return "Canonical user ID of an AWS account";
case Aws::S3::Model::Type::Group:
return "Predefined Amazon S3 group";
case Aws::S3::Model::Type::NOT_SET:
return "Not set";
default:
return "Type unknown";
}
}
//! Routine which converts a built-in type enumeration to a human-readable string.
/*!
\param permission: Permission enumeration.
\return String: Human-readable string.
*/
Aws::String getPermissionString(const Aws::S3::Model::Permission &permission) {
switch (permission) {
case Aws::S3::Model::Permission::FULL_CONTROL:
return "Can list objects in this bucket, create/overwrite/delete "
"objects in this bucket, and read/write this "
"bucket's permissions";
case Aws::S3::Model::Permission::NOT_SET:
return "Permission not set";
case Aws::S3::Model::Permission::READ:
return "Can list objects in this bucket";
case Aws::S3::Model::Permission::READ_ACP:
return "Can read this bucket's permissions";
case Aws::S3::Model::Permission::WRITE:
return "Can create, overwrite, and delete objects in this bucket";
case Aws::S3::Model::Permission::WRITE_ACP:
return "Can write this bucket's permissions";
default:
return "Permission unknown";
}
return "Permission unknown";
}
```
+ 如需 API 詳細資訊，請參閱*《適用於 C\$1\$1 的 AWS SDK API 參考》*中的 [GetBucketAcl](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/GetBucketAcl)。
------
#### [ CLI ]
**AWS CLI**
下列命令會擷取名為 `amzn-s3-demo-bucket` 之儲存貯體的存取控制清單：
```
aws s3api get-bucket-acl --bucket amzn-s3-demo-bucket
```
輸出：
```
{
"Owner": {
"DisplayName": "my-username",
"ID": "7009a8971cd538e11f6b6606438875e7c86c5b672f46db45460ddcd087d36c32"
},
"Grants": [
{
"Grantee": {
"DisplayName": "my-username",
"ID": "7009a8971cd538e11f6b6606438875e7c86c5b672f46db45460ddcd087d36c32"
},
"Permission": "FULL_CONTROL"
}
]
}
```
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [GetBucketAcl](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3api/get-bucket-acl.html)。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/s3#code-examples)中設定和執行。
```
import software.amazon.awssdk.services.s3.model.S3Exception;
import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.s3.S3Client;
import software.amazon.awssdk.services.s3.model.GetObjectAclRequest;
import software.amazon.awssdk.services.s3.model.GetObjectAclResponse;
import software.amazon.awssdk.services.s3.model.Grant;
import java.util.List;
/**
* Before running this Java V2 code example, set up your development
* environment, including your credentials.
*
* For more information, see the following documentation topic:
*
* https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/get-started.html
*/
public class GetAcl {
public static void main(String[] args) {
final String usage = """
Usage:
Where:
bucketName - The Amazon S3 bucket to get the access control list (ACL) for.
objectKey - The object to get the ACL for.\s
""";
if (args.length != 2) {
System.out.println(usage);
System.exit(1);
}
String bucketName = args[0];
String objectKey = args[1];
System.out.println("Retrieving ACL for object: " + objectKey);
System.out.println("in bucket: " + bucketName);
Region region = Region.US_EAST_1;
S3Client s3 = S3Client.builder()
.region(region)
.build();
getBucketACL(s3, objectKey, bucketName);
s3.close();
System.out.println("Done!");
}
/**
* Retrieves the Access Control List (ACL) for an object in an Amazon S3 bucket.
*
* @param s3 The S3Client object used to interact with the Amazon S3 service.
* @param objectKey The key of the object for which the ACL is to be retrieved.
* @param bucketName The name of the bucket containing the object.
* @return The ID of the grantee who has permission on the object, or an empty string if an error occurs.
*/
public static String getBucketACL(S3Client s3, String objectKey, String bucketName) {
try {
GetObjectAclRequest aclReq = GetObjectAclRequest.builder()
.bucket(bucketName)
.key(objectKey)
.build();
GetObjectAclResponse aclRes = s3.getObjectAcl(aclReq);
List grants = aclRes.grants();
String grantee = "";
for (Grant grant : grants) {
System.out.format(" %s: %s\n", grant.grantee().id(), grant.permission());
grantee = grant.grantee().id();
}
return grantee;
} catch (S3Exception e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
return "";
}
}
```
+ 如需 API 詳細資訊，請參閱*《AWS SDK for Java 2.x API 參考》*中的 [GetBucketAcl](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/GetBucketAcl)。
------
#### [ JavaScript ]
**適用於 JavaScript (v3) 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/s3#code-examples)中設定和執行。
取得 ACL 許可。
```
import {
GetBucketAclCommand,
S3Client,
S3ServiceException,
} from "@aws-sdk/client-s3";
/**
* Retrieves the Access Control List (ACL) for an S3 bucket.
* @param {{ bucketName: string }}
*/
export const main = async ({ bucketName }) => {
const client = new S3Client({});
try {
const response = await client.send(
new GetBucketAclCommand({
Bucket: bucketName,
}),
);
console.log(`ACL for bucket "${bucketName}":`);
console.log(JSON.stringify(response, null, 2));
} catch (caught) {
if (
caught instanceof S3ServiceException &&
caught.name === "NoSuchBucket"
) {
console.error(
`Error from S3 while getting ACL for ${bucketName}. The bucket doesn't exist.`,
);
} else if (caught instanceof S3ServiceException) {
console.error(
`Error from S3 while getting ACL for ${bucketName}. ${caught.name}: ${caught.message}`,
);
} else {
throw caught;
}
}
};
```
+ 如需詳細資訊，請參閱《[適用於 JavaScript 的 AWS SDK 開發人員指南](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/s3-example-access-permissions.html#s3-example-access-permissions-get-acl)》。
+ 如需 API 詳細資訊，請參閱*《適用於 JavaScript 的 AWS SDK API 參考》*中的 [GetBucketAcl](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/s3/command/GetBucketAclCommand)。
------
#### [ PowerShell ]
**Tools for PowerShell V5**
**範例 1： 命令會取得 S3 物件之物件擁有者的詳細資訊。**
```
(Get-S3BucketACL -BucketName 'amzn-s3-demo-bucket' -Select *).Owner
```
**輸出：**
```
DisplayName Id
----------- --
testusername 9988776a6554433d22f1100112e334acb45566778899009e9887bd7f66c5f544
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [GetBucketAcl](https://docs.aws.amazon.com/powershell/v5/reference)。
------
#### [ Python ]
**適用於 Python 的 SDK (Boto3)**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/s3/s3_basics#code-examples)中設定和執行。
```
class BucketWrapper:
"""Encapsulates S3 bucket actions."""
def __init__(self, bucket):
"""
:param bucket: A Boto3 Bucket resource. This is a high-level resource in Boto3
that wraps bucket actions in a class-like structure.
"""
self.bucket = bucket
self.name = bucket.name
def get_acl(self):
"""
Get the ACL of the bucket.
:return: The ACL of the bucket.
"""
try:
acl = self.bucket.Acl()
logger.info(
"Got ACL for bucket %s. Owner is %s.", self.bucket.name, acl.owner
)
except ClientError:
logger.exception("Couldn't get ACL for bucket %s.", self.bucket.name)
raise
else:
return acl
```
+ 如需 API 詳細資訊，請參閱*《適用於 Python (Boto3) 的AWS SDK API 參考》*中的 [GetBucketAcl](https://docs.aws.amazon.com/goto/boto3/s3-2006-03-01/GetBucketAcl)。
------
#### [ SAP ABAP ]
**適用於 SAP ABAP 的開發套件**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/s3#code-examples)中設定和執行。
```
TRY.
oo_result = lo_s3->getbucketacl( " oo_result is returned for testing purposes. "
iv_bucket = iv_bucket_name ).
MESSAGE 'Retrieved bucket ACL.' TYPE 'I'.
CATCH /aws1/cx_s3_nosuchbucket.
MESSAGE 'Bucket does not exist.' TYPE 'E'.
ENDTRY.
```
+ 如需 API 詳細資訊，請參閱《適用於 *AWS SAP ABAP 的 SDK API 參考*》中的 [GetBucketAcl](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)。
------
# 搭配使用 `GetBucketAnalyticsConfiguration` 與 CLI
下列程式碼範例示範如何使用 `GetBucketAnalyticsConfiguration`。
------
#### [ CLI ]
**AWS CLI**
**擷取具有特定 ID 之儲存貯體的分析組態**
下列 `get-bucket-analytics-configuration` 範例顯示指定儲存貯體和 ID 的分析組態。
```
aws s3api get-bucket-analytics-configuration \
--bucket amzn-s3-demo-bucket \
--id 1
```
輸出：
```
{
"AnalyticsConfiguration": {
"StorageClassAnalysis": {},
"Id": "1"
}
}
```
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [GetBucketAnalyticsConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3api/get-bucket-analytics-configuration.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此命令會傳回指定 S3 儲存貯體中名為 'testfilter' 的分析篩選條件詳細資訊。**
```
Get-S3BucketAnalyticsConfiguration -BucketName 'amzn-s3-demo-bucket' -AnalyticsId 'testfilter'
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [GetBucketAnalyticsConfiguration](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此命令會傳回指定 S3 儲存貯體中名為 'testfilter' 的分析篩選條件詳細資訊。**
```
Get-S3BucketAnalyticsConfiguration -BucketName 'amzn-s3-demo-bucket' -AnalyticsId 'testfilter'
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [GetBucketAnalyticsConfiguration](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# `GetBucketCors` 搭配 AWS SDK 或 CLI 使用
下列程式碼範例示範如何使用 `GetBucketCors`。
------
#### [ .NET ]
**適用於 .NET 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/S3#code-examples)中設定和執行。
```
///
/// Retrieve the CORS configuration applied to the Amazon S3 bucket.
///
/// The initialized Amazon S3 client object used
/// to retrieve the CORS configuration.
/// The created CORS configuration object.
private static async Task RetrieveCORSConfigurationAsync(AmazonS3Client client)
{
GetCORSConfigurationRequest request = new GetCORSConfigurationRequest()
{
BucketName = BucketName,
};
var response = await client.GetCORSConfigurationAsync(request);
var configuration = response.Configuration;
PrintCORSRules(configuration);
return configuration;
}
```
+ 如需 API 詳細資訊，請參閱*《適用於 .NET 的 AWS SDK API 參考》*中的 [GetBucketCors](https://docs.aws.amazon.com/goto/DotNetSDKV3/s3-2006-03-01/GetBucketCors)。
------
#### [ CLI ]
**AWS CLI**
下列命令會擷取名為 `amzn-s3-demo-bucket` 之儲存貯體的跨來源資源共享組態：
```
aws s3api get-bucket-cors --bucket amzn-s3-demo-bucket
```
輸出：
```
{
"CORSRules": [
{
"AllowedHeaders": [
"*"
],
"ExposeHeaders": [
"x-amz-server-side-encryption"
],
"AllowedMethods": [
"PUT",
"POST",
"DELETE"
],
"MaxAgeSeconds": 3000,
"AllowedOrigins": [
"http://www.example.com"
]
},
{
"AllowedHeaders": [
"Authorization"
],
"MaxAgeSeconds": 3000,
"AllowedMethods": [
"GET"
],
"AllowedOrigins": [
"*"
]
}
]
}
```
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [GetBucketCors](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3api/get-bucket-cors.html)。
------
#### [ JavaScript ]
**適用於 JavaScript (v3) 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/s3#code-examples)中設定和執行。
取得儲存貯體的 CORS 政策。
```
import {
GetBucketCorsCommand,
S3Client,
S3ServiceException,
} from "@aws-sdk/client-s3";
/**
* Log the Cross-Origin Resource Sharing (CORS) configuration information
* set for the bucket.
* @param {{ bucketName: string }}
*/
export const main = async ({ bucketName }) => {
const client = new S3Client({});
const command = new GetBucketCorsCommand({
Bucket: bucketName,
});
try {
const { CORSRules } = await client.send(command);
console.log(JSON.stringify(CORSRules));
CORSRules.forEach((cr, i) => {
console.log(
`\nCORSRule ${i + 1}`,
`\n${"-".repeat(10)}`,
`\nAllowedHeaders: ${cr.AllowedHeaders}`,
`\nAllowedMethods: ${cr.AllowedMethods}`,
`\nAllowedOrigins: ${cr.AllowedOrigins}`,
`\nExposeHeaders: ${cr.ExposeHeaders}`,
`\nMaxAgeSeconds: ${cr.MaxAgeSeconds}`,
);
});
} catch (caught) {
if (
caught instanceof S3ServiceException &&
caught.name === "NoSuchBucket"
) {
console.error(
`Error from S3 while getting bucket CORS rules for ${bucketName}. The bucket doesn't exist.`,
);
} else if (caught instanceof S3ServiceException) {
console.error(
`Error from S3 while getting bucket CORS rules for ${bucketName}. ${caught.name}: ${caught.message}`,
);
} else {
throw caught;
}
}
};
```
+ 如需詳細資訊，請參閱《[適用於 JavaScript 的 AWS SDK 開發人員指南](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/s3-example-configuring-buckets.html#s3-example-configuring-buckets-get-cors)》。
+ 如需 API 詳細資訊，請參閱*《適用於 JavaScript 的 AWS SDK API 參考》*中的 [GetBucketCors](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/s3/command/GetBucketCorsCommand)。
------
#### [ Python ]
**適用於 Python 的 SDK (Boto3)**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/s3/s3_basics#code-examples)中設定和執行。
```
class BucketWrapper:
"""Encapsulates S3 bucket actions."""
def __init__(self, bucket):
"""
:param bucket: A Boto3 Bucket resource. This is a high-level resource in Boto3
that wraps bucket actions in a class-like structure.
"""
self.bucket = bucket
self.name = bucket.name
def get_cors(self):
"""
Get the CORS rules for the bucket.
:return The CORS rules for the specified bucket.
"""
try:
cors = self.bucket.Cors()
logger.info(
"Got CORS rules %s for bucket '%s'.", cors.cors_rules, self.bucket.name
)
except ClientError:
logger.exception(("Couldn't get CORS for bucket %s.", self.bucket.name))
raise
else:
return cors
```
+ 如需 API 詳細資訊，請參閱*《適用於 Python (Boto3) 的AWS SDK API 參考》*中的 [GetBucketCors](https://docs.aws.amazon.com/goto/boto3/s3-2006-03-01/GetBucketCors)。
------
#### [ Ruby ]
**SDK for Ruby**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/ruby/example_code/s3#code-examples)中設定和執行。
```
require 'aws-sdk-s3'
# Wraps Amazon S3 bucket CORS configuration.
class BucketCorsWrapper
attr_reader :bucket_cors
# @param bucket_cors [Aws::S3::BucketCors] A bucket CORS object configured with an existing bucket.
def initialize(bucket_cors)
@bucket_cors = bucket_cors
end
# Gets the CORS configuration of a bucket.
#
# @return [Aws::S3::Type::GetBucketCorsOutput, nil] The current CORS configuration for the bucket.
def cors
@bucket_cors.data
rescue Aws::Errors::ServiceError => e
puts "Couldn't get CORS configuration for #{@bucket_cors.bucket.name}. Here's why: #{e.message}"
nil
end
end
```
+ 如需 API 詳細資訊，請參閱*《適用於 Ruby 的 AWS SDK API 參考》*中的 [GetBucketCors](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/GetBucketCors)。
------
#### [ SAP ABAP ]
**適用於 SAP ABAP 的開發套件**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/s3#code-examples)中設定和執行。
```
TRY.
oo_result = lo_s3->getbucketcors( " oo_result is returned for testing purposes. "
iv_bucket = iv_bucket_name ).
MESSAGE 'Retrieved bucket CORS configuration.' TYPE 'I'.
CATCH /aws1/cx_s3_nosuchbucket.
MESSAGE 'Bucket does not exist.' TYPE 'E'.
ENDTRY.
```
+ 如需 API 詳細資訊，請參閱《適用於 *AWS SAP ABAP 的 SDK API 參考*》中的 [GetBucketCors](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)。
------
# `GetBucketEncryption` 搭配 AWS SDK 或 CLI 使用
下列程式碼範例示範如何使用 `GetBucketEncryption`。
------
#### [ .NET ]
**適用於 .NET 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/S3/PutBucketEncryption#code-examples)中設定和執行。
```
///
/// Get and print the encryption settings of a bucket.
///
/// Name of the bucket.
/// Async task.
public static async Task GetEncryptionSettings(string bucketName)
{
// Check and print the bucket encryption settings.
Console.WriteLine($"Getting encryption settings for bucket {bucketName}.");
try
{
var settings =
await _s3Client.GetBucketEncryptionAsync(
new GetBucketEncryptionRequest() { BucketName = bucketName });
foreach (var encryptionSettings in settings?.ServerSideEncryptionConfiguration?.ServerSideEncryptionRules!)
{
Console.WriteLine(
$"\tAlgorithm: {encryptionSettings.ServerSideEncryptionByDefault.ServerSideEncryptionAlgorithm}");
Console.WriteLine(
$"\tKey: {encryptionSettings.ServerSideEncryptionByDefault.ServerSideEncryptionKeyManagementServiceKeyId}");
}
}
catch (AmazonS3Exception ex)
{
Console.WriteLine(ex.ErrorCode == "InvalidBucketName"
? $"Bucket {bucketName} was not found."
: $"Unable to get bucket encryption for bucket {bucketName}, {ex.Message}");
}
}
```
+ 如需 API 詳細資訊，請參閱《適用於 .NET 的 AWS SDK API 參考》**中的 [GetBucketEncryption](https://docs.aws.amazon.com/goto/DotNetSDKV3/s3-2006-03-01/GetBucketEncryption)。
------
#### [ CLI ]
**AWS CLI**
**擷取儲存貯體的伺服器端加密組態**
下列 `get-bucket-encryption` 範例會擷取儲存貯體 `amzn-s3-demo-bucket` 的伺服器端加密組態。
```
aws s3api get-bucket-encryption \
--bucket amzn-s3-demo-bucket
```
輸出：
```
{
"ServerSideEncryptionConfiguration": {
"Rules": [
{
"ApplyServerSideEncryptionByDefault": {
"SSEAlgorithm": "AES256"
}
}
]
}
}
```
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [GetBucketEncryption](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3api/get-bucket-encryption.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此命令會傳回與指定儲存貯體相關聯的所有伺服器端加密規則。**
```
Get-S3BucketEncryption -BucketName 'amzn-s3-demo-bucket'
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [GetBucketEncryption](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此命令會傳回與指定儲存貯體相關聯的所有伺服器端加密規則。**
```
Get-S3BucketEncryption -BucketName 'amzn-s3-demo-bucket'
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [GetBucketEncryption](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `GetBucketInventoryConfiguration` 與 CLI
下列程式碼範例示範如何使用 `GetBucketInventoryConfiguration`。
------
#### [ CLI ]
**AWS CLI**
**擷取儲存貯體的庫存組態**
下列 `get-bucket-inventory-configuration` 範例會擷取 ID 為 `1` 之指定儲存貯體的庫存組態。
```
aws s3api get-bucket-inventory-configuration \
--bucket amzn-s3-demo-bucket \
--id 1
```
輸出：
```
{
"InventoryConfiguration": {
"IsEnabled": true,
"Destination": {
"S3BucketDestination": {
"Format": "ORC",
"Bucket": "arn:aws:s3:::amzn-s3-demo-bucket",
"AccountId": "123456789012"
}
},
"IncludedObjectVersions": "Current",
"Id": "1",
"Schedule": {
"Frequency": "Weekly"
}
}
}
```
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [GetBucketInventoryConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3api/get-bucket-inventory-configuration.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此命令會傳回給定 S3 儲存貯體之名為 'testinventory' 的庫存詳細資訊。**
```
Get-S3BucketInventoryConfiguration -BucketName 'amzn-s3-demo-bucket' -InventoryId 'testinventory'
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [GetBucketInventoryConfiguration](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此命令會傳回給定 S3 儲存貯體之名為 'testinventory' 的庫存詳細資訊。**
```
Get-S3BucketInventoryConfiguration -BucketName 'amzn-s3-demo-bucket' -InventoryId 'testinventory'
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [GetBucketInventoryConfiguration](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# `GetBucketLifecycleConfiguration` 搭配 AWS SDK 或 CLI 使用
下列程式碼範例示範如何使用 `GetBucketLifecycleConfiguration`。
------
#### [ .NET ]
**適用於 .NET 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/S3#code-examples)中設定和執行。
```
///
/// Returns a configuration object for the supplied bucket name.
///
/// The S3 client object used to call
/// the GetLifecycleConfigurationAsync method.
/// The name of the S3 bucket for which a
/// configuration will be created.
/// Returns a new LifecycleConfiguration object.
public static async Task RetrieveLifecycleConfigAsync(IAmazonS3 client, string bucketName)
{
var request = new GetLifecycleConfigurationRequest()
{
BucketName = bucketName,
};
var response = await client.GetLifecycleConfigurationAsync(request);
var configuration = response.Configuration;
return configuration;
}
```
+ 如需 API 詳細資訊，請參閱《適用於 .NET 的 AWS SDK API 參考》**中的 [GetBucketLifecycleConfiguration](https://docs.aws.amazon.com/goto/DotNetSDKV3/s3-2006-03-01/GetBucketLifecycleConfiguration)。
------
#### [ CLI ]
**AWS CLI**
下列命令會擷取名為 `amzn-s3-demo-bucket` 之儲存貯體的生命週期組態：
```
aws s3api get-bucket-lifecycle-configuration --bucket amzn-s3-demo-bucket
```
輸出：
```
{
"Rules": [
{
"ID": "Move rotated logs to Glacier",
"Prefix": "rotated/",
"Status": "Enabled",
"Transitions": [
{
"Date": "2015-11-10T00:00:00.000Z",
"StorageClass": "GLACIER"
}
]
},
{
"Status": "Enabled",
"Prefix": "",
"NoncurrentVersionTransitions": [
{
"NoncurrentDays": 0,
"StorageClass": "GLACIER"
}
],
"ID": "Move old versions to Glacier"
}
]
}
```
+ 如需 API 詳細資訊，請參閱《*AWS CLI API 參考*》中的 [GetBucketLifecycleConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3api/get-bucket-lifecycle-configuration.html)。
------
#### [ Python ]
**適用於 Python 的 SDK (Boto3)**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/s3/s3_basics#code-examples)中設定和執行。
```
class BucketWrapper:
"""Encapsulates S3 bucket actions."""
def __init__(self, bucket):
"""
:param bucket: A Boto3 Bucket resource. This is a high-level resource in Boto3
that wraps bucket actions in a class-like structure.
"""
self.bucket = bucket
self.name = bucket.name
def get_lifecycle_configuration(self):
"""
Get the lifecycle configuration of the bucket.
:return: The lifecycle rules of the specified bucket.
"""
try:
config = self.bucket.LifecycleConfiguration()
logger.info(
"Got lifecycle rules %s for bucket '%s'.",
config.rules,
self.bucket.name,
)
except:
logger.exception(
"Couldn't get lifecycle rules for bucket '%s'.", self.bucket.name
)
raise
else:
return config.rules
```
+ 如需 API 詳細資訊，請參閱*《適用於 Python (Boto3) 的AWS SDK API 參考》*中的 [GetBucketLifecycleConfiguration](https://docs.aws.amazon.com/goto/boto3/s3-2006-03-01/GetBucketLifecycleConfiguration)。
------
#### [ SAP ABAP ]
**適用於 SAP ABAP 的開發套件**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/s3#code-examples)中設定和執行。
```
TRY.
oo_result = lo_s3->getbucketlifecycleconf( " oo_result is returned for testing purposes. "
iv_bucket = iv_bucket_name ).
MESSAGE 'Retrieved bucket lifecycle configuration.' TYPE 'I'.
CATCH /aws1/cx_s3_nosuchbucket.
MESSAGE 'Bucket does not exist.' TYPE 'E'.
ENDTRY.
```
+ 如需 API 詳細資訊，請參閱《適用於 *AWS SAP ABAP 的 SDK API 參考*》中的 [GetBucketLifecycleConfiguration](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)。
------
# `GetBucketLocation` 搭配 AWS SDK 或 CLI 使用
下列程式碼範例示範如何使用 `GetBucketLocation`。
------
#### [ CLI ]
**AWS CLI**
如果存在限制，以下命令會擷取名為 `amzn-s3-demo-bucket` 之儲存貯體的位置限制條件：
```
aws s3api get-bucket-location --bucket amzn-s3-demo-bucket
```
輸出：
```
{
"LocationConstraint": "us-west-2"
}
```
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [GetBucketLocation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3api/get-bucket-location.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：如果存在限制，此命令會傳回儲存貯體 'amzn-s3-demo-bucket' 的位置限制。**
```
Get-S3BucketLocation -BucketName 'amzn-s3-demo-bucket'
```
**輸出：**
```
Value
-----
ap-south-1
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [GetBucketLocation](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：如果存在限制，此命令會傳回儲存貯體 'amzn-s3-demo-bucket' 的位置限制。**
```
Get-S3BucketLocation -BucketName 'amzn-s3-demo-bucket'
```
**輸出：**
```
Value
-----
ap-south-1
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [GetBucketLocation](https://docs.aws.amazon.com/powershell/v5/reference)。
------
#### [ Rust ]
**適用於 Rust 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/rustv1/examples/s3#code-examples)中設定和執行。
```
async fn show_buckets(
strict: bool,
client: &Client,
region: BucketLocationConstraint,
) -> Result<(), S3ExampleError> {
let mut buckets = client.list_buckets().into_paginator().send();
let mut num_buckets = 0;
let mut in_region = 0;
while let Some(Ok(output)) = buckets.next().await {
for bucket in output.buckets() {
num_buckets += 1;
if strict {
let r = client
.get_bucket_location()
.bucket(bucket.name().unwrap_or_default())
.send()
.await?;
if r.location_constraint() == Some(®ion) {
println!("{}", bucket.name().unwrap_or_default());
in_region += 1;
}
} else {
println!("{}", bucket.name().unwrap_or_default());
}
}
}
println!();
if strict {
println!(
"Found {} buckets in the {} region out of a total of {} buckets.",
in_region, region, num_buckets
);
} else {
println!("Found {} buckets in all regions.", num_buckets);
}
Ok(())
}
```
+ 如需 API 詳細資訊，請參閱*《適用於 Rust 的AWS SDK API 參考》*中的 [GetBucketLocation](https://docs.rs/aws-sdk-s3/latest/aws_sdk_s3/client/struct.Client.html#method.get_bucket_location)。
------
# 搭配使用 `GetBucketLogging` 與 CLI
下列程式碼範例示範如何使用 `GetBucketLogging`。
------
#### [ CLI ]
**AWS CLI**
**擷取儲存貯體的記錄狀態**
下列 `get-bucket-logging` 範例會擷取指定儲存貯體的記錄狀態。
```
aws s3api get-bucket-logging \
--bucket amzn-s3-demo-bucket
```
輸出：
```
{
"LoggingEnabled": {
"TargetPrefix": "",
"TargetBucket": "amzn-s3-demo-bucket-logs"
}
}
```
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [GetBucketLogging](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3api/get-bucket-logging.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此命令會傳回指定儲存貯體的記錄狀態。**
```
Get-S3BucketLogging -BucketName 'amzn-s3-demo-bucket'
```
**輸出：**
```
TargetBucketName Grants TargetPrefix
---------------- ------ ------------
testbucket1 {} testprefix
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [GetBucketLogging](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此命令會傳回指定儲存貯體的記錄狀態。**
```
Get-S3BucketLogging -BucketName 'amzn-s3-demo-bucket'
```
**輸出：**
```
TargetBucketName Grants TargetPrefix
---------------- ------ ------------
testbucket1 {} testprefix
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [GetBucketLogging](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `GetBucketMetricsConfiguration` 與 CLI
下列程式碼範例示範如何使用 `GetBucketMetricsConfiguration`。
------
#### [ CLI ]
**AWS CLI**
**擷取具有特定 ID 之儲存貯體的指標組態**
下列 `get-bucket-metrics-configuration` 範例顯示指定儲存貯體和 ID 的指標組態。
```
aws s3api get-bucket-metrics-configuration \
--bucket amzn-s3-demo-bucket \
--id 123
```
輸出：
```
{
"MetricsConfiguration": {
"Filter": {
"Prefix": "logs"
},
"Id": "123"
}
}
```
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [GetBucketMetricsConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3api/get-bucket-metrics-configuration.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此命令會傳回給定 S3 儲存貯體之名為 'testfilter' 的指標篩選條件詳細資訊。**
```
Get-S3BucketMetricsConfiguration -BucketName 'amzn-s3-demo-bucket' -MetricsId 'testfilter'
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [GetBucketMetricsConfiguration](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此命令會傳回給定 S3 儲存貯體之名為 'testfilter' 的指標篩選條件詳細資訊。**
```
Get-S3BucketMetricsConfiguration -BucketName 'amzn-s3-demo-bucket' -MetricsId 'testfilter'
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [GetBucketMetricsConfiguration](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `GetBucketNotification` 與 CLI
下列程式碼範例示範如何使用 `GetBucketNotification`。
------
#### [ CLI ]
**AWS CLI**
下列命令會擷取名為 `amzn-s3-demo-bucket` 之儲存貯體的通知組態：
```
aws s3api get-bucket-notification --bucket amzn-s3-demo-bucket
```
輸出：
```
{
"TopicConfiguration": {
"Topic": "arn:aws:sns:us-west-2:123456789012:my-notification-topic",
"Id": "YmQzMmEwM2EjZWVlI0NGItNzVtZjI1MC00ZjgyLWZDBiZWNl",
"Event": "s3:ObjectCreated:*",
"Events": [
"s3:ObjectCreated:*"
]
}
}
```
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [GetBucketNotification](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3api/get-bucket-notification.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例會擷取給定儲存貯體的通知組態**
```
Get-S3BucketNotification -BucketName amzn-s3-demo-bucket | select -ExpandProperty TopicConfigurations
```
**輸出：**
```
Id Topic
-- -----
mimo arn:aws:sns:eu-west-1:123456789012:topic-1
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [GetBucketNotification](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例會擷取給定儲存貯體的通知組態**
```
Get-S3BucketNotification -BucketName amzn-s3-demo-bucket | select -ExpandProperty TopicConfigurations
```
**輸出：**
```
Id Topic
-- -----
mimo arn:aws:sns:eu-west-1:123456789012:topic-1
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [GetBucketNotification](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# `GetBucketPolicy` 搭配 AWS SDK 或 CLI 使用
下列程式碼範例示範如何使用 `GetBucketPolicy`。
------
#### [ C\$1\$1 ]
**適用於 C\$1\$1 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/s3#code-examples)中設定和執行。
```
bool AwsDoc::S3::getBucketPolicy(const Aws::String &bucketName,
const Aws::S3::S3ClientConfiguration &clientConfig) {
Aws::S3::S3Client s3Client(clientConfig);
Aws::S3::Model::GetBucketPolicyRequest request;
request.SetBucket(bucketName);
Aws::S3::Model::GetBucketPolicyOutcome outcome =
s3Client.GetBucketPolicy(request);
if (!outcome.IsSuccess()) {
const Aws::S3::S3Error &err = outcome.GetError();
std::cerr << "Error: getBucketPolicy: "
<< err.GetExceptionName() << ": " << err.GetMessage() << std::endl;
} else {
Aws::StringStream policy_stream;
Aws::String line;
outcome.GetResult().GetPolicy() >> line;
policy_stream << line;
std::cout << "Retrieve the policy for bucket '" << bucketName << "':\n\n" <<
policy_stream.str() << std::endl;
}
return outcome.IsSuccess();
}
```
+ 如需 API 詳細資訊，請參閱*《適用於 C\$1\$1 的 AWS SDK API 參考》*中的 [GetBucketPolicy](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/GetBucketPolicy)。
------
#### [ CLI ]
**AWS CLI**
下列命令會擷取名為 `amzn-s3-demo-bucket` 之儲存貯體的儲存貯體政策：
```
aws s3api get-bucket-policy --bucket amzn-s3-demo-bucket
```
輸出：
```
{
"Policy": "{\"Version\":\"2008-10-17\",\"Statement\":[{\"Sid\":\"\",\"Effect\":\"Allow\",\"Principal\":\"*\",\"Action\":\"s3:GetObject\",\"Resource\":\"arn:aws:s3:::amzn-s3-demo-bucket/*\"},{\"Sid\":\"\",\"Effect\":\"Deny\",\"Principal\":\"*\",\"Action\":\"s3:GetObject\",\"Resource\":\"arn:aws:s3:::amzn-s3-demo-bucket/secret/*\"}]}"
}
```
取得並放置儲存貯體政策。下列範例示範如何下載 Amazon S3 儲存貯體政策、修改檔案，然後使用 `put-bucket-policy` 套用修改過的儲存貯體政策。若要將儲存貯體政策下載至檔案，您可以執行：
```
aws s3api get-bucket-policy --bucket amzn-s3-demo-bucket --query Policy --output text > policy.json
```
然後視需要修改 `policy.json` 檔案。最後，您可以執行下列動作，將此修改後的政策套用回 S3 儲存貯體：
`policy.json` 檔案 (視需要)。最後，您可以執行下列動作，將此修改後的政策套用回 S3 儲存貯體：
檔案 (視需要)。最後，您可以執行下列動作，將此修改後的政策套用回 S3 儲存貯體：
```
aws s3api put-bucket-policy --bucket amzn-s3-demo-bucket --policy file://policy.json
```
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [GetBucketPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3api/get-bucket-policy.html)。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/s3#code-examples)中設定和執行。
```
import software.amazon.awssdk.services.s3.model.S3Exception;
import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.s3.S3Client;
import software.amazon.awssdk.services.s3.model.GetBucketPolicyRequest;
import software.amazon.awssdk.services.s3.model.GetBucketPolicyResponse;
/**
* Before running this Java V2 code example, set up your development
* environment, including your credentials.
*
* For more information, see the following documentation topic:
*
* https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/get-started.html
*/
public class GetBucketPolicy {
public static void main(String[] args) {
final String usage = """
Usage:
Where:
bucketName - The Amazon S3 bucket to get the policy from.
""";
if (args.length != 1) {
System.out.println(usage);
System.exit(1);
}
String bucketName = args[0];
System.out.format("Getting policy for bucket: \"%s\"\n\n", bucketName);
Region region = Region.US_EAST_1;
S3Client s3 = S3Client.builder()
.region(region)
.build();
String polText = getPolicy(s3, bucketName);
System.out.println("Policy Text: " + polText);
s3.close();
}
/**
* Retrieves the policy for the specified Amazon S3 bucket.
*
* @param s3 the {@link S3Client} instance to use for making the request
* @param bucketName the name of the S3 bucket for which to retrieve the policy
* @return the policy text for the specified bucket, or an empty string if an error occurs
*/
public static String getPolicy(S3Client s3, String bucketName) {
String policyText;
System.out.format("Getting policy for bucket: \"%s\"\n\n", bucketName);
GetBucketPolicyRequest policyReq = GetBucketPolicyRequest.builder()
.bucket(bucketName)
.build();
try {
GetBucketPolicyResponse policyRes = s3.getBucketPolicy(policyReq);
policyText = policyRes.policy();
return policyText;
} catch (S3Exception e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
return "";
}
}
```
+ 如需 API 詳細資訊，請參閱*《AWS SDK for Java 2.x API 參考》*中的 [GetBucketPolicy](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/GetBucketPolicy)。
------
#### [ JavaScript ]
**適用於 JavaScript (v3) 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/s3#code-examples)中設定和執行。
取得儲存貯體政策。
```
import {
GetBucketPolicyCommand,
S3Client,
S3ServiceException,
} from "@aws-sdk/client-s3";
/**
* Logs the policy for a specified bucket.
* @param {{ bucketName: string }}
*/
export const main = async ({ bucketName }) => {
const client = new S3Client({});
try {
const { Policy } = await client.send(
new GetBucketPolicyCommand({
Bucket: bucketName,
}),
);
console.log(`Policy for "${bucketName}":\n${Policy}`);
} catch (caught) {
if (
caught instanceof S3ServiceException &&
caught.name === "NoSuchBucket"
) {
console.error(
`Error from S3 while getting policy from ${bucketName}. The bucket doesn't exist.`,
);
} else if (caught instanceof S3ServiceException) {
console.error(
`Error from S3 while getting policy from ${bucketName}. ${caught.name}: ${caught.message}`,
);
} else {
throw caught;
}
}
};
```
+ 如需詳細資訊，請參閱《[適用於 JavaScript 的 AWS SDK 開發人員指南](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/s3-example-bucket-policies.html#s3-example-bucket-policies-get-policy)》。
+ 如需 API 詳細資訊，請參閱*《適用於 JavaScript 的 AWS SDK API 參考》*中的 [GetBucketPolicy](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/s3/command/GetBucketPolicyCommand)。
------
#### [ Kotlin ]
**適用於 Kotlin 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/s3#code-examples)中設定和執行。
```
suspend fun getPolicy(bucketName: String): String? {
println("Getting policy for bucket $bucketName")
val request =
GetBucketPolicyRequest {
bucket = bucketName
}
S3Client.fromEnvironment { region = "us-east-1" }.use { s3 ->
val policyRes = s3.getBucketPolicy(request)
return policyRes.policy
}
}
```
+ 如需 API 詳細資訊，請參閱*《適用於 Kotlin 的AWS SDK API 參考》*中的 [GetBucketPolicy](https://sdk.amazonaws.com/kotlin/api/latest/index.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此命令會輸出與給定 S3 儲存貯體相關聯的儲存貯體政策。**
```
Get-S3BucketPolicy -BucketName 'amzn-s3-demo-bucket'
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [GetBucketPolicy](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此命令會輸出與給定 S3 儲存貯體相關聯的儲存貯體政策。**
```
Get-S3BucketPolicy -BucketName 'amzn-s3-demo-bucket'
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [GetBucketPolicy](https://docs.aws.amazon.com/powershell/v5/reference)。
------
#### [ Python ]
**適用於 Python 的 SDK (Boto3)**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/s3/s3_basics#code-examples)中設定和執行。
```
class BucketWrapper:
"""Encapsulates S3 bucket actions."""
def __init__(self, bucket):
"""
:param bucket: A Boto3 Bucket resource. This is a high-level resource in Boto3
that wraps bucket actions in a class-like structure.
"""
self.bucket = bucket
self.name = bucket.name
def get_policy(self):
"""
Get the security policy of the bucket.
:return: The security policy of the specified bucket, in JSON format.
"""
try:
policy = self.bucket.Policy()
logger.info(
"Got policy %s for bucket '%s'.", policy.policy, self.bucket.name
)
except ClientError:
logger.exception("Couldn't get policy for bucket '%s'.", self.bucket.name)
raise
else:
return json.loads(policy.policy)
```
+ 如需 API 詳細資訊，請參閱*《適用於 Python (Boto3) 的AWS SDK API 參考》*中的 [GetBucketPolicy](https://docs.aws.amazon.com/goto/boto3/s3-2006-03-01/GetBucketPolicy)。
------
#### [ Ruby ]
**SDK for Ruby**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/ruby/example_code/s3#code-examples)中設定和執行。
```
# Wraps an Amazon S3 bucket policy.
class BucketPolicyWrapper
attr_reader :bucket_policy
# @param bucket_policy [Aws::S3::BucketPolicy] A bucket policy object configured with an existing bucket.
def initialize(bucket_policy)
@bucket_policy = bucket_policy
end
# Gets the policy of a bucket.
#
# @return [Aws::S3::GetBucketPolicyOutput, nil] The current bucket policy.
def policy
policy = @bucket_policy.data.policy
policy.respond_to?(:read) ? policy.read : policy
rescue Aws::Errors::ServiceError => e
puts "Couldn't get the policy for #{@bucket_policy.bucket.name}. Here's why: #{e.message}"
nil
end
end
```
+ 如需 API 詳細資訊，請參閱*《適用於 Ruby 的 AWS SDK API 參考》*中的 [GetBucketPolicy](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/GetBucketPolicy)。
------
#### [ SAP ABAP ]
**適用於 SAP ABAP 的開發套件**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/s3#code-examples)中設定和執行。
```
TRY.
oo_result = lo_s3->getbucketpolicy( " oo_result is returned for testing purposes. "
iv_bucket = iv_bucket_name ).
DATA(lv_policy) = oo_result->get_policy( ).
MESSAGE 'Retrieved bucket policy.' TYPE 'I'.
CATCH /aws1/cx_s3_nosuchbucket.
MESSAGE 'Bucket does not exist.' TYPE 'E'.
ENDTRY.
```
+ 如需 API 詳細資訊，請參閱《適用於 *AWS SAP ABAP 的 SDK API 參考*》中的 [GetBucketPolicy](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)。
------
# 搭配使用 `GetBucketPolicyStatus` 與 CLI
下列程式碼範例示範如何使用 `GetBucketPolicyStatus`。
------
#### [ CLI ]
**AWS CLI**
**擷取儲存貯體的政策狀態以指出儲存貯體是否為公有**
下列 `get-bucket-policy-status` 範例會擷取儲存貯體 `amzn-s3-demo-bucket` 的政策狀態。
```
aws s3api get-bucket-policy-status \
--bucket amzn-s3-demo-bucket
```
輸出：
```
{
"PolicyStatus": {
"IsPublic": false
}
}
```
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [GetBucketPolicyStatus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3api/get-bucket-policy-status.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此命令會傳回給定 S3 儲存貯體的政策狀態，其指出儲存貯體是否為公有。**
```
Get-S3BucketPolicyStatus -BucketName 'amzn-s3-demo-bucket'
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [GetBucketPolicyStatus](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此命令會傳回給定 S3 儲存貯體的政策狀態，其指出儲存貯體是否為公有。**
```
Get-S3BucketPolicyStatus -BucketName 'amzn-s3-demo-bucket'
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [GetBucketPolicyStatus](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# `GetBucketReplication` 搭配 AWS SDK 或 CLI 使用
下列程式碼範例示範如何使用 `GetBucketReplication`。
------
#### [ CLI ]
**AWS CLI**
下列命令會擷取名為 `amzn-s3-demo-bucket` 之儲存貯體的複寫組態：
```
aws s3api get-bucket-replication --bucket amzn-s3-demo-bucket
```
輸出：
```
{
"ReplicationConfiguration": {
"Rules": [
{
"Status": "Enabled",
"Prefix": "",
"Destination": {
"Bucket": "arn:aws:s3:::amzn-s3-demo-bucket-backup",
"StorageClass": "STANDARD"
},
"ID": "ZmUwNzE4ZmQ4tMjVhOS00MTlkLOGI4NDkzZTIWJjNTUtYTA1"
}
],
"Role": "arn:aws:iam::123456789012:role/s3-replication-role"
}
}
```
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [GetBucketReplication](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3api/get-bucket-replication.html)。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/s3#code-examples)中設定和執行。
```
/**
* Retrieves the replication details for the specified S3 bucket.
*
* @param s3Client the S3 client used to interact with the S3 service
* @param sourceBucketName the name of the S3 bucket to retrieve the replication details for
*
* @throws S3Exception if there is an error retrieving the replication details
*/
public static void getReplicationDetails(S3Client s3Client, String sourceBucketName) {
GetBucketReplicationRequest getRequest = GetBucketReplicationRequest.builder()
.bucket(sourceBucketName)
.build();
try {
ReplicationConfiguration replicationConfig = s3Client.getBucketReplication(getRequest).replicationConfiguration();
ReplicationRule rule = replicationConfig.rules().get(0);
System.out.println("Retrieved destination bucket: " + rule.destination().bucket());
System.out.println("Retrieved priority: " + rule.priority());
System.out.println("Retrieved source-bucket replication rule status: " + rule.status());
} catch (S3Exception e) {
System.err.println("Failed to retrieve replication details: " + e.awsErrorDetails().errorMessage());
}
}
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Java 2.x API 參考》**中的 [GetBucketReplication](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/GetBucketReplication)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：傳回在名為 'amzn-s3-demo-bucket' 的儲存貯體上設定的複寫組態資訊。**
```
Get-S3BucketReplication -BucketName amzn-s3-demo-bucket
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [GetBucketReplication](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：傳回在名為 'amzn-s3-demo-bucket' 的儲存貯體上設定的複寫組態資訊。**
```
Get-S3BucketReplication -BucketName amzn-s3-demo-bucket
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [GetBucketReplication](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `GetBucketRequestPayment` 與 CLI
下列程式碼範例示範如何使用 `GetBucketRequestPayment`。
------
#### [ CLI ]
**AWS CLI**
**擷取儲存貯體的請求付款組態**
下列 `get-bucket-request-payment` 範例會擷取請求者支付指定儲存貯體的組態。
```
aws s3api get-bucket-request-payment \
--bucket amzn-s3-demo-bucket
```
輸出：
```
{
"Payer": "BucketOwner"
}
```
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [GetBucketRequestPayment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3api/get-bucket-request-payment.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：傳回名為 'amzn-s3-demo-bucket' 之儲存貯體的請求付款組態。根據預設，儲存貯體擁有者會支付從儲存貯體下載的費用。**
```
Get-S3BucketRequestPayment -BucketName amzn-s3-demo-bucket
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**的 [GetBucketRequestPayment](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：傳回名為 'amzn-s3-demo-bucket' 之儲存貯體的請求付款組態。根據預設，儲存貯體擁有者會支付從儲存貯體下載的費用。**
```
Get-S3BucketRequestPayment -BucketName amzn-s3-demo-bucket
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**的 [GetBucketRequestPayment](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `GetBucketTagging` 與 CLI
下列程式碼範例示範如何使用 `GetBucketTagging`。
------
#### [ CLI ]
**AWS CLI**
下列命令會擷取名為 `amzn-s3-demo-bucket` 之儲存貯體的標記組態：
```
aws s3api get-bucket-tagging --bucket amzn-s3-demo-bucket
```
輸出：
```
{
"TagSet": [
{
"Value": "marketing",
"Key": "organization"
}
]
}
```
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [GetBucketTagging](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3api/get-bucket-tagging.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此命令會傳回與給定儲存貯體相關聯的所有標籤。**
```
Get-S3BucketTagging -BucketName 'amzn-s3-demo-bucket'
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [GetBucketTagging](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此命令會傳回與給定儲存貯體相關聯的所有標籤。**
```
Get-S3BucketTagging -BucketName 'amzn-s3-demo-bucket'
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [GetBucketTagging](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `GetBucketVersioning` 與 CLI
下列程式碼範例示範如何使用 `GetBucketVersioning`。
------
#### [ CLI ]
**AWS CLI**
下列命令會擷取名為 `amzn-s3-demo-bucket` 之儲存貯體的版本控制組態：
```
aws s3api get-bucket-versioning --bucket amzn-s3-demo-bucket
```
輸出：
```
{
"Status": "Enabled"
}
```
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [GetBucketVersioning](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3api/get-bucket-versioning.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此命令會傳回與給定儲存貯體相關的版本控制狀態。**
```
Get-S3BucketVersioning -BucketName 'amzn-s3-demo-bucket'
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [GetBucketVersioning](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此命令會傳回與給定儲存貯體相關的版本控制狀態。**
```
Get-S3BucketVersioning -BucketName 'amzn-s3-demo-bucket'
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [GetBucketVersioning](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# `GetBucketWebsite` 搭配 AWS SDK 或 CLI 使用
下列程式碼範例示範如何使用 `GetBucketWebsite`。
------
#### [ .NET ]
**適用於 .NET 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/S3#code-examples)中設定和執行。
```
// Get the website configuration.
GetBucketWebsiteRequest getRequest = new GetBucketWebsiteRequest()
{
BucketName = bucketName,
};
GetBucketWebsiteResponse getResponse = await client.GetBucketWebsiteAsync(getRequest);
Console.WriteLine($"Index document: {getResponse.WebsiteConfiguration.IndexDocumentSuffix}");
Console.WriteLine($"Error document: {getResponse.WebsiteConfiguration.ErrorDocument}");
```
+ 如需 API 詳細資訊，請參閱*《適用於 .NET 的 AWS SDK API 參考》*中的 [GetBucketWebsite](https://docs.aws.amazon.com/goto/DotNetSDKV3/s3-2006-03-01/GetBucketWebsite)。
------
#### [ C\$1\$1 ]
**適用於 C\$1\$1 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/s3#code-examples)中設定和執行。
```
bool AwsDoc::S3::getWebsiteConfig(const Aws::String &bucketName,
const Aws::S3::S3ClientConfiguration &clientConfig) {
Aws::S3::S3Client s3Client(clientConfig);
Aws::S3::Model::GetBucketWebsiteRequest request;
request.SetBucket(bucketName);
Aws::S3::Model::GetBucketWebsiteOutcome outcome =
s3Client.GetBucketWebsite(request);
if (!outcome.IsSuccess()) {
const Aws::S3::S3Error &err = outcome.GetError();
std::cerr << "Error: GetBucketWebsite: "
<< err.GetMessage() << std::endl;
} else {
Aws::S3::Model::GetBucketWebsiteResult websiteResult = outcome.GetResult();
std::cout << "Success: GetBucketWebsite: "
<< std::endl << std::endl
<< "For bucket '" << bucketName << "':"
<< std::endl
<< "Index page : "
<< websiteResult.GetIndexDocument().GetSuffix()
<< std::endl
<< "Error page: "
<< websiteResult.GetErrorDocument().GetKey()
<< std::endl;
}
return outcome.IsSuccess();
}
```
+ 如需 API 詳細資訊，請參閱*《適用於 C\$1\$1 的 AWS SDK API 參考》*中的 [GetBucketWebsite](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/GetBucketWebsite)。
------
#### [ CLI ]
**AWS CLI**
下列命令會擷取名為 `amzn-s3-demo-bucket` 之儲存貯體的靜態網站組態：
```
aws s3api get-bucket-website --bucket amzn-s3-demo-bucket
```
輸出：
```
{
"IndexDocument": {
"Suffix": "index.html"
},
"ErrorDocument": {
"Key": "error.html"
}
}
```
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [GetBucketWebsite](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3api/get-bucket-website.html)。
------
#### [ JavaScript ]
**適用於 JavaScript (v3) 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/s3#code-examples)中設定和執行。
取得網站組態。
```
import {
GetBucketWebsiteCommand,
S3Client,
S3ServiceException,
} from "@aws-sdk/client-s3";
/**
* Log the website configuration for a bucket.
* @param {{ bucketName }}
*/
export const main = async ({ bucketName }) => {
const client = new S3Client({});
try {
const response = await client.send(
new GetBucketWebsiteCommand({
Bucket: bucketName,
}),
);
console.log(
`Your bucket is set up to host a website with the following configuration:\n${JSON.stringify(response, null, 2)}`,
);
} catch (caught) {
if (
caught instanceof S3ServiceException &&
caught.name === "NoSuchWebsiteConfiguration"
) {
console.error(
`Error from S3 while getting website configuration for ${bucketName}. The bucket isn't configured as a website.`,
);
} else if (caught instanceof S3ServiceException) {
console.error(
`Error from S3 while getting website configuration for ${bucketName}. ${caught.name}: ${caught.message}`,
);
} else {
throw caught;
}
}
};
```
+ 如需 API 詳細資訊，請參閱*《適用於 JavaScript 的 AWS SDK API 參考》*中的 [GetBucketWebsite](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/s3/command/GetBucketWebsiteCommand)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此命令會傳回給定 S3 儲存貯體之靜態網站組態的詳細資訊。**
```
Get-S3BucketWebsite -BucketName 'amzn-s3-demo-bucket'
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [GetBucketWebsite](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此命令會傳回給定 S3 儲存貯體之靜態網站組態的詳細資訊。**
```
Get-S3BucketWebsite -BucketName 'amzn-s3-demo-bucket'
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [GetBucketWebsite](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# `GetObject` 搭配 AWS SDK 或 CLI 使用
下列程式碼範例示範如何使用 `GetObject`。
動作範例是大型程式的程式碼摘錄，必須在內容中執行。您可以在下列程式碼範例的內容中看到此動作：
+ [了解基本概念](s3_example_s3_Scenario_GettingStarted_section.md)
+ [從儲存貯體中取得物件 (如果其已修改的話)](s3_example_s3_GetObject_IfModifiedSince_section.md)
+ [從多區域存取點取得物件](s3_example_s3_GetObject_MRAP_section.md)
+ [開始使用加密](s3_example_s3_Encryption_section.md)
+ [開始使用 S3](s3_example_s3_GettingStarted_section.md)
+ [提出條件式請求](s3_example_s3_Scenario_ConditionalRequests_section.md)
+ [追蹤上傳和下載](s3_example_s3_Scenario_TrackUploadDownload_section.md)
------
#### [ .NET ]
**適用於 .NET 的 SDK (v4)**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv4/S3#code-examples)中設定和執行。
```
///
/// Shows how to download an object from an Amazon S3 bucket to the
/// local computer.
///
/// The name of the bucket where the object is
/// currently stored.
/// The name of the object to download.
/// The path, including filename, where the
/// downloaded object will be stored.
/// A boolean value indicating the success or failure of the
/// download process.
public async Task DownloadObjectFromBucketAsync(
string bucketName,
string objectName,
string filePath)
{
var request = new GetObjectRequest
{
BucketName = bucketName,
Key = objectName,
};
using GetObjectResponse response = await _amazonS3.GetObjectAsync(request);
try
{
// Save object to local file
await response.WriteResponseStreamToFileAsync($"{filePath}\\{objectName}", true, CancellationToken.None);
return response.HttpStatusCode == System.Net.HttpStatusCode.OK;
}
catch (AmazonS3Exception ex)
{
Console.WriteLine($"Error saving {objectName}: {ex.Message}");
return false;
}
}
```
+ 如需 API 詳細資訊，請參閱*《適用於 .NET 的 AWS SDK API 參考》*中的 [GetObject](https://docs.aws.amazon.com/goto/DotNetSDKV4/s3-2006-03-01/GetObject)。
**適用於 .NET 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/S3#code-examples)中設定和執行。
使用條件式請求取得物件。
```
///
/// Retrieves an object from Amazon S3 with a conditional request.
///
/// The key of the object to retrieve.
/// The source bucket of the object.
/// The type of condition: 'IfMatch', 'IfNoneMatch', 'IfModifiedSince', 'IfUnmodifiedSince'.
/// The value to use for the condition for dates.
/// The value to use for the condition for etags.
/// True if the conditional read is successful, False otherwise.
public async Task GetObjectConditional(string objectKey, string sourceBucket,
S3ConditionType conditionType, DateTime? conditionDateValue = null, string? etagConditionalValue = null)
{
try
{
var getObjectRequest = new GetObjectRequest
{
BucketName = sourceBucket,
Key = objectKey
};
switch (conditionType)
{
case S3ConditionType.IfMatch:
getObjectRequest.EtagToMatch = etagConditionalValue;
break;
case S3ConditionType.IfNoneMatch:
getObjectRequest.EtagToNotMatch = etagConditionalValue;
break;
case S3ConditionType.IfModifiedSince:
getObjectRequest.ModifiedSinceDateUtc = conditionDateValue.GetValueOrDefault();
break;
case S3ConditionType.IfUnmodifiedSince:
getObjectRequest.UnmodifiedSinceDateUtc = conditionDateValue.GetValueOrDefault();
break;
default:
throw new ArgumentOutOfRangeException(nameof(conditionType), conditionType, null);
}
var response = await _amazonS3.GetObjectAsync(getObjectRequest);
var sampleBytes = new byte[20];
await response.ResponseStream.ReadAsync(sampleBytes, 0, 20);
_logger.LogInformation($"Conditional read successful. Here are the first 20 bytes of the object:\n{System.Text.Encoding.UTF8.GetString(sampleBytes)}");
return true;
}
catch (AmazonS3Exception e)
{
if (e.ErrorCode == "PreconditionFailed")
{
_logger.LogError("Conditional read failed: Precondition failed");
}
else if (e.ErrorCode == "NotModified")
{
_logger.LogError("Conditional read failed: Object not modified");
}
else
{
_logger.LogError($"Unexpected error: {e.ErrorCode}");
throw;
}
return false;
}
}
```
+ 如需 API 詳細資訊，請參閱*《適用於 .NET 的 AWS SDK API 參考》*中的 [GetObject](https://docs.aws.amazon.com/goto/DotNetSDKV3/s3-2006-03-01/GetObject)。
------
#### [ Bash ]
**AWS CLI 使用 Bash 指令碼**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/aws-cli/bash-linux/s3#code-examples)中設定和執行。
```
###############################################################################
# function errecho
#
# This function outputs everything sent to it to STDERR (standard error output).
###############################################################################
function errecho() {
printf "%s\n" "$*" 1>&2
}
###############################################################################
# function download_object_from_bucket
#
# This function downloads an object in a bucket to a file.
#
# Parameters:
# $1 - The name of the bucket to download the object from.
# $2 - The path and file name to store the downloaded bucket.
# $3 - The key (name) of the object in the bucket.
#
# Returns:
# 0 - If successful.
# 1 - If it fails.
###############################################################################
function download_object_from_bucket() {
local bucket_name=$1
local destination_file_name=$2
local object_name=$3
local response
response=$(aws s3api get-object \
--bucket "$bucket_name" \
--key "$object_name" \
"$destination_file_name")
# shellcheck disable=SC2181
if [[ ${?} -ne 0 ]]; then
errecho "ERROR: AWS reports put-object operation failed.\n$response"
return 1
fi
}
```
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [GetObject](https://docs.aws.amazon.com/goto/aws-cli/s3-2006-03-01/GetObject)。
------
#### [ C\$1\$1 ]
**適用於 C\$1\$1 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/s3#code-examples)中設定和執行。
```
bool AwsDoc::S3::getObject(const Aws::String &objectKey,
const Aws::String &fromBucket,
const Aws::S3::S3ClientConfiguration &clientConfig) {
Aws::S3::S3Client client(clientConfig);
Aws::S3::Model::GetObjectRequest request;
request.SetBucket(fromBucket);
request.SetKey(objectKey);
Aws::S3::Model::GetObjectOutcome outcome =
client.GetObject(request);
if (!outcome.IsSuccess()) {
const Aws::S3::S3Error &err = outcome.GetError();
std::cerr << "Error: getObject: " <<
err.GetExceptionName() << ": " << err.GetMessage() << std::endl;
} else {
std::cout << "Successfully retrieved '" << objectKey << "' from '"
<< fromBucket << "'." << std::endl;
}
return outcome.IsSuccess();
}
```
+ 如需 API 詳細資訊，請參閱*《適用於 C\$1\$1 的 AWS SDK API 參考》*中的 [GetObject](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/GetObject)。
------
#### [ CLI ]
**AWS CLI**
以下範例使用 `get-object` 命令，從 Amazon S3 下載物件。
```
aws s3api get-object --bucket text-content --key dir/my_images.tar.bz2 my_images.tar.bz2
```
請注意，outfile 參數是在沒有選項名稱的情況下指定，例如 "--outfile"。輸出檔案名稱必須是命令中的最後一個參數。
以下範例展示如何使用 `--range` 從物件下載特定位元組範圍。請注意，位元組範圍必須以 "bytes=" 開頭：
```
aws s3api get-object --bucket text-content --key dir/my_data --range bytes=8888-9999 my_data_range
```
如需擷取物件的詳細資訊，請參閱《Amazon S3 開發人員指南》**中的「取得物件」。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [GetObject](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3api/get-object.html)。
------
#### [ Go ]
**SDK for Go V2**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/gov2/s3#code-examples)中設定和執行。
```
import (
"bytes"
"context"
"errors"
"fmt"
"io"
"log"
"os"
"time"
"github.com/aws/aws-sdk-go-v2/aws"
"github.com/aws/aws-sdk-go-v2/feature/s3/manager"
"github.com/aws/aws-sdk-go-v2/service/s3"
"github.com/aws/aws-sdk-go-v2/service/s3/types"
"github.com/aws/smithy-go"
)
// BucketBasics encapsulates the Amazon Simple Storage Service (Amazon S3) actions
// used in the examples.
// It contains S3Client, an Amazon S3 service client that is used to perform bucket
// and object actions.
type BucketBasics struct {
S3Client *s3.Client
}
// DownloadFile gets an object from a bucket and stores it in a local file.
func (basics BucketBasics) DownloadFile(ctx context.Context, bucketName string, objectKey string, fileName string) error {
result, err := basics.S3Client.GetObject(ctx, &s3.GetObjectInput{
Bucket: aws.String(bucketName),
Key: aws.String(objectKey),
})
if err != nil {
var noKey *types.NoSuchKey
if errors.As(err, &noKey) {
log.Printf("Can't get object %s from bucket %s. No such key exists.\n", objectKey, bucketName)
err = noKey
} else {
log.Printf("Couldn't get object %v:%v. Here's why: %v\n", bucketName, objectKey, err)
}
return err
}
defer result.Body.Close()
file, err := os.Create(fileName)
if err != nil {
log.Printf("Couldn't create file %v. Here's why: %v\n", fileName, err)
return err
}
defer file.Close()
body, err := io.ReadAll(result.Body)
if err != nil {
log.Printf("Couldn't read object body from %v. Here's why: %v\n", objectKey, err)
}
_, err = file.Write(body)
return err
}
```
+ 如需 API 詳細資訊，請參閱*《適用於 Go 的 AWS SDK API 參考》*中的 [GetObject](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/s3#Client.GetObject)。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/s3#code-examples)中設定和執行。
使用 [S3Client](https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/s3/S3Client.html) 將資料當作位元組陣列讀取。
```
/**
* Asynchronously retrieves the bytes of an object from an Amazon S3 bucket and writes them to a local file.
*
* @param bucketName the name of the S3 bucket containing the object
* @param keyName the key (or name) of the S3 object to retrieve
* @param path the local file path where the object's bytes will be written
* @return a {@link CompletableFuture} that completes when the object bytes have been written to the local file
*/
public CompletableFuture getObjectBytesAsync(String bucketName, String keyName, String path) {
GetObjectRequest objectRequest = GetObjectRequest.builder()
.key(keyName)
.bucket(bucketName)
.build();
CompletableFuture> response = getAsyncClient().getObject(objectRequest, AsyncResponseTransformer.toBytes());
return response.thenAccept(objectBytes -> {
try {
byte[] data = objectBytes.asByteArray();
Path filePath = Paths.get(path);
Files.write(filePath, data);
logger.info("Successfully obtained bytes from an S3 object");
} catch (IOException ex) {
throw new RuntimeException("Failed to write data to file", ex);
}
}).whenComplete((resp, ex) -> {
if (ex != null) {
throw new RuntimeException("Failed to get object bytes from S3", ex);
}
});
}
```
使用 [S3TransferManager](https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/transfer/s3/S3TransferManager.html) 將 S3 儲存貯體中的[物件下載](https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/transfer/s3/S3TransferManager.html#downloadFile(software.amazon.awssdk.transfer.s3.DownloadFileRequest))到本機檔案。檢視[完整檔案](https://github.com/awsdocs/aws-doc-sdk-examples/blob/main/javav2/example_code/s3/src/main/java/com/example/s3/transfermanager/DownloadFile.java)並[測試](https://github.com/awsdocs/aws-doc-sdk-examples/blob/main/javav2/example_code/s3/src/test/java/TransferManagerTest.java)。
```
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import software.amazon.awssdk.core.exception.SdkException;
import software.amazon.awssdk.core.sync.RequestBody;
import software.amazon.awssdk.transfer.s3.S3TransferManager;
import software.amazon.awssdk.transfer.s3.model.CompletedFileDownload;
import software.amazon.awssdk.transfer.s3.model.DownloadFileRequest;
import software.amazon.awssdk.transfer.s3.model.FileDownload;
import software.amazon.awssdk.transfer.s3.progress.LoggingTransferListener;
import java.io.IOException;
import java.net.URISyntaxException;
import java.net.URL;
import java.nio.file.Files;
import java.nio.file.NoSuchFileException;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.UUID;
public Long downloadFile(S3TransferManager transferManager, String bucketName,
String key, String downloadedFileWithPath) {
DownloadFileRequest downloadFileRequest = DownloadFileRequest.builder()
.getObjectRequest(b -> b.bucket(bucketName).key(key))
.destination(Paths.get(downloadedFileWithPath))
.build();
FileDownload downloadFile = transferManager.downloadFile(downloadFileRequest);
CompletedFileDownload downloadResult = downloadFile.completionFuture().join();
logger.info("Content length [{}]", downloadResult.response().contentLength());
return downloadResult.response().contentLength();
}
```
使用 [S3Client](https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/s3/S3Client.html) 讀取屬於某個物件的索引標籤。
```
import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.s3.S3Client;
import software.amazon.awssdk.services.s3.model.GetObjectTaggingRequest;
import software.amazon.awssdk.services.s3.model.GetObjectTaggingResponse;
import software.amazon.awssdk.services.s3.model.S3Exception;
import software.amazon.awssdk.services.s3.model.Tag;
import java.util.List;
/**
* Before running this Java V2 code example, set up your development
* environment, including your credentials.
*
* For more information, see the following documentation topic:
*
* https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/get-started.html
*/
public class GetObjectTags {
public static void main(String[] args) {
final String usage = """
Usage:
\s
Where:
bucketName - The Amazon S3 bucket name.\s
keyName - A key name that represents the object.\s
""";
if (args.length != 2) {
System.out.println(usage);
System.exit(1);
}
String bucketName = args[0];
String keyName = args[1];
Region region = Region.US_EAST_1;
S3Client s3 = S3Client.builder()
.region(region)
.build();
listTags(s3, bucketName, keyName);
s3.close();
}
/**
* Lists the tags associated with an Amazon S3 object.
*
* @param s3 the S3Client object used to interact with the Amazon S3 service
* @param bucketName the name of the S3 bucket that contains the object
* @param keyName the key (name) of the S3 object
*/
public static void listTags(S3Client s3, String bucketName, String keyName) {
try {
GetObjectTaggingRequest getTaggingRequest = GetObjectTaggingRequest
.builder()
.key(keyName)
.bucket(bucketName)
.build();
GetObjectTaggingResponse tags = s3.getObjectTagging(getTaggingRequest);
List tagSet = tags.tagSet();
for (Tag tag : tagSet) {
System.out.println(tag.key());
System.out.println(tag.value());
}
} catch (S3Exception e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
}
}
```
使用 [S3Client](https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/s3/S3Client.html) 取得物件的 URL。
```
import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.s3.S3Client;
import software.amazon.awssdk.services.s3.model.GetUrlRequest;
import software.amazon.awssdk.services.s3.model.S3Exception;
import java.net.URL;
/**
* Before running this Java V2 code example, set up your development
* environment, including your credentials.
*
* For more information, see the following documentation topic:
*
* https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/get-started.html
*/
public class GetObjectUrl {
public static void main(String[] args) {
final String usage = """
Usage:
\s
Where:
bucketName - The Amazon S3 bucket name.
keyName - A key name that represents the object.\s
""";
if (args.length != 2) {
System.out.println(usage);
System.exit(1);
}
String bucketName = args[0];
String keyName = args[1];
Region region = Region.US_EAST_1;
S3Client s3 = S3Client.builder()
.region(region)
.build();
getURL(s3, bucketName, keyName);
s3.close();
}
/**
* Retrieves the URL for a specific object in an Amazon S3 bucket.
*
* @param s3 the S3Client object used to interact with the Amazon S3 service
* @param bucketName the name of the S3 bucket where the object is stored
* @param keyName the name of the object for which the URL should be retrieved
* @throws S3Exception if there is an error retrieving the URL for the specified object
*/
public static void getURL(S3Client s3, String bucketName, String keyName) {
try {
GetUrlRequest request = GetUrlRequest.builder()
.bucket(bucketName)
.key(keyName)
.build();
URL url = s3.utilities().getUrl(request);
System.out.println("The URL for " + keyName + " is " + url);
} catch (S3Exception e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
}
}
```
使用 [S3Client](https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/s3/S3Client.html) 透過使用 S3Presigner 用戶端物件取得物件。
```
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.net.HttpURLConnection;
import java.time.Duration;
import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.s3.model.GetObjectRequest;
import software.amazon.awssdk.services.s3.model.S3Exception;
import software.amazon.awssdk.services.s3.presigner.model.GetObjectPresignRequest;
import software.amazon.awssdk.services.s3.presigner.model.PresignedGetObjectRequest;
import software.amazon.awssdk.services.s3.presigner.S3Presigner;
import software.amazon.awssdk.utils.IoUtils;
/**
* Before running this Java V2 code example, set up your development
* environment, including your credentials.
*
* For more information, see the following documentation topic:
*
* https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/get-started.html
*/
public class GetObjectPresignedUrl {
public static void main(String[] args) {
final String USAGE = """
Usage:
\s
Where:
bucketName - The Amazon S3 bucket name.\s
keyName - A key name that represents a text file.\s
""";
if (args.length != 2) {
System.out.println(USAGE);
System.exit(1);
}
String bucketName = args[0];
String keyName = args[1];
Region region = Region.US_EAST_1;
S3Presigner presigner = S3Presigner.builder()
.region(region)
.build();
getPresignedUrl(presigner, bucketName, keyName);
presigner.close();
}
/**
* Generates a pre-signed URL for an Amazon S3 object.
*
* @param presigner The {@link S3Presigner} instance to use for generating the pre-signed URL.
* @param bucketName The name of the Amazon S3 bucket where the object is stored.
* @param keyName The key name (file name) of the object in the Amazon S3 bucket.
*
* @throws S3Exception If there is an error interacting with the Amazon S3 service.
* @throws IOException If there is an error opening the HTTP connection or reading/writing the request/response.
*/
public static void getPresignedUrl(S3Presigner presigner, String bucketName, String keyName) {
try {
GetObjectRequest getObjectRequest = GetObjectRequest.builder()
.bucket(bucketName)
.key(keyName)
.build();
GetObjectPresignRequest getObjectPresignRequest = GetObjectPresignRequest.builder()
.signatureDuration(Duration.ofMinutes(60))
.getObjectRequest(getObjectRequest)
.build();
PresignedGetObjectRequest presignedGetObjectRequest = presigner.presignGetObject(getObjectPresignRequest);
String theUrl = presignedGetObjectRequest.url().toString();
System.out.println("Presigned URL: " + theUrl);
HttpURLConnection connection = (HttpURLConnection) presignedGetObjectRequest.url().openConnection();
presignedGetObjectRequest.httpRequest().headers().forEach((header, values) -> {
values.forEach(value -> {
connection.addRequestProperty(header, value);
});
});
// Send any request payload that the service needs (not needed when
// isBrowserExecutable is true).
if (presignedGetObjectRequest.signedPayload().isPresent()) {
connection.setDoOutput(true);
try (InputStream signedPayload = presignedGetObjectRequest.signedPayload().get().asInputStream();
OutputStream httpOutputStream = connection.getOutputStream()) {
IoUtils.copy(signedPayload, httpOutputStream);
}
}
// Download the result of executing the request.
try (InputStream content = connection.getInputStream()) {
System.out.println("Service returned response: ");
IoUtils.copy(content, System.out);
}
} catch (S3Exception | IOException e) {
e.printStackTrace();
}
}
}
```
使用 ResponseTransformer 物件和[S3Client](https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/s3/S3Client.html) 取得物件。
```
import software.amazon.awssdk.core.ResponseBytes;
import software.amazon.awssdk.core.sync.ResponseTransformer;
import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.s3.S3Client;
import software.amazon.awssdk.services.s3.model.GetObjectRequest;
import software.amazon.awssdk.services.s3.model.S3Exception;
import software.amazon.awssdk.services.s3.model.GetObjectResponse;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.OutputStream;
/**
* Before running this Java V2 code example, set up your development
* environment, including your credentials.
*
* For more information, see the following documentation topic:
*
* https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/get-started.html
*/
public class GetObjectData {
public static void main(String[] args) {
final String usage = """
Usage:
Where:
bucketName - The Amazon S3 bucket name.\s
keyName - The key name.\s
path - The path where the file is written to.\s
""";
if (args.length != 3) {
System.out.println(usage);
System.exit(1);
}
String bucketName = args[0];
String keyName = args[1];
String path = args[2];
Region region = Region.US_EAST_1;
S3Client s3 = S3Client.builder()
.region(region)
.build();
getObjectBytes(s3, bucketName, keyName, path);
s3.close();
}
/**
* Retrieves the bytes of an object stored in an Amazon S3 bucket and saves them to a local file.
*
* @param s3 The S3Client instance used to interact with the Amazon S3 service.
* @param bucketName The name of the S3 bucket where the object is stored.
* @param keyName The key (or name) of the S3 object.
* @param path The local file path where the object's bytes will be saved.
* @throws IOException If an I/O error occurs while writing the bytes to the local file.
* @throws S3Exception If an error occurs while retrieving the object from the S3 bucket.
*/
public static void getObjectBytes(S3Client s3, String bucketName, String keyName, String path) {
try {
GetObjectRequest objectRequest = GetObjectRequest
.builder()
.key(keyName)
.bucket(bucketName)
.build();
ResponseBytes objectBytes = s3.getObject(objectRequest, ResponseTransformer.toBytes());
byte[] data = objectBytes.asByteArray();
// Write the data to a local file.
File myFile = new File(path);
OutputStream os = new FileOutputStream(myFile);
os.write(data);
System.out.println("Successfully obtained bytes from an S3 object");
os.close();
} catch (IOException ex) {
ex.printStackTrace();
} catch (S3Exception e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
}
}
```
+ 如需 API 詳細資訊，請參閱*《AWS SDK for Java 2.x API 參考》*中的 [GetObject](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/GetObject)。
------
#### [ JavaScript ]
**適用於 JavaScript (v3) 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/s3#code-examples)中設定和執行。
下載物件。
```
import {
GetObjectCommand,
NoSuchKey,
S3Client,
S3ServiceException,
} from "@aws-sdk/client-s3";
/**
* Get a single object from a specified S3 bucket.
* @param {{ bucketName: string, key: string }}
*/
export const main = async ({ bucketName, key }) => {
const client = new S3Client({});
try {
const response = await client.send(
new GetObjectCommand({
Bucket: bucketName,
Key: key,
}),
);
// The Body object also has 'transformToByteArray' and 'transformToWebStream' methods.
const str = await response.Body.transformToString();
console.log(str);
} catch (caught) {
if (caught instanceof NoSuchKey) {
console.error(
`Error from S3 while getting object "${key}" from "${bucketName}". No such key exists.`,
);
} else if (caught instanceof S3ServiceException) {
console.error(
`Error from S3 while getting object from ${bucketName}. ${caught.name}: ${caught.message}`,
);
} else {
throw caught;
}
}
};
```
如果物件的 ETag 與提供的 ETag 相符，則下載該物件。
```
import {
GetObjectCommand,
NoSuchKey,
S3Client,
S3ServiceException,
} from "@aws-sdk/client-s3";
/**
* Get a single object from a specified S3 bucket.
* @param {{ bucketName: string, key: string, eTag: string }}
*/
export const main = async ({ bucketName, key, eTag }) => {
const client = new S3Client({});
try {
const response = await client.send(
new GetObjectCommand({
Bucket: bucketName,
Key: key,
IfMatch: eTag,
}),
);
// The Body object also has 'transformToByteArray' and 'transformToWebStream' methods.
const str = await response.Body.transformToString();
console.log("Success. Here is text of the file:", str);
} catch (caught) {
if (caught instanceof NoSuchKey) {
console.error(
`Error from S3 while getting object "${key}" from "${bucketName}". No such key exists.`,
);
} else if (caught instanceof S3ServiceException) {
console.error(
`Error from S3 while getting object from ${bucketName}. ${caught.name}: ${caught.message}`,
);
} else {
throw caught;
}
}
};
// Call function if run directly
import { parseArgs } from "node:util";
import {
isMain,
validateArgs,
} from "@aws-doc-sdk-examples/lib/utils/util-node.js";
const loadArgs = () => {
const options = {
bucketName: {
type: "string",
required: true,
},
key: {
type: "string",
required: true,
},
eTag: {
type: "string",
required: true,
},
};
const results = parseArgs({ options });
const { errors } = validateArgs({ options }, results);
return { errors, results };
};
if (isMain(import.meta.url)) {
const { errors, results } = loadArgs();
if (!errors) {
main(results.values);
} else {
console.error(errors.join("\n"));
}
}
```
如果物件的 ETag 與提供的 ETag 不相符，則下載該物件。
```
import {
GetObjectCommand,
NoSuchKey,
S3Client,
S3ServiceException,
} from "@aws-sdk/client-s3";
/**
* Get a single object from a specified S3 bucket.
* @param {{ bucketName: string, key: string, eTag: string }}
*/
export const main = async ({ bucketName, key, eTag }) => {
const client = new S3Client({});
try {
const response = await client.send(
new GetObjectCommand({
Bucket: bucketName,
Key: key,
IfNoneMatch: eTag,
}),
);
// The Body object also has 'transformToByteArray' and 'transformToWebStream' methods.
const str = await response.Body.transformToString();
console.log("Success. Here is text of the file:", str);
} catch (caught) {
if (caught instanceof NoSuchKey) {
console.error(
`Error from S3 while getting object "${key}" from "${bucketName}". No such key exists.`,
);
} else if (caught instanceof S3ServiceException) {
console.error(
`Error from S3 while getting object from ${bucketName}. ${caught.name}: ${caught.message}`,
);
} else {
throw caught;
}
}
};
// Call function if run directly
import { parseArgs } from "node:util";
import {
isMain,
validateArgs,
} from "@aws-doc-sdk-examples/lib/utils/util-node.js";
const loadArgs = () => {
const options = {
bucketName: {
type: "string",
required: true,
},
key: {
type: "string",
required: true,
},
eTag: {
type: "string",
required: true,
},
};
const results = parseArgs({ options });
const { errors } = validateArgs({ options }, results);
return { errors, results };
};
if (isMain(import.meta.url)) {
const { errors, results } = loadArgs();
if (!errors) {
main(results.values);
} else {
console.error(errors.join("\n"));
}
}
```
在給定的時間範圍內建立或修改物件的情況下，下載該物件。
```
import {
GetObjectCommand,
NoSuchKey,
S3Client,
S3ServiceException,
} from "@aws-sdk/client-s3";
/**
* Get a single object from a specified S3 bucket.
* @param {{ bucketName: string, key: string }}
*/
export const main = async ({ bucketName, key }) => {
const client = new S3Client({});
const date = new Date();
date.setDate(date.getDate() - 1);
try {
const response = await client.send(
new GetObjectCommand({
Bucket: bucketName,
Key: key,
IfModifiedSince: date,
}),
);
// The Body object also has 'transformToByteArray' and 'transformToWebStream' methods.
const str = await response.Body.transformToString();
console.log("Success. Here is text of the file:", str);
} catch (caught) {
if (caught instanceof NoSuchKey) {
console.error(
`Error from S3 while getting object "${key}" from "${bucketName}". No such key exists.`,
);
} else if (caught instanceof S3ServiceException) {
console.error(
`Error from S3 while getting object from ${bucketName}. ${caught.name}: ${caught.message}`,
);
} else {
throw caught;
}
}
};
// Call function if run directly
import { parseArgs } from "node:util";
import {
isMain,
validateArgs,
} from "@aws-doc-sdk-examples/lib/utils/util-node.js";
const loadArgs = () => {
const options = {
bucketName: {
type: "string",
required: true,
},
key: {
type: "string",
required: true,
},
};
const results = parseArgs({ options });
const { errors } = validateArgs({ options }, results);
return { errors, results };
};
if (isMain(import.meta.url)) {
const { errors, results } = loadArgs();
if (!errors) {
main(results.values);
} else {
console.error(errors.join("\n"));
}
}
```
在給定的時間範圍內未建立或修改物件的情況下，下載該物件。
```
import {
GetObjectCommand,
NoSuchKey,
S3Client,
S3ServiceException,
} from "@aws-sdk/client-s3";
/**
* Get a single object from a specified S3 bucket.
* @param {{ bucketName: string, key: string }}
*/
export const main = async ({ bucketName, key }) => {
const client = new S3Client({});
const date = new Date();
date.setDate(date.getDate() - 1);
try {
const response = await client.send(
new GetObjectCommand({
Bucket: bucketName,
Key: key,
IfUnmodifiedSince: date,
}),
);
// The Body object also has 'transformToByteArray' and 'transformToWebStream' methods.
const str = await response.Body.transformToString();
console.log("Success. Here is text of the file:", str);
} catch (caught) {
if (caught instanceof NoSuchKey) {
console.error(
`Error from S3 while getting object "${key}" from "${bucketName}". No such key exists.`,
);
} else if (caught instanceof S3ServiceException) {
console.error(
`Error from S3 while getting object from ${bucketName}. ${caught.name}: ${caught.message}`,
);
} else {
throw caught;
}
}
};
// Call function if run directly
import { parseArgs } from "node:util";
import {
isMain,
validateArgs,
} from "@aws-doc-sdk-examples/lib/utils/util-node.js";
const loadArgs = () => {
const options = {
bucketName: {
type: "string",
required: true,
},
key: {
type: "string",
required: true,
},
};
const results = parseArgs({ options });
const { errors } = validateArgs({ options }, results);
return { errors, results };
};
if (isMain(import.meta.url)) {
const { errors, results } = loadArgs();
if (!errors) {
main(results.values);
} else {
console.error(errors.join("\n"));
}
}
```
+ 如需詳細資訊，請參閱《[適用於 JavaScript 的 AWS SDK 開發人員指南](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/s3-example-creating-buckets.html#s3-example-creating-buckets-get-object)》。
+ 如需 API 詳細資訊，請參閱*《適用於 JavaScript 的 AWS SDK API 參考》*中的 [GetObject](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/s3/command/GetObjectCommand)。
------
#### [ Kotlin ]
**適用於 Kotlin 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/s3#code-examples)中設定和執行。
```
suspend fun getObjectBytes(
bucketName: String,
keyName: String,
path: String,
) {
val request =
GetObjectRequest {
key = keyName
bucket = bucketName
}
S3Client.fromEnvironment { region = "us-east-1" }.use { s3 ->
s3.getObject(request) { resp ->
val myFile = File(path)
resp.body?.writeToFile(myFile)
println("Successfully read $keyName from $bucketName")
}
}
}
```
+ 如需 API 詳細資訊，請參閱《適用於 Kotlin 的AWS SDK API 參考》**中的 [GetObject](https://sdk.amazonaws.com/kotlin/api/latest/index.html)。
------
#### [ PHP ]
**適用於 PHP 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code/s3#code-examples)中設定和執行。
取得物件。
```
$s3client = new Aws\S3\S3Client(['region' => 'us-west-2']);
try {
$file = $this->s3client->getObject([
'Bucket' => $this->bucketName,
'Key' => $fileName,
]);
$body = $file->get('Body');
$body->rewind();
echo "Downloaded the file and it begins with: {$body->read(26)}.\n";
} catch (Exception $exception) {
echo "Failed to download $fileName from $this->bucketName with error: " . $exception->getMessage();
exit("Please fix error with file downloading before continuing.");
}
```
+ 如需 API 詳細資訊，請參閱*《適用於 PHP 的 AWS SDK API 參考》*中的 [GetObject](https://docs.aws.amazon.com/goto/SdkForPHPV3/s3-2006-03-01/GetObject)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此命令會從儲存貯體 "amzn-s3-demo-bucket" 擷取項目 "sample.txt"，並將其儲存至目前位置中名為 "local-sample.txt" 的檔案。在呼叫此命令之前，檔案 "local-sample.txt" 不需存在。**
```
Read-S3Object -BucketName amzn-s3-demo-bucket -Key sample.txt -File local-sample.txt
```
**範例 2：此命令會從儲存貯體 "amzn-s3-demo-bucket" 擷取虛擬目錄 "DIR"，並將其儲存至目前位置中名為 "Local-DIR" 的資料夾。呼叫此命令之前，資料夾 "Local-DIR" 不需存在。**
```
Read-S3Object -BucketName amzn-s3-demo-bucket -KeyPrefix DIR -Folder Local-DIR
```
**範例 3：將所有金鑰以 '.json' 結尾的物件，從儲存貯體名稱具有 'config' 的儲存貯體，下載到指定資料夾中的檔案。物件金鑰用於設定檔案名稱。**
```
Get-S3Bucket | ? { $_.BucketName -like '*config*' } | Get-S3Object | ? { $_.Key -like '*.json' } | Read-S3Object -Folder C:\ConfigObjects
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [GetObject](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此命令會從儲存貯體 "amzn-s3-demo-bucket" 擷取項目 "sample.txt"，並將其儲存至目前位置中名為 "local-sample.txt" 的檔案。在呼叫此命令之前，檔案 "local-sample.txt" 不需存在。**
```
Read-S3Object -BucketName amzn-s3-demo-bucket -Key sample.txt -File local-sample.txt
```
**範例 2：此命令會從儲存貯體 "amzn-s3-demo-bucket" 擷取虛擬目錄 "DIR"，並將其儲存至目前位置中名為 "Local-DIR" 的資料夾。呼叫此命令之前，資料夾 "Local-DIR" 不需存在。**
```
Read-S3Object -BucketName amzn-s3-demo-bucket -KeyPrefix DIR -Folder Local-DIR
```
**範例 3：將所有金鑰以 '.json' 結尾的物件，從儲存貯體名稱具有 'config' 的儲存貯體，下載到指定資料夾中的檔案。物件金鑰用於設定檔案名稱。**
```
Get-S3Bucket | ? { $_.BucketName -like '*config*' } | Get-S3Object | ? { $_.Key -like '*.json' } | Read-S3Object -Folder C:\ConfigObjects
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [GetObject](https://docs.aws.amazon.com/powershell/v5/reference)。
------
#### [ Python ]
**適用於 Python 的 SDK (Boto3)**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/s3/s3_basics#code-examples)中設定和執行。
```
class ObjectWrapper:
"""Encapsulates S3 object actions."""
def __init__(self, s3_object):
"""
:param s3_object: A Boto3 Object resource. This is a high-level resource in Boto3
that wraps object actions in a class-like structure.
"""
self.object = s3_object
self.key = self.object.key
def get(self):
"""
Gets the object.
:return: The object data in bytes.
"""
try:
body = self.object.get()["Body"].read()
logger.info(
"Got object '%s' from bucket '%s'.",
self.object.key,
self.object.bucket_name,
)
except ClientError:
logger.exception(
"Couldn't get object '%s' from bucket '%s'.",
self.object.key,
self.object.bucket_name,
)
raise
else:
return body
```
使用條件式請求取得物件。
```
class S3ConditionalRequests:
"""Encapsulates S3 conditional request operations."""
def __init__(self, s3_client):
self.s3 = s3_client
@classmethod
def from_client(cls):
"""
Instantiates this class from a Boto3 client.
"""
s3_client = boto3.client("s3")
return cls(s3_client)
def get_object_conditional(
self,
object_key: str,
source_bucket: str,
condition_type: str,
condition_value: str,
):
"""
Retrieves an object from Amazon S3 with a conditional request.
:param object_key: The key of the object to retrieve.
:param source_bucket: The source bucket of the object.
:param condition_type: The type of condition: 'IfMatch', 'IfNoneMatch', 'IfModifiedSince', 'IfUnmodifiedSince'.
:param condition_value: The value to use for the condition.
"""
try:
response = self.s3.get_object(
Bucket=source_bucket,
Key=object_key,
**{condition_type: condition_value},
)
sample_bytes = response["Body"].read(20)
print(
f"\tConditional read successful. Here are the first 20 bytes of the object:\n"
)
print(f"\t{sample_bytes}")
except ClientError as e:
error_code = e.response["Error"]["Code"]
if error_code == "PreconditionFailed":
print("\tConditional read failed: Precondition failed")
elif error_code == "304": # Not modified error code.
print("\tConditional read failed: Object not modified")
else:
logger.error(f"Unexpected error: {error_code}")
raise
```
+ 如需 API 詳細資訊，請參閱*《適用於 Python (Boto3) 的AWS SDK API 參考》*中的 [GetObject](https://docs.aws.amazon.com/goto/boto3/s3-2006-03-01/GetObject)。
------
#### [ Ruby ]
**SDK for Ruby**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/ruby/example_code/s3#code-examples)中設定和執行。
取得物件。
```
require 'aws-sdk-s3'
# Wraps Amazon S3 object actions.
class ObjectGetWrapper
attr_reader :object
# @param object [Aws::S3::Object] An existing Amazon S3 object.
def initialize(object)
@object = object
end
# Gets the object directly to a file.
#
# @param target_path [String] The path to the file where the object is downloaded.
# @return [Aws::S3::Types::GetObjectOutput, nil] The retrieved object data if successful; otherwise nil.
def get_object(target_path)
@object.get(response_target: target_path)
rescue Aws::Errors::ServiceError => e
puts "Couldn't get object #{@object.key}. Here's why: #{e.message}"
end
end
# Example usage:
def run_demo
bucket_name = "amzn-s3-demo-bucket"
object_key = "my-object.txt"
target_path = "my-object-as-file.txt"
wrapper = ObjectGetWrapper.new(Aws::S3::Object.new(bucket_name, object_key))
obj_data = wrapper.get_object(target_path)
return unless obj_data
puts "Object #{object_key} (#{obj_data.content_length} bytes} downloaded to #{target_path}."
end
run_demo if $PROGRAM_NAME == __FILE__
```
取得物件並報告其伺服器端的加密狀態。
```
require 'aws-sdk-s3'
# Wraps Amazon S3 object actions.
class ObjectGetEncryptionWrapper
attr_reader :object
# @param object [Aws::S3::Object] An existing Amazon S3 object.
def initialize(object)
@object = object
end
# Gets the object into memory.
#
# @return [Aws::S3::Types::GetObjectOutput, nil] The retrieved object data if successful; otherwise nil.
def object
@object.get
rescue Aws::Errors::ServiceError => e
puts "Couldn't get object #{@object.key}. Here's why: #{e.message}"
end
end
# Example usage:
def run_demo
bucket_name = "amzn-s3-demo-bucket"
object_key = "my-object.txt"
wrapper = ObjectGetEncryptionWrapper.new(Aws::S3::Object.new(bucket_name, object_key))
obj_data = wrapper.get_object
return unless obj_data
encryption = obj_data.server_side_encryption.nil? ? 'no' : obj_data.server_side_encryption
puts "Object #{object_key} uses #{encryption} encryption."
end
run_demo if $PROGRAM_NAME == __FILE__
```
+ 如需 API 詳細資訊，請參閱*《適用於 Ruby 的 AWS SDK API 參考》*中的 [GetObject](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/GetObject)。
------
#### [ Rust ]
**適用於 Rust 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/rustv1/examples/s3#code-examples)中設定和執行。
```
async fn get_object(client: Client, opt: Opt) -> Result {
trace!("bucket: {}", opt.bucket);
trace!("object: {}", opt.object);
trace!("destination: {}", opt.destination.display());
let mut file = File::create(opt.destination.clone()).map_err(|err| {
S3ExampleError::new(format!(
"Failed to initialize file for saving S3 download: {err:?}"
))
})?;
let mut object = client
.get_object()
.bucket(opt.bucket)
.key(opt.object)
.send()
.await?;
let mut byte_count = 0_usize;
while let Some(bytes) = object.body.try_next().await.map_err(|err| {
S3ExampleError::new(format!("Failed to read from S3 download stream: {err:?}"))
})? {
let bytes_len = bytes.len();
file.write_all(&bytes).map_err(|err| {
S3ExampleError::new(format!(
"Failed to write from S3 download stream to local file: {err:?}"
))
})?;
trace!("Intermediate write of {bytes_len}");
byte_count += bytes_len;
}
Ok(byte_count)
}
```
+ 如需 API 詳細資訊，請參閱《適用於 Rust 的AWS SDK API 參考》**中的 [GetObject](https://docs.rs/aws-sdk-s3/latest/aws_sdk_s3/client/struct.Client.html#method.get_object)。
------
#### [ SAP ABAP ]
**適用於 SAP ABAP 的開發套件**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/s3#code-examples)中設定和執行。
```
TRY.
oo_result = lo_s3->getobject( " oo_result is returned for testing purposes. "
iv_bucket = iv_bucket_name
iv_key = iv_object_key ).
DATA(lv_object_data) = oo_result->get_body( ).
MESSAGE 'Object retrieved from S3 bucket.' TYPE 'I'.
CATCH /aws1/cx_s3_nosuchbucket.
MESSAGE 'Bucket does not exist.' TYPE 'E'.
CATCH /aws1/cx_s3_nosuchkey.
MESSAGE 'Object key does not exist.' TYPE 'E'.
ENDTRY.
```
+ 如需 API 詳細資訊，請參閱《適用於 SAP ABAP 的AWS SDK API 參考》**中的 [GetObject](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)。
------
#### [ Swift ]
**適用於 Swift 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/swift/example_code/s3/basics#code-examples)中設定和執行。
```
import AWSS3
public func downloadFile(bucket: String, key: String, to: String) async throws {
let fileUrl = URL(fileURLWithPath: to).appendingPathComponent(key)
let input = GetObjectInput(
bucket: bucket,
key: key
)
do {
let output = try await client.getObject(input: input)
guard let body = output.body else {
throw HandlerError.getObjectBody("GetObjectInput missing body.")
}
guard let data = try await body.readData() else {
throw HandlerError.readGetObjectBody("GetObjectInput unable to read data.")
}
try data.write(to: fileUrl)
}
catch {
print("ERROR: ", dump(error, name: "Downloading a file."))
throw error
}
}
```
```
import AWSS3
public func readFile(bucket: String, key: String) async throws -> Data {
let input = GetObjectInput(
bucket: bucket,
key: key
)
do {
let output = try await client.getObject(input: input)
guard let body = output.body else {
throw HandlerError.getObjectBody("GetObjectInput missing body.")
}
guard let data = try await body.readData() else {
throw HandlerError.readGetObjectBody("GetObjectInput unable to read data.")
}
return data
}
catch {
print("ERROR: ", dump(error, name: "Reading a file."))
throw error
}
}
```
+ 如需 API 詳細資訊，請參閱 *《適用於 Swift 的AWS SDK API 參考》*中的 [GetObject](https://sdk.amazonaws.com/swift/api/awss3/latest/documentation/awss3/s3client/getobject(input:))。
------
# `GetObjectAcl` 搭配 AWS SDK 或 CLI 使用
下列程式碼範例示範如何使用 `GetObjectAcl`。
動作範例是大型程式的程式碼摘錄，必須在內容中執行。您可以在下列程式碼範例的內容中看到此動作：
+ [管理存取控制清單 (ACL)](s3_example_s3_Scenario_ManageACLs_section.md)
------
#### [ C\$1\$1 ]
**SDK for C\$1\$1**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/s3#code-examples)中設定和執行。
```
bool AwsDoc::S3::getObjectAcl(const Aws::String &bucketName,
const Aws::String &objectKey,
const Aws::S3::S3ClientConfiguration &clientConfig) {
Aws::S3::S3Client s3Client(clientConfig);
Aws::S3::Model::GetObjectAclRequest request;
request.SetBucket(bucketName);
request.SetKey(objectKey);
Aws::S3::Model::GetObjectAclOutcome outcome =
s3Client.GetObjectAcl(request);
if (!outcome.IsSuccess()) {
const Aws::S3::S3Error &err = outcome.GetError();
std::cerr << "Error: getObjectAcl: "
<< err.GetExceptionName() << ": " << err.GetMessage() << std::endl;
} else {
Aws::Vector grants =
outcome.GetResult().GetGrants();
for (auto it = grants.begin(); it != grants.end(); it++) {
std::cout << "For object " << objectKey << ": "
<< std::endl << std::endl;
Aws::S3::Model::Grant grant = *it;
Aws::S3::Model::Grantee grantee = grant.GetGrantee();
if (grantee.TypeHasBeenSet()) {
std::cout << "Type: "
<< getGranteeTypeString(grantee.GetType()) << std::endl;
}
if (grantee.DisplayNameHasBeenSet()) {
std::cout << "Display name: "
<< grantee.GetDisplayName() << std::endl;
}
if (grantee.EmailAddressHasBeenSet()) {
std::cout << "Email address: "
<< grantee.GetEmailAddress() << std::endl;
}
if (grantee.IDHasBeenSet()) {
std::cout << "ID: "
<< grantee.GetID() << std::endl;
}
if (grantee.URIHasBeenSet()) {
std::cout << "URI: "
<< grantee.GetURI() << std::endl;
}
std::cout << "Permission: " <<
getPermissionString(grant.GetPermission()) <<
std::endl << std::endl;
}
}
return outcome.IsSuccess();
}
//! Routine which converts a built-in type enumeration to a human-readable string.
/*!
\param type: Type enumeration.
\return String: Human-readable string
*/
Aws::String getGranteeTypeString(const Aws::S3::Model::Type &type) {
switch (type) {
case Aws::S3::Model::Type::AmazonCustomerByEmail:
return "Email address of an AWS account";
case Aws::S3::Model::Type::CanonicalUser:
return "Canonical user ID of an AWS account";
case Aws::S3::Model::Type::Group:
return "Predefined Amazon S3 group";
case Aws::S3::Model::Type::NOT_SET:
return "Not set";
default:
return "Type unknown";
}
}
//! Routine which converts a built-in type enumeration to a human-readable string.
/*!
\param permission: Permission enumeration.
\return String: Human-readable string
*/
Aws::String getPermissionString(const Aws::S3::Model::Permission &permission) {
switch (permission) {
case Aws::S3::Model::Permission::FULL_CONTROL:
return "Can read this object's data and its metadata, "
"and read/write this object's permissions";
case Aws::S3::Model::Permission::NOT_SET:
return "Permission not set";
case Aws::S3::Model::Permission::READ:
return "Can read this object's data and its metadata";
case Aws::S3::Model::Permission::READ_ACP:
return "Can read this object's permissions";
// case Aws::S3::Model::Permission::WRITE // Not applicable.
case Aws::S3::Model::Permission::WRITE_ACP:
return "Can write this object's permissions";
default:
return "Permission unknown";
}
}
```
+ 如需 API 詳細資訊，請參閱*《適用於 C\$1\$1 的 AWS SDK API 參考》*中的 [GetObjectAcl](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/GetObjectAcl)。
------
#### [ CLI ]
**AWS CLI**
下列命令會擷取名為 `amzn-s3-demo-bucket` 之儲存貯體中物件的存取控制清單：
```
aws s3api get-object-acl --bucket amzn-s3-demo-bucket --key index.html
```
輸出：
```
{
"Owner": {
"DisplayName": "my-username",
"ID": "7009a8971cd538e11f6b6606438875e7c86c5b672f46db45460ddcd087d36c32"
},
"Grants": [
{
"Grantee": {
"DisplayName": "my-username",
"ID": "7009a8971cd538e11f6b6606438875e7c86c5b672f46db45460ddcd087d36c32"
},
"Permission": "FULL_CONTROL"
},
{
"Grantee": {
"URI": "http://acs.amazonaws.com/groups/global/AllUsers"
},
"Permission": "READ"
}
]
}
```
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [GetObjectAcl](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3api/get-object-acl.html)。
------
#### [ Kotlin ]
**適用於 Kotlin 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/s3#code-examples)中設定和執行。
```
suspend fun getBucketACL(
objectKey: String,
bucketName: String,
) {
val request =
GetObjectAclRequest {
bucket = bucketName
key = objectKey
}
S3Client.fromEnvironment { region = "us-east-1" }.use { s3 ->
val response = s3.getObjectAcl(request)
response.grants?.forEach { grant ->
println("Grant permission is ${grant.permission}")
}
}
}
```
+ 如需 API 詳細資訊，請參閱《適用於 Kotlin 的AWS SDK API 參考》**中的 [GetObjectAcl](https://sdk.amazonaws.com/kotlin/api/latest/index.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V5**
**範例 1： 命令會取得 S3 物件之物件擁有者的詳細資訊。**
```
(Get-S3ObjectACL -BucketName 'amzn-s3-demo-bucket' -key 'initialize.ps1' -Select *).Owner
```
**輸出：**
```
DisplayName Id
----------- --
testusername 9988776a6554433d22f1100112e334acb45566778899009e9887bd7f66c5f544
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [GetObjectAcl](https://docs.aws.amazon.com/powershell/v5/reference)。
------
#### [ Python ]
**適用於 Python 的 SDK (Boto3)**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/s3/s3_basics#code-examples)中設定和執行。
```
class ObjectWrapper:
"""Encapsulates S3 object actions."""
def __init__(self, s3_object):
"""
:param s3_object: A Boto3 Object resource. This is a high-level resource in Boto3
that wraps object actions in a class-like structure.
"""
self.object = s3_object
self.key = self.object.key
def get_acl(self):
"""
Gets the ACL of the object.
:return: The ACL of the object.
"""
try:
acl = self.object.Acl()
logger.info(
"Got ACL for object %s owned by %s.",
self.object.key,
acl.owner["DisplayName"],
)
except ClientError:
logger.exception("Couldn't get ACL for object %s.", self.object.key)
raise
else:
return acl
```
+ 如需 API 詳細資訊，請參閱*《適用於 Python (Boto3) 的AWS SDK API 參考》*中的 [GetObjectAcl](https://docs.aws.amazon.com/goto/boto3/s3-2006-03-01/GetObjectAcl)。
------
#### [ SAP ABAP ]
**適用於 SAP ABAP 的開發套件**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/s3#code-examples)中設定和執行。
```
TRY.
oo_result = lo_s3->getobjectacl( " oo_result is returned for testing purposes. "
iv_bucket = iv_bucket_name
iv_key = iv_object_key ).
MESSAGE 'Retrieved object ACL.' TYPE 'I'.
CATCH /aws1/cx_s3_nosuchbucket.
MESSAGE 'Bucket does not exist.' TYPE 'E'.
CATCH /aws1/cx_s3_nosuchkey.
MESSAGE 'Object key does not exist.' TYPE 'E'.
ENDTRY.
```
+ 如需 API 詳細資訊，請參閱《適用於 *AWS SAP ABAP 的 SDK API 參考*》中的 [GetObjectAcl](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)。
------
# `GetObjectAttributes` 搭配 AWS SDK 或 CLI 使用
下列程式碼範例示範如何使用 `GetObjectAttributes`。
動作範例是大型程式的程式碼摘錄，必須在內容中執行。您可以在下列程式碼範例的內容中看到此動作：
+ [使用 Amazon S3 物件完整性](s3_example_s3_Scenario_ObjectIntegrity_section.md)
------
#### [ C\$1\$1 ]
**SDK for C\$1\$1**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/s3#code-examples)中設定和執行。
```
// ! Routine which retrieves the hash value of an object stored in an S3 bucket.
/*!
\param bucket: The name of the S3 bucket where the object is stored.
\param key: The unique identifier (key) of the object within the S3 bucket.
\param hashMethod: The hashing algorithm used to calculate the hash value of the object.
\param[out] hashData: The retrieved hash.
\param[out] partHashes: The part hashes if available.
\param client: The S3 client instance used to retrieve the object.
\return bool: Function succeeded.
*/
bool AwsDoc::S3::retrieveObjectHash(const Aws::String &bucket, const Aws::String &key,
AwsDoc::S3::HASH_METHOD hashMethod,
Aws::String &hashData,
std::vector *partHashes,
const Aws::S3::S3Client &client) {
Aws::S3::Model::GetObjectAttributesRequest request;
request.SetBucket(bucket);
request.SetKey(key);
if (hashMethod == MD5) {
Aws::Vector attributes;
attributes.push_back(Aws::S3::Model::ObjectAttributes::ETag);
request.SetObjectAttributes(attributes);
Aws::S3::Model::GetObjectAttributesOutcome outcome = client.GetObjectAttributes(
request);
if (outcome.IsSuccess()) {
const Aws::S3::Model::GetObjectAttributesResult &result = outcome.GetResult();
hashData = result.GetETag();
} else {
std::cerr << "Error retrieving object etag attributes." <<
outcome.GetError().GetMessage() << std::endl;
return false;
}
} else { // hashMethod != MD5
Aws::Vector attributes;
attributes.push_back(Aws::S3::Model::ObjectAttributes::Checksum);
request.SetObjectAttributes(attributes);
Aws::S3::Model::GetObjectAttributesOutcome outcome = client.GetObjectAttributes(
request);
if (outcome.IsSuccess()) {
const Aws::S3::Model::GetObjectAttributesResult &result = outcome.GetResult();
switch (hashMethod) {
case AwsDoc::S3::DEFAULT: // NOLINT(*-branch-clone)
break; // Default is not supported.
#pragma clang diagnostic push
#pragma ide diagnostic ignored "UnreachableCode"
case AwsDoc::S3::MD5:
break; // MD5 is not supported.
#pragma clang diagnostic pop
case AwsDoc::S3::SHA1:
hashData = result.GetChecksum().GetChecksumSHA1();
break;
case AwsDoc::S3::SHA256:
hashData = result.GetChecksum().GetChecksumSHA256();
break;
case AwsDoc::S3::CRC32:
hashData = result.GetChecksum().GetChecksumCRC32();
break;
case AwsDoc::S3::CRC32C:
hashData = result.GetChecksum().GetChecksumCRC32C();
break;
default:
std::cerr << "Unknown hash method." << std::endl;
return false;
}
} else {
std::cerr << "Error retrieving object checksum attributes." <<
outcome.GetError().GetMessage() << std::endl;
return false;
}
if (nullptr != partHashes) {
attributes.clear();
attributes.push_back(Aws::S3::Model::ObjectAttributes::ObjectParts);
request.SetObjectAttributes(attributes);
outcome = client.GetObjectAttributes(request);
if (outcome.IsSuccess()) {
const Aws::S3::Model::GetObjectAttributesResult &result = outcome.GetResult();
const Aws::Vector parts = result.GetObjectParts().GetParts();
for (const Aws::S3::Model::ObjectPart &part: parts) {
switch (hashMethod) {
case AwsDoc::S3::DEFAULT: // Default is not supported. NOLINT(*-branch-clone)
break;
case AwsDoc::S3::MD5: // MD5 is not supported.
break;
case AwsDoc::S3::SHA1:
partHashes->push_back(part.GetChecksumSHA1());
break;
case AwsDoc::S3::SHA256:
partHashes->push_back(part.GetChecksumSHA256());
break;
case AwsDoc::S3::CRC32:
partHashes->push_back(part.GetChecksumCRC32());
break;
case AwsDoc::S3::CRC32C:
partHashes->push_back(part.GetChecksumCRC32C());
break;
default:
std::cerr << "Unknown hash method." << std::endl;
return false;
}
}
} else {
std::cerr << "Error retrieving object attributes for object parts." <<
outcome.GetError().GetMessage() << std::endl;
return false;
}
}
}
return true;
}
```
+ 如需 API 詳細資訊，請參閱《適用於 C\$1\$1 的 AWS SDK API 參考》**中的 [GetObjectAttributes](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/GetObjectAttributes)。
------
#### [ CLI ]
**AWS CLI**
**從物件擷取中繼資料而不傳回物件本身**
下列 `get-object-attributes` 範例會從物件 `doc1.rtf` 擷取中繼資料。
```
aws s3api get-object-attributes \
--bucket amzn-s3-demo-bucket \
--key doc1.rtf \
--object-attributes "StorageClass" "ETag" "ObjectSize"
```
輸出：
```
{
"LastModified": "2022-03-15T19:37:31+00:00",
"VersionId": "IuCPjXTDzHNfldAuitVBIKJpF2p1fg4P",
"ETag": "b662d79adeb7c8d787ea7eafb9ef6207",
"StorageClass": "STANDARD",
"ObjectSize": 405
}
```
如需詳細資訊，請參閱《Amazon S3 API 參考》中的 [GetObjectAttributes](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html)。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [GetObjectAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3api/get-object-attributes.html)。
------
# `GetObjectLegalHold` 搭配 AWS SDK 或 CLI 使用
下列程式碼範例示範如何使用 `GetObjectLegalHold`。
動作範例是大型程式的程式碼摘錄，必須在內容中執行。您可以在下列程式碼範例的內容中看到此動作：
+ [鎖定 Amazon S3 物件](s3_example_s3_Scenario_ObjectLock_section.md)
------
#### [ .NET ]
**適用於 .NET 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/S3/scenarios/S3ObjectLockScenario#code-examples)中設定和執行。
```
///
/// Get the legal hold details for an S3 object.
///
/// The bucket of the object.
/// The object key.
/// The object legal hold details.
public async Task GetObjectLegalHold(string bucketName,
string objectKey)
{
try
{
var request = new GetObjectLegalHoldRequest()
{
BucketName = bucketName,
Key = objectKey
};
var response = await _amazonS3.GetObjectLegalHoldAsync(request);
Console.WriteLine($"\tObject legal hold for {objectKey} in {bucketName}: " +
$"\n\tStatus: {response.LegalHold.Status}");
return response.LegalHold;
}
catch (AmazonS3Exception ex)
{
Console.WriteLine($"\tUnable to fetch legal hold: '{ex.Message}'");
return new ObjectLockLegalHold();
}
}
```
+ 如需 API 詳細資訊，請參閱《適用於 .NET 的 AWS SDK API 參考》**中的 [GetObjectLegalHold](https://docs.aws.amazon.com/goto/DotNetSDKV3/s3-2006-03-01/GetObjectLegalHold)。
------
#### [ CLI ]
**AWS CLI**
**擷取物件的法務保存狀態**
下列 `get-object-legal-hold` 範例會擷取指定物件的法務保存狀態。
```
aws s3api get-object-legal-hold \
--bucket amzn-s3-demo-bucket-with-object-lock \
--key doc1.rtf
```
輸出：
```
{
"LegalHold": {
"Status": "ON"
}
}
```
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [GetObjectLegalHold](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3api/get-object-legal-hold.html)。
------
#### [ Go ]
**SDK for Go V2**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/gov2/workflows/s3_object_lock#code-examples)中設定和執行。
```
import (
"bytes"
"context"
"errors"
"fmt"
"log"
"time"
"github.com/aws/aws-sdk-go-v2/aws"
"github.com/aws/aws-sdk-go-v2/feature/s3/manager"
"github.com/aws/aws-sdk-go-v2/service/s3"
"github.com/aws/aws-sdk-go-v2/service/s3/types"
"github.com/aws/smithy-go"
)
// S3Actions wraps S3 service actions.
type S3Actions struct {
S3Client *s3.Client
S3Manager *manager.Uploader
}
// GetObjectLegalHold retrieves the legal hold status for an S3 object.
func (actor S3Actions) GetObjectLegalHold(ctx context.Context, bucket string, key string, versionId string) (*types.ObjectLockLegalHoldStatus, error) {
var status *types.ObjectLockLegalHoldStatus
input := &s3.GetObjectLegalHoldInput{
Bucket: aws.String(bucket),
Key: aws.String(key),
VersionId: aws.String(versionId),
}
output, err := actor.S3Client.GetObjectLegalHold(ctx, input)
if err != nil {
var noSuchKeyErr *types.NoSuchKey
var apiErr *smithy.GenericAPIError
if errors.As(err, &noSuchKeyErr) {
log.Printf("Object %s does not exist in bucket %s.\n", key, bucket)
err = noSuchKeyErr
} else if errors.As(err, &apiErr) {
switch apiErr.ErrorCode() {
case "NoSuchObjectLockConfiguration":
log.Printf("Object %s does not have an object lock configuration.\n", key)
err = nil
case "InvalidRequest":
log.Printf("Bucket %s does not have an object lock configuration.\n", bucket)
err = nil
}
}
} else {
status = &output.LegalHold.Status
}
return status, err
}
```
+ 如需 API 詳細資訊，請參閱《適用於 Go 的 AWS SDK API 參考》**中的 [GetObjectLegalHold](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/s3#Client.GetObjectLegalHold)。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/s3#code-examples)中設定和執行。
```
// Get the legal hold details for an S3 object.
public ObjectLockLegalHold getObjectLegalHold(String bucketName, String objectKey) {
try {
GetObjectLegalHoldRequest legalHoldRequest = GetObjectLegalHoldRequest.builder()
.bucket(bucketName)
.key(objectKey)
.build();
GetObjectLegalHoldResponse response = getClient().getObjectLegalHold(legalHoldRequest);
System.out.println("Object legal hold for " + objectKey + " in " + bucketName +
":\n\tStatus: " + response.legalHold().status());
return response.legalHold();
} catch (S3Exception ex) {
System.out.println("\tUnable to fetch legal hold: '" + ex.getMessage() + "'");
}
return null;
}
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Java 2.x API 參考》**中的 [GetObjectLegalHold](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/GetObjectLegalHold)。
------
#### [ JavaScript ]
**適用於 JavaScript (v3) 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/s3#code-examples)中設定和執行。
```
import {
GetObjectLegalHoldCommand,
S3Client,
S3ServiceException,
} from "@aws-sdk/client-s3";
/**
* Get an object's current legal hold status.
* @param {{ bucketName: string, key: string }}
*/
export const main = async ({ bucketName, key }) => {
const client = new S3Client({});
try {
const response = await client.send(
new GetObjectLegalHoldCommand({
Bucket: bucketName,
Key: key,
// Optionally, you can provide additional parameters
// ExpectedBucketOwner: "",
// VersionId: "",
}),
);
console.log(`Legal Hold Status: ${response.LegalHold.Status}`);
} catch (caught) {
if (
caught instanceof S3ServiceException &&
caught.name === "NoSuchBucket"
) {
console.error(
`Error from S3 while getting legal hold status for ${key} in ${bucketName}. The bucket doesn't exist.`,
);
} else if (caught instanceof S3ServiceException) {
console.error(
`Error from S3 while getting legal hold status for ${key} in ${bucketName} from ${bucketName}. ${caught.name}: ${caught.message}`,
);
} else {
throw caught;
}
}
};
// Call function if run directly
import { parseArgs } from "node:util";
import {
isMain,
validateArgs,
} from "@aws-doc-sdk-examples/lib/utils/util-node.js";
const loadArgs = () => {
const options = {
bucketName: {
type: "string",
required: true,
},
key: {
type: "string",
required: true,
},
};
const results = parseArgs({ options });
const { errors } = validateArgs({ options }, results);
return { errors, results };
};
if (isMain(import.meta.url)) {
const { errors, results } = loadArgs();
if (!errors) {
main(results.values);
} else {
console.error(errors.join("\n"));
}
}
```
+ 如需 API 詳細資訊，請參閱《適用於 JavaScript 的 AWS SDK API 參考》**中的 [GetObjectLegalHold](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/s3/command/GetObjectLegalHoldCommand)。
------
#### [ Python ]
**適用於 Python 的 SDK (Boto3)**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/s3/scenarios/object-locking#code-examples)中設定和執行。
放置物件法務保存。
```
def get_legal_hold(s3_client, bucket: str, key: str) -> None:
"""
Get the legal hold status of a specific file in a bucket.
Args:
s3_client: Boto3 S3 client.
bucket: The name of the bucket containing the file.
key: The key of the file to get the legal hold status of.
"""
print()
logger.info("Getting legal hold status of file [%s] in bucket [%s]", key, bucket)
try:
response = s3_client.get_object_legal_hold(Bucket=bucket, Key=key)
legal_hold_status = response["LegalHold"]["Status"]
logger.debug(
"Legal hold status of file [%s] in bucket [%s] is [%s]",
key,
bucket,
legal_hold_status,
)
except Exception as e:
logger.error(
"Failed to get legal hold status of file [%s] in bucket [%s]: %s",
key,
bucket,
e,
)
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Python (Boto3) API 參考》**中的 [GetObjectLegalHold](https://docs.aws.amazon.com/goto/boto3/s3-2006-03-01/GetObjectLegalHold)。
------
#### [ SAP ABAP ]
**適用於 SAP ABAP 的開發套件**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/s3#code-examples)中設定和執行。
```
TRY.
oo_result = lo_s3->getobjectlegalhold( " oo_result is returned for testing purposes. "
iv_bucket = iv_bucket_name
iv_key = iv_object_key ).
MESSAGE 'Retrieved object legal hold status.' TYPE 'I'.
CATCH /aws1/cx_s3_nosuchbucket.
MESSAGE 'Bucket does not exist.' TYPE 'E'.
CATCH /aws1/cx_s3_nosuchkey.
MESSAGE 'Object key does not exist.' TYPE 'E'.
ENDTRY.
```
+ 如需 API 詳細資訊，請參閱《適用於 *AWS SAP ABAP 的 SDK API 參考*》中的 [GetObjectLegalHold](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)。
------
# `GetObjectLockConfiguration` 搭配 AWS SDK 或 CLI 使用
下列程式碼範例示範如何使用 `GetObjectLockConfiguration`。
動作範例是大型程式的程式碼摘錄，必須在內容中執行。您可以在下列程式碼範例的內容中看到此動作：
+ [鎖定 Amazon S3 物件](s3_example_s3_Scenario_ObjectLock_section.md)
------
#### [ .NET ]
**適用於 .NET 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/S3/scenarios/S3ObjectLockScenario#code-examples)中設定和執行。
```
///
/// Get the object lock configuration details for an S3 bucket.
///
/// The bucket to get details.
/// The bucket's object lock configuration details.
public async Task GetBucketObjectLockConfiguration(string bucketName)
{
try
{
var request = new GetObjectLockConfigurationRequest()
{
BucketName = bucketName
};
var response = await _amazonS3.GetObjectLockConfigurationAsync(request);
Console.WriteLine($"\tBucket object lock config for {bucketName} in {bucketName}: " +
$"\n\tEnabled: {response.ObjectLockConfiguration.ObjectLockEnabled}" +
$"\n\tRule: {response.ObjectLockConfiguration.Rule?.DefaultRetention}");
return response.ObjectLockConfiguration;
}
catch (AmazonS3Exception ex)
{
Console.WriteLine($"\tUnable to fetch object lock config: '{ex.Message}'");
return new ObjectLockConfiguration();
}
}
```
+ 如需 API 詳細資訊，請參閱《適用於 .NET 的 AWS SDK API 參考》**中的 [GetObjectLockConfiguration](https://docs.aws.amazon.com/goto/DotNetSDKV3/s3-2006-03-01/GetObjectLockConfiguration)。
------
#### [ CLI ]
**AWS CLI**
**擷取儲存貯體的物件鎖定組態**
下列 `get-object-lock-configuration` 範例會擷取指定儲存貯體的物件鎖定組態。
```
aws s3api get-object-lock-configuration \
--bucket amzn-s3-demo-bucket-with-object-lock
```
輸出：
```
{
"ObjectLockConfiguration": {
"ObjectLockEnabled": "Enabled",
"Rule": {
"DefaultRetention": {
"Mode": "COMPLIANCE",
"Days": 50
}
}
}
}
```
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [GetObjectLockConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3api/get-object-lock-configuration.html)。
------
#### [ Go ]
**SDK for Go V2**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/gov2/workflows/s3_object_lock#code-examples)中設定和執行。
```
import (
"bytes"
"context"
"errors"
"fmt"
"log"
"time"
"github.com/aws/aws-sdk-go-v2/aws"
"github.com/aws/aws-sdk-go-v2/feature/s3/manager"
"github.com/aws/aws-sdk-go-v2/service/s3"
"github.com/aws/aws-sdk-go-v2/service/s3/types"
"github.com/aws/smithy-go"
)
// S3Actions wraps S3 service actions.
type S3Actions struct {
S3Client *s3.Client
S3Manager *manager.Uploader
}
// GetObjectLockConfiguration retrieves the object lock configuration for an S3 bucket.
func (actor S3Actions) GetObjectLockConfiguration(ctx context.Context, bucket string) (*types.ObjectLockConfiguration, error) {
var lockConfig *types.ObjectLockConfiguration
input := &s3.GetObjectLockConfigurationInput{
Bucket: aws.String(bucket),
}
output, err := actor.S3Client.GetObjectLockConfiguration(ctx, input)
if err != nil {
var noBucket *types.NoSuchBucket
var apiErr *smithy.GenericAPIError
if errors.As(err, &noBucket) {
log.Printf("Bucket %s does not exist.\n", bucket)
err = noBucket
} else if errors.As(err, &apiErr) && apiErr.ErrorCode() == "ObjectLockConfigurationNotFoundError" {
log.Printf("Bucket %s does not have an object lock configuration.\n", bucket)
err = nil
}
} else {
lockConfig = output.ObjectLockConfiguration
}
return lockConfig, err
}
```
+ 如需 API 詳細資訊，請參閱《適用於 Go 的 AWS SDK API 參考》**中的 [GetObjectLockConfiguration](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/s3#Client.GetObjectLockConfiguration)。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/s3#code-examples)中設定和執行。
```
// Get the object lock configuration details for an S3 bucket.
public void getBucketObjectLockConfiguration(String bucketName) {
GetObjectLockConfigurationRequest objectLockConfigurationRequest = GetObjectLockConfigurationRequest.builder()
.bucket(bucketName)
.build();
GetObjectLockConfigurationResponse response = getClient().getObjectLockConfiguration(objectLockConfigurationRequest);
System.out.println("Bucket object lock config for "+bucketName +": ");
System.out.println("\tEnabled: "+response.objectLockConfiguration().objectLockEnabled());
System.out.println("\tRule: "+ response.objectLockConfiguration().rule().defaultRetention());
}
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Java 2.x API 參考》**中的 [GetObjectLockConfiguration](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/GetObjectLockConfiguration)。
------
#### [ JavaScript ]
**適用於 JavaScript (v3) 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/s3#code-examples)中設定和執行。
```
import {
GetObjectLockConfigurationCommand,
S3Client,
S3ServiceException,
} from "@aws-sdk/client-s3";
/**
* Gets the Object Lock configuration for a bucket.
* @param {{ bucketName: string }}
*/
export const main = async ({ bucketName }) => {
const client = new S3Client({});
try {
const { ObjectLockConfiguration } = await client.send(
new GetObjectLockConfigurationCommand({
Bucket: bucketName,
// Optionally, you can provide additional parameters
// ExpectedBucketOwner: "",
}),
);
console.log(
`Object Lock Configuration:\n${JSON.stringify(ObjectLockConfiguration)}`,
);
} catch (caught) {
if (
caught instanceof S3ServiceException &&
caught.name === "NoSuchBucket"
) {
console.error(
`Error from S3 while getting object lock configuration for ${bucketName}. The bucket doesn't exist.`,
);
} else if (caught instanceof S3ServiceException) {
console.error(
`Error from S3 while getting object lock configuration for ${bucketName}. ${caught.name}: ${caught.message}`,
);
} else {
throw caught;
}
}
};
// Call function if run directly
import { parseArgs } from "node:util";
import {
isMain,
validateArgs,
} from "@aws-doc-sdk-examples/lib/utils/util-node.js";
const loadArgs = () => {
const options = {
bucketName: {
type: "string",
required: true,
},
};
const results = parseArgs({ options });
const { errors } = validateArgs({ options }, results);
return { errors, results };
};
if (isMain(import.meta.url)) {
const { errors, results } = loadArgs();
if (!errors) {
main(results.values);
} else {
console.error(errors.join("\n"));
}
}
```
+ 如需 API 詳細資訊，請參閱《適用於 JavaScript 的 AWS SDK API 參考》**中的 [GetObjectLockConfiguration](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/s3/command/GetObjectLockConfigurationCommand)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：如果為給定的 S3 儲存貯體啟用物件鎖定組態，此命令會傳回值 'Enabled'。**
```
Get-S3ObjectLockConfiguration -BucketName 'amzn-s3-demo-bucket' -Select ObjectLockConfiguration.ObjectLockEnabled
```
**輸出：**
```
Value
-----
Enabled
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [GetObjectLockConfiguration](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：如果為給定的 S3 儲存貯體啟用物件鎖定組態，此命令會傳回值 'Enabled'**。
```
Get-S3ObjectLockConfiguration -BucketName 'amzn-s3-demo-bucket' -Select ObjectLockConfiguration.ObjectLockEnabled
```
**輸出：**
```
Value
-----
Enabled
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [GetObjectLockConfiguration](https://docs.aws.amazon.com/powershell/v5/reference)。
------
#### [ Python ]
**適用於 Python 的 SDK (Boto3)**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/s3/scenarios/object-locking#code-examples)中設定和執行。
取得物件鎖定組態。
```
def is_object_lock_enabled(s3_client, bucket: str) -> bool:
"""
Check if object lock is enabled for a bucket.
Args:
s3_client: Boto3 S3 client.
bucket: The name of the bucket to check.
Returns:
True if object lock is enabled, False otherwise.
"""
try:
response = s3_client.get_object_lock_configuration(Bucket=bucket)
return (
"ObjectLockConfiguration" in response
and response["ObjectLockConfiguration"]["ObjectLockEnabled"] == "Enabled"
)
except s3_client.exceptions.ClientError as e:
if e.response["Error"]["Code"] == "ObjectLockConfigurationNotFoundError":
return False
else:
raise
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Python (Boto3) API 參考》**中的 [GetObjectLockConfiguration](https://docs.aws.amazon.com/goto/boto3/s3-2006-03-01/GetObjectLockConfiguration)。
------
#### [ SAP ABAP ]
**適用於 SAP ABAP 的開發套件**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/s3#code-examples)中設定和執行。
```
TRY.
oo_result = lo_s3->getobjectlockconfiguration( " oo_result is returned for testing purposes. "
iv_bucket = iv_bucket_name ).
MESSAGE 'Retrieved object lock configuration.' TYPE 'I'.
CATCH /aws1/cx_s3_nosuchbucket.
MESSAGE 'Bucket does not exist.' TYPE 'E'.
ENDTRY.
```
+ 如需 API 詳細資訊，請參閱《適用於 *AWS SAP ABAP 的 SDK API 參考*》中的 [GetObjectLockConfiguration](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)。
------
# `GetObjectRetention` 搭配 AWS SDK 或 CLI 使用
下列程式碼範例示範如何使用 `GetObjectRetention`。
動作範例是大型程式的程式碼摘錄，必須在內容中執行。您可以在下列程式碼範例的內容中看到此動作：
+ [鎖定 Amazon S3 物件](s3_example_s3_Scenario_ObjectLock_section.md)
------
#### [ .NET ]
**適用於 .NET 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/S3/scenarios/S3ObjectLockScenario#code-examples)中設定和執行。
```
///
/// Get the retention period for an S3 object.
///
/// The bucket of the object.
/// The object key.
/// The object retention details.
public async Task GetObjectRetention(string bucketName,
string objectKey)
{
try
{
var request = new GetObjectRetentionRequest()
{
BucketName = bucketName,
Key = objectKey
};
var response = await _amazonS3.GetObjectRetentionAsync(request);
Console.WriteLine($"\tObject retention for {objectKey} in {bucketName}: " +
$"\n\t{response.Retention.Mode} until {response.Retention.RetainUntilDate:d}.");
return response.Retention;
}
catch (AmazonS3Exception ex)
{
Console.WriteLine($"\tUnable to fetch object lock retention: '{ex.Message}'");
return new ObjectLockRetention();
}
}
```
+ 如需 API 詳細資訊，請參閱《*適用於 .NET 的 AWS SDK API 參考*》中的 [GetObjectRetention](https://docs.aws.amazon.com/goto/DotNetSDKV3/s3-2006-03-01/GetObjectRetention)。
------
#### [ CLI ]
**AWS CLI**
**擷取物件的物件保留組態**
下列 `get-object-retention` 範例會擷取指定物件的物件保留組態。
```
aws s3api get-object-retention \
--bucket amzn-s3-demo-bucket-with-object-lock \
--key doc1.rtf
```
輸出：
```
{
"Retention": {
"Mode": "GOVERNANCE",
"RetainUntilDate": "2025-01-01T00:00:00.000Z"
}
}
```
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [GetObjectRetention](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3api/get-object-retention.html)。
------
#### [ Go ]
**SDK for Go V2**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/gov2/workflows/s3_object_lock#code-examples)中設定和執行。
```
import (
"bytes"
"context"
"errors"
"fmt"
"log"
"time"
"github.com/aws/aws-sdk-go-v2/aws"
"github.com/aws/aws-sdk-go-v2/feature/s3/manager"
"github.com/aws/aws-sdk-go-v2/service/s3"
"github.com/aws/aws-sdk-go-v2/service/s3/types"
"github.com/aws/smithy-go"
)
// S3Actions wraps S3 service actions.
type S3Actions struct {
S3Client *s3.Client
S3Manager *manager.Uploader
}
// GetObjectRetention retrieves the object retention configuration for an S3 object.
func (actor S3Actions) GetObjectRetention(ctx context.Context, bucket string, key string) (*types.ObjectLockRetention, error) {
var retention *types.ObjectLockRetention
input := &s3.GetObjectRetentionInput{
Bucket: aws.String(bucket),
Key: aws.String(key),
}
output, err := actor.S3Client.GetObjectRetention(ctx, input)
if err != nil {
var noKey *types.NoSuchKey
var apiErr *smithy.GenericAPIError
if errors.As(err, &noKey) {
log.Printf("Object %s does not exist in bucket %s.\n", key, bucket)
err = noKey
} else if errors.As(err, &apiErr) {
switch apiErr.ErrorCode() {
case "NoSuchObjectLockConfiguration":
err = nil
case "InvalidRequest":
log.Printf("Bucket %s does not have locking enabled.", bucket)
err = nil
}
}
} else {
retention = output.Retention
}
return retention, err
}
```
+ 如需 API 詳細資訊，請參閱《*適用於 Go 的 AWS SDK API 參考*》中的 [GetObjectRetention](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/s3#Client.GetObjectRetention)。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/s3#code-examples)中設定和執行。
```
// Get the retention period for an S3 object.
public ObjectLockRetention getObjectRetention(String bucketName, String key){
try {
GetObjectRetentionRequest retentionRequest = GetObjectRetentionRequest.builder()
.bucket(bucketName)
.key(key)
.build();
GetObjectRetentionResponse response = getClient().getObjectRetention(retentionRequest);
System.out.println("tObject retention for "+key +" in "+ bucketName +": " + response.retention().mode() +" until "+ response.retention().retainUntilDate() +".");
return response.retention();
} catch (S3Exception e) {
System.err.println(e.awsErrorDetails().errorMessage());
return null;
}
}
```
+ 如需 API 詳細資訊，請參閱《*AWS SDK for Java 2.x API 參考*》中的 [GetObjectRetention](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/GetObjectRetention)。
------
#### [ JavaScript ]
**適用於 JavaScript (v3) 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/s3#code-examples)中設定和執行。
```
import {
GetObjectRetentionCommand,
S3Client,
S3ServiceException,
} from "@aws-sdk/client-s3";
/**
* Log the "RetainUntilDate" for an object in an S3 bucket.
* @param {{ bucketName: string, key: string }}
*/
export const main = async ({ bucketName, key }) => {
const client = new S3Client({});
try {
const { Retention } = await client.send(
new GetObjectRetentionCommand({
Bucket: bucketName,
Key: key,
}),
);
console.log(
`${key} in ${bucketName} will be retained until ${Retention.RetainUntilDate}`,
);
} catch (caught) {
if (
caught instanceof S3ServiceException &&
caught.name === "NoSuchObjectLockConfiguration"
) {
console.warn(
`The object "${key}" in the bucket "${bucketName}" does not have an ObjectLock configuration.`,
);
} else if (caught instanceof S3ServiceException) {
console.error(
`Error from S3 while getting object retention settings for "${bucketName}". ${caught.name}: ${caught.message}`,
);
} else {
throw caught;
}
}
};
// Call function if run directly
import { parseArgs } from "node:util";
import {
isMain,
validateArgs,
} from "@aws-doc-sdk-examples/lib/utils/util-node.js";
const loadArgs = () => {
const options = {
bucketName: {
type: "string",
required: true,
},
key: {
type: "string",
required: true,
},
};
const results = parseArgs({ options });
const { errors } = validateArgs({ options }, results);
return { errors, results };
};
if (isMain(import.meta.url)) {
const { errors, results } = loadArgs();
if (!errors) {
main(results.values);
} else {
console.error(errors.join("\n"));
}
}
```
+ 如需 API 詳細資訊，請參閱《*適用於 JavaScript 的 AWS SDK API 參考*》中的 [GetObjectRetention](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/s3/command/GetObjectRetentionCommand)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：命令會傳回模式和日期，直到保留物件為止。**
```
Get-S3ObjectRetention -BucketName 'amzn-s3-demo-bucket' -Key 'testfile.txt'
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [GetObjectRetention](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：命令會傳回模式和日期，直到保留物件為止。**
```
Get-S3ObjectRetention -BucketName 'amzn-s3-demo-bucket' -Key 'testfile.txt'
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [GetObjectRetention](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `GetObjectTagging` 與 CLI
下列程式碼範例示範如何使用 `GetObjectTagging`。
動作範例是大型程式的程式碼摘錄，必須在內容中執行。您可以在下列程式碼範例的內容中看到此動作：
+ [開始使用索引標籤](s3_example_s3_Scenario_Tagging_section.md)
------
#### [ CLI ]
**AWS CLI**
**擷取連接至物件的標籤**
下列 `get-object-tagging` 範例會從指定的物件擷取指定的索引鍵值。
```
aws s3api get-object-tagging \
--bucket amzn-s3-demo-bucket \
--key doc1.rtf
```
輸出：
```
{
"TagSet": [
{
"Value": "confidential",
"Key": "designation"
}
]
}
```
下列 `get-object-tagging` 範例會嘗試擷取沒有標籤之物件 `doc2.rtf` 的標籤集。
```
aws s3api get-object-tagging \
--bucket amzn-s3-demo-bucket \
--key doc2.rtf
```
輸出：
```
{
"TagSet": []
}
```
下列 `get-object-tagging` 範例會擷取具有多個標籤之物件 `doc3.rtf` 的標籤集。
```
aws s3api get-object-tagging \
--bucket amzn-s3-demo-bucket \
--key doc3.rtf
```
輸出：
```
{
"TagSet": [
{
"Value": "confidential",
"Key": "designation"
},
{
"Value": "finance",
"Key": "department"
},
{
"Value": "payroll",
"Key": "team"
}
]
}
```
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [GetObjectTagging](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3api/get-object-tagging.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：範例會傳回與給定 S3 儲存貯體上存在之物件相關聯的標籤。**
```
Get-S3ObjectTagSet -Key 'testfile.txt' -BucketName 'amzn-s3-demo-bucket'
```
**輸出：**
```
Key Value
--- -----
test value
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [GetObjectTagging](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：範例會傳回與給定 S3 儲存貯體上存在之物件相關聯的標籤。**
```
Get-S3ObjectTagSet -Key 'testfile.txt' -BucketName 'amzn-s3-demo-bucket'
```
**輸出：**
```
Key Value
--- -----
test value
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [GetObjectTagging](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `GetPublicAccessBlock` 與 CLI
下列程式碼範例示範如何使用 `GetPublicAccessBlock`。
------
#### [ CLI ]
**AWS CLI**
**設定或修改儲存貯體的封鎖公開存取組態**
下列 `get-public-access-block` 範例顯示指定儲存貯體的封鎖公開存取組態。
```
aws s3api get-public-access-block \
--bucket amzn-s3-demo-bucket
```
輸出：
```
{
"PublicAccessBlockConfiguration": {
"IgnorePublicAcls": true,
"BlockPublicPolicy": true,
"BlockPublicAcls": true,
"RestrictPublicBuckets": true
}
}
```
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [GetPublicAccessBlock](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3api/get-public-access-block.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1： 命令會傳回給定 S3 儲存貯體的公有存取區塊組態。**
```
Get-S3PublicAccessBlock -BucketName 'amzn-s3-demo-bucket'
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [GetPublicAccessBlock](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1： 命令會傳回給定 S3 儲存貯體的公有存取區塊組態。**
```
Get-S3PublicAccessBlock -BucketName 'amzn-s3-demo-bucket'
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [GetPublicAccessBlock](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# `HeadBucket` 搭配 AWS SDK 或 CLI 使用
下列程式碼範例示範如何使用 `HeadBucket`。
------
#### [ Bash ]
**AWS CLI 使用 Bash 指令碼**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/aws-cli/bash-linux/s3#code-examples)中設定和執行。
```
###############################################################################
# function bucket_exists
#
# This function checks to see if the specified bucket already exists.
#
# Parameters:
# $1 - The name of the bucket to check.
#
# Returns:
# 0 - If the bucket already exists.
# 1 - If the bucket doesn't exist.
###############################################################################
function bucket_exists() {
local bucket_name
bucket_name=$1
# Check whether the bucket already exists.
# We suppress all output - we're interested only in the return code.
if aws s3api head-bucket \
--bucket "$bucket_name" \
>/dev/null 2>&1; then
return 0 # 0 in Bash script means true.
else
return 1 # 1 in Bash script means false.
fi
}
```
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [HeadBucket](https://docs.aws.amazon.com/goto/aws-cli/s3-2006-03-01/HeadBucket)。
------
#### [ CLI ]
**AWS CLI**
下列命令會驗證對名為 `amzn-s3-demo-bucket` 之儲存貯體的存取：
```
aws s3api head-bucket --bucket amzn-s3-demo-bucket
```
如果儲存貯體存在，且您有其存取權，則不會傳回任何輸出。否則，會顯示錯誤訊息。例如：
```
A client error (404) occurred when calling the HeadBucket operation: Not Found
```
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [HeadBucket](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3api/head-bucket.html)。
------
#### [ Go ]
**SDK for Go V2**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/gov2/s3#code-examples)中設定和執行。
```
import (
"bytes"
"context"
"errors"
"fmt"
"io"
"log"
"os"
"time"
"github.com/aws/aws-sdk-go-v2/aws"
"github.com/aws/aws-sdk-go-v2/feature/s3/manager"
"github.com/aws/aws-sdk-go-v2/service/s3"
"github.com/aws/aws-sdk-go-v2/service/s3/types"
"github.com/aws/smithy-go"
)
// BucketBasics encapsulates the Amazon Simple Storage Service (Amazon S3) actions
// used in the examples.
// It contains S3Client, an Amazon S3 service client that is used to perform bucket
// and object actions.
type BucketBasics struct {
S3Client *s3.Client
}
// BucketExists checks whether a bucket exists in the current account.
func (basics BucketBasics) BucketExists(ctx context.Context, bucketName string) (bool, error) {
_, err := basics.S3Client.HeadBucket(ctx, &s3.HeadBucketInput{
Bucket: aws.String(bucketName),
})
exists := true
if err != nil {
var apiError smithy.APIError
if errors.As(err, &apiError) {
switch apiError.(type) {
case *types.NotFound:
log.Printf("Bucket %v is available.\n", bucketName)
exists = false
err = nil
default:
log.Printf("Either you don't have access to bucket %v or another error occurred. "+
"Here's what happened: %v\n", bucketName, err)
}
}
} else {
log.Printf("Bucket %v exists and you already own it.", bucketName)
}
return exists, err
}
```
+ 如需 API 詳細資訊，請參閱《適用於 Go 的 AWS SDK API 參考》**中的 [HeadBucket](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/s3#Client.HeadBucket)。
------
#### [ PowerShell ]
**Tools for PowerShell V5**
**範例 1：當使用者有權存取現有儲存貯體時，此命令會傳回 HTTP 狀態碼為 200 OK 的輸出。BucketArn 參數僅支援 S3 目錄儲存貯體。**
```
Get-S3HeadBucket -BucketName amzn-s3-demo-bucket
```
**輸出：**
```
AccessPointAlias : False
BucketArn :
BucketLocationName :
BucketLocationType :
BucketRegion : us-east-2
ResponseMetadata : Amazon.Runtime.ResponseMetadata
ContentLength : 0
HttpStatusCode : OK
```
**範例 2：此命令會針對不存在的儲存貯體擲回 HTTP 狀態碼 NotFound 的錯誤。**
```
Get-S3HeadBucket -BucketName amzn-s3-non-existing-bucket
```
**輸出：**
```
Get-S3HeadBucket: Error making request with Error Code NotFound and Http Status Code NotFound. No further error information was returned by the service.
```
**範例 3：對於使用者無權存取的現有儲存貯體，此命令會擲回 HTTP 狀態碼為 Forbidden (禁止) 的錯誤。**
```
Get-S3HeadBucket -BucketName amzn-s3-no-access-bucket
```
**輸出：**
```
Get-S3HeadBucket: Error making request with Error Code Forbidden and Http Status Code Forbidden. No further error information was returned by the service.
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [HeadBucket](https://docs.aws.amazon.com/powershell/v5/reference)。
------
#### [ Python ]
**適用於 Python 的 SDK (Boto3)**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/s3/s3_basics#code-examples)中設定和執行。
```
class BucketWrapper:
"""Encapsulates S3 bucket actions."""
def __init__(self, bucket):
"""
:param bucket: A Boto3 Bucket resource. This is a high-level resource in Boto3
that wraps bucket actions in a class-like structure.
"""
self.bucket = bucket
self.name = bucket.name
def exists(self):
"""
Determine whether the bucket exists and you have access to it.
:return: True when the bucket exists; otherwise, False.
"""
try:
self.bucket.meta.client.head_bucket(Bucket=self.bucket.name)
logger.info("Bucket %s exists.", self.bucket.name)
exists = True
except ClientError:
logger.warning(
"Bucket %s doesn't exist or you don't have access to it.",
self.bucket.name,
)
exists = False
return exists
```
+ 如需 API 詳細資訊，請參閱*《適用於 Python (Boto3) 的AWS SDK API 參考》*中的[HeadBucket](https://docs.aws.amazon.com/goto/boto3/s3-2006-03-01/HeadBucket)。
------
#### [ SAP ABAP ]
**適用於 SAP ABAP 的開發套件**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/s3#code-examples)中設定和執行。
```
TRY.
oo_result = lo_s3->headbucket( " oo_result is returned for testing purposes. "
iv_bucket = iv_bucket_name ).
MESSAGE 'Bucket exists and you have access to it.' TYPE 'I'.
CATCH /aws1/cx_s3_nosuchbucket.
MESSAGE 'Bucket does not exist.' TYPE 'E'.
ENDTRY.
```
+ 如需 API 詳細資訊，請參閱《適用於 *AWS SAP ABAP 的 SDK API 參考*》中的 [HeadBucket](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)。
------
# `HeadObject` 搭配 AWS SDK 或 CLI 使用
下列程式碼範例示範如何使用 `HeadObject`。
動作範例是大型程式的程式碼摘錄，必須在內容中執行。您可以在下列程式碼範例的內容中看到此動作：
+ [開始使用 S3](s3_example_s3_GettingStarted_section.md)
------
#### [ CLI ]
**AWS CLI**
下列命令會擷取名為 `amzn-s3-demo-bucket` 之儲存貯體中物件的中繼資料：
```
aws s3api head-object --bucket amzn-s3-demo-bucket --key index.html
```
輸出：
```
{
"AcceptRanges": "bytes",
"ContentType": "text/html",
"LastModified": "Thu, 16 Apr 2015 18:19:14 GMT",
"ContentLength": 77,
"VersionId": "null",
"ETag": "\"30a6ec7e1a9ad79c203d05a589c8b400\"",
"Metadata": {}
}
```
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [HeadObject](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3api/head-object.html)。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/s3#code-examples)中設定和執行。
判斷物件的內容類型。
```
import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.s3.S3Client;
import software.amazon.awssdk.services.s3.model.HeadObjectRequest;
import software.amazon.awssdk.services.s3.model.HeadObjectResponse;
import software.amazon.awssdk.services.s3.model.S3Exception;
/**
* Before running this Java V2 code example, set up your development
* environment, including your credentials.
*
* For more information, see the following documentation topic:
*
* https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/get-started.html
*/
public class GetObjectContentType {
public static void main(String[] args) {
final String usage = """
Usage:
Where:
bucketName - The Amazon S3 bucket name.\s
keyName - The key name.\s
""";
if (args.length != 2) {
System.out.println(usage);
System.exit(1);
}
String bucketName = args[0];
String keyName = args[1];
Region region = Region.US_EAST_1;
S3Client s3 = S3Client.builder()
.region(region)
.build();
getContentType(s3, bucketName, keyName);
s3.close();
}
/**
* Retrieves the content type of an object stored in an Amazon S3 bucket.
*
* @param s3 an instance of the {@link S3Client} class, which is used to interact with the Amazon S3 service
* @param bucketName the name of the S3 bucket where the object is stored
* @param keyName the key (file name) of the object in the S3 bucket
*/
public static void getContentType(S3Client s3, String bucketName, String keyName) {
try {
HeadObjectRequest objectRequest = HeadObjectRequest.builder()
.key(keyName)
.bucket(bucketName)
.build();
HeadObjectResponse objectHead = s3.headObject(objectRequest);
String type = objectHead.contentType();
System.out.println("The object content type is " + type);
} catch (S3Exception e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
}
}
```
取得物件的還原狀態。
```
import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.s3.S3Client;
import software.amazon.awssdk.services.s3.model.HeadObjectRequest;
import software.amazon.awssdk.services.s3.model.HeadObjectResponse;
import software.amazon.awssdk.services.s3.model.S3Exception;
public class GetObjectRestoreStatus {
public static void main(String[] args) {
final String usage = """
Usage:
\s
Where:
bucketName - The Amazon S3 bucket name.\s
keyName - A key name that represents the object.\s
""";
if (args.length != 2) {
System.out.println(usage);
System.exit(1);
}
String bucketName = args[0];
String keyName = args[1];
Region region = Region.US_EAST_1;
S3Client s3 = S3Client.builder()
.region(region)
.build();
checkStatus(s3, bucketName, keyName);
s3.close();
}
/**
* Checks the restoration status of an Amazon S3 object.
*
* @param s3 an instance of the {@link S3Client} class used to interact with the Amazon S3 service
* @param bucketName the name of the Amazon S3 bucket where the object is stored
* @param keyName the name of the Amazon S3 object to be checked
* @throws S3Exception if an error occurs while interacting with the Amazon S3 service
*/
public static void checkStatus(S3Client s3, String bucketName, String keyName) {
try {
HeadObjectRequest headObjectRequest = HeadObjectRequest.builder()
.bucket(bucketName)
.key(keyName)
.build();
HeadObjectResponse response = s3.headObject(headObjectRequest);
System.out.println("The Amazon S3 object restoration status is " + response.restore());
} catch (S3Exception e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
}
}
```
+ 如需 API 詳細資訊，請參閱*《AWS SDK for Java 2.x API 參考》*中的 [HeadObject](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/HeadObject)。
------
#### [ Ruby ]
**SDK for Ruby**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/ruby/example_code/s3#code-examples)中設定和執行。
```
require 'aws-sdk-s3'
# Wraps Amazon S3 object actions.
class ObjectExistsWrapper
attr_reader :object
# @param object [Aws::S3::Object] An Amazon S3 object.
def initialize(object)
@object = object
end
# Checks whether the object exists.
#
# @return [Boolean] True if the object exists; otherwise false.
def exists?
@object.exists?
rescue Aws::Errors::ServiceError => e
puts "Couldn't check existence of object #{@object.bucket.name}:#{@object.key}. Here's why: #{e.message}"
false
end
end
# Example usage:
def run_demo
bucket_name = "amzn-s3-demo-bucket"
object_key = "my-object.txt"
wrapper = ObjectExistsWrapper.new(Aws::S3::Object.new(bucket_name, object_key))
exists = wrapper.exists?
puts "Object #{object_key} #{exists ? 'does' : 'does not'} exist."
end
run_demo if $PROGRAM_NAME == __FILE__
```
+ 如需 API 詳細資訊，請參閱*《適用於 Ruby 的 AWS SDK API 參考》*中的 [HeadObject](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/HeadObject)。
------
# 搭配使用 `ListBucketAnalyticsConfigurations` 與 CLI
下列程式碼範例示範如何使用 `ListBucketAnalyticsConfigurations`。
------
#### [ CLI ]
**AWS CLI**
**擷取儲存貯體的分析組態清單**
下列 `list-bucket-analytics-configurations` 會擷取指定儲存貯體的分析組態清單。
```
aws s3api list-bucket-analytics-configurations \
--bucket amzn-s3-demo-bucket
```
輸出：
```
{
"AnalyticsConfigurationList": [
{
"StorageClassAnalysis": {},
"Id": "1"
}
],
"IsTruncated": false
}
```
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [ListBucketAnalyticsConfigurations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3api/list-bucket-analytics-configurations.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此命令會傳回給定 S3 儲存貯體的前 100 個分析組態。**
```
Get-S3BucketAnalyticsConfigurationList -BucketName 'amzn-s3-demo-bucket'
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [ListBucketAnalyticsConfigurations](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此命令會傳回給定 S3 儲存貯體的前 100 個分析組態。**
```
Get-S3BucketAnalyticsConfigurationList -BucketName 'amzn-s3-demo-bucket'
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [ListBucketAnalyticsConfigurations](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `ListBucketInventoryConfigurations` 與 CLI
下列程式碼範例示範如何使用 `ListBucketInventoryConfigurations`。
------
#### [ CLI ]
**AWS CLI**
**擷取儲存貯體的庫存組態清單**
下列 `list-bucket-inventory-configurations` 範例列出指定儲存貯體的庫存組態。
```
aws s3api list-bucket-inventory-configurations \
--bucket amzn-s3-demo-bucket
```
輸出：
```
{
"InventoryConfigurationList": [
{
"IsEnabled": true,
"Destination": {
"S3BucketDestination": {
"Format": "ORC",
"Bucket": "arn:aws:s3:::amzn-s3-demo-bucket",
"AccountId": "123456789012"
}
},
"IncludedObjectVersions": "Current",
"Id": "1",
"Schedule": {
"Frequency": "Weekly"
}
},
{
"IsEnabled": true,
"Destination": {
"S3BucketDestination": {
"Format": "CSV",
"Bucket": "arn:aws:s3:::amzn-s3-demo-bucket",
"AccountId": "123456789012"
}
},
"IncludedObjectVersions": "Current",
"Id": "2",
"Schedule": {
"Frequency": "Daily"
}
}
],
"IsTruncated": false
}
```
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [ListBucketInventoryConfigurations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3api/list-bucket-inventory-configurations.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此命令會傳回給定 S3 儲存貯體的前 100 個庫存組態。**
```
Get-S3BucketInventoryConfigurationList -BucketName 'amzn-s3-demo-bucket'
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [ListBucketInventoryConfigurations](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此命令會傳回給定 S3 儲存貯體的前 100 個庫存組態。**
```
Get-S3BucketInventoryConfigurationList -BucketName 'amzn-s3-demo-bucket'
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [ListBucketInventoryConfigurations](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# `ListBuckets` 搭配 AWS SDK 或 CLI 使用
下列程式碼範例示範如何使用 `ListBuckets`。
------
#### [ .NET ]
**適用於 .NET 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/S3#code-examples)中設定和執行。
```
namespace ListBucketsExample
{
using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Amazon.S3;
using Amazon.S3.Model;
///
/// This example uses the AWS SDK for .NET to list the Amazon Simple Storage
/// Service (Amazon S3) buckets belonging to the default account.
///
public class ListBuckets
{
private static IAmazonS3 _s3Client;
///
/// Get a list of the buckets owned by the default user.
///
/// An initialized Amazon S3 client object.
/// The response from the ListingBuckets call that contains a
/// list of the buckets owned by the default user.
public static async Task GetBuckets(IAmazonS3 client)
{
return await client.ListBucketsAsync();
}
///
/// This method lists the name and creation date for the buckets in
/// the passed List of S3 buckets.
///
/// A List of S3 bucket objects.
public static void DisplayBucketList(List bucketList)
{
bucketList
.ForEach(b => Console.WriteLine($"Bucket name: {b.BucketName}, created on: {b.CreationDate}"));
}
public static async Task Main()
{
// The client uses the AWS Region of the default user.
// If the Region where the buckets were created is different,
// pass the Region to the client constructor. For example:
// _s3Client = new AmazonS3Client(RegionEndpoint.USEast1);
_s3Client = new AmazonS3Client();
var response = await GetBuckets(_s3Client);
DisplayBucketList(response.Buckets);
}
}
}
```
+ 如需 API 詳細資訊，請參閱*《適用於 .NET 的 AWS SDK API 參考》*中的 [ListBuckets](https://docs.aws.amazon.com/goto/DotNetSDKV3/s3-2006-03-01/ListBuckets)。
------
#### [ C\$1\$1 ]
**適用於 C\$1\$1 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/s3#code-examples)中設定和執行。
```
bool AwsDoc::S3::listBuckets(const Aws::S3::S3ClientConfiguration &clientConfig) {
Aws::S3::S3Client client(clientConfig);
auto outcome = client.ListBuckets();
bool result = true;
if (!outcome.IsSuccess()) {
std::cerr << "Failed with error: " << outcome.GetError() << std::endl;
result = false;
} else {
std::cout << "Found " << outcome.GetResult().GetBuckets().size() << " buckets\n";
for (auto &&b: outcome.GetResult().GetBuckets()) {
std::cout << b.GetName() << std::endl;
}
}
return result;
}
```
+ 如需 API 詳細資訊，請參閱*《適用於 C\$1\$1 的 AWS SDK API 參考》*中的 [ListBuckets](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/ListBuckets)。
------
#### [ CLI ]
**AWS CLI**
下列命令會使用 `list-buckets` 命令來顯示所有 Amazon S3 儲存貯體的名稱 (跨所有區域)：
```
aws s3api list-buckets --query "Buckets[].Name"
```
查詢選項會將 `list-buckets` 的輸出向下篩選出僅儲存貯體名稱。
如需儲存貯體的詳細資訊，請參閱《*Amazon S3 開發人員指南*》中的「使用 Amazon S3 儲存貯體」。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [ListBuckets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3api/list-buckets.html)。
------
#### [ Go ]
**SDK for Go V2**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/gov2/s3#code-examples)中設定和執行。
```
import (
"bytes"
"context"
"errors"
"fmt"
"io"
"log"
"os"
"time"
"github.com/aws/aws-sdk-go-v2/aws"
"github.com/aws/aws-sdk-go-v2/feature/s3/manager"
"github.com/aws/aws-sdk-go-v2/service/s3"
"github.com/aws/aws-sdk-go-v2/service/s3/types"
"github.com/aws/smithy-go"
)
// BucketBasics encapsulates the Amazon Simple Storage Service (Amazon S3) actions
// used in the examples.
// It contains S3Client, an Amazon S3 service client that is used to perform bucket
// and object actions.
type BucketBasics struct {
S3Client *s3.Client
}
// ListBuckets lists the buckets in the current account.
func (basics BucketBasics) ListBuckets(ctx context.Context) ([]types.Bucket, error) {
var err error
var output *s3.ListBucketsOutput
var buckets []types.Bucket
bucketPaginator := s3.NewListBucketsPaginator(basics.S3Client, &s3.ListBucketsInput{})
for bucketPaginator.HasMorePages() {
output, err = bucketPaginator.NextPage(ctx)
if err != nil {
var apiErr smithy.APIError
if errors.As(err, &apiErr) && apiErr.ErrorCode() == "AccessDenied" {
fmt.Println("You don't have permission to list buckets for this account.")
err = apiErr
} else {
log.Printf("Couldn't list buckets for your account. Here's why: %v\n", err)
}
break
} else {
buckets = append(buckets, output.Buckets...)
}
}
return buckets, err
}
```
+ 如需 API 詳細資訊，請參閱*《適用於 Go 的 AWS SDK API 參考》*中的 [ListBuckets](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/s3#Client.ListBuckets)。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/s3#code-examples)中設定和執行。
```
import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.s3.S3Client;
import software.amazon.awssdk.services.s3.paginators.ListBucketsIterable;
/**
* Before running this Java V2 code example, set up your development
* environment, including your credentials.
*
* For more information, see the following documentation topic:
*
* https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/get-started.html
*/
public class ListBuckets {
public static void main(String[] args) {
Region region = Region.US_EAST_1;
S3Client s3 = S3Client.builder()
.region(region)
.build();
listAllBuckets(s3);
}
/**
* Lists all the S3 buckets available in the current AWS account.
*
* @param s3 The {@link S3Client} instance to use for interacting with the Amazon S3 service.
*/
public static void listAllBuckets(S3Client s3) {
ListBucketsIterable response = s3.listBucketsPaginator();
response.buckets().forEach(bucket ->
System.out.println("Bucket Name: " + bucket.name()));
}
```
+ 如需 API 詳細資訊，請參閱*《AWS SDK for Java 2.x API 參考》*中的 [ListBuckets](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/ListBuckets)。
------
#### [ JavaScript ]
**適用於 JavaScript (v3) 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/s3#code-examples)中設定和執行。
列出儲存貯體。
```
import {
paginateListBuckets,
S3Client,
S3ServiceException,
} from "@aws-sdk/client-s3";
/**
* List the Amazon S3 buckets in your account.
*/
export const main = async () => {
const client = new S3Client({});
/** @type {?import('@aws-sdk/client-s3').Owner} */
let Owner = null;
/** @type {import('@aws-sdk/client-s3').Bucket[]} */
const Buckets = [];
try {
const paginator = paginateListBuckets({ client }, {});
for await (const page of paginator) {
if (!Owner) {
Owner = page.Owner;
}
Buckets.push(...page.Buckets);
}
console.log(
`${Owner.DisplayName} owns ${Buckets.length} bucket${
Buckets.length === 1 ? "" : "s"
}:`,
);
console.log(`${Buckets.map((b) => ` • ${b.Name}`).join("\n")}`);
} catch (caught) {
if (caught instanceof S3ServiceException) {
console.error(
`Error from S3 while listing buckets. ${caught.name}: ${caught.message}`,
);
} else {
throw caught;
}
}
};
```
+ 如需詳細資訊，請參閱《[適用於 JavaScript 的 AWS SDK 開發人員指南](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/s3-example-creating-buckets.html#s3-example-creating-buckets-list-buckets)》。
+ 如需 API 詳細資訊，請參閱*《適用於 JavaScript 的 AWS SDK API 參考》*中的 [ListBuckets](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/s3/command/ListBucketsCommand)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此命令會傳回所有 S3 儲存貯體。**
```
Get-S3Bucket
```
**範例 2：此命令會傳回名為 "test-files" 的儲存貯體**
```
Get-S3Bucket -BucketName amzn-s3-demo-bucket
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [ListBuckets](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此命令會傳回所有 S3 儲存貯體。**
```
Get-S3Bucket
```
**範例 2：此命令會傳回名為 "test-files" 的儲存貯體**
```
Get-S3Bucket -BucketName amzn-s3-demo-bucket
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [ListBuckets](https://docs.aws.amazon.com/powershell/v5/reference)。
------
#### [ Python ]
**適用於 Python 的 SDK (Boto3)**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/s3/s3_basics#code-examples)中設定和執行。
```
class BucketWrapper:
"""Encapsulates S3 bucket actions."""
def __init__(self, bucket):
"""
:param bucket: A Boto3 Bucket resource. This is a high-level resource in Boto3
that wraps bucket actions in a class-like structure.
"""
self.bucket = bucket
self.name = bucket.name
@staticmethod
def list(s3_resource):
"""
Get the buckets in all Regions for the current account.
:param s3_resource: A Boto3 S3 resource. This is a high-level resource in Boto3
that contains collections and factory methods to create
other high-level S3 sub-resources.
:return: The list of buckets.
"""
try:
buckets = list(s3_resource.buckets.all())
logger.info("Got buckets: %s.", buckets)
except ClientError:
logger.exception("Couldn't get buckets.")
raise
else:
return buckets
```
+ 如需 API 詳細資訊，請參閱*《適用於 Python (Boto3) 的AWS SDK API 參考》*中的 [ListBuckets](https://docs.aws.amazon.com/goto/boto3/s3-2006-03-01/ListBuckets)。
------
#### [ Ruby ]
**SDK for Ruby**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/ruby/example_code/s3#code-examples)中設定和執行。
```
require 'aws-sdk-s3'
# Wraps Amazon S3 resource actions.
class BucketListWrapper
attr_reader :s3_resource
# @param s3_resource [Aws::S3::Resource] An Amazon S3 resource.
def initialize(s3_resource)
@s3_resource = s3_resource
end
# Lists buckets for the current account.
#
# @param count [Integer] The maximum number of buckets to list.
def list_buckets(count)
puts 'Found these buckets:'
@s3_resource.buckets.each do |bucket|
puts "\t#{bucket.name}"
count -= 1
break if count.zero?
end
true
rescue Aws::Errors::ServiceError => e
puts "Couldn't list buckets. Here's why: #{e.message}"
false
end
end
# Example usage:
def run_demo
wrapper = BucketListWrapper.new(Aws::S3::Resource.new)
wrapper.list_buckets(25)
end
run_demo if $PROGRAM_NAME == __FILE__
```
+ 如需 API 詳細資訊，請參閱*《適用於 Ruby 的 AWS SDK API 參考》*中的 [ListBuckets](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/ListBuckets)。
------
#### [ Rust ]
**適用於 Rust 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/rustv1/examples/s3#code-examples)中設定和執行。
```
async fn show_buckets(
strict: bool,
client: &Client,
region: BucketLocationConstraint,
) -> Result<(), S3ExampleError> {
let mut buckets = client.list_buckets().into_paginator().send();
let mut num_buckets = 0;
let mut in_region = 0;
while let Some(Ok(output)) = buckets.next().await {
for bucket in output.buckets() {
num_buckets += 1;
if strict {
let r = client
.get_bucket_location()
.bucket(bucket.name().unwrap_or_default())
.send()
.await?;
if r.location_constraint() == Some(®ion) {
println!("{}", bucket.name().unwrap_or_default());
in_region += 1;
}
} else {
println!("{}", bucket.name().unwrap_or_default());
}
}
}
println!();
if strict {
println!(
"Found {} buckets in the {} region out of a total of {} buckets.",
in_region, region, num_buckets
);
} else {
println!("Found {} buckets in all regions.", num_buckets);
}
Ok(())
}
```
+ 如需 API 詳細資訊，請參閱*《適用於 Rust 的AWS SDK API 參考》*中的 [ListBuckets](https://docs.rs/aws-sdk-s3/latest/aws_sdk_s3/client/struct.Client.html#method.list_buckets)。
------
#### [ Swift ]
**適用於 Swift 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/swift/example_code/s3#code-examples)中設定和執行。
```
import AWSS3
/// Return an array containing information about every available bucket.
///
/// - Returns: An array of ``S3ClientTypes.Bucket`` objects describing
/// each bucket.
public func getAllBuckets() async throws -> [S3ClientTypes.Bucket] {
return try await client.listBuckets(input: ListBucketsInput())
}
```
+ 如需 API 詳細資訊，請參閱《適用於 Swift 的AWS SDK API 參考》**中的 [ListBuckets](https://sdk.amazonaws.com/swift/api/awss3/latest/documentation/awss3/s3client/listbuckets(input:))。
------
# `ListMultipartUploads` 搭配 AWS SDK 或 CLI 使用
下列程式碼範例示範如何使用 `ListMultipartUploads`。
動作範例是大型程式的程式碼摘錄，必須在內容中執行。您可以在下列程式碼範例的內容中看到此動作：
+ [刪除未完成的分段上傳](s3_example_s3_Scenario_AbortMultipartUpload_section.md)
------
#### [ CLI ]
**AWS CLI**
下列命令會列出名為 `amzn-s3-demo-bucket` 之儲存貯體的所有作用中分段上傳：
```
aws s3api list-multipart-uploads --bucket amzn-s3-demo-bucket
```
輸出：
```
{
"Uploads": [
{
"Initiator": {
"DisplayName": "username",
"ID": "arn:aws:iam::0123456789012:user/username"
},
"Initiated": "2015-06-02T18:01:30.000Z",
"UploadId": "dfRtDYU0WWCCcH43C3WFbkRONycyCpTJJvxu2i5GYkZljF.Yxwh6XG7WfS2vC4to6HiV6Yjlx.cph0gtNBtJ8P3URCSbB7rjxI5iEwVDmgaXZOGgkk5nVTW16HOQ5l0R",
"StorageClass": "STANDARD",
"Key": "multipart/01",
"Owner": {
"DisplayName": "aws-account-name",
"ID": "100719349fc3b6dcd7c820a124bf7aecd408092c3d7b51b38494939801fc248b"
}
}
],
"CommonPrefixes": []
}
```
進行中的分段上傳會在 Amazon S3 中產生儲存成本。完成或中止作用中的分段上傳，以從您的帳戶中移除該部分。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [ListMultipartUploads](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3api/list-multipart-uploads.html)。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/s3#code-examples)中設定和執行。
```
import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.s3.S3Client;
import software.amazon.awssdk.services.s3.model.ListMultipartUploadsRequest;
import software.amazon.awssdk.services.s3.model.ListMultipartUploadsResponse;
import software.amazon.awssdk.services.s3.model.MultipartUpload;
import software.amazon.awssdk.services.s3.model.S3Exception;
import java.util.List;
/**
* Before running this Java V2 code example, set up your development
* environment, including your credentials.
*
* For more information, see the following documentation topic:
*
* https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/get-started.html
*/
public class ListMultipartUploads {
public static void main(String[] args) {
final String usage = """
Usage:
\s
Where:
bucketName - The name of the Amazon S3 bucket where an in-progress multipart upload is occurring.
""";
if (args.length != 1) {
System.out.println(usage);
System.exit(1);
}
String bucketName = args[0];
Region region = Region.US_EAST_1;
S3Client s3 = S3Client.builder()
.region(region)
.build();
listUploads(s3, bucketName);
s3.close();
}
/**
* Lists the multipart uploads currently in progress in the specified Amazon S3 bucket.
*
* @param s3 the S3Client object used to interact with Amazon S3
* @param bucketName the name of the Amazon S3 bucket to list the multipart uploads for
*/
public static void listUploads(S3Client s3, String bucketName) {
try {
ListMultipartUploadsRequest listMultipartUploadsRequest = ListMultipartUploadsRequest.builder()
.bucket(bucketName)
.build();
ListMultipartUploadsResponse response = s3.listMultipartUploads(listMultipartUploadsRequest);
List uploads = response.uploads();
for (MultipartUpload upload : uploads) {
System.out.println("Upload in progress: Key = \"" + upload.key() + "\", id = " + upload.uploadId());
}
} catch (S3Exception e) {
System.err.println(e.getMessage());
System.exit(1);
}
}
}
```
+ 如需 API 詳細資訊，請參閱*《AWS SDK for Java 2.x API 參考》*中的 [ListMultipartUploads](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/ListMultipartUploads)。
------
# `ListObjectVersions` 搭配 AWS SDK 或 CLI 使用
下列程式碼範例示範如何使用 `ListObjectVersions`。
動作範例是大型程式的程式碼摘錄，必須在內容中執行。您可以在下列程式碼範例的內容中看到此動作：
+ [開始使用 S3](s3_example_s3_GettingStarted_section.md)
+ [使用版本化物件](s3_example_s3_Scenario_ObjectVersioningUsage_section.md)
------
#### [ .NET ]
**適用於 .NET 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/S3#code-examples)中設定和執行。
```
using System;
using System.Threading.Tasks;
using Amazon.S3;
using Amazon.S3.Model;
///
/// This example lists the versions of the objects in a version enabled
/// Amazon Simple Storage Service (Amazon S3) bucket.
///
public class ListObjectVersions
{
public static async Task Main()
{
string bucketName = "amzn-s3-demo-bucket";
// If the AWS Region where your bucket is defined is different from
// the AWS Region where the Amazon S3 bucket is defined, pass the constant
// for the AWS Region to the client constructor like this:
// var client = new AmazonS3Client(RegionEndpoint.USWest2);
IAmazonS3 client = new AmazonS3Client();
await GetObjectListWithAllVersionsAsync(client, bucketName);
}
///
/// This method lists all versions of the objects within an Amazon S3
/// version enabled bucket.
///
/// The initialized client object used to call
/// ListVersionsAsync.
/// The name of the version enabled Amazon S3 bucket
/// for which you want to list the versions of the contained objects.
public static async Task GetObjectListWithAllVersionsAsync(IAmazonS3 client, string bucketName)
{
try
{
// When you instantiate the ListVersionRequest, you can
// optionally specify a key name prefix in the request
// if you want a list of object versions of a specific object.
// For this example we set a small limit in MaxKeys to return
// a small list of versions.
ListVersionsRequest request = new ListVersionsRequest()
{
BucketName = bucketName,
MaxKeys = 2,
};
do
{
ListVersionsResponse response = await client.ListVersionsAsync(request);
// Process response.
foreach (S3ObjectVersion entry in response.Versions)
{
Console.WriteLine($"key: {entry.Key} size: {entry.Size}");
}
// If response is truncated, set the marker to get the next
// set of keys.
if (response.IsTruncated)
{
request.KeyMarker = response.NextKeyMarker;
request.VersionIdMarker = response.NextVersionIdMarker;
}
else
{
request = null;
}
}
while (request != null);
}
catch (AmazonS3Exception ex)
{
Console.WriteLine($"Error: '{ex.Message}'");
}
}
}
```
+ 如需 API 詳細資訊，請參閱《適用於 .NET 的 AWS SDK API 參考》**中的 [ListObjectVersions](https://docs.aws.amazon.com/goto/DotNetSDKV3/s3-2006-03-01/ListObjectVersions)。
------
#### [ CLI ]
**AWS CLI**
下列命令會擷取名為 `amzn-s3-demo-bucket` 之儲存貯體中物件的版本資訊：
```
aws s3api list-object-versions --bucket amzn-s3-demo-bucket --prefix index.html
```
輸出：
```
{
"DeleteMarkers": [
{
"Owner": {
"DisplayName": "my-username",
"ID": "7009a8971cd660687538875e7c86c5b672fe116bd438f46db45460ddcd036c32"
},
"IsLatest": true,
"VersionId": "B2VsEK5saUNNHKcOAJj7hIE86RozToyq",
"Key": "index.html",
"LastModified": "2015-11-10T00:57:03.000Z"
},
{
"Owner": {
"DisplayName": "my-username",
"ID": "7009a8971cd660687538875e7c86c5b672fe116bd438f46db45460ddcd036c32"
},
"IsLatest": false,
"VersionId": ".FLQEZscLIcfxSq.jsFJ.szUkmng2Yw6",
"Key": "index.html",
"LastModified": "2015-11-09T23:32:20.000Z"
}
],
"Versions": [
{
"LastModified": "2015-11-10T00:20:11.000Z",
"VersionId": "Rb_l2T8UHDkFEwCgJjhlgPOZC0qJ.vpD",
"ETag": "\"0622528de826c0df5db1258a23b80be5\"",
"StorageClass": "STANDARD",
"Key": "index.html",
"Owner": {
"DisplayName": "my-username",
"ID": "7009a8971cd660687538875e7c86c5b672fe116bd438f46db45460ddcd036c32"
},
"IsLatest": false,
"Size": 38
},
{
"LastModified": "2015-11-09T23:26:41.000Z",
"VersionId": "rasWWGpgk9E4s0LyTJgusGeRQKLVIAFf",
"ETag": "\"06225825b8028de826c0df5db1a23be5\"",
"StorageClass": "STANDARD",
"Key": "index.html",
"Owner": {
"DisplayName": "my-username",
"ID": "7009a8971cd660687538875e7c86c5b672fe116bd438f46db45460ddcd036c32"
},
"IsLatest": false,
"Size": 38
},
{
"LastModified": "2015-11-09T22:50:50.000Z",
"VersionId": "null",
"ETag": "\"d1f45267a863c8392e07d24dd592f1b9\"",
"StorageClass": "STANDARD",
"Key": "index.html",
"Owner": {
"DisplayName": "my-username",
"ID": "7009a8971cd660687538875e7c86c5b672fe116bd438f46db45460ddcd036c32"
},
"IsLatest": false,
"Size": 533823
}
]
}
```
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [ListObjectVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3api/list-object-versions.html)。
------
#### [ Go ]
**SDK for Go V2**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/gov2/workflows/s3_object_lock#code-examples)中設定和執行。
```
import (
"bytes"
"context"
"errors"
"fmt"
"log"
"time"
"github.com/aws/aws-sdk-go-v2/aws"
"github.com/aws/aws-sdk-go-v2/feature/s3/manager"
"github.com/aws/aws-sdk-go-v2/service/s3"
"github.com/aws/aws-sdk-go-v2/service/s3/types"
"github.com/aws/smithy-go"
)
// S3Actions wraps S3 service actions.
type S3Actions struct {
S3Client *s3.Client
S3Manager *manager.Uploader
}
// ListObjectVersions lists all versions of all objects in a bucket.
func (actor S3Actions) ListObjectVersions(ctx context.Context, bucket string) ([]types.ObjectVersion, error) {
var err error
var output *s3.ListObjectVersionsOutput
var versions []types.ObjectVersion
input := &s3.ListObjectVersionsInput{Bucket: aws.String(bucket)}
versionPaginator := s3.NewListObjectVersionsPaginator(actor.S3Client, input)
for versionPaginator.HasMorePages() {
output, err = versionPaginator.NextPage(ctx)
if err != nil {
var noBucket *types.NoSuchBucket
if errors.As(err, &noBucket) {
log.Printf("Bucket %s does not exist.\n", bucket)
err = noBucket
}
break
} else {
versions = append(versions, output.Versions...)
}
}
return versions, err
}
```
+ 如需 API 詳細資訊，請參閱《適用於 Go 的 AWS SDK API 參考》**中的 [ListObjectVersions](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/s3#Client.ListObjectVersions)。
------
#### [ Rust ]
**適用於 Rust 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/rustv1/examples/s3#code-examples)中設定和執行。
```
async fn show_versions(client: &Client, bucket: &str) -> Result<(), Error> {
let resp = client.list_object_versions().bucket(bucket).send().await?;
for version in resp.versions() {
println!("{}", version.key().unwrap_or_default());
println!(" version ID: {}", version.version_id().unwrap_or_default());
println!();
}
Ok(())
}
```
+ 如需 API 詳細資訊，請參閱《適用於 Rust 的AWS SDK API 參考》**中的 [ListObjectVersions](https://docs.rs/aws-sdk-s3/latest/aws_sdk_s3/client/struct.Client.html#method.list_object_versions)。
------
#### [ SAP ABAP ]
**適用於 SAP ABAP 的開發套件**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/s3#code-examples)中設定和執行。
```
TRY.
oo_result = lo_s3->listobjectversions( " oo_result is returned for testing purposes. "
iv_bucket = iv_bucket_name
iv_prefix = iv_prefix ).
MESSAGE 'Retrieved object versions.' TYPE 'I'.
CATCH /aws1/cx_s3_nosuchbucket.
MESSAGE 'Bucket does not exist.' TYPE 'E'.
ENDTRY.
```
+ 如需 API 詳細資訊，請參閱《適用於 *AWS SAP ABAP 的 SDK API 參考*》中的 [ListObjectVersions](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)。
------
# 搭配使用 `ListObjects` 與 CLI
下列程式碼範例示範如何使用 `ListObjects`。
動作範例是大型程式的程式碼摘錄，必須在內容中執行。您可以在下列程式碼範例的內容中看到此動作：
+ [建立列出 Amazon S3 物件的網頁](s3_example_s3_Scenario_ListObjectsWeb_section.md)
------
#### [ CLI ]
**AWS CLI**
下列範例使用 `list-objects` 命令來顯示指定儲存貯體中所有物件的名稱：
```
aws s3api list-objects --bucket text-content --query 'Contents[].{Key: Key, Size: Size}'
```
此範例使用 `--query` 引數，將 `list-objects` 的輸出篩選為每個物件的金鑰值和大小
如需物件的詳細資訊，請參閱《Amazon S3 開發人員指南》**中的使用 Amazon S3 物件。
+ 如需 API 詳細資訊，請參閱《AWS CLI API 參考》**中的 [ListObjects](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3api/list-objects.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此命令會擷取儲存貯體 "test-files" 中所有項目的相關資訊。**
```
Get-S3Object -BucketName amzn-s3-demo-bucket
```
**範例 2：此命令會從儲存貯體 "test-files" 擷取項目 "sample.txt" 的相關資訊。**
```
Get-S3Object -BucketName amzn-s3-demo-bucket -Key sample.txt
```
**範例 3：此命令會從儲存貯體 "test-files" 擷取字首為 "sample" 之所有項目的相關資訊。**
```
Get-S3Object -BucketName amzn-s3-demo-bucket -KeyPrefix sample
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [ListObjects](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此命令會擷取儲存貯體 "test-files" 中所有項目的相關資訊。**
```
Get-S3Object -BucketName amzn-s3-demo-bucket
```
**範例 2：此命令會從儲存貯體 "test-files" 擷取項目 "sample.txt" 的相關資訊。**
```
Get-S3Object -BucketName amzn-s3-demo-bucket -Key sample.txt
```
**範例 3：此命令會從儲存貯體 "test-files" 擷取字首為 "sample" 之所有項目的相關資訊。**
```
Get-S3Object -BucketName amzn-s3-demo-bucket -KeyPrefix sample
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [ListObjects](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# `ListObjectsV2` 搭配 AWS SDK 或 CLI 使用
下列程式碼範例示範如何使用 `ListObjectsV2`。
動作範例是大型程式的程式碼摘錄，必須在內容中執行。您可以在下列程式碼範例的內容中看到此動作：
+ [了解基本概念](s3_example_s3_Scenario_GettingStarted_section.md)
+ [刪除儲存貯體中的所有物件](s3_example_s3_Scenario_DeleteAllObjects_section.md)
+ [開始使用 S3](s3_example_s3_GettingStarted_section.md)
------
#### [ .NET ]
**適用於 .NET 的 SDK (v4)**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv4/S3#code-examples)中設定和執行。
```
///
/// Shows how to list the objects in an Amazon S3 bucket.
///
/// The name of the bucket for which to list.
/// True to print out the list.
/// The collection of objects.
public async Task?> ListBucketContentsAsync(string bucketName, bool printList = true)
{
try
{
var request = new ListObjectsV2Request
{
BucketName = bucketName,
MaxKeys = 5,
};
if (printList)
{
Console.WriteLine("--------------------------------------");
Console.WriteLine($"Listing the contents of {bucketName}:");
Console.WriteLine("--------------------------------------");
}
var listObjectsV2Paginator = _amazonS3.Paginators.ListObjectsV2(new ListObjectsV2Request
{
BucketName = bucketName,
});
var s3Objects = new List();
await foreach (var response in listObjectsV2Paginator.Responses)
{
if (response.S3Objects != null)
{
s3Objects.AddRange(response.S3Objects);
}
}
if (printList)
{
Console.WriteLine($"Number of Objects: {s3Objects.Count}");
foreach (var entry in s3Objects)
{
Console.WriteLine($"Key = {entry.Key} Size = {entry.Size}");
}
}
return s3Objects;
}
catch (AmazonS3Exception ex)
{
Console.WriteLine($"Error encountered on server. Message:'{ex.Message}' getting list of objects.");
return null;
}
}
```
+ 如需 API 詳細資訊，請參閱《*適用於 .NET 的 AWS SDK API 參考*》中的 [ListObjectsV2](https://docs.aws.amazon.com/goto/DotNetSDKV4/s3-2006-03-01/ListObjectsV2)。
**適用於 .NET 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/S3#code-examples)中設定和執行。
使用分頁程式列出物件。
```
using System;
using System.Threading.Tasks;
using Amazon.S3;
using Amazon.S3.Model;
///
/// The following example lists objects in an Amazon Simple Storage
/// Service (Amazon S3) bucket.
///
public class ListObjectsPaginator
{
private const string BucketName = "amzn-s3-demo-bucket";
public static async Task Main()
{
IAmazonS3 s3Client = new AmazonS3Client();
Console.WriteLine($"Listing the objects contained in {BucketName}:\n");
await ListingObjectsAsync(s3Client, BucketName);
}
///
/// This method uses a paginator to retrieve the list of objects in an
/// an Amazon S3 bucket.
///
/// An Amazon S3 client object.
/// The name of the S3 bucket whose objects
/// you want to list.
public static async Task ListingObjectsAsync(IAmazonS3 client, string bucketName)
{
var listObjectsV2Paginator = client.Paginators.ListObjectsV2(new ListObjectsV2Request
{
BucketName = bucketName,
});
await foreach (var response in listObjectsV2Paginator.Responses)
{
Console.WriteLine($"HttpStatusCode: {response.HttpStatusCode}");
Console.WriteLine($"Number of Keys: {response.KeyCount}");
foreach (var entry in response.S3Objects)
{
Console.WriteLine($"Key = {entry.Key} Size = {entry.Size}");
}
}
}
}
```
+ 如需 API 詳細資訊，請參閱《*適用於 .NET 的 AWS SDK API 參考*》中的 [ListObjectsV2](https://docs.aws.amazon.com/goto/DotNetSDKV3/s3-2006-03-01/ListObjectsV2)。
------
#### [ Bash ]
**AWS CLI 使用 Bash 指令碼**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/aws-cli/bash-linux/s3#code-examples)中設定和執行。
```
###############################################################################
# function errecho
#
# This function outputs everything sent to it to STDERR (standard error output).
###############################################################################
function errecho() {
printf "%s\n" "$*" 1>&2
}
###############################################################################
# function list_items_in_bucket
#
# This function displays a list of the files in the bucket with each file's
# size. The function uses the --query parameter to retrieve only the key and
# size fields from the Contents collection.
#
# Parameters:
# $1 - The name of the bucket.
#
# Returns:
# The list of files in text format.
# And:
# 0 - If successful.
# 1 - If it fails.
###############################################################################
function list_items_in_bucket() {
local bucket_name=$1
local response
response=$(aws s3api list-objects \
--bucket "$bucket_name" \
--output text \
--query 'Contents[].{Key: Key, Size: Size}')
# shellcheck disable=SC2181
if [[ ${?} -eq 0 ]]; then
echo "$response"
else
errecho "ERROR: AWS reports s3api list-objects operation failed.\n$response"
return 1
fi
}
```
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [ListObjectsV2](https://docs.aws.amazon.com/goto/aws-cli/s3-2006-03-01/ListObjectsV2)。
------
#### [ C\$1\$1 ]
**適用於 C\$1\$1 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/s3#code-examples)中設定和執行。
```
bool AwsDoc::S3::listObjects(const Aws::String &bucketName,
Aws::Vector &keysResult,
const Aws::S3::S3ClientConfiguration &clientConfig) {
Aws::S3::S3Client s3Client(clientConfig);
Aws::S3::Model::ListObjectsV2Request request;
request.WithBucket(bucketName);
Aws::String continuationToken; // Used for pagination.
Aws::Vector allObjects;
do {
if (!continuationToken.empty()) {
request.SetContinuationToken(continuationToken);
}
auto outcome = s3Client.ListObjectsV2(request);
if (!outcome.IsSuccess()) {
std::cerr << "Error: listObjects: " <<
outcome.GetError().GetMessage() << std::endl;
return false;
} else {
Aws::Vector objects =
outcome.GetResult().GetContents();
allObjects.insert(allObjects.end(), objects.begin(), objects.end());
continuationToken = outcome.GetResult().GetNextContinuationToken();
}
} while (!continuationToken.empty());
std::cout << allObjects.size() << " object(s) found:" << std::endl;
for (const auto &object: allObjects) {
std::cout << " " << object.GetKey() << std::endl;
keysResult.push_back(object.GetKey());
}
return true;
}
```
+ 如需 API 詳細資訊，請參閱《*適用於 C\$1\$1 的 AWS SDK API 參考*》中的 [ListObjectsV2](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/ListObjectsV2)。
------
#### [ CLI ]
**AWS CLI**
**取得儲存貯體中的物件清單**
下列 `list-objects-v2` 範例會列出指定儲存貯體中的物件。
```
aws s3api list-objects-v2 \
--bucket amzn-s3-demo-bucket
```
輸出：
```
{
"Contents": [
{
"LastModified": "2019-11-05T23:11:50.000Z",
"ETag": "\"621503c373607d548b37cff8778d992c\"",
"StorageClass": "STANDARD",
"Key": "doc1.rtf",
"Size": 391
},
{
"LastModified": "2019-11-05T23:11:50.000Z",
"ETag": "\"a2cecc36ab7c7fe3a71a273b9d45b1b5\"",
"StorageClass": "STANDARD",
"Key": "doc2.rtf",
"Size": 373
},
{
"LastModified": "2019-11-05T23:11:50.000Z",
"ETag": "\"08210852f65a2e9cb999972539a64d68\"",
"StorageClass": "STANDARD",
"Key": "doc3.rtf",
"Size": 399
},
{
"LastModified": "2019-11-05T23:11:50.000Z",
"ETag": "\"d1852dd683f404306569471af106988e\"",
"StorageClass": "STANDARD",
"Key": "doc4.rtf",
"Size": 6225
}
]
}
```
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [ListObjectsV2](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3api/list-objects-v2.html)。
------
#### [ Go ]
**SDK for Go V2**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/gov2/s3#code-examples)中設定和執行。
```
import (
"bytes"
"context"
"errors"
"fmt"
"io"
"log"
"os"
"time"
"github.com/aws/aws-sdk-go-v2/aws"
"github.com/aws/aws-sdk-go-v2/feature/s3/manager"
"github.com/aws/aws-sdk-go-v2/service/s3"
"github.com/aws/aws-sdk-go-v2/service/s3/types"
"github.com/aws/smithy-go"
)
// BucketBasics encapsulates the Amazon Simple Storage Service (Amazon S3) actions
// used in the examples.
// It contains S3Client, an Amazon S3 service client that is used to perform bucket
// and object actions.
type BucketBasics struct {
S3Client *s3.Client
}
// ListObjects lists the objects in a bucket.
func (basics BucketBasics) ListObjects(ctx context.Context, bucketName string) ([]types.Object, error) {
var err error
var output *s3.ListObjectsV2Output
input := &s3.ListObjectsV2Input{
Bucket: aws.String(bucketName),
}
var objects []types.Object
objectPaginator := s3.NewListObjectsV2Paginator(basics.S3Client, input)
for objectPaginator.HasMorePages() {
output, err = objectPaginator.NextPage(ctx)
if err != nil {
var noBucket *types.NoSuchBucket
if errors.As(err, &noBucket) {
log.Printf("Bucket %s does not exist.\n", bucketName)
err = noBucket
}
break
} else {
objects = append(objects, output.Contents...)
}
}
return objects, err
}
```
+ 如需 API 詳細資訊，請參閱《*適用於 Go 的 AWS SDK API 參考*》中的 [ListObjectsV2](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/s3#Client.ListObjectsV2)。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/s3#code-examples)中設定和執行。
```
/**
* Asynchronously lists all objects in the specified S3 bucket.
*
* @param bucketName the name of the S3 bucket to list objects for
* @return a {@link CompletableFuture} that completes when all objects have been listed
*/
public CompletableFuture listAllObjectsAsync(String bucketName) {
ListObjectsV2Request initialRequest = ListObjectsV2Request.builder()
.bucket(bucketName)
.maxKeys(1)
.build();
ListObjectsV2Publisher paginator = getAsyncClient().listObjectsV2Paginator(initialRequest);
return paginator.subscribe(response -> {
response.contents().forEach(s3Object -> {
logger.info("Object key: " + s3Object.key());
});
}).thenRun(() -> {
logger.info("Successfully listed all objects in the bucket: " + bucketName);
}).exceptionally(ex -> {
throw new RuntimeException("Failed to list objects", ex);
});
}
```
使用分頁列出物件。
```
import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.s3.S3Client;
import software.amazon.awssdk.services.s3.model.ListObjectsV2Request;
import software.amazon.awssdk.services.s3.model.S3Exception;
import software.amazon.awssdk.services.s3.paginators.ListObjectsV2Iterable;
public class ListObjectsPaginated {
public static void main(String[] args) {
final String usage = """
Usage:
\s
Where:
bucketName - The Amazon S3 bucket from which objects are read.\s
""";
if (args.length != 1) {
System.out.println(usage);
System.exit(1);
}
String bucketName = args[0];
Region region = Region.US_EAST_1;
S3Client s3 = S3Client.builder()
.region(region)
.build();
listBucketObjects(s3, bucketName);
s3.close();
}
/**
* Lists the objects in the specified S3 bucket.
*
* @param s3 the S3Client instance used to interact with Amazon S3
* @param bucketName the name of the S3 bucket to list the objects from
*/
public static void listBucketObjects(S3Client s3, String bucketName) {
try {
ListObjectsV2Request listReq = ListObjectsV2Request.builder()
.bucket(bucketName)
.maxKeys(1)
.build();
ListObjectsV2Iterable listRes = s3.listObjectsV2Paginator(listReq);
listRes.stream()
.flatMap(r -> r.contents().stream())
.forEach(content -> System.out.println(" Key: " + content.key() + " size = " + content.size()));
} catch (S3Exception e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
}
}
```
+ 如需 API 詳細資訊，請參閱《*AWS SDK for Java 2.x API 參考*》中的 [ListObjectsV2](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/ListObjectsV2)。
------
#### [ JavaScript ]
**適用於 JavaScript (v3) 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/s3#code-examples)中設定和執行。
條列儲存貯體中的所有物件。若有多個物件，IsTruncated 和 NextContinuationToken 將用於重複執行整份清單。
```
import {
S3Client,
S3ServiceException,
// This command supersedes the ListObjectsCommand and is the recommended way to list objects.
paginateListObjectsV2,
} from "@aws-sdk/client-s3";
/**
* Log all of the object keys in a bucket.
* @param {{ bucketName: string, pageSize: string }}
*/
export const main = async ({ bucketName, pageSize }) => {
const client = new S3Client({});
/** @type {string[][]} */
const objects = [];
try {
const paginator = paginateListObjectsV2(
{ client, /* Max items per page */ pageSize: Number.parseInt(pageSize) },
{ Bucket: bucketName },
);
for await (const page of paginator) {
objects.push(page.Contents.map((o) => o.Key));
}
objects.forEach((objectList, pageNum) => {
console.log(
`Page ${pageNum + 1}\n------\n${objectList.map((o) => `• ${o}`).join("\n")}\n`,
);
});
} catch (caught) {
if (
caught instanceof S3ServiceException &&
caught.name === "NoSuchBucket"
) {
console.error(
`Error from S3 while listing objects for "${bucketName}". The bucket doesn't exist.`,
);
} else if (caught instanceof S3ServiceException) {
console.error(
`Error from S3 while listing objects for "${bucketName}". ${caught.name}: ${caught.message}`,
);
} else {
throw caught;
}
}
};
```
+ 如需 API 詳細資訊，請參閱《*適用於 JavaScript 的 AWS SDK API 參考*》中的 [ListObjectsV2](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/s3/command/ListObjectsV2Command)。
------
#### [ Kotlin ]
**適用於 Kotlin 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/s3#code-examples)中設定和執行。
```
suspend fun listBucketObjects(bucketName: String) {
val request =
ListObjectsRequest {
bucket = bucketName
}
S3Client.fromEnvironment { region = "us-east-1" }.use { s3 ->
val response = s3.listObjects(request)
response.contents?.forEach { myObject ->
println("The name of the key is ${myObject.key}")
println("The object is ${myObject.size?.let { calKb(it) }} KBs")
println("The owner is ${myObject.owner}")
}
}
}
private fun calKb(intValue: Long): Long = intValue / 1024
```
+ 如需 API 詳細資訊，請參閱《*適用於 Kotlin 的AWS SDK API 參考*》中的 [ListObjectsV2](https://sdk.amazonaws.com/kotlin/api/latest/index.html)。
------
#### [ PHP ]
**適用於 PHP 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code/s3#code-examples)中設定和執行。
列出儲存貯體中的物件。
```
$s3client = new Aws\S3\S3Client(['region' => 'us-west-2']);
try {
$contents = $this->s3client->listObjectsV2([
'Bucket' => $this->bucketName,
]);
echo "The contents of your bucket are: \n";
foreach ($contents['Contents'] as $content) {
echo $content['Key'] . "\n";
}
} catch (Exception $exception) {
echo "Failed to list objects in $this->bucketName with error: " . $exception->getMessage();
exit("Please fix error with listing objects before continuing.");
}
```
+ 如需 API 詳細資訊，請參閱《*適用於 PHP 的 AWS SDK API 參考*》中的 [ListObjectsV2](https://docs.aws.amazon.com/goto/SdkForPHPV3/s3-2006-03-01/ListObjectsV2)。
------
#### [ Python ]
**適用於 Python 的 SDK (Boto3)**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/s3/s3_basics#code-examples)中設定和執行。
```
class ObjectWrapper:
"""Encapsulates S3 object actions."""
def __init__(self, s3_object):
"""
:param s3_object: A Boto3 Object resource. This is a high-level resource in Boto3
that wraps object actions in a class-like structure.
"""
self.object = s3_object
self.key = self.object.key
@staticmethod
def list(bucket, prefix=None):
"""
Lists the objects in a bucket, optionally filtered by a prefix.
:param bucket: The bucket to query. This is a Boto3 Bucket resource.
:param prefix: When specified, only objects that start with this prefix are listed.
:return: The list of objects.
"""
try:
if not prefix:
objects = list(bucket.objects.all())
else:
objects = list(bucket.objects.filter(Prefix=prefix))
logger.info(
"Got objects %s from bucket '%s'", [o.key for o in objects], bucket.name
)
except ClientError:
logger.exception("Couldn't get objects for bucket '%s'.", bucket.name)
raise
else:
return objects
```
+ 如需 API 詳細資訊，請參閱《*適用於 Python (Boto3) 的AWS SDK API 參考*》中的 [ListObjectsV2](https://docs.aws.amazon.com/goto/boto3/s3-2006-03-01/ListObjectsV2)。
------
#### [ Ruby ]
**SDK for Ruby**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/ruby/example_code/s3#code-examples)中設定和執行。
```
require 'aws-sdk-s3'
# Wraps Amazon S3 bucket actions.
class BucketListObjectsWrapper
attr_reader :bucket
# @param bucket [Aws::S3::Bucket] An existing Amazon S3 bucket.
def initialize(bucket)
@bucket = bucket
end
# Lists object in a bucket.
#
# @param max_objects [Integer] The maximum number of objects to list.
# @return [Integer] The number of objects listed.
def list_objects(max_objects)
count = 0
puts "The objects in #{@bucket.name} are:"
@bucket.objects.each do |obj|
puts "\t#{obj.key}"
count += 1
break if count == max_objects
end
count
rescue Aws::Errors::ServiceError => e
puts "Couldn't list objects in bucket #{bucket.name}. Here's why: #{e.message}"
0
end
end
# Example usage:
def run_demo
bucket_name = "amzn-s3-demo-bucket"
wrapper = BucketListObjectsWrapper.new(Aws::S3::Bucket.new(bucket_name))
count = wrapper.list_objects(25)
puts "Listed #{count} objects."
end
run_demo if $PROGRAM_NAME == __FILE__
```
+ 如需 API 詳細資訊，請參閱《*適用於 Ruby 的 AWS SDK API 參考*》中的 [ListObjectsV2](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/ListObjectsV2)。
------
#### [ Rust ]
**適用於 Rust 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/rustv1/examples/s3#code-examples)中設定和執行。
```
pub async fn list_objects(client: &aws_sdk_s3::Client, bucket: &str) -> Result<(), S3ExampleError> {
let mut response = client
.list_objects_v2()
.bucket(bucket.to_owned())
.max_keys(10) // In this example, go 10 at a time.
.into_paginator()
.send();
while let Some(result) = response.next().await {
match result {
Ok(output) => {
for object in output.contents() {
println!(" - {}", object.key().unwrap_or("Unknown"));
}
}
Err(err) => {
eprintln!("{err:?}")
}
}
}
Ok(())
}
```
+ 如需 API 詳細資訊，請參閱《*適用於 Rust 的AWS SDK API 參考*》中的 [ListObjectsV2](https://docs.rs/aws-sdk-s3/latest/aws_sdk_s3/client/struct.Client.html#method.list_objects_v2)。
------
#### [ SAP ABAP ]
**適用於 SAP ABAP 的開發套件**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/s3#code-examples)中設定和執行。
```
TRY.
oo_result = lo_s3->listobjectsv2( " oo_result is returned for testing purposes. "
iv_bucket = iv_bucket_name ).
MESSAGE 'Retrieved list of objects in S3 bucket.' TYPE 'I'.
CATCH /aws1/cx_s3_nosuchbucket.
MESSAGE 'Bucket does not exist.' TYPE 'E'.
ENDTRY.
```
+ 如需 API 詳細資訊，請參閱《*適用於 SAP ABAP 的AWS SDK API 參考*》中的 [ListObjectsV2](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)。
------
#### [ Swift ]
**適用於 Swift 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/swift/example_code/s3/basics#code-examples)中設定和執行。
```
import AWSS3
public func listBucketFiles(bucket: String) async throws -> [String] {
do {
let input = ListObjectsV2Input(
bucket: bucket
)
// Use "Paginated" to get all the objects.
// This lets the SDK handle the 'continuationToken' in "ListObjectsV2Output".
let output = client.listObjectsV2Paginated(input: input)
var names: [String] = []
for try await page in output {
guard let objList = page.contents else {
print("ERROR: listObjectsV2Paginated returned nil contents.")
continue
}
for obj in objList {
if let objName = obj.key {
names.append(objName)
}
}
}
return names
}
catch {
print("ERROR: ", dump(error, name: "Listing objects."))
throw error
}
}
```
+ 如需 API 詳細資訊，請參閱《*適用於 Swift 的AWS SDK API 參考*》中的 [ListObjectsV2](https://sdk.amazonaws.com/swift/api/awss3/latest/documentation/awss3/s3client/listobjectsv2(input:))。
------
# `PutBucketAccelerateConfiguration` 搭配 AWS SDK 或 CLI 使用
下列程式碼範例示範如何使用 `PutBucketAccelerateConfiguration`。
------
#### [ .NET ]
**適用於 .NET 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/S3#code-examples)中設定和執行。
```
using System;
using System.Threading.Tasks;
using Amazon.S3;
using Amazon.S3.Model;
///
/// Amazon Simple Storage Service (Amazon S3) Transfer Acceleration is a
/// bucket-level feature that enables you to perform faster data transfers
/// to Amazon S3. This example shows how to configure Transfer
/// Acceleration.
///
public class TransferAcceleration
{
///
/// The main method initializes the client object and sets the
/// Amazon Simple Storage Service (Amazon S3) bucket name before
/// calling EnableAccelerationAsync.
///
public static async Task Main()
{
var s3Client = new AmazonS3Client();
const string bucketName = "amzn-s3-demo-bucket";
await EnableAccelerationAsync(s3Client, bucketName);
}
///
/// This method sets the configuration to enable transfer acceleration
/// for the bucket referred to in the bucketName parameter.
///
/// An Amazon S3 client used to enable the
/// acceleration on an Amazon S3 bucket.
/// The name of the Amazon S3 bucket for which the
/// method will be enabling acceleration.
private static async Task EnableAccelerationAsync(AmazonS3Client client, string bucketName)
{
try
{
var putRequest = new PutBucketAccelerateConfigurationRequest
{
BucketName = bucketName,
AccelerateConfiguration = new AccelerateConfiguration
{
Status = BucketAccelerateStatus.Enabled,
},
};
await client.PutBucketAccelerateConfigurationAsync(putRequest);
var getRequest = new GetBucketAccelerateConfigurationRequest
{
BucketName = bucketName,
};
var response = await client.GetBucketAccelerateConfigurationAsync(getRequest);
Console.WriteLine($"Acceleration state = '{response.Status}' ");
}
catch (AmazonS3Exception ex)
{
Console.WriteLine($"Error occurred. Message:'{ex.Message}' when setting transfer acceleration");
}
}
}
```
+ 如需 API 詳細資訊，請參閱《適用於 .NET 的 AWS SDK API 參考》**中的 [PutBucketAccelerateConfiguration](https://docs.aws.amazon.com/goto/DotNetSDKV3/s3-2006-03-01/PutBucketAccelerateConfiguration)。
------
#### [ CLI ]
**AWS CLI**
**設定儲存貯體的加速組態**
下列 `put-bucket-accelerate-configuration` 範例會啟用指定儲存貯體的加速組態。
```
aws s3api put-bucket-accelerate-configuration \
--bucket amzn-s3-demo-bucket \
--accelerate-configuration Status=Enabled
```
此命令不會產生輸出。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [PutBucketAccelerateConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3api/put-bucket-accelerate-configuration.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此命令會使給定 S3 儲存貯體的傳輸加速。**
```
$statusVal = New-Object Amazon.S3.BucketAccelerateStatus('Enabled')
Write-S3BucketAccelerateConfiguration -BucketName 'amzn-s3-demo-bucket' -AccelerateConfiguration_Status $statusVal
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [PutBucketAccelerateConfiguration](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此命令會使給定 S3 儲存貯體的傳輸加速。**
```
$statusVal = New-Object Amazon.S3.BucketAccelerateStatus('Enabled')
Write-S3BucketAccelerateConfiguration -BucketName 'amzn-s3-demo-bucket' -AccelerateConfiguration_Status $statusVal
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [PutBucketAccelerateConfiguration](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# `PutBucketAcl` 搭配 AWS SDK 或 CLI 使用
下列程式碼範例示範如何使用 `PutBucketAcl`。
動作範例是大型程式的程式碼摘錄，必須在內容中執行。您可以在下列程式碼範例的內容中看到此動作：
+ [管理存取控制清單 (ACL)](s3_example_s3_Scenario_ManageACLs_section.md)
------
#### [ .NET ]
**適用於 .NET 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/S3#code-examples)中設定和執行。
```
///
/// Creates an Amazon S3 bucket with an ACL to control access to the
/// bucket and the objects stored in it.
///
/// The initialized client object used to create
/// an Amazon S3 bucket, with an ACL applied to the bucket.
///
/// The AWS Region where the bucket will be created.
/// The name of the bucket to create.
/// A boolean value indicating success or failure.
public static async Task CreateBucketUseCannedACLAsync(IAmazonS3 client, S3Region region, string newBucketName)
{
try
{
// Create a new Amazon S3 bucket with Canned ACL.
var putBucketRequest = new PutBucketRequest()
{
BucketName = newBucketName,
BucketRegion = region,
CannedACL = S3CannedACL.LogDeliveryWrite,
};
PutBucketResponse putBucketResponse = await client.PutBucketAsync(putBucketRequest);
return putBucketResponse.HttpStatusCode == System.Net.HttpStatusCode.OK;
}
catch (AmazonS3Exception ex)
{
Console.WriteLine($"Amazon S3 error: {ex.Message}");
}
return false;
}
```
+ 如需 API 詳細資訊，請參閱*《適用於 .NET 的 AWS SDK API 參考》*中的 [PutBucketAcl](https://docs.aws.amazon.com/goto/DotNetSDKV3/s3-2006-03-01/PutBucketAcl)。
------
#### [ C\$1\$1 ]
**適用於 C\$1\$1 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/s3#code-examples)中設定和執行。
```
bool AwsDoc::S3::putBucketAcl(const Aws::String &bucketName, const Aws::String &ownerID,
const Aws::String &granteePermission,
const Aws::String &granteeType, const Aws::String &granteeID,
const Aws::String &granteeEmailAddress,
const Aws::String &granteeURI, const Aws::S3::S3ClientConfiguration &clientConfig) {
Aws::S3::S3Client s3Client(clientConfig);
Aws::S3::Model::Owner owner;
owner.SetID(ownerID);
Aws::S3::Model::Grantee grantee;
grantee.SetType(setGranteeType(granteeType));
if (!granteeEmailAddress.empty()) {
grantee.SetEmailAddress(granteeEmailAddress);
}
if (!granteeID.empty()) {
grantee.SetID(granteeID);
}
if (!granteeURI.empty()) {
grantee.SetURI(granteeURI);
}
Aws::S3::Model::Grant grant;
grant.SetGrantee(grantee);
grant.SetPermission(setGranteePermission(granteePermission));
Aws::Vector grants;
grants.push_back(grant);
Aws::S3::Model::AccessControlPolicy acp;
acp.SetOwner(owner);
acp.SetGrants(grants);
Aws::S3::Model::PutBucketAclRequest request;
request.SetAccessControlPolicy(acp);
request.SetBucket(bucketName);
Aws::S3::Model::PutBucketAclOutcome outcome =
s3Client.PutBucketAcl(request);
if (!outcome.IsSuccess()) {
const Aws::S3::S3Error &error = outcome.GetError();
std::cerr << "Error: putBucketAcl: " << error.GetExceptionName()
<< " - " << error.GetMessage() << std::endl;
} else {
std::cout << "Successfully added an ACL to the bucket '" << bucketName
<< "'." << std::endl;
}
return outcome.IsSuccess();
}
//! Routine which converts a human-readable string to a built-in type enumeration.
/*!
\param access: Human readable string.
\return Permission: A Permission enum.
*/
Aws::S3::Model::Permission setGranteePermission(const Aws::String &access) {
if (access == "FULL_CONTROL")
return Aws::S3::Model::Permission::FULL_CONTROL;
if (access == "WRITE")
return Aws::S3::Model::Permission::WRITE;
if (access == "READ")
return Aws::S3::Model::Permission::READ;
if (access == "WRITE_ACP")
return Aws::S3::Model::Permission::WRITE_ACP;
if (access == "READ_ACP")
return Aws::S3::Model::Permission::READ_ACP;
return Aws::S3::Model::Permission::NOT_SET;
}
//! Routine which converts a human-readable string to a built-in type enumeration.
/*!
\param type: Human readable string.
\return Type: Type enumeration
*/
Aws::S3::Model::Type setGranteeType(const Aws::String &type) {
if (type == "Amazon customer by email")
return Aws::S3::Model::Type::AmazonCustomerByEmail;
if (type == "Canonical user")
return Aws::S3::Model::Type::CanonicalUser;
if (type == "Group")
return Aws::S3::Model::Type::Group;
return Aws::S3::Model::Type::NOT_SET;
}
```
+ 如需 API 詳細資訊，請參閱*《適用於 C\$1\$1 的 AWS SDK API 參考》*中的 [PutBucketAcl](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/PutBucketAcl)。
------
#### [ CLI ]
**AWS CLI**
此範例`full control`授予兩個 AWS 使用者 (*user1@example.com* 和 *user2@example.com*) 和`read`許可給每個人：
```
aws s3api put-bucket-acl --bucket amzn-s3-demo-bucket --grant-full-control emailaddress=user1@example.com,emailaddress=user2@example.com --grant-read uri=http://acs.amazonaws.com/groups/global/AllUsers
```
如需自訂 ACL (s3api ACL 命令如 `put-bucket-acl`，使用相同的速記引數表示法)，請參閱 http://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTacl.html。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [PutBucketAcl](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3api/put-bucket-acl.html)。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/s3#code-examples)中設定和執行。
```
import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.s3.S3Client;
import software.amazon.awssdk.services.s3.model.AccessControlPolicy;
import software.amazon.awssdk.services.s3.model.Grant;
import software.amazon.awssdk.services.s3.model.Permission;
import software.amazon.awssdk.services.s3.model.PutBucketAclRequest;
import software.amazon.awssdk.services.s3.model.S3Exception;
import software.amazon.awssdk.services.s3.model.Type;
import java.util.ArrayList;
import java.util.List;
/**
* Before running this Java V2 code example, set up your development
* environment, including your credentials.
*
* For more information, see the following documentation topic:
*
* https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/get-started.html
*/
public class SetAcl {
public static void main(String[] args) {
final String usage = """
Usage:
\s
Where:
bucketName - The Amazon S3 bucket to grant permissions on.\s
id - The ID of the owner of this bucket (you can get this value from the AWS Management Console).
""";
if (args.length != 2) {
System.out.println(usage);
return;
}
String bucketName = args[0];
String id = args[1];
System.out.format("Setting access \n");
System.out.println(" in bucket: " + bucketName);
Region region = Region.US_EAST_1;
S3Client s3 = S3Client.builder()
.region(region)
.build();
setBucketAcl(s3, bucketName, id);
System.out.println("Done!");
s3.close();
}
/**
* Sets the Access Control List (ACL) for an Amazon S3 bucket.
*
* @param s3 the S3Client instance to be used for the operation
* @param bucketName the name of the S3 bucket to set the ACL for
* @param id the ID of the AWS user or account that will be granted full control of the bucket
* @throws S3Exception if an error occurs while setting the bucket ACL
*/
public static void setBucketAcl(S3Client s3, String bucketName, String id) {
try {
Grant ownerGrant = Grant.builder()
.grantee(builder -> builder.id(id)
.type(Type.CANONICAL_USER))
.permission(Permission.FULL_CONTROL)
.build();
List grantList2 = new ArrayList<>();
grantList2.add(ownerGrant);
AccessControlPolicy acl = AccessControlPolicy.builder()
.owner(builder -> builder.id(id))
.grants(grantList2)
.build();
PutBucketAclRequest putAclReq = PutBucketAclRequest.builder()
.bucket(bucketName)
.accessControlPolicy(acl)
.build();
s3.putBucketAcl(putAclReq);
} catch (S3Exception e) {
e.printStackTrace();
System.exit(1);
}
}
}
```
+ 如需 API 詳細資訊，請參閱*《AWS SDK for Java 2.x API 參考》*中的 [PutBucketAcl](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/PutBucketAcl)。
------
#### [ JavaScript ]
**適用於 JavaScript (v3) 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/s3#code-examples)中設定和執行。
放置儲存貯體的 ACL。
```
import {
PutBucketAclCommand,
S3Client,
S3ServiceException,
} from "@aws-sdk/client-s3";
/**
* Grant read access to a user using their canonical AWS account ID.
*
* Most Amazon S3 use cases don't require the use of access control lists (ACLs).
* We recommend that you disable ACLs, except in unusual circumstances where
* you need to control access for each object individually. Consider a policy instead.
* For more information see https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucket-policies.html.
* @param {{ bucketName: string, granteeCanonicalUserId: string, ownerCanonicalUserId }}
*/
export const main = async ({
bucketName,
granteeCanonicalUserId,
ownerCanonicalUserId,
}) => {
const client = new S3Client({});
const command = new PutBucketAclCommand({
Bucket: bucketName,
AccessControlPolicy: {
Grants: [
{
Grantee: {
// The canonical ID of the user. This ID is an obfuscated form of your AWS account number.
// It's unique to Amazon S3 and can't be found elsewhere.
// For more information, see https://docs.aws.amazon.com/AmazonS3/latest/userguide/finding-canonical-user-id.html.
ID: granteeCanonicalUserId,
Type: "CanonicalUser",
},
// One of FULL_CONTROL | READ | WRITE | READ_ACP | WRITE_ACP
// https://docs.aws.amazon.com/AmazonS3/latest/API/API_Grant.html#AmazonS3-Type-Grant-Permission
Permission: "READ",
},
],
Owner: {
ID: ownerCanonicalUserId,
},
},
});
try {
await client.send(command);
console.log(`Granted READ access to ${bucketName}`);
} catch (caught) {
if (
caught instanceof S3ServiceException &&
caught.name === "NoSuchBucket"
) {
console.error(
`Error from S3 while setting ACL for bucket ${bucketName}. The bucket doesn't exist.`,
);
} else if (caught instanceof S3ServiceException) {
console.error(
`Error from S3 while setting ACL for bucket ${bucketName}. ${caught.name}: ${caught.message}`,
);
} else {
throw caught;
}
}
};
```
+ 如需詳細資訊，請參閱《[適用於 JavaScript 的 AWS SDK 開發人員指南](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/s3-example-access-permissions.html#s3-example-access-permissions-put-acl)》。
+ 如需 API 詳細資訊，請參閱*《適用於 JavaScript 的 AWS SDK API 參考》*中的 [PutBucketAcl](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/s3/command/PutBucketAclCommand)。
------
#### [ Kotlin ]
**適用於 Kotlin 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/s3#code-examples)中設定和執行。
```
suspend fun setBucketAcl(
bucketName: String,
idVal: String,
) {
val myGrant =
Grantee {
id = idVal
type = Type.CanonicalUser
}
val ownerGrant =
Grant {
grantee = myGrant
permission = Permission.FullControl
}
val grantList = mutableListOf()
grantList.add(ownerGrant)
val ownerOb =
Owner {
id = idVal
}
val acl =
AccessControlPolicy {
owner = ownerOb
grants = grantList
}
val request =
PutBucketAclRequest {
bucket = bucketName
accessControlPolicy = acl
}
S3Client.fromEnvironment { region = "us-east-1" }.use { s3 ->
s3.putBucketAcl(request)
println("An ACL was successfully set on $bucketName")
}
}
```
+ 如需 API 詳細資訊，請參閱*《適用於 Kotlin 的AWS SDK API 參考》*中的 [PutBucketAcl](https://sdk.amazonaws.com/kotlin/api/latest/index.html)。
------
#### [ Python ]
**適用於 Python 的 SDK (Boto3)**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/s3/s3_basics#code-examples)中設定和執行。
```
class BucketWrapper:
"""Encapsulates S3 bucket actions."""
def __init__(self, bucket):
"""
:param bucket: A Boto3 Bucket resource. This is a high-level resource in Boto3
that wraps bucket actions in a class-like structure.
"""
self.bucket = bucket
self.name = bucket.name
def grant_log_delivery_access(self):
"""
Grant the AWS Log Delivery group write access to the bucket so that
Amazon S3 can deliver access logs to the bucket. This is the only recommended
use of an S3 bucket ACL.
"""
try:
acl = self.bucket.Acl()
# Putting an ACL overwrites the existing ACL. If you want to preserve
# existing grants, append new grants to the list of existing grants.
grants = acl.grants if acl.grants else []
grants.append(
{
"Grantee": {
"Type": "Group",
"URI": "http://acs.amazonaws.com/groups/s3/LogDelivery",
},
"Permission": "WRITE",
}
)
acl.put(AccessControlPolicy={"Grants": grants, "Owner": acl.owner})
logger.info("Granted log delivery access to bucket '%s'", self.bucket.name)
except ClientError:
logger.exception("Couldn't add ACL to bucket '%s'.", self.bucket.name)
raise
```
+ 如需 API 詳細資訊，請參閱*《適用於 Python (Boto3) 的AWS SDK API 參考》*中的 [PutBucketAcl](https://docs.aws.amazon.com/goto/boto3/s3-2006-03-01/PutBucketAcl)。
------
#### [ SAP ABAP ]
**適用於 SAP ABAP 的開發套件**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/s3#code-examples)中設定和執行。
```
TRY.
" Example: Grant log delivery access to a bucket
" iv_grantwrite = 'uri=http://acs.amazonaws.com/groups/s3/LogDelivery'
lo_s3->putbucketacl(
iv_bucket = iv_bucket_name
iv_grantwrite = iv_grantwrite ).
MESSAGE 'Bucket ACL updated.' TYPE 'I'.
CATCH /aws1/cx_s3_nosuchbucket.
MESSAGE 'Bucket does not exist.' TYPE 'E'.
ENDTRY.
```
+ 如需 API 詳細資訊，請參閱《適用於 *AWS SAP ABAP 的 SDK API 參考*》中的 [PutBucketAcl](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)。
------
# `PutBucketCors` 搭配 AWS SDK 或 CLI 使用
下列程式碼範例示範如何使用 `PutBucketCors`。
------
#### [ .NET ]
**適用於 .NET 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/S3#code-examples)中設定和執行。
```
///
/// Add CORS configuration to the Amazon S3 bucket.
///
/// The initialized Amazon S3 client object used
/// to apply the CORS configuration to an Amazon S3 bucket.
/// The CORS configuration to apply.
private static async Task PutCORSConfigurationAsync(AmazonS3Client client, CORSConfiguration configuration)
{
PutCORSConfigurationRequest request = new PutCORSConfigurationRequest()
{
BucketName = BucketName,
Configuration = configuration,
};
_ = await client.PutCORSConfigurationAsync(request);
}
```
+ 如需 API 詳細資訊，請參閱*《適用於 .NET 的 AWS SDK API 參考》*中的 [PutBucketCors](https://docs.aws.amazon.com/goto/DotNetSDKV3/s3-2006-03-01/PutBucketCors)。
------
#### [ CLI ]
**AWS CLI**
下列範例會啟用來自 *www.example.com* 的 `PUT`、`POST` 和 `DELETE` 請求，並啟用來自任何網域的 `GET` 請求：
```
aws s3api put-bucket-cors --bucket amzn-s3-demo-bucket --cors-configuration file://cors.json
cors.json:
{
"CORSRules": [
{
"AllowedOrigins": ["http://www.example.com"],
"AllowedHeaders": ["*"],
"AllowedMethods": ["PUT", "POST", "DELETE"],
"MaxAgeSeconds": 3000,
"ExposeHeaders": ["x-amz-server-side-encryption"]
},
{
"AllowedOrigins": ["*"],
"AllowedHeaders": ["Authorization"],
"AllowedMethods": ["GET"],
"MaxAgeSeconds": 3000
}
]
}
```
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [PutBucketCors](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3api/put-bucket-cors.html)。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/s3#code-examples)中設定和執行。
```
import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.s3.S3Client;
import java.util.ArrayList;
import java.util.List;
import software.amazon.awssdk.services.s3.model.GetBucketCorsRequest;
import software.amazon.awssdk.services.s3.model.GetBucketCorsResponse;
import software.amazon.awssdk.services.s3.model.DeleteBucketCorsRequest;
import software.amazon.awssdk.services.s3.model.S3Exception;
import software.amazon.awssdk.services.s3.model.CORSRule;
import software.amazon.awssdk.services.s3.model.CORSConfiguration;
import software.amazon.awssdk.services.s3.model.PutBucketCorsRequest;
/**
* Before running this Java V2 code example, set up your development
* environment, including your credentials.
*
* For more information, see the following documentation topic:
*
* https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/get-started.html
*/
public class S3Cors {
public static void main(String[] args) {
final String usage = """
Usage:
\s
Where:
bucketName - The Amazon S3 bucket to upload an object into.
accountId - The id of the account that owns the Amazon S3 bucket.
""";
if (args.length != 2) {
System.out.println(usage);
System.exit(1);
}
String bucketName = args[0];
String accountId = args[1];
Region region = Region.US_EAST_1;
S3Client s3 = S3Client.builder()
.region(region)
.build();
setCorsInformation(s3, bucketName, accountId);
getBucketCorsInformation(s3, bucketName, accountId);
deleteBucketCorsInformation(s3, bucketName, accountId);
s3.close();
}
/**
* Deletes the CORS (Cross-Origin Resource Sharing) configuration for an Amazon S3 bucket.
*
* @param s3 the {@link S3Client} instance used to interact with the Amazon S3 service
* @param bucketName the name of the Amazon S3 bucket for which the CORS configuration should be deleted
* @param accountId the expected AWS account ID of the bucket owner
*
* @throws S3Exception if an error occurs while deleting the CORS configuration for the bucket
*/
public static void deleteBucketCorsInformation(S3Client s3, String bucketName, String accountId) {
try {
DeleteBucketCorsRequest bucketCorsRequest = DeleteBucketCorsRequest.builder()
.bucket(bucketName)
.expectedBucketOwner(accountId)
.build();
s3.deleteBucketCors(bucketCorsRequest);
} catch (S3Exception e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
}
/**
* Retrieves the CORS (Cross-Origin Resource Sharing) configuration for the specified S3 bucket.
*
* @param s3 the S3Client instance to use for the operation
* @param bucketName the name of the S3 bucket to retrieve the CORS configuration for
* @param accountId the expected bucket owner's account ID
*
* @throws S3Exception if there is an error retrieving the CORS configuration
*/
public static void getBucketCorsInformation(S3Client s3, String bucketName, String accountId) {
try {
GetBucketCorsRequest bucketCorsRequest = GetBucketCorsRequest.builder()
.bucket(bucketName)
.expectedBucketOwner(accountId)
.build();
GetBucketCorsResponse corsResponse = s3.getBucketCors(bucketCorsRequest);
List corsRules = corsResponse.corsRules();
for (CORSRule rule : corsRules) {
System.out.println("allowOrigins: " + rule.allowedOrigins());
System.out.println("AllowedMethod: " + rule.allowedMethods());
}
} catch (S3Exception e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
}
/**
* Sets the Cross-Origin Resource Sharing (CORS) rules for an Amazon S3 bucket.
*
* @param s3 The S3Client object used to interact with the Amazon S3 service.
* @param bucketName The name of the S3 bucket to set the CORS rules for.
* @param accountId The AWS account ID of the bucket owner.
*/
public static void setCorsInformation(S3Client s3, String bucketName, String accountId) {
List allowMethods = new ArrayList<>();
allowMethods.add("PUT");
allowMethods.add("POST");
allowMethods.add("DELETE");
List allowOrigins = new ArrayList<>();
allowOrigins.add("http://example.com");
try {
// Define CORS rules.
CORSRule corsRule = CORSRule.builder()
.allowedMethods(allowMethods)
.allowedOrigins(allowOrigins)
.build();
List corsRules = new ArrayList<>();
corsRules.add(corsRule);
CORSConfiguration configuration = CORSConfiguration.builder()
.corsRules(corsRules)
.build();
PutBucketCorsRequest putBucketCorsRequest = PutBucketCorsRequest.builder()
.bucket(bucketName)
.corsConfiguration(configuration)
.expectedBucketOwner(accountId)
.build();
s3.putBucketCors(putBucketCorsRequest);
} catch (S3Exception e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
}
}
```
+ 如需 API 詳細資訊，請參閱*《AWS SDK for Java 2.x API 參考》*中的 [PutBucketCors](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/PutBucketCors)。
------
#### [ JavaScript ]
**適用於 JavaScript (v3) 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/s3#code-examples)中設定和執行。
新增 CORS 規則。
```
import {
PutBucketCorsCommand,
S3Client,
S3ServiceException,
} from "@aws-sdk/client-s3";
/**
* Allows cross-origin requests to an S3 bucket by setting the CORS configuration.
* @param {{ bucketName: string }}
*/
export const main = async ({ bucketName }) => {
const client = new S3Client({});
try {
await client.send(
new PutBucketCorsCommand({
Bucket: bucketName,
CORSConfiguration: {
CORSRules: [
{
// Allow all headers to be sent to this bucket.
AllowedHeaders: ["*"],
// Allow only GET and PUT methods to be sent to this bucket.
AllowedMethods: ["GET", "PUT"],
// Allow only requests from the specified origin.
AllowedOrigins: ["https://www.example.com"],
// Allow the entity tag (ETag) header to be returned in the response. The ETag header
// The entity tag represents a specific version of the object. The ETag reflects
// changes only to the contents of an object, not its metadata.
ExposeHeaders: ["ETag"],
// How long the requesting browser should cache the preflight response. After
// this time, the preflight request will have to be made again.
MaxAgeSeconds: 3600,
},
],
},
}),
);
console.log(`Successfully set CORS rules for bucket: ${bucketName}`);
} catch (caught) {
if (
caught instanceof S3ServiceException &&
caught.name === "NoSuchBucket"
) {
console.error(
`Error from S3 while setting CORS rules for ${bucketName}. The bucket doesn't exist.`,
);
} else if (caught instanceof S3ServiceException) {
console.error(
`Error from S3 while setting CORS rules for ${bucketName}. ${caught.name}: ${caught.message}`,
);
} else {
throw caught;
}
}
};
```
+ 如需詳細資訊，請參閱《[適用於 JavaScript 的 AWS SDK 開發人員指南](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/s3-example-configuring-buckets.html#s3-example-configuring-buckets-put-cors)》。
+ 如需 API 詳細資訊，請參閱*《適用於 JavaScript 的 AWS SDK API 參考》*中的 [PutBucketCors](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/s3/command/PutBucketCorsCommand)。
------
#### [ Python ]
**適用於 Python 的 SDK (Boto3)**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/s3/s3_basics#code-examples)中設定和執行。
```
class BucketWrapper:
"""Encapsulates S3 bucket actions."""
def __init__(self, bucket):
"""
:param bucket: A Boto3 Bucket resource. This is a high-level resource in Boto3
that wraps bucket actions in a class-like structure.
"""
self.bucket = bucket
self.name = bucket.name
def put_cors(self, cors_rules):
"""
Apply CORS rules to the bucket. CORS rules specify the HTTP actions that are
allowed from other domains.
:param cors_rules: The CORS rules to apply.
"""
try:
self.bucket.Cors().put(CORSConfiguration={"CORSRules": cors_rules})
logger.info(
"Put CORS rules %s for bucket '%s'.", cors_rules, self.bucket.name
)
except ClientError:
logger.exception("Couldn't put CORS rules for bucket %s.", self.bucket.name)
raise
```
+ 如需 API 詳細資訊，請參閱*《適用於 Python (Boto3) 的AWS SDK API 參考》*中的 [PutBucketCors](https://docs.aws.amazon.com/goto/boto3/s3-2006-03-01/PutBucketCors)。
------
#### [ Ruby ]
**SDK for Ruby**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/ruby/example_code/s3#code-examples)中設定和執行。
```
require 'aws-sdk-s3'
# Wraps Amazon S3 bucket CORS configuration.
class BucketCorsWrapper
attr_reader :bucket_cors
# @param bucket_cors [Aws::S3::BucketCors] A bucket CORS object configured with an existing bucket.
def initialize(bucket_cors)
@bucket_cors = bucket_cors
end
# Sets CORS rules on a bucket.
#
# @param allowed_methods [Array] The types of HTTP requests to allow.
# @param allowed_origins [Array] The origins to allow.
# @returns [Boolean] True if the CORS rules were set; otherwise, false.
def set_cors(allowed_methods, allowed_origins)
@bucket_cors.put(
cors_configuration: {
cors_rules: [
{
allowed_methods: allowed_methods,
allowed_origins: allowed_origins,
allowed_headers: %w[*],
max_age_seconds: 3600
}
]
}
)
true
rescue Aws::Errors::ServiceError => e
puts "Couldn't set CORS rules for #{@bucket_cors.bucket.name}. Here's why: #{e.message}"
false
end
end
```
+ 如需 API 詳細資訊，請參閱*《適用於 Ruby 的 AWS SDK API 參考》*中的 [PutBucketCors](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/PutBucketCors)。
------
#### [ SAP ABAP ]
**適用於 SAP ABAP 的開發套件**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/s3#code-examples)中設定和執行。
```
TRY.
" Example: Allow PUT, POST, DELETE methods from http://www.example.com
lo_s3->putbucketcors(
iv_bucket = iv_bucket_name
io_corsconfiguration = NEW /aws1/cl_s3_corsconfiguration(
it_corsrules = it_cors_rules ) ).
MESSAGE 'Bucket CORS configuration set.' TYPE 'I'.
CATCH /aws1/cx_s3_nosuchbucket.
MESSAGE 'Bucket does not exist.' TYPE 'E'.
ENDTRY.
```
+ 如需 API 詳細資訊，請參閱《適用於 *AWS SAP ABAP 的 SDK API 參考*》中的 [PutBucketCors](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)。
------
# `PutBucketEncryption` 搭配 AWS SDK 或 CLI 使用
下列程式碼範例示範如何使用 `PutBucketEncryption`。
動作範例是大型程式的程式碼摘錄，必須在內容中執行。您可以在下列程式碼範例的內容中看到此動作：
+ [開始使用 S3](s3_example_s3_GettingStarted_section.md)
------
#### [ .NET ]
**適用於 .NET 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/S3/PutBucketEncryption#code-examples)中設定和執行。
```
///
/// Set the bucket server side encryption to use AWSKMS with a customer-managed key id.
///
/// Name of the bucket.
/// The Id of the KMS Key.
/// True if successful.
public static async Task SetBucketServerSideEncryption(string bucketName, string kmsKeyId)
{
var serverSideEncryptionByDefault = new ServerSideEncryptionConfiguration
{
ServerSideEncryptionRules = new List
{
new ServerSideEncryptionRule
{
ServerSideEncryptionByDefault = new ServerSideEncryptionByDefault
{
ServerSideEncryptionAlgorithm = ServerSideEncryptionMethod.AWSKMS,
ServerSideEncryptionKeyManagementServiceKeyId = kmsKeyId
}
}
}
};
try
{
var encryptionResponse = await _s3Client.PutBucketEncryptionAsync(new PutBucketEncryptionRequest
{
BucketName = bucketName,
ServerSideEncryptionConfiguration = serverSideEncryptionByDefault,
});
return encryptionResponse.HttpStatusCode == HttpStatusCode.OK;
}
catch (AmazonS3Exception ex)
{
Console.WriteLine(ex.ErrorCode == "AccessDenied"
? $"This account does not have permission to set encryption on {bucketName}, please try again."
: $"Unable to set bucket encryption for bucket {bucketName}, {ex.Message}");
}
return false;
}
```
+ 如需 API 詳細資訊，請參閱《*適用於 .NET 的 AWS SDK API 參考*》中的 [PutBucketEncryption](https://docs.aws.amazon.com/goto/DotNetSDKV3/s3-2006-03-01/PutBucketEncryption)。
------
#### [ CLI ]
**AWS CLI**
**針對儲存貯體設定伺服器端加密組態**
下列 `put-bucket-encryption` 範例會將 AES256 加密設定為指定儲存貯體的預設值。
```
aws s3api put-bucket-encryption \
--bucket amzn-s3-demo-bucket \
--server-side-encryption-configuration '{"Rules": [{"ApplyServerSideEncryptionByDefault": {"SSEAlgorithm": "AES256"}}]}'
```
此命令不會產生輸出。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [PutBucketEncryption](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3api/put-bucket-encryption.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此命令會在給定的儲存貯體上使用 Amazon S3 受管金鑰 (SSE-S3)，以啟用預設 AES256 伺服器端加密。 **
```
$Encryptionconfig = @{ServerSideEncryptionByDefault = @{ServerSideEncryptionAlgorithm = "AES256"}}
Set-S3BucketEncryption -BucketName 'amzn-s3-demo-bucket' -ServerSideEncryptionConfiguration_ServerSideEncryptionRule $Encryptionconfig
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [PutBucketEncryption](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此命令會在給定的儲存貯體上使用 Amazon S3 受管金鑰 (SSE-S3)，以啟用預設 AES256 伺服器端加密。 **
```
$Encryptionconfig = @{ServerSideEncryptionByDefault = @{ServerSideEncryptionAlgorithm = "AES256"}}
Set-S3BucketEncryption -BucketName 'amzn-s3-demo-bucket' -ServerSideEncryptionConfiguration_ServerSideEncryptionRule $Encryptionconfig
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [PutBucketEncryption](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# `PutBucketLifecycleConfiguration` 搭配 AWS SDK 或 CLI 使用
下列程式碼範例示範如何使用 `PutBucketLifecycleConfiguration`。
動作範例是大型程式的程式碼摘錄，必須在內容中執行。您可以在下列程式碼範例的內容中看到此動作：
+ [刪除未完成的分段上傳](s3_example_s3_Scenario_AbortMultipartUpload_section.md)
+ [使用 S3 管理大型訊息](s3_example_sqs_Scenario_SqsExtendedClient_section.md)
+ [使用版本化物件](s3_example_s3_Scenario_ObjectVersioningUsage_section.md)
------
#### [ .NET ]
**適用於 .NET 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/S3#code-examples)中設定和執行。
```
///
/// Adds lifecycle configuration information to the S3 bucket named in
/// the bucketName parameter.
///
/// The S3 client used to call the
/// PutLifecycleConfigurationAsync method.
/// A string representing the S3 bucket to
/// which configuration information will be added.
/// A LifecycleConfiguration object that
/// will be applied to the S3 bucket.
public static async Task AddExampleLifecycleConfigAsync(IAmazonS3 client, string bucketName, LifecycleConfiguration configuration)
{
var request = new PutLifecycleConfigurationRequest()
{
BucketName = bucketName,
Configuration = configuration,
};
var response = await client.PutLifecycleConfigurationAsync(request);
}
```
+ 如需 API 詳細資訊，請參閱*《適用於 .NET 的 AWS SDK API 參考》*中的 [PutBucketLifecycleConfiguration](https://docs.aws.amazon.com/goto/DotNetSDKV3/s3-2006-03-01/PutBucketLifecycleConfiguration)。
------
#### [ CLI ]
**AWS CLI**
下列命令會將生命週期組態套用至名為 `amzn-s3-demo-bucket` 的儲存貯體：
```
aws s3api put-bucket-lifecycle-configuration --bucket amzn-s3-demo-bucket --lifecycle-configuration file://lifecycle.json
```
檔案 `lifecycle.json` 是目前資料夾中的 JSON 文件，其中指定兩個規則：
```
{
"Rules": [
{
"ID": "Move rotated logs to Glacier",
"Prefix": "rotated/",
"Status": "Enabled",
"Transitions": [
{
"Date": "2015-11-10T00:00:00.000Z",
"StorageClass": "GLACIER"
}
]
},
{
"Status": "Enabled",
"Prefix": "",
"NoncurrentVersionTransitions": [
{
"NoncurrentDays": 2,
"StorageClass": "GLACIER"
}
],
"ID": "Move old versions to Glacier"
}
]
}
```
第一個規則會在指定的日期，將字首為 `rotated` 的檔案移至 Glacier。當舊物件版本不再是目前版本時，第二個規則會將舊物件版本移至 Glacier。如需可接受時間戳記格式的資訊，請參閱《*AWS CLI 使用者指南*》中的「指定參數值」。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [PutBucketLifecycleConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3api/put-bucket-lifecycle-configuration.html)。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/s3#code-examples)中設定和執行。
```
import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.s3.S3Client;
import software.amazon.awssdk.services.s3.model.LifecycleRuleFilter;
import software.amazon.awssdk.services.s3.model.Transition;
import software.amazon.awssdk.services.s3.model.GetBucketLifecycleConfigurationRequest;
import software.amazon.awssdk.services.s3.model.GetBucketLifecycleConfigurationResponse;
import software.amazon.awssdk.services.s3.model.DeleteBucketLifecycleRequest;
import software.amazon.awssdk.services.s3.model.TransitionStorageClass;
import software.amazon.awssdk.services.s3.model.LifecycleRule;
import software.amazon.awssdk.services.s3.model.ExpirationStatus;
import software.amazon.awssdk.services.s3.model.BucketLifecycleConfiguration;
import software.amazon.awssdk.services.s3.model.PutBucketLifecycleConfigurationRequest;
import software.amazon.awssdk.services.s3.model.S3Exception;
import java.util.ArrayList;
import java.util.List;
/**
* Before running this Java V2 code example, set up your development
* environment, including your credentials.
*
* For more information, see the following documentation topic:
*
* https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/get-started.html
*/
public class LifecycleConfiguration {
public static void main(String[] args) {
final String usage = """
Usage:
\s
Where:
bucketName - The Amazon Simple Storage Service (Amazon S3) bucket to upload an object into.
accountId - The id of the account that owns the Amazon S3 bucket.
""";
if (args.length != 2) {
System.out.println(usage);
System.exit(1);
}
String bucketName = args[0];
String accountId = args[1];
Region region = Region.US_EAST_1;
S3Client s3 = S3Client.builder()
.region(region)
.build();
setLifecycleConfig(s3, bucketName, accountId);
getLifecycleConfig(s3, bucketName, accountId);
deleteLifecycleConfig(s3, bucketName, accountId);
System.out.println("You have successfully created, updated, and deleted a Lifecycle configuration");
s3.close();
}
/**
* Sets the lifecycle configuration for an Amazon S3 bucket.
*
* @param s3 The Amazon S3 client to use for the operation.
* @param bucketName The name of the Amazon S3 bucket.
* @param accountId The expected owner of the Amazon S3 bucket.
*
* @throws S3Exception if there is an error setting the lifecycle configuration.
*/
public static void setLifecycleConfig(S3Client s3, String bucketName, String accountId) {
try {
// Create a rule to archive objects with the "glacierobjects/" prefix to the
// S3 Glacier Flexible Retrieval storage class immediately.
LifecycleRuleFilter ruleFilter = LifecycleRuleFilter.builder()
.prefix("glacierobjects/")
.build();
Transition transition = Transition.builder()
.storageClass(TransitionStorageClass.GLACIER)
.days(0)
.build();
LifecycleRule rule1 = LifecycleRule.builder()
.id("Archive immediately rule")
.filter(ruleFilter)
.transitions(transition)
.status(ExpirationStatus.ENABLED)
.build();
// Create a second rule.
Transition transition2 = Transition.builder()
.storageClass(TransitionStorageClass.GLACIER)
.days(0)
.build();
List transitionList = new ArrayList<>();
transitionList.add(transition2);
LifecycleRuleFilter ruleFilter2 = LifecycleRuleFilter.builder()
.prefix("glacierobjects/")
.build();
LifecycleRule rule2 = LifecycleRule.builder()
.id("Archive and then delete rule")
.filter(ruleFilter2)
.transitions(transitionList)
.status(ExpirationStatus.ENABLED)
.build();
// Add the LifecycleRule objects to an ArrayList.
ArrayList ruleList = new ArrayList<>();
ruleList.add(rule1);
ruleList.add(rule2);
BucketLifecycleConfiguration lifecycleConfiguration = BucketLifecycleConfiguration.builder()
.rules(ruleList)
.build();
PutBucketLifecycleConfigurationRequest putBucketLifecycleConfigurationRequest = PutBucketLifecycleConfigurationRequest
.builder()
.bucket(bucketName)
.lifecycleConfiguration(lifecycleConfiguration)
.expectedBucketOwner(accountId)
.build();
s3.putBucketLifecycleConfiguration(putBucketLifecycleConfigurationRequest);
} catch (S3Exception e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
}
/**
* Retrieves the lifecycle configuration for an Amazon S3 bucket and adds a new lifecycle rule to it.
*
* @param s3 the S3Client instance used to interact with Amazon S3
* @param bucketName the name of the Amazon S3 bucket
* @param accountId the expected owner of the Amazon S3 bucket
*/
public static void getLifecycleConfig(S3Client s3, String bucketName, String accountId) {
try {
GetBucketLifecycleConfigurationRequest getBucketLifecycleConfigurationRequest = GetBucketLifecycleConfigurationRequest
.builder()
.bucket(bucketName)
.expectedBucketOwner(accountId)
.build();
GetBucketLifecycleConfigurationResponse response = s3
.getBucketLifecycleConfiguration(getBucketLifecycleConfigurationRequest);
List newList = new ArrayList<>();
List rules = response.rules();
for (LifecycleRule rule : rules) {
newList.add(rule);
}
// Add a new rule with both a prefix predicate and a tag predicate.
LifecycleRuleFilter ruleFilter = LifecycleRuleFilter.builder()
.prefix("YearlyDocuments/")
.build();
Transition transition = Transition.builder()
.storageClass(TransitionStorageClass.GLACIER)
.days(3650)
.build();
LifecycleRule rule1 = LifecycleRule.builder()
.id("NewRule")
.filter(ruleFilter)
.transitions(transition)
.status(ExpirationStatus.ENABLED)
.build();
// Add the new rule to the list.
newList.add(rule1);
BucketLifecycleConfiguration lifecycleConfiguration = BucketLifecycleConfiguration.builder()
.rules(newList)
.build();
PutBucketLifecycleConfigurationRequest putBucketLifecycleConfigurationRequest = PutBucketLifecycleConfigurationRequest
.builder()
.bucket(bucketName)
.lifecycleConfiguration(lifecycleConfiguration)
.expectedBucketOwner(accountId)
.build();
s3.putBucketLifecycleConfiguration(putBucketLifecycleConfigurationRequest);
} catch (S3Exception e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
}
/**
* Deletes the lifecycle configuration for an Amazon S3 bucket.
*
* @param s3 the {@link S3Client} to use for the operation
* @param bucketName the name of the S3 bucket
* @param accountId the expected account owner of the S3 bucket
*
* @throws S3Exception if an error occurs while deleting the lifecycle configuration
*/
public static void deleteLifecycleConfig(S3Client s3, String bucketName, String accountId) {
try {
DeleteBucketLifecycleRequest deleteBucketLifecycleRequest = DeleteBucketLifecycleRequest
.builder()
.bucket(bucketName)
.expectedBucketOwner(accountId)
.build();
s3.deleteBucketLifecycle(deleteBucketLifecycleRequest);
} catch (S3Exception e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
}
}
```
+ 如需 API 詳細資訊，請參閱*《AWS SDK for Java 2.x API 參考》*中的 [PutBucketLifecycleConfiguration](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/PutBucketLifecycleConfiguration)。
------
#### [ Python ]
**適用於 Python 的 SDK (Boto3)**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/s3/s3_basics#code-examples)中設定和執行。
```
class BucketWrapper:
"""Encapsulates S3 bucket actions."""
def __init__(self, bucket):
"""
:param bucket: A Boto3 Bucket resource. This is a high-level resource in Boto3
that wraps bucket actions in a class-like structure.
"""
self.bucket = bucket
self.name = bucket.name
def put_lifecycle_configuration(self, lifecycle_rules):
"""
Apply a lifecycle configuration to the bucket. The lifecycle configuration can
be used to archive or delete the objects in the bucket according to specified
parameters, such as a number of days.
:param lifecycle_rules: The lifecycle rules to apply.
"""
try:
self.bucket.LifecycleConfiguration().put(
LifecycleConfiguration={"Rules": lifecycle_rules}
)
logger.info(
"Put lifecycle rules %s for bucket '%s'.",
lifecycle_rules,
self.bucket.name,
)
except ClientError:
logger.exception(
"Couldn't put lifecycle rules for bucket '%s'.", self.bucket.name
)
raise
```
+ 如需 API 詳細資訊，請參閱*《適用於 Python (Boto3) 的AWS SDK API 參考》*中的 [PutBucketLifecycleConfiguration](https://docs.aws.amazon.com/goto/boto3/s3-2006-03-01/PutBucketLifecycleConfiguration)。
------
#### [ SAP ABAP ]
**適用於 SAP ABAP 的開發套件**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/s3#code-examples)中設定和執行。
```
TRY.
" Example: Expire objects with prefix 'logs/' after 30 days
lo_s3->putbucketlifecycleconf(
iv_bucket = iv_bucket_name
io_lifecycleconfiguration = NEW /aws1/cl_s3_bucketlcconf(
it_rules = it_lifecycle_rule ) ).
MESSAGE 'Bucket lifecycle configuration set.' TYPE 'I'.
CATCH /aws1/cx_s3_nosuchbucket.
MESSAGE 'Bucket does not exist.' TYPE 'E'.
ENDTRY.
```
+ 如需 API 詳細資訊，請參閱《適用於 *AWS SAP ABAP 的 SDK API 參考*》中的 [PutBucketLifecycleConfiguration](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)。
------
# `PutBucketLogging` 搭配 AWS SDK 或 CLI 使用
下列程式碼範例示範如何使用 `PutBucketLogging`。
------
#### [ .NET ]
**適用於 .NET 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/S3#code-examples)中設定和執行。
```
using System;
using System.IO;
using System.Threading.Tasks;
using Amazon.S3;
using Amazon.S3.Model;
using Microsoft.Extensions.Configuration;
///
/// This example shows how to enable logging on an Amazon Simple Storage
/// Service (Amazon S3) bucket. You need to have two Amazon S3 buckets for
/// this example. The first is the bucket for which you wish to enable
/// logging, and the second is the location where you want to store the
/// logs.
///
public class ServerAccessLogging
{
private static IConfiguration _configuration = null!;
public static async Task Main()
{
LoadConfig();
string bucketName = _configuration["BucketName"];
string logBucketName = _configuration["LogBucketName"];
string logObjectKeyPrefix = _configuration["LogObjectKeyPrefix"];
string accountId = _configuration["AccountId"];
// If the AWS Region defined for your default user is different
// from the Region where your Amazon S3 bucket is located,
// pass the Region name to the Amazon S3 client object's constructor.
// For example: RegionEndpoint.USWest2 or RegionEndpoint.USEast2.
IAmazonS3 client = new AmazonS3Client();
try
{
// Update bucket policy for target bucket to allow delivery of logs to it.
await SetBucketPolicyToAllowLogDelivery(
client,
bucketName,
logBucketName,
logObjectKeyPrefix,
accountId);
// Enable logging on the source bucket.
await EnableLoggingAsync(
client,
bucketName,
logBucketName,
logObjectKeyPrefix);
}
catch (AmazonS3Exception e)
{
Console.WriteLine($"Error: {e.Message}");
}
}
///
/// This method grants appropriate permissions for logging to the
/// Amazon S3 bucket where the logs will be stored.
///
/// The initialized Amazon S3 client which will be used
/// to apply the bucket policy.
/// The name of the source bucket.
/// The name of the bucket where logging
/// information will be stored.
/// The logging prefix where the logs should be delivered.
/// The account id of the account where the source bucket exists.
/// Async task.
public static async Task SetBucketPolicyToAllowLogDelivery(
IAmazonS3 client,
string sourceBucketName,
string logBucketName,
string logPrefix,
string accountId)
{
var resourceArn = @"""arn:aws:s3:::" + logBucketName + "/" + logPrefix + @"*""";
var newPolicy = @"{
""Statement"":[{
""Sid"": ""S3ServerAccessLogsPolicy"",
""Effect"": ""Allow"",
""Principal"": { ""Service"": ""logging.s3.amazonaws.com"" },
""Action"": [""s3:PutObject""],
""Resource"": [" + resourceArn + @"],
""Condition"": {
""ArnLike"": { ""aws:SourceArn"": ""arn:aws:s3:::" + sourceBucketName + @""" },
""StringEquals"": { ""aws:SourceAccount"": """ + accountId + @""" }
}
}]
}";
Console.WriteLine($"The policy to apply to bucket {logBucketName} to enable logging:");
Console.WriteLine(newPolicy);
PutBucketPolicyRequest putRequest = new PutBucketPolicyRequest
{
BucketName = logBucketName,
Policy = newPolicy,
};
await client.PutBucketPolicyAsync(putRequest);
Console.WriteLine("Policy applied.");
}
///
/// This method enables logging for an Amazon S3 bucket. Logs will be stored
/// in the bucket you selected for logging. Selected prefix
/// will be prepended to each log object.
///
/// The initialized Amazon S3 client which will be used
/// to configure and apply logging to the selected Amazon S3 bucket.
/// The name of the Amazon S3 bucket for which you
/// wish to enable logging.
/// The name of the Amazon S3 bucket where logging
/// information will be stored.
/// The prefix to prepend to each
/// object key.
/// Async task.
public static async Task EnableLoggingAsync(
IAmazonS3 client,
string bucketName,
string logBucketName,
string logObjectKeyPrefix)
{
Console.WriteLine($"Enabling logging for bucket {bucketName}.");
var loggingConfig = new S3BucketLoggingConfig
{
TargetBucketName = logBucketName,
TargetPrefix = logObjectKeyPrefix,
};
var putBucketLoggingRequest = new PutBucketLoggingRequest
{
BucketName = bucketName,
LoggingConfig = loggingConfig,
};
await client.PutBucketLoggingAsync(putBucketLoggingRequest);
Console.WriteLine($"Logging enabled.");
}
///
/// Loads configuration from settings files.
///
public static void LoadConfig()
{
_configuration = new ConfigurationBuilder()
.SetBasePath(Directory.GetCurrentDirectory())
.AddJsonFile("settings.json") // Load settings from .json file.
.AddJsonFile("settings.local.json", true) // Optionally, load local settings.
.Build();
}
}
```
+ 如需 API 詳細資訊，請參閱《適用於 .NET 的 AWS SDK API 參考》**中的 [PutBucketLogging](https://docs.aws.amazon.com/goto/DotNetSDKV3/s3-2006-03-01/PutBucketLogging)。
------
#### [ CLI ]
**AWS CLI**
**範例 1：設定儲存貯體政策記錄**
以下 `put-bucket-logging` 範例會設定 *amzn-s3-demo-bucket* 的記錄政策。首先，使用 `put-bucket-policy` 命令在儲存貯體政策中，將許可權授予日誌記錄服務主體。
```
aws s3api put-bucket-policy \
--bucket amzn-s3-demo-bucket \
--policy file://policy.json
```
`policy.json` 的內容：
```
{
"Version":"2012-10-17",
"Statement": [
{
"Sid": "S3ServerAccessLogsPolicy",
"Effect": "Allow",
"Principal": {"Service": "logging.s3.amazonaws.com"},
"Action": "s3:PutObject",
"Resource": "arn:aws:s3:::amzn-s3-demo-bucket/Logs/*",
"Condition": {
"ArnLike": {"aws:SourceARN": "arn:aws:s3:::SOURCE-BUCKET-NAME"},
"StringEquals": {"aws:SourceAccount": "SOURCE-AWS-ACCOUNT-ID"}
}
}
]
}
```
使用 `put-bucket-logging` 套用記錄政策。
```
aws s3api put-bucket-logging \
--bucket amzn-s3-demo-bucket \
--bucket-logging-status file://logging.json
```
`logging.json` 的內容：
```
{
"LoggingEnabled": {
"TargetBucket": "amzn-s3-demo-bucket",
"TargetPrefix": "Logs/"
}
}
```
需要 `put-bucket-policy` 命令才能將 `s3:PutObject` 許可權授予日誌記錄服務主體。
如需詳細資訊，請參閱《Amazon S3 使用者指南》**中的 [Amazon S3 伺服器存取日誌記錄](https://docs.aws.amazon.com/AmazonS3/latest/userguide/ServerLogs.html)。
**範例 2：僅將日誌記錄的儲存貯體政策設定給單一使用者**
以下 `put-bucket-logging` 範例會設定 *amzn-s3-demo-bucket* 的記錄政策。 AWS 使用者 *bob@example.com* 將擁有對日誌檔案的完全控制權，且沒有人具有任何存取權。首先，使用 `put-bucket-acl` 授予 S3 許可權。
```
aws s3api put-bucket-acl \
--bucket amzn-s3-demo-bucket \
--grant-write URI=http://acs.amazonaws.com/groups/s3/LogDelivery \
--grant-read-acp URI=http://acs.amazonaws.com/groups/s3/LogDelivery
```
接著，使用 `put-bucket-logging` 套用日誌記錄政策。
```
aws s3api put-bucket-logging \
--bucket amzn-s3-demo-bucket \
--bucket-logging-status file://logging.json
```
`logging.json` 的內容：
```
{
"LoggingEnabled": {
"TargetBucket": "amzn-s3-demo-bucket",
"TargetPrefix": "amzn-s3-demo-bucket-logs/",
"TargetGrants": [
{
"Grantee": {
"Type": "AmazonCustomerByEmail",
"EmailAddress": "bob@example.com"
},
"Permission": "FULL_CONTROL"
}
]
}
}
```
必須使用 `put-bucket-acl` 命令，才能將必要許可權 (write 及 read-acp 許可權) 授予 S3 日誌交付系統。
如需詳細資訊，請參閱《Amazon S3 開發人員指南》**中的 [Amazon S3 伺服器存取日誌記錄](https://docs.aws.amazon.com/AmazonS3/latest/userguide/ServerLogs.html)。
+ 如需 API 詳細資訊，請參閱《*AWS CLI 命令參考*》中的 [PutBucketLogging](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3api/put-bucket-logging.html)。
------
# 搭配使用 `PutBucketNotification` 與 CLI
下列程式碼範例示範如何使用 `PutBucketNotification`。
------
#### [ CLI ]
**AWS CLI**
將通知組態套用至名為 `amzn-s3-demo-bucket` 的儲存貯體：
```
aws s3api put-bucket-notification --bucket amzn-s3-demo-bucket --notification-configuration file://notification.json
```
檔案 `notification.json` 是目前資料夾中的 JSON 文件，可用來指定 SNS 主題，以及要監控的事件類型：
```
{
"TopicConfiguration": {
"Event": "s3:ObjectCreated:*",
"Topic": "arn:aws:sns:us-west-2:123456789012:s3-notification-topic"
}
}
```
SNS 主題必須連接 IAM 政策，以允許 Amazon S3 發佈至該政策：
```
{
"Version":"2012-10-17",
"Id": "example-ID",
"Statement": [
{
"Sid": "example-statement-ID",
"Effect": "Allow",
"Principal": {
"Service": "s3.amazonaws.com"
},
"Action": [
"SNS:Publish"
],
"Resource": "arn:aws:sns:us-west-2:123456789012:amzn-s3-demo-bucket",
"Condition": {
"ArnLike": {
"aws:SourceArn": "arn:aws:s3:*:*:amzn-s3-demo-bucket"
}
}
}
]
}
```
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [PutBucketNotification](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3api/put-bucket-notification.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例會設定 S3 事件 ObjectRemovedDelete 的 SNS 主題組態，並啟用給定 s3 儲存貯體的通知**
```
$topic = [Amazon.S3.Model.TopicConfiguration] @{
Id = "delete-event"
Topic = "arn:aws:sns:eu-west-1:123456789012:topic-1"
Event = [Amazon.S3.EventType]::ObjectRemovedDelete
}
Write-S3BucketNotification -BucketName amzn-s3-demo-bucket -TopicConfiguration $topic
```
**範例 2：此範例會為傳送至 Lambda 函式的給定儲存貯體，啟用 ObjectCreatedAll 通知。**
```
$lambdaConfig = [Amazon.S3.Model.LambdaFunctionConfiguration] @{
Events = "s3:ObjectCreated:*"
FunctionArn = "arn:aws:lambda:eu-west-1:123456789012:function:rdplock"
Id = "ObjectCreated-Lambda"
Filter = @{
S3KeyFilter = @{
FilterRules = @(
@{Name="Prefix";Value="dada"}
@{Name="Suffix";Value=".pem"}
)
}
}
}
Write-S3BucketNotification -BucketName amzn-s3-demo-bucket -LambdaFunctionConfiguration $lambdaConfig
```
**範例 3：此範例會根據不同的索引鍵尾碼建立 2 個不同的 Lambda 組態，並在單一命令中同時設定兩者。**
```
#Lambda Config 1
$firstLambdaConfig = [Amazon.S3.Model.LambdaFunctionConfiguration] @{
Events = "s3:ObjectCreated:*"
FunctionArn = "arn:aws:lambda:eu-west-1:123456789012:function:verifynet"
Id = "ObjectCreated-dada-ps1"
Filter = @{
S3KeyFilter = @{
FilterRules = @(
@{Name="Prefix";Value="dada"}
@{Name="Suffix";Value=".ps1"}
)
}
}
}
#Lambda Config 2
$secondlambdaConfig = [Amazon.S3.Model.LambdaFunctionConfiguration] @{
Events = [Amazon.S3.EventType]::ObjectCreatedAll
FunctionArn = "arn:aws:lambda:eu-west-1:123456789012:function:verifyssm"
Id = "ObjectCreated-dada-json"
Filter = @{
S3KeyFilter = @{
FilterRules = @(
@{Name="Prefix";Value="dada"}
@{Name="Suffix";Value=".json"}
)
}
}
}
Write-S3BucketNotification -BucketName amzn-s3-demo-bucket -LambdaFunctionConfiguration $firstLambdaConfig,$secondlambdaConfig
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [PutBucketNotification](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例會設定 S3 事件 ObjectRemovedDelete 的 SNS 主題組態，並啟用給定 s3 儲存貯體的通知**
```
$topic = [Amazon.S3.Model.TopicConfiguration] @{
Id = "delete-event"
Topic = "arn:aws:sns:eu-west-1:123456789012:topic-1"
Event = [Amazon.S3.EventType]::ObjectRemovedDelete
}
Write-S3BucketNotification -BucketName amzn-s3-demo-bucket -TopicConfiguration $topic
```
**範例 2：此範例會為傳送至 Lambda 函式的給定儲存貯體，啟用 ObjectCreatedAll 通知。**
```
$lambdaConfig = [Amazon.S3.Model.LambdaFunctionConfiguration] @{
Events = "s3:ObjectCreated:*"
FunctionArn = "arn:aws:lambda:eu-west-1:123456789012:function:rdplock"
Id = "ObjectCreated-Lambda"
Filter = @{
S3KeyFilter = @{
FilterRules = @(
@{Name="Prefix";Value="dada"}
@{Name="Suffix";Value=".pem"}
)
}
}
}
Write-S3BucketNotification -BucketName amzn-s3-demo-bucket -LambdaFunctionConfiguration $lambdaConfig
```
**範例 3：此範例會根據不同的索引鍵尾碼建立 2 個不同的 Lambda 組態，並在單一命令中同時設定兩者。**
```
#Lambda Config 1
$firstLambdaConfig = [Amazon.S3.Model.LambdaFunctionConfiguration] @{
Events = "s3:ObjectCreated:*"
FunctionArn = "arn:aws:lambda:eu-west-1:123456789012:function:verifynet"
Id = "ObjectCreated-dada-ps1"
Filter = @{
S3KeyFilter = @{
FilterRules = @(
@{Name="Prefix";Value="dada"}
@{Name="Suffix";Value=".ps1"}
)
}
}
}
#Lambda Config 2
$secondlambdaConfig = [Amazon.S3.Model.LambdaFunctionConfiguration] @{
Events = [Amazon.S3.EventType]::ObjectCreatedAll
FunctionArn = "arn:aws:lambda:eu-west-1:123456789012:function:verifyssm"
Id = "ObjectCreated-dada-json"
Filter = @{
S3KeyFilter = @{
FilterRules = @(
@{Name="Prefix";Value="dada"}
@{Name="Suffix";Value=".json"}
)
}
}
}
Write-S3BucketNotification -BucketName amzn-s3-demo-bucket -LambdaFunctionConfiguration $firstLambdaConfig,$secondlambdaConfig
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [PutBucketNotification](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# `PutBucketNotificationConfiguration` 搭配 AWS SDK 或 CLI 使用
下列程式碼範例示範如何使用 `PutBucketNotificationConfiguration`。
動作範例是大型程式的程式碼摘錄，必須在內容中執行。您可以在下列程式碼範例的內容中看到此動作：
+ [處理 S3 事件通知](s3_example_s3_Scenario_ProcessS3EventNotification_section.md)
+ [將事件通知傳送至 EventBridge](s3_example_s3_Scenario_PutBucketNotificationConfiguration_section.md)
------
#### [ .NET ]
**適用於 .NET 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/S3#code-examples)中設定和執行。
```
using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Amazon.S3;
using Amazon.S3.Model;
///
/// This example shows how to enable notifications for an Amazon Simple
/// Storage Service (Amazon S3) bucket.
///
public class EnableNotifications
{
public static async Task Main()
{
const string bucketName = "amzn-s3-demo-bucket1";
const string snsTopic = "arn:aws:sns:us-east-2:0123456789ab:bucket-notify";
const string sqsQueue = "arn:aws:sqs:us-east-2:0123456789ab:Example_Queue";
IAmazonS3 client = new AmazonS3Client(Amazon.RegionEndpoint.USEast2);
await EnableNotificationAsync(client, bucketName, snsTopic, sqsQueue);
}
///
/// This method makes the call to the PutBucketNotificationAsync method.
///
/// An initialized Amazon S3 client used to call
/// the PutBucketNotificationAsync method.
/// The name of the bucket for which
/// notifications will be turned on.
/// The ARN for the Amazon Simple Notification
/// Service (Amazon SNS) topic associated with the S3 bucket.
/// The ARN of the Amazon Simple Queue Service
/// (Amazon SQS) queue to which notifications will be pushed.
public static async Task EnableNotificationAsync(
IAmazonS3 client,
string bucketName,
string snsTopic,
string sqsQueue)
{
try
{
// The bucket for which we are setting up notifications.
var request = new PutBucketNotificationRequest()
{
BucketName = bucketName,
};
// Defines the topic to use when sending a notification.
var topicConfig = new TopicConfiguration()
{
Events = new List { EventType.ObjectCreatedCopy },
Topic = snsTopic,
};
request.TopicConfigurations = new List
{
topicConfig,
};
request.QueueConfigurations = new List
{
new QueueConfiguration()
{
Events = new List { EventType.ObjectCreatedPut },
Queue = sqsQueue,
},
};
// Now apply the notification settings to the bucket.
PutBucketNotificationResponse response = await client.PutBucketNotificationAsync(request);
}
catch (AmazonS3Exception ex)
{
Console.WriteLine($"Error: {ex.Message}");
}
}
}
```
+ 如需 API 詳細資訊，請參閱《適用於 .NET 的 AWS SDK API 參考》**中的 [PutBucketNotificationConfiguration](https://docs.aws.amazon.com/goto/DotNetSDKV3/s3-2006-03-01/PutBucketNotificationConfiguration)。
------
#### [ CLI ]
**AWS CLI**
**啟用儲存貯體的指定通知**
以下 `put-bucket-notification-configuration` 範例會套用通知組態至名為 `amzn-s3-demo-bucket` 的儲存貯體。檔案 `notification.json` 是目前資料夾中的 JSON 文件，可用來指定 SNS 主題，以及要監控的事件類型。
```
aws s3api put-bucket-notification-configuration \
--bucket amzn-s3-demo-bucket \
--notification-configuration file://notification.json
```
`notification.json` 的內容：
```
{
"TopicConfigurations": [
{
"TopicArn": "arn:aws:sns:us-west-2:123456789012:s3-notification-topic",
"Events": [
"s3:ObjectCreated:*"
]
}
]
}
```
SNS 主題必須連接 IAM 政策，以允許 Amazon S3 發佈至該政策。
```
{
"Version":"2012-10-17",
"Id": "example-ID",
"Statement": [
{
"Sid": "example-statement-ID",
"Effect": "Allow",
"Principal": {
"Service": "s3.amazonaws.com"
},
"Action": [
"SNS:Publish"
],
"Resource": "arn:aws:sns:us-west-2:123456789012::s3-notification-topic",
"Condition": {
"ArnLike": {
"aws:SourceArn": "arn:aws:s3:*:*:amzn-s3-demo-bucket"
}
}
}
]
}
```
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [PutBucketNotificationConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3api/put-bucket-notification-configuration.html)。
------
# `PutBucketPolicy` 搭配 AWS SDK 或 CLI 使用
下列程式碼範例示範如何使用 `PutBucketPolicy`。
------
#### [ C\$1\$1 ]
**適用於 C\$1\$1 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/s3#code-examples)中設定和執行。
```
bool AwsDoc::S3::putBucketPolicy(const Aws::String &bucketName,
const Aws::String &policyBody,
const Aws::S3::S3ClientConfiguration &clientConfig) {
Aws::S3::S3Client s3Client(clientConfig);
std::shared_ptr request_body =
Aws::MakeShared("");
*request_body << policyBody;
Aws::S3::Model::PutBucketPolicyRequest request;
request.SetBucket(bucketName);
request.SetBody(request_body);
Aws::S3::Model::PutBucketPolicyOutcome outcome =
s3Client.PutBucketPolicy(request);
if (!outcome.IsSuccess()) {
std::cerr << "Error: putBucketPolicy: "
<< outcome.GetError().GetMessage() << std::endl;
} else {
std::cout << "Set the following policy body for the bucket '" <<
bucketName << "':" << std::endl << std::endl;
std::cout << policyBody << std::endl;
}
return outcome.IsSuccess();
}
//! Build a policy JSON string.
/*!
\param userArn: Aws user Amazon Resource Name (ARN).
For more information, see https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns.
\param bucketName: Name of a bucket.
\return String: Policy as JSON string.
*/
Aws::String getPolicyString(const Aws::String &userArn,
const Aws::String &bucketName) {
return
"{\n"
" \"Version\":\"2012-10-17\",\n"
" \"Statement\":[\n"
" {\n"
" \"Sid\": \"1\",\n"
" \"Effect\": \"Allow\",\n"
" \"Principal\": {\n"
" \"AWS\": \""
+ userArn +
"\"\n"" },\n"
" \"Action\": [ \"s3:getObject\" ],\n"
" \"Resource\": [ \"arn:aws:s3:::"
+ bucketName +
"/*\" ]\n"
" }\n"
" ]\n"
"}";
}
```
+ 如需 API 詳細資訊，請參閱*《適用於 C\$1\$1 的 AWS SDK API 參考》*中的 [PutBucketPolicy](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/PutBucketPolicy)。
------
#### [ CLI ]
**AWS CLI**
此範例允許所有使用者擷取 *amzn-s3-demo-bucket* 中的任何物件，但 *MySecretFolder* 中的物件除外。它也會將 `put`和 `delete`許可授予 AWS 帳戶 的根使用者`1234-5678-9012`：
```
aws s3api put-bucket-policy --bucket amzn-s3-demo-bucket --policy file://policy.json
policy.json:
{
"Statement": [
{
"Effect": "Allow",
"Principal": "*",
"Action": "s3:GetObject",
"Resource": "arn:aws:s3:::amzn-s3-demo-bucket/*"
},
{
"Effect": "Deny",
"Principal": "*",
"Action": "s3:GetObject",
"Resource": "arn:aws:s3:::amzn-s3-demo-bucket/MySecretFolder/*"
},
{
"Effect": "Allow",
"Principal": {
"AWS": "arn:aws:iam::123456789012:root"
},
"Action": [
"s3:DeleteObject",
"s3:PutObject"
],
"Resource": "arn:aws:s3:::amzn-s3-demo-bucket/*"
}
]
}
```
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [PutBucketPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3api/put-bucket-policy.html)。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/s3#code-examples)中設定和執行。
```
import software.amazon.awssdk.services.s3.S3Client;
import software.amazon.awssdk.services.s3.model.PutBucketPolicyRequest;
import software.amazon.awssdk.services.s3.model.S3Exception;
import software.amazon.awssdk.regions.Region;
import java.io.IOException;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.nio.file.Paths;
import java.util.List;
import com.fasterxml.jackson.core.JsonParser;
import com.fasterxml.jackson.databind.ObjectMapper;
/**
* Before running this Java V2 code example, set up your development
* environment, including your credentials.
*
* For more information, see the following documentation topic:
*
* https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/get-started.html
*/
public class SetBucketPolicy {
public static void main(String[] args) {
final String usage = """
Usage:
Where:
bucketName - The Amazon S3 bucket to set the policy on.
polFile - A JSON file containing the policy (see the Amazon S3 Readme for an example).\s
""";
if (args.length != 2) {
System.out.println(usage);
System.exit(1);
}
String bucketName = args[0];
String polFile = args[1];
String policyText = getBucketPolicyFromFile(polFile);
Region region = Region.US_EAST_1;
S3Client s3 = S3Client.builder()
.region(region)
.build();
setPolicy(s3, bucketName, policyText);
s3.close();
}
/**
* Sets the policy for an Amazon S3 bucket.
*
* @param s3 the {@link S3Client} object used to interact with the Amazon S3 service
* @param bucketName the name of the Amazon S3 bucket
* @param policyText the text of the policy to be set on the bucket
* @throws S3Exception if there is an error setting the bucket policy
*/
public static void setPolicy(S3Client s3, String bucketName, String policyText) {
System.out.println("Setting policy:");
System.out.println("----");
System.out.println(policyText);
System.out.println("----");
System.out.format("On Amazon S3 bucket: \"%s\"\n", bucketName);
try {
PutBucketPolicyRequest policyReq = PutBucketPolicyRequest.builder()
.bucket(bucketName)
.policy(policyText)
.build();
s3.putBucketPolicy(policyReq);
} catch (S3Exception e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
System.out.println("Done!");
}
/**
* Retrieves the bucket policy from a specified file.
*
* @param policyFile the path to the file containing the bucket policy
* @return the content of the bucket policy file as a string
*/
public static String getBucketPolicyFromFile(String policyFile) {
StringBuilder fileText = new StringBuilder();
try {
List lines = Files.readAllLines(Paths.get(policyFile), StandardCharsets.UTF_8);
for (String line : lines) {
fileText.append(line);
}
} catch (IOException e) {
System.out.format("Problem reading file: \"%s\"", policyFile);
System.out.println(e.getMessage());
}
try {
final JsonParser parser = new ObjectMapper().getFactory().createParser(fileText.toString());
while (parser.nextToken() != null) {
}
} catch (IOException jpe) {
jpe.printStackTrace();
}
return fileText.toString();
}
}
```
+ 如需 API 詳細資訊，請參閱*《AWS SDK for Java 2.x API 參考》*中的 [PutBucketPolicy](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/PutBucketPolicy)。
------
#### [ JavaScript ]
**適用於 JavaScript (v3) 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/s3#code-examples)中設定和執行。
新增政策。
```
import {
PutBucketPolicyCommand,
S3Client,
S3ServiceException,
} from "@aws-sdk/client-s3";
/**
* Grant an IAM role GetObject access to all of the objects
* in the provided bucket.
* @param {{ bucketName: string, iamRoleArn: string }}
*/
export const main = async ({ bucketName, iamRoleArn }) => {
const client = new S3Client({});
const command = new PutBucketPolicyCommand({
// This is a resource-based policy. For more information on resource-based policies,
// see https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_resource-based.
Policy: JSON.stringify({
Version: "2012-10-17",
Statement: [
{
Effect: "Allow",
Principal: {
AWS: iamRoleArn,
},
Action: "s3:GetObject",
Resource: `arn:aws:s3:::${bucketName}/*`,
},
],
}),
// Apply the preceding policy to this bucket.
Bucket: bucketName,
});
try {
await client.send(command);
console.log(
`GetObject access to the bucket "${bucketName}" was granted to the provided IAM role.`,
);
} catch (caught) {
if (
caught instanceof S3ServiceException &&
caught.name === "MalformedPolicy"
) {
console.error(
`Error from S3 while setting the bucket policy for the bucket "${bucketName}". The policy was malformed.`,
);
} else if (caught instanceof S3ServiceException) {
console.error(
`Error from S3 while setting the bucket policy for the bucket "${bucketName}". ${caught.name}: ${caught.message}`,
);
} else {
throw caught;
}
}
};
```
+ 如需詳細資訊，請參閱《[適用於 JavaScript 的 AWS SDK 開發人員指南](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/s3-example-bucket-policies.html#s3-example-bucket-policies-set-policy)》。
+ 如需 API 詳細資訊，請參閱*《適用於 JavaScript 的 AWS SDK API 參考》*中的 [PutBucketPolicy](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/s3/command/PutBucketPolicyCommand)。
------
#### [ Python ]
**適用於 Python 的 SDK (Boto3)**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/s3/s3_basics#code-examples)中設定和執行。
```
class BucketWrapper:
"""Encapsulates S3 bucket actions."""
def __init__(self, bucket):
"""
:param bucket: A Boto3 Bucket resource. This is a high-level resource in Boto3
that wraps bucket actions in a class-like structure.
"""
self.bucket = bucket
self.name = bucket.name
def put_policy(self, policy):
"""
Apply a security policy to the bucket. Policies control users' ability
to perform specific actions, such as listing the objects in the bucket.
:param policy: The policy to apply to the bucket.
"""
try:
self.bucket.Policy().put(Policy=json.dumps(policy))
logger.info("Put policy %s for bucket '%s'.", policy, self.bucket.name)
except ClientError:
logger.exception("Couldn't apply policy to bucket '%s'.", self.bucket.name)
raise
```
+ 如需 API 詳細資訊，請參閱*《適用於 Python (Boto3) 的AWS SDK API 參考》*中的 [PutBucketPolicy](https://docs.aws.amazon.com/goto/boto3/s3-2006-03-01/PutBucketPolicy)。
------
#### [ Ruby ]
**SDK for Ruby**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/ruby/example_code/s3#code-examples)中設定和執行。
```
# Wraps an Amazon S3 bucket policy.
class BucketPolicyWrapper
attr_reader :bucket_policy
# @param bucket_policy [Aws::S3::BucketPolicy] A bucket policy object configured with an existing bucket.
def initialize(bucket_policy)
@bucket_policy = bucket_policy
end
# Sets a policy on a bucket.
#
def policy(policy)
@bucket_policy.put(policy: policy)
true
rescue Aws::Errors::ServiceError => e
puts "Couldn't set the policy for #{@bucket_policy.bucket.name}. Here's why: #{e.message}"
false
end
end
```
+ 如需 API 詳細資訊，請參閱*《適用於 Ruby 的 AWS SDK API 參考》*中的 [PutBucketPolicy](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/PutBucketPolicy)。
------
#### [ SAP ABAP ]
**適用於 SAP ABAP 的開發套件**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/s3#code-examples)中設定和執行。
```
TRY.
" Example policy JSON string
" iv_policy = '{"Version":"2012-10-17", "Statement":[{"Effect":"Allow","Principal":{"AWS":"arn:aws:iam::123456789012:user/user"},"Action":["s3:GetObject"],"Resource":["arn:aws:s3:::bucketname/*"]}]}'
lo_s3->putbucketpolicy(
iv_bucket = iv_bucket_name
iv_policy = iv_policy ).
MESSAGE 'Bucket policy set.' TYPE 'I'.
CATCH /aws1/cx_s3_nosuchbucket.
MESSAGE 'Bucket does not exist.' TYPE 'E'.
ENDTRY.
```
+ 如需 API 詳細資訊，請參閱《適用於 *AWS SAP ABAP 的 SDK API 參考*》中的 [PutBucketPolicy](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)。
------
# `PutBucketReplication` 搭配 AWS SDK 或 CLI 使用
下列程式碼範例示範如何使用 `PutBucketReplication`。
------
#### [ CLI ]
**AWS CLI**
**設定 S3 儲存貯體的複寫**
下列 `put-bucket-replication` 範例會將複寫組態套用至指定的 S3 儲存貯體。
```
aws s3api put-bucket-replication \
--bucket amzn-s3-demo-bucket1 \
--replication-configuration file://replication.json
```
`replication.json` 的內容：
```
{
"Role": "arn:aws:iam::123456789012:role/s3-replication-role",
"Rules": [
{
"Status": "Enabled",
"Priority": 1,
"DeleteMarkerReplication": { "Status": "Disabled" },
"Filter" : { "Prefix": ""},
"Destination": {
"Bucket": "arn:aws:s3:::amzn-s3-demo-bucket2"
}
}
]
}
```
目的地儲存貯體必須啟用版本控制。指定的角色必須具有寫入目的地儲存貯體的許可權，並具有允許 Amazon S3 擔任該角色的信任關係。
範例角色許可政策：
```
{
"Version":"2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"s3:GetReplicationConfiguration",
"s3:ListBucket"
],
"Resource": [
"arn:aws:s3:::amzn-s3-demo-bucket1"
]
},
{
"Effect": "Allow",
"Action": [
"s3:GetObjectVersion",
"s3:GetObjectVersionAcl",
"s3:GetObjectVersionTagging"
],
"Resource": [
"arn:aws:s3:::amzn-s3-demo-bucket1/*"
]
},
{
"Effect": "Allow",
"Action": [
"s3:ReplicateObject",
"s3:ReplicateDelete",
"s3:ReplicateTags"
],
"Resource": "arn:aws:s3:::amzn-s3-demo-bucket2/*"
}
]
}
```
範例信任關係政策：
```
{
"Version":"2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Principal": {
"Service": "s3.amazonaws.com"
},
"Action": "sts:AssumeRole"
}
]
}
```
此命令不會產生輸出。
如需詳細資訊，請參閱《Amazon Simple Storage Service 主控台使用者指南》**中的[這是主題標題](https://docs.aws.amazon.com/AmazonS3/latest/user-guide/enable-replication.html)。
+ 如需 API 詳細資訊，請參閱《*AWS CLI 命令參考*》中的 [PutBucketReplication](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3api/put-bucket-replication.html)。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/s3#code-examples)中設定和執行。
```
/**
* Sets the replication configuration for an Amazon S3 bucket.
*
* @param s3Client the S3Client instance to use for the operation
* @param sourceBucketName the name of the source bucket
* @param destBucketName the name of the destination bucket
* @param destinationBucketARN the Amazon Resource Name (ARN) of the destination bucket
* @param roleARN the ARN of the IAM role to use for the replication configuration
*/
public static void setReplication(S3Client s3Client, String sourceBucketName, String destBucketName, String destinationBucketARN, String roleARN) {
try {
Destination destination = Destination.builder()
.bucket(destinationBucketARN)
.storageClass(StorageClass.STANDARD)
.build();
// Define a prefix filter for replication.
ReplicationRuleFilter ruleFilter = ReplicationRuleFilter.builder()
.prefix("documents/")
.build();
// Define delete marker replication setting.
DeleteMarkerReplication deleteMarkerReplication = DeleteMarkerReplication.builder()
.status(DeleteMarkerReplicationStatus.DISABLED)
.build();
// Create the replication rule.
ReplicationRule replicationRule = ReplicationRule.builder()
.priority(1)
.filter(ruleFilter)
.status(ReplicationRuleStatus.ENABLED)
.deleteMarkerReplication(deleteMarkerReplication)
.destination(destination)
.build();
List replicationRuleList = new ArrayList<>();
replicationRuleList.add(replicationRule);
// Define the replication configuration with IAM role.
ReplicationConfiguration configuration = ReplicationConfiguration.builder()
.role(roleARN)
.rules(replicationRuleList)
.build();
// Apply the replication configuration to the source bucket.
PutBucketReplicationRequest replicationRequest = PutBucketReplicationRequest.builder()
.bucket(sourceBucketName)
.replicationConfiguration(configuration)
.build();
s3Client.putBucketReplication(replicationRequest);
System.out.println("Replication configuration set successfully.");
} catch (IllegalArgumentException e) {
System.err.println("Configuration error: " + e.getMessage());
} catch (S3Exception e) {
System.err.println("S3 Exception: " + e.awsErrorDetails().errorMessage());
System.err.println("Status Code: " + e.statusCode());
System.err.println("Error Code: " + e.awsErrorDetails().errorCode());
} catch (SdkException e) {
System.err.println("SDK Exception: " + e.getMessage());
}
}
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Java 2.x API 參考》**中的 [PutBucketReplication](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/PutBucketReplication)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例設定了一個複寫組態，其中的一條規則允許將儲存貯體 'amzn-s3-demo-bucket' 中鍵名字首為 "TaxDocs" 所建立的任何新物件，複製到 'amzn-s3-demo-bucket' 儲存貯體。**
```
$rule1 = New-Object Amazon.S3.Model.ReplicationRule
$rule1.ID = "Rule-1"
$rule1.Status = "Enabled"
$rule1.Prefix = "TaxDocs"
$rule1.Destination = @{ BucketArn = "arn:aws:s3:::amzn-s3-demo-destination-bucket" }
$params = @{
BucketName = "amzn-s3-demo-bucket"
Configuration_Role = "arn:aws:iam::35667example:role/CrossRegionReplicationRoleForS3"
Configuration_Rule = $rule1
}
Write-S3BucketReplication @params
```
**範例 2：此範例設定具有多個規則的複寫組態，可將任何以鍵名字首 "TaxDocs" 或 "OtherDocs" 建立的新物件，複寫至 'amzn-s3-demo-bucket' 儲存貯體。索引鍵字首不得重疊。**
```
$rule1 = New-Object Amazon.S3.Model.ReplicationRule
$rule1.ID = "Rule-1"
$rule1.Status = "Enabled"
$rule1.Prefix = "TaxDocs"
$rule1.Destination = @{ BucketArn = "arn:aws:s3:::amzn-s3-demo-destination-bucket" }
$rule2 = New-Object Amazon.S3.Model.ReplicationRule
$rule2.ID = "Rule-2"
$rule2.Status = "Enabled"
$rule2.Prefix = "OtherDocs"
$rule2.Destination = @{ BucketArn = "arn:aws:s3:::amzn-s3-demo-destination-bucket" }
$params = @{
BucketName = "amzn-s3-demo-bucket"
Configuration_Role = "arn:aws:iam::35667example:role/CrossRegionReplicationRoleForS3"
Configuration_Rule = $rule1,$rule2
}
Write-S3BucketReplication @params
```
**範例 3：此範例會更新指定之儲存貯體上的複寫組態，以停用控制將鍵名字首為 "TaxDocs" 之物件複寫至 'amzn-s3-demo-bucket' 儲存貯體的規則。**
```
$rule1 = New-Object Amazon.S3.Model.ReplicationRule
$rule1.ID = "Rule-1"
$rule1.Status = "Disabled"
$rule1.Prefix = "TaxDocs"
$rule1.Destination = @{ BucketArn = "arn:aws:s3:::amzn-s3-demo-destination-bucket" }
$params = @{
BucketName = "amzn-s3-demo-bucket"
Configuration_Role = "arn:aws:iam::35667example:role/CrossRegionReplicationRoleForS3"
Configuration_Rule = $rule1
}
Write-S3BucketReplication @params
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [PutBucketReplication](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例設定了一個複寫組態，其中的一條規則允許將儲存貯體 'amzn-s3-demo-bucket' 中鍵名字首為 "TaxDocs" 所建立的任何新物件，複製到 'amzn-s3-demo-bucket' 儲存貯體。**
```
$rule1 = New-Object Amazon.S3.Model.ReplicationRule
$rule1.ID = "Rule-1"
$rule1.Status = "Enabled"
$rule1.Prefix = "TaxDocs"
$rule1.Destination = @{ BucketArn = "arn:aws:s3:::amzn-s3-demo-destination-bucket" }
$params = @{
BucketName = "amzn-s3-demo-bucket"
Configuration_Role = "arn:aws:iam::35667example:role/CrossRegionReplicationRoleForS3"
Configuration_Rule = $rule1
}
Write-S3BucketReplication @params
```
**範例 2：此範例設定具有多個規則的複寫組態，可將任何以鍵名字首 "TaxDocs" 或 "OtherDocs" 建立的新物件，複寫至 'amzn-s3-demo-bucket' 儲存貯體。索引鍵字首不得重疊。**
```
$rule1 = New-Object Amazon.S3.Model.ReplicationRule
$rule1.ID = "Rule-1"
$rule1.Status = "Enabled"
$rule1.Prefix = "TaxDocs"
$rule1.Destination = @{ BucketArn = "arn:aws:s3:::amzn-s3-demo-destination-bucket" }
$rule2 = New-Object Amazon.S3.Model.ReplicationRule
$rule2.ID = "Rule-2"
$rule2.Status = "Enabled"
$rule2.Prefix = "OtherDocs"
$rule2.Destination = @{ BucketArn = "arn:aws:s3:::amzn-s3-demo-destination-bucket" }
$params = @{
BucketName = "amzn-s3-demo-bucket"
Configuration_Role = "arn:aws:iam::35667example:role/CrossRegionReplicationRoleForS3"
Configuration_Rule = $rule1,$rule2
}
Write-S3BucketReplication @params
```
**範例 3：此範例會更新指定之儲存貯體上的複寫組態，以停用控制將鍵名字首為 "TaxDocs" 之物件複寫至 'amzn-s3-demo-bucket' 儲存貯體的規則。**
```
$rule1 = New-Object Amazon.S3.Model.ReplicationRule
$rule1.ID = "Rule-1"
$rule1.Status = "Disabled"
$rule1.Prefix = "TaxDocs"
$rule1.Destination = @{ BucketArn = "arn:aws:s3:::amzn-s3-demo-destination-bucket" }
$params = @{
BucketName = "amzn-s3-demo-bucket"
Configuration_Role = "arn:aws:iam::35667example:role/CrossRegionReplicationRoleForS3"
Configuration_Rule = $rule1
}
Write-S3BucketReplication @params
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [PutBucketReplication](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `PutBucketRequestPayment` 與 CLI
下列程式碼範例示範如何使用 `PutBucketRequestPayment`。
------
#### [ CLI ]
**AWS CLI**
**範例 1：啟用儲存貯體的 ``requester pays`` 組態**
下列 `put-bucket-request-payment` 範例會啟用指定儲存貯體的 `requester pays`。
```
aws s3api put-bucket-request-payment \
--bucket amzn-s3-demo-bucket \
--request-payment-configuration '{"Payer":"Requester"}'
```
此命令不會產生輸出。
**範例 2：停用儲存貯體的 ``requester pays`` 組態**
下列 `put-bucket-request-payment` 範例會針對指定的儲存貯體停用 `requester pays`。
```
aws s3api put-bucket-request-payment \
--bucket amzn-s3-demo-bucket \
--request-payment-configuration '{"Payer":"BucketOwner"}'
```
此命令不會產生輸出。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [PutBucketRequestPayment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3api/put-bucket-request-payment.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：更新名為 'amzn-s3-demo-bucket' 之儲存貯體的請求付費組態，如此一來，請求從儲存貯體下載的人員將需支付下載費用。根據預設，儲存貯體擁有者需支付下載費用。若要將請求付費設回預設，請針對 RequestPaymentConfiguration\$1Payer 參數使用 'BucketOwner'。**
```
Write-S3BucketRequestPayment -BucketName amzn-s3-demo-bucket -RequestPaymentConfiguration_Payer Requester
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [PutBucketRequestPayment](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：更新名為 'amzn-s3-demo-bucket' 之儲存貯體的請求付費組態，如此一來，請求從儲存貯體下載的人員將需支付下載費用。根據預設，儲存貯體擁有者需支付下載費用。若要將請求付費設回預設，請針對 RequestPaymentConfiguration\$1Payer 參數使用 'BucketOwner'。**
```
Write-S3BucketRequestPayment -BucketName amzn-s3-demo-bucket -RequestPaymentConfiguration_Payer Requester
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [PutBucketRequestPayment](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `PutBucketTagging` 與 CLI
下列程式碼範例示範如何使用 `PutBucketTagging`。
動作範例是大型程式的程式碼摘錄，必須在內容中執行。您可以在下列程式碼範例的內容中看到此動作：
+ [開始使用 S3](s3_example_s3_GettingStarted_section.md)
------
#### [ CLI ]
**AWS CLI**
下列命令會將標記組態套用至名為 `amzn-s3-demo-bucket` 的儲存貯體：
```
aws s3api put-bucket-tagging --bucket amzn-s3-demo-bucket --tagging file://tagging.json
```
檔案 `tagging.json` 是目前資料夾中指定標籤的 JSON 文件：
```
{
"TagSet": [
{
"Key": "organization",
"Value": "marketing"
}
]
}
```
或直接從命令列將標記組態套用至 `amzn-s3-demo-bucket`：
```
aws s3api put-bucket-tagging --bucket amzn-s3-demo-bucket --tagging 'TagSet=[{Key=organization,Value=marketing}]'
```
+ 如需 API 詳細資訊，請參閱《*AWS CLI 命令參考*》中的 [PutBucketTagging](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3api/put-bucket-tagging.html)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此命令會將兩個標籤套用至名為 `cloudtrail-test-2018` 的儲存貯體：一個是索引鍵為 Stage 且值為 Test 的標籤，另一個是索引鍵為 Environment 且值為 Alpha 的標籤。若要驗證標籤是否已新增至儲存貯體，請執行 `Get-S3BucketTagging -BucketName bucket_name`。結果應該會顯示您在第一個命令中套用至儲存貯體的標籤。請注意，`Write-S3BucketTagging` 會覆寫儲存貯體上設定的整個現有標籤。若要新增或刪除個別標籤，請執行資源群組和標記 API Cmdlet，`Add-RGTResourceTag` 和 `Remove-RGTResourceTag`。或者，在 AWS 管理主控台中使用標籤編輯器來管理 S3 儲存貯體標籤。**
```
Write-S3BucketTagging -BucketName amzn-s3-demo-bucket -TagSet @( @{ Key="Stage"; Value="Test" }, @{ Key="Environment"; Value="Alpha" } )
```
**範例 2：此命令會將名為 `cloudtrail-test-2018` 的儲存貯體傳輸至 `Write-S3BucketTagging` cmdlet。範例會將標籤 Stage:Production 和 Department:Finance 套用至儲存貯體。請注意，`Write-S3BucketTagging` 會覆寫儲存貯體上設定的整個現有標籤。**
```
Get-S3Bucket -BucketName amzn-s3-demo-bucket | Write-S3BucketTagging -TagSet @( @{ Key="Stage"; Value="Production" }, @{ Key="Department"; Value="Finance" } )
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [PutBucketTagging](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此命令會將兩個標籤套用至名為 `cloudtrail-test-2018` 的儲存貯體：一個是索引鍵為 Stage 且值為 Test 的標籤，另一個是索引鍵為 Environment 且值為 Alpha 的標籤。若要驗證標籤是否已新增至儲存貯體，請執行 `Get-S3BucketTagging -BucketName bucket_name`。結果應該會顯示您在第一個命令中套用至儲存貯體的標籤。請注意，`Write-S3BucketTagging` 會覆寫儲存貯體上設定的整個現有標籤。若要新增或刪除個別標籤，請執行資源群組和標記 API Cmdlet，`Add-RGTResourceTag` 和 `Remove-RGTResourceTag`。或者，在 AWS 管理主控台中使用標籤編輯器來管理 S3 儲存貯體標籤。**
```
Write-S3BucketTagging -BucketName amzn-s3-demo-bucket -TagSet @( @{ Key="Stage"; Value="Test" }, @{ Key="Environment"; Value="Alpha" } )
```
**範例 2：此命令會將名為 `cloudtrail-test-2018` 的儲存貯體傳輸至 `Write-S3BucketTagging` cmdlet。範例會將標籤 Stage:Production 和 Department:Finance 套用至儲存貯體。請注意，`Write-S3BucketTagging` 會覆寫儲存貯體上設定的整個現有標籤。**
```
Get-S3Bucket -BucketName amzn-s3-demo-bucket | Write-S3BucketTagging -TagSet @( @{ Key="Stage"; Value="Production" }, @{ Key="Department"; Value="Finance" } )
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [PutBucketTagging](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# `PutBucketVersioning` 搭配 AWS SDK 或 CLI 使用
下列程式碼範例示範如何使用 `PutBucketVersioning`。
動作範例是大型程式的程式碼摘錄，必須在內容中執行。您可以在下列程式碼範例的內容中看到此動作：
+ [開始使用 S3](s3_example_s3_GettingStarted_section.md)
------
#### [ CLI ]
**AWS CLI**
下列命令會啟用名為 `amzn-s3-demo-bucket` 的儲存貯體上的版本控制：
```
aws s3api put-bucket-versioning --bucket amzn-s3-demo-bucket --versioning-configuration Status=Enabled
```
下列命令會啟用版本控制，並使用 mfa 程式碼
```
aws s3api put-bucket-versioning --bucket amzn-s3-demo-bucket --versioning-configuration Status=Enabled --mfa "SERIAL 123456"
```
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [PutBucketVersioning](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3api/put-bucket-versioning.html)。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/s3#code-examples)中設定和執行。
```
/**
* Enables bucket versioning for the specified S3 bucket.
*
* @param s3Client the S3 client to use for the operation
* @param bucketName the name of the S3 bucket to enable versioning for
*/
public static void enableBucketVersioning(S3Client s3Client, String bucketName){
VersioningConfiguration versioningConfiguration = VersioningConfiguration.builder()
.status(BucketVersioningStatus.ENABLED)
.build();
PutBucketVersioningRequest versioningRequest = PutBucketVersioningRequest.builder()
.bucket(bucketName)
.versioningConfiguration(versioningConfiguration)
.build();
s3Client.putBucketVersioning(versioningRequest);
System.out.println("Bucket versioning has been enabled for "+bucketName);
}
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Java 2.x API 參考》**中的 [PutBucketVersioning](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/PutBucketVersioning)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1： 命令會啟用給定 S3 儲存貯體的版本控制。**
```
Write-S3BucketVersioning -BucketName 'amzn-s3-demo-bucket' -VersioningConfig_Status Enabled
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [PutBucketVersioning](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1： 命令會啟用給定 S3 儲存貯體的版本控制。**
```
Write-S3BucketVersioning -BucketName 'amzn-s3-demo-bucket' -VersioningConfig_Status Enabled
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [PutBucketVersioning](https://docs.aws.amazon.com/powershell/v5/reference)。
------
#### [ SAP ABAP ]
**適用於 SAP ABAP 的開發套件**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/s3#code-examples)中設定和執行。
```
TRY.
" Example: Enable versioning on a bucket
" iv_status = 'Enabled'
lo_s3->putbucketversioning(
iv_bucket = iv_bucket_name
io_versioningconfiguration = NEW /aws1/cl_s3_versioningconf(
iv_status = iv_status ) ).
MESSAGE 'Bucket versioning enabled.' TYPE 'I'.
CATCH /aws1/cx_s3_nosuchbucket.
MESSAGE 'Bucket does not exist.' TYPE 'E'.
ENDTRY.
```
+ 如需 API 詳細資訊，請參閱《適用於 *AWS SAP ABAP 的 SDK API 參考*》中的 [PutBucketVersioning](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)。
------
# `PutBucketWebsite` 搭配 AWS SDK 或 CLI 使用
下列程式碼範例示範如何使用 `PutBucketWebsite`。
------
#### [ .NET ]
**適用於 .NET 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/S3#code-examples)中設定和執行。
```
// Put the website configuration.
PutBucketWebsiteRequest putRequest = new PutBucketWebsiteRequest()
{
BucketName = bucketName,
WebsiteConfiguration = new WebsiteConfiguration()
{
IndexDocumentSuffix = indexDocumentSuffix,
ErrorDocument = errorDocument,
},
};
PutBucketWebsiteResponse response = await client.PutBucketWebsiteAsync(putRequest);
```
+ 如需 API 詳細資訊，請參閱*《適用於 .NET 的 AWS SDK API 參考》*中的 [PutBucketWebsite](https://docs.aws.amazon.com/goto/DotNetSDKV3/s3-2006-03-01/PutBucketWebsite)。
------
#### [ C\$1\$1 ]
**適用於 C\$1\$1 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/s3#code-examples)中設定和執行。
```
bool AwsDoc::S3::putWebsiteConfig(const Aws::String &bucketName,
const Aws::String &indexPage, const Aws::String &errorPage,
const Aws::S3::S3ClientConfiguration &clientConfig) {
Aws::S3::S3Client client(clientConfig);
Aws::S3::Model::IndexDocument indexDocument;
indexDocument.SetSuffix(indexPage);
Aws::S3::Model::ErrorDocument errorDocument;
errorDocument.SetKey(errorPage);
Aws::S3::Model::WebsiteConfiguration websiteConfiguration;
websiteConfiguration.SetIndexDocument(indexDocument);
websiteConfiguration.SetErrorDocument(errorDocument);
Aws::S3::Model::PutBucketWebsiteRequest request;
request.SetBucket(bucketName);
request.SetWebsiteConfiguration(websiteConfiguration);
Aws::S3::Model::PutBucketWebsiteOutcome outcome =
client.PutBucketWebsite(request);
if (!outcome.IsSuccess()) {
std::cerr << "Error: PutBucketWebsite: "
<< outcome.GetError().GetMessage() << std::endl;
} else {
std::cout << "Success: Set website configuration for bucket '"
<< bucketName << "'." << std::endl;
}
return outcome.IsSuccess();
}
```
+ 如需 API 詳細資訊，請參閱*《適用於 C\$1\$1 的 AWS SDK API 參考》*中的 [PutBucketWebsite](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/PutBucketWebsite)。
------
#### [ CLI ]
**AWS CLI**
將靜態網站組態套用至名為 `amzn-s3-demo-bucket` 的儲存貯體：
```
aws s3api put-bucket-website --bucket amzn-s3-demo-bucket --website-configuration file://website.json
```
檔案 `website.json` 是目前資料夾中的 JSON 文件，可用於指定網站的索引和錯誤頁面：
```
{
"IndexDocument": {
"Suffix": "index.html"
},
"ErrorDocument": {
"Key": "error.html"
}
}
```
+ 如需 API 詳細資訊，請參閱《*AWS CLI 命令參考*》中的 [PutBucketWebsite](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3api/put-bucket-website.html)。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/s3#code-examples)中設定和執行。
```
import software.amazon.awssdk.services.s3.S3Client;
import software.amazon.awssdk.services.s3.model.IndexDocument;
import software.amazon.awssdk.services.s3.model.PutBucketWebsiteRequest;
import software.amazon.awssdk.services.s3.model.WebsiteConfiguration;
import software.amazon.awssdk.services.s3.model.S3Exception;
import software.amazon.awssdk.regions.Region;
/**
* Before running this Java V2 code example, set up your development
* environment, including your credentials.
*
* For more information, see the following documentation topic:
*
* https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/get-started.html
*/
public class SetWebsiteConfiguration {
public static void main(String[] args) {
final String usage = """
Usage: [indexdoc]\s
Where:
bucketName - The Amazon S3 bucket to set the website configuration on.\s
indexdoc - The index document, ex. 'index.html'
If not specified, 'index.html' will be set.
""";
if (args.length != 1) {
System.out.println(usage);
System.exit(1);
}
String bucketName = args[0];
String indexDoc = "index.html";
Region region = Region.US_EAST_1;
S3Client s3 = S3Client.builder()
.region(region)
.build();
setWebsiteConfig(s3, bucketName, indexDoc);
s3.close();
}
/**
* Sets the website configuration for an Amazon S3 bucket.
*
* @param s3 The {@link S3Client} instance to use for the AWS SDK operations.
* @param bucketName The name of the S3 bucket to configure.
* @param indexDoc The name of the index document to use for the website configuration.
*/
public static void setWebsiteConfig(S3Client s3, String bucketName, String indexDoc) {
try {
WebsiteConfiguration websiteConfig = WebsiteConfiguration.builder()
.indexDocument(IndexDocument.builder().suffix(indexDoc).build())
.build();
PutBucketWebsiteRequest pubWebsiteReq = PutBucketWebsiteRequest.builder()
.bucket(bucketName)
.websiteConfiguration(websiteConfig)
.build();
s3.putBucketWebsite(pubWebsiteReq);
System.out.println("The call was successful");
} catch (S3Exception e) {
System.err.println(e.awsErrorDetails().errorMessage());
System.exit(1);
}
}
}
```
+ 如需 API 詳細資訊，請參閱*《AWS SDK for Java 2.x API 參考》*中的 [PutBucketWebsite](https://docs.aws.amazon.com/goto/SdkForJavaV2/s3-2006-03-01/PutBucketWebsite)。
------
#### [ JavaScript ]
**適用於 JavaScript (v3) 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/s3#code-examples)中設定和執行。
設定儲存貯體網站組態。
```
import {
PutBucketWebsiteCommand,
S3Client,
S3ServiceException,
} from "@aws-sdk/client-s3";
/**
* Configure an Amazon S3 bucket to serve a static website.
* Website access must also be granted separately. For more information
* on setting the permissions for website access, see
* https://docs.aws.amazon.com/AmazonS3/latest/userguide/WebsiteAccessPermissionsReqd.html.
*
* @param {{ bucketName: string }}
*/
export const main = async ({ bucketName }) => {
const client = new S3Client({});
const command = new PutBucketWebsiteCommand({
Bucket: bucketName,
WebsiteConfiguration: {
ErrorDocument: {
// The object key name to use when a 4XX class error occurs.
Key: "error.html",
},
IndexDocument: {
// A suffix that is appended to a request when the request is
// for a directory.
Suffix: "index.html",
},
},
});
try {
await client.send(command);
console.log(
`The bucket "${bucketName}" has been configured as a static website.`,
);
} catch (caught) {
if (
caught instanceof S3ServiceException &&
caught.name === "NoSuchBucket"
) {
console.error(
`Error from S3 while configuring the bucket "${bucketName}" as a static website. The bucket doesn't exist.`,
);
} else if (caught instanceof S3ServiceException) {
console.error(
`Error from S3 while configuring the bucket "${bucketName}" as a static website. ${caught.name}: ${caught.message}`,
);
} else {
throw caught;
}
}
};
```
+ 如需詳細資訊，請參閱《[適用於 JavaScript 的 AWS SDK 開發人員指南](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/s3-example-static-web-host.html#s3-example-static-web-host-set-website)》。
+ 如需 API 詳細資訊，請參閱*《適用於 JavaScript 的 AWS SDK API 參考》*中的 [PutBucketWebsite](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/s3/command/PutBucketWebsiteCommand)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：命令會啟用給定儲存貯體的網站託管，其中索引文件為 'index.html'，錯誤文件為 'error.html'。**
```
Write-S3BucketWebsite -BucketName 'amzn-s3-demo-bucket' -WebsiteConfiguration_IndexDocumentSuffix 'index.html' -WebsiteConfiguration_ErrorDocument 'error.html'
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [PutBucketWebsite](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：命令會啟用給定儲存貯體的網站託管，其中索引文件為 'index.html'，錯誤文件為 'error.html'。**
```
Write-S3BucketWebsite -BucketName 'amzn-s3-demo-bucket' -WebsiteConfiguration_IndexDocumentSuffix 'index.html' -WebsiteConfiguration_ErrorDocument 'error.html'
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [PutBucketWebsite](https://docs.aws.amazon.com/powershell/v5/reference)。
------
#### [ Ruby ]
**SDK for Ruby**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/ruby/example_code/s3#code-examples)中設定和執行。
```
require 'aws-sdk-s3'
# Wraps Amazon S3 bucket website actions.
class BucketWebsiteWrapper
attr_reader :bucket_website
# @param bucket_website [Aws::S3::BucketWebsite] A bucket website object configured with an existing bucket.
def initialize(bucket_website)
@bucket_website = bucket_website
end
# Sets a bucket as a static website.
#
# @param index_document [String] The name of the index document for the website.
# @param error_document [String] The name of the error document to show for 4XX errors.
# @return [Boolean] True when the bucket is configured as a website; otherwise, false.
def set_website(index_document, error_document)
@bucket_website.put(
website_configuration: {
index_document: { suffix: index_document },
error_document: { key: error_document }
}
)
true
rescue Aws::Errors::ServiceError => e
puts "Couldn't configure #{@bucket_website.bucket.name} as a website. Here's why: #{e.message}"
false
end
end
# Example usage:
def run_demo
bucket_name = "amzn-s3-demo-bucket"
index_document = "index.html"
error_document = "404.html"
wrapper = BucketWebsiteWrapper.new(Aws::S3::BucketWebsite.new(bucket_name))
return unless wrapper.set_website(index_document, error_document)
puts "Successfully configured bucket #{bucket_name} as a static website."
end
run_demo if $PROGRAM_NAME == __FILE__
```
+ 如需 API 詳細資訊，請參閱*《適用於 Ruby 的 AWS SDK API 參考》*中的 [PutBucketWebsite](https://docs.aws.amazon.com/goto/SdkForRubyV3/s3-2006-03-01/PutBucketWebsite)。
------
# `PutObject` 搭配 AWS SDK 或 CLI 使用
下列程式碼範例示範如何使用 `PutObject`。
動作範例是大型程式的程式碼摘錄，必須在內容中執行。您可以在下列程式碼範例的內容中看到此動作：
+ [了解基本概念](s3_example_s3_Scenario_GettingStarted_section.md)
+ [開始使用 S3](s3_example_s3_GettingStarted_section.md)
+ [提出條件式請求](s3_example_s3_Scenario_ConditionalRequests_section.md)
+ [追蹤上傳和下載](s3_example_s3_Scenario_TrackUploadDownload_section.md)
+ [使用 Amazon S3 物件完整性](s3_example_s3_Scenario_ObjectIntegrity_section.md)
------
#### [ .NET ]
**適用於 .NET 的 SDK (v4)**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv4/S3#code-examples)中設定和執行。
```
///
/// Shows how to upload a file from the local computer to an Amazon S3
/// bucket.
///
/// The Amazon S3 bucket to which the object
/// will be uploaded.
/// The object to upload.
/// The path, including file name, of the object
/// on the local computer to upload.
/// A boolean value indicating the success or failure of the
/// upload procedure.
public async Task UploadFileAsync(
string bucketName,
string objectName,
string filePath)
{
try
{
var request = new PutObjectRequest
{
BucketName = bucketName,
Key = objectName,
FilePath = filePath,
};
var response = await _amazonS3.PutObjectAsync(request);
return response.HttpStatusCode == System.Net.HttpStatusCode.OK;
}
catch (AmazonS3Exception ex)
{
Console.WriteLine($"Error uploading {objectName}: {ex.Message}");
return false;
}
}
```
+ 如需 API 詳細資訊，請參閱*《適用於 .NET 的 AWS SDK API 參考》*中的 [PutObject](https://docs.aws.amazon.com/goto/DotNetSDKV4/s3-2006-03-01/PutObject)。
**適用於 .NET 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/S3#code-examples)中設定和執行。
使用伺服器端加密上傳物件。
```
using System;
using System.Threading.Tasks;
using Amazon.S3;
using Amazon.S3.Model;
///
/// This example shows how to upload an object to an Amazon Simple Storage
/// Service (Amazon S3) bucket with server-side encryption enabled.
///
public class ServerSideEncryption
{
public static async Task Main()
{
string bucketName = "amzn-s3-demo-bucket";
string keyName = "samplefile.txt";
// If the AWS Region defined for your default user is different
// from the Region where your Amazon S3 bucket is located,
// pass the Region name to the Amazon S3 client object's constructor.
// For example: RegionEndpoint.USWest2.
IAmazonS3 client = new AmazonS3Client();
await WritingAnObjectAsync(client, bucketName, keyName);
}
///
/// Upload a sample object include a setting for encryption.
///
/// The initialized Amazon S3 client object used to
/// to upload a file and apply server-side encryption.
/// The name of the Amazon S3 bucket where the
/// encrypted object will reside.
/// The name for the object that you want to
/// create in the supplied bucket.
public static async Task WritingAnObjectAsync(IAmazonS3 client, string bucketName, string keyName)
{
try
{
var putRequest = new PutObjectRequest
{
BucketName = bucketName,
Key = keyName,
ContentBody = "sample text",
ServerSideEncryptionMethod = ServerSideEncryptionMethod.AES256,
};
var putResponse = await client.PutObjectAsync(putRequest);
// Determine the encryption state of an object.
GetObjectMetadataRequest metadataRequest = new GetObjectMetadataRequest
{
BucketName = bucketName,
Key = keyName,
};
GetObjectMetadataResponse response = await client.GetObjectMetadataAsync(metadataRequest);
ServerSideEncryptionMethod objectEncryption = response.ServerSideEncryptionMethod;
Console.WriteLine($"Encryption method used: {0}", objectEncryption.ToString());
}
catch (AmazonS3Exception ex)
{
Console.WriteLine($"Error: '{ex.Message}' when writing an object");
}
}
}
```
使用條件式請求放置物件。
```
///
/// Uploads an object to Amazon S3 with a conditional request. Prevents overwrite using an IfNoneMatch condition for the object key.
///
/// The key of the object to upload.
/// The source bucket of the object.
/// The content to upload as a string.
/// The ETag if the conditional write is successful, empty otherwise.
public async Task PutObjectConditional(string objectKey, string bucket, string content)
{
try
{
var putObjectRequest = new PutObjectRequest
{
BucketName = bucket,
Key = objectKey,
ContentBody = content,
IfNoneMatch = "*"
};
var putResult = await _amazonS3.PutObjectAsync(putObjectRequest);
_logger.LogInformation($"Conditional write successful for key {objectKey} in bucket {bucket}.");
return putResult.ETag;
}
catch (AmazonS3Exception e)
{
if (e.ErrorCode == "PreconditionFailed")
{
_logger.LogError("Conditional write failed: Precondition failed");
}
else
{
_logger.LogError($"Unexpected error: {e.ErrorCode}");
throw;
}
return string.Empty;
}
}
```
+ 如需 API 詳細資訊，請參閱*《適用於 .NET 的 AWS SDK API 參考》*中的 [PutObject](https://docs.aws.amazon.com/goto/DotNetSDKV3/s3-2006-03-01/PutObject)。
------
#### [ Bash ]
**AWS CLI 使用 Bash 指令碼**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/aws-cli/bash-linux/s3#code-examples)中設定和執行。
```
###############################################################################
# function errecho
#
# This function outputs everything sent to it to STDERR (standard error output).
###############################################################################
function errecho() {
printf "%s\n" "$*" 1>&2
}
###############################################################################
# function copy_file_to_bucket
#
# This function creates a file in the specified bucket.
#
# Parameters:
# $1 - The name of the bucket to copy the file to.
# $2 - The path and file name of the local file to copy to the bucket.
# $3 - The key (name) to call the copy of the file in the bucket.
#
# Returns:
# 0 - If successful.
# 1 - If it fails.
###############################################################################
function copy_file_to_bucket() {
local response bucket_name source_file destination_file_name
bucket_name=$1
source_file=$2
destination_file_name=$3
response=$(aws s3api put-object \
--bucket "$bucket_name" \
--body "$source_file" \
--key "$destination_file_name")
# shellcheck disable=SC2181
if [[ ${?} -ne 0 ]]; then
errecho "ERROR: AWS reports put-object operation failed.\n$response"
return 1
fi
}
```
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [PutObject](https://docs.aws.amazon.com/goto/aws-cli/s3-2006-03-01/PutObject)。
------
#### [ C\$1\$1 ]
**適用於 C\$1\$1 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp/example_code/s3#code-examples)中設定和執行。
```
bool AwsDoc::S3::putObject(const Aws::String &bucketName,
const Aws::String &fileName,
const Aws::S3::S3ClientConfiguration &clientConfig) {
Aws::S3::S3Client s3Client(clientConfig);
Aws::S3::Model::PutObjectRequest request;
request.SetBucket(bucketName);
//We are using the name of the file as the key for the object in the bucket.
//However, this is just a string and can be set according to your retrieval needs.
request.SetKey(fileName);
std::shared_ptr inputData =
Aws::MakeShared("SampleAllocationTag",
fileName.c_str(),
std::ios_base::in | std::ios_base::binary);
if (!*inputData) {
std::cerr << "Error unable to read file " << fileName << std::endl;
return false;
}
request.SetBody(inputData);
Aws::S3::Model::PutObjectOutcome outcome =
s3Client.PutObject(request);
if (!outcome.IsSuccess()) {
std::cerr << "Error: putObject: " <<
outcome.GetError().GetMessage() << std::endl;
} else {
std::cout << "Added object '" << fileName << "' to bucket '"
<< bucketName << "'.";
}
return outcome.IsSuccess();
}
```
+ 如需 API 詳細資訊，請參閱*《適用於 C\$1\$1 的 AWS SDK API 參考》*中的 [PutObject](https://docs.aws.amazon.com/goto/SdkForCpp/s3-2006-03-01/PutObject)。
------
#### [ CLI ]
**AWS CLI**
**範例 1：將物件上傳至 Amazon S3**
以下 `put-object` 命令會將物件上傳至 Amazon S3。
```
aws s3api put-object \
--bucket amzn-s3-demo-bucket \
--key my-dir/MySampleImage.png \
--body MySampleImage.png
```
如需有關上傳物件的詳細資訊，請參閱《*Amazon S3 開發人員指南*》中的「上傳物件」。
**範例 2：將影片檔上傳至 Amazon S3**
以下 `put-object` 範例會上傳影片檔。
```
aws s3api put-object \
--bucket amzn-s3-demo-bucket \
--key my-dir/big-video-file.mp4 \
--body /media/videos/f-sharp-3-data-services.mp4
```
如需有關上傳物件的詳細資訊，請參閱《*Amazon S3 開發人員指南*》中的「上傳物件」。
+ 如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [PutObject](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3api/put-object.html)。
------
#### [ Go ]
**SDK for Go V2**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/gov2/s3#code-examples)中設定和執行。
使用低階 API 將物件放入儲存貯體。
```
import (
"bytes"
"context"
"errors"
"fmt"
"io"
"log"
"os"
"time"
"github.com/aws/aws-sdk-go-v2/aws"
"github.com/aws/aws-sdk-go-v2/feature/s3/manager"
"github.com/aws/aws-sdk-go-v2/service/s3"
"github.com/aws/aws-sdk-go-v2/service/s3/types"
"github.com/aws/smithy-go"
)
// BucketBasics encapsulates the Amazon Simple Storage Service (Amazon S3) actions
// used in the examples.
// It contains S3Client, an Amazon S3 service client that is used to perform bucket
// and object actions.
type BucketBasics struct {
S3Client *s3.Client
}
// UploadFile reads from a file and puts the data into an object in a bucket.
func (basics BucketBasics) UploadFile(ctx context.Context, bucketName string, objectKey string, fileName string) error {
file, err := os.Open(fileName)
if err != nil {
log.Printf("Couldn't open file %v to upload. Here's why: %v\n", fileName, err)
} else {
defer file.Close()
_, err = basics.S3Client.PutObject(ctx, &s3.PutObjectInput{
Bucket: aws.String(bucketName),
Key: aws.String(objectKey),
Body: file,
})
if err != nil {
var apiErr smithy.APIError
if errors.As(err, &apiErr) && apiErr.ErrorCode() == "EntityTooLarge" {
log.Printf("Error while uploading object to %s. The object is too large.\n"+
"To upload objects larger than 5GB, use the S3 console (160GB max)\n"+
"or the multipart upload API (5TB max).", bucketName)
} else {
log.Printf("Couldn't upload file %v to %v:%v. Here's why: %v\n",
fileName, bucketName, objectKey, err)
}
} else {
err = s3.NewObjectExistsWaiter(basics.S3Client).Wait(
ctx, &s3.HeadObjectInput{Bucket: aws.String(bucketName), Key: aws.String(objectKey)}, time.Minute)
if err != nil {
log.Printf("Failed attempt to wait for object %s to exist.\n", objectKey)
}
}
}
return err
}
```
使用傳輸管理員將物件上傳至儲存貯體。
```
import (
"bytes"
"context"
"errors"
"fmt"
"log"
"time"
"github.com/aws/aws-sdk-go-v2/aws"
"github.com/aws/aws-sdk-go-v2/feature/s3/manager"
"github.com/aws/aws-sdk-go-v2/service/s3"
"github.com/aws/aws-sdk-go-v2/service/s3/types"
"github.com/aws/smithy-go"
)
// S3Actions wraps S3 service actions.
type S3Actions struct {
S3Client *s3.Client
S3Manager *manager.Uploader
}
// UploadObject uses the S3 upload manager to upload an object to a bucket.
func (actor S3Actions) UploadObject(ctx context.Context, bucket string, key string, contents string) (string, error) {
var outKey string
input := &s3.PutObjectInput{
Bucket: aws.String(bucket),
Key: aws.String(key),
Body: bytes.NewReader([]byte(contents)),
ChecksumAlgorithm: types.ChecksumAlgorithmSha256,
}
output, err := actor.S3Manager.Upload(ctx, input)
if err != nil {
var noBucket *types.NoSuchBucket
if errors.As(err, &noBucket) {
log.Printf("Bucket %s does not exist.\n", bucket)
err = noBucket
}
} else {
err := s3.NewObjectExistsWaiter(actor.S3Client).Wait(ctx, &s3.HeadObjectInput{
Bucket: aws.String(bucket),
Key: aws.String(key),
}, time.Minute)
if err != nil {
log.Printf("Failed attempt to wait for object %s to exist in %s.\n", key, bucket)
} else {
outKey = *output.Key
}
}
return outKey, err
}
```
+ 如需 API 詳細資訊，請參閱*《適用於 Go 的 AWS SDK API 參考》*中的 [PutObject](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/s3#Client.PutObject)。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/s3#code-examples)中設定和執行。
使用 [S3Client](https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/s3/S3Client.html) 將文件上傳到儲存貯體。
```
/**
* Uploads a local file to an AWS S3 bucket asynchronously.
*
* @param bucketName the name of the S3 bucket to upload the file to
* @param key the key (object name) to use for the uploaded file
* @param objectPath the local file path of the file to be uploaded
* @return a {@link CompletableFuture} that completes with the {@link PutObjectResponse} when the upload is successful, or throws a {@link RuntimeException} if the upload fails
*/
public CompletableFuture uploadLocalFileAsync(String bucketName, String key, String objectPath) {
PutObjectRequest objectRequest = PutObjectRequest.builder()
.bucket(bucketName)
.key(key)
.build();
CompletableFuture response = getAsyncClient().putObject(objectRequest, AsyncRequestBody.fromFile(Paths.get(objectPath)));
return response.whenComplete((resp, ex) -> {
if (ex != null) {
throw new RuntimeException("Failed to upload file", ex);
}
});
}
```
使用 [S3TransferManager](https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/transfer/s3/S3TransferManager.html) 將[檔案上傳](https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/transfer/s3/S3TransferManager.html#uploadFile(software.amazon.awssdk.transfer.s3.UploadFileRequest))至儲存貯體。檢視[完整檔案](https://github.com/awsdocs/aws-doc-sdk-examples/blob/main/javav2/example_code/s3/src/main/java/com/example/s3/transfermanager/UploadFile.java)並[測試](https://github.com/awsdocs/aws-doc-sdk-examples/blob/main/javav2/example_code/s3/src/test/java/TransferManagerTest.java)。
```
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import software.amazon.awssdk.transfer.s3.S3TransferManager;
import software.amazon.awssdk.transfer.s3.model.CompletedFileUpload;
import software.amazon.awssdk.transfer.s3.model.FileUpload;
import software.amazon.awssdk.transfer.s3.model.UploadFileRequest;
import software.amazon.awssdk.transfer.s3.progress.LoggingTransferListener;
import java.net.URI;
import java.net.URISyntaxException;
import java.net.URL;
import java.nio.file.Paths;
import java.util.UUID;
public String uploadFile(S3TransferManager transferManager, String bucketName,
String key, URI filePathURI) {
UploadFileRequest uploadFileRequest = UploadFileRequest.builder()
.putObjectRequest(b -> b.bucket(bucketName).key(key))
.source(Paths.get(filePathURI))
.build();
FileUpload fileUpload = transferManager.uploadFile(uploadFileRequest);
CompletedFileUpload uploadResult = fileUpload.completionFuture().join();
return uploadResult.response().eTag();
}
```
使用 [S3Client](https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/s3/S3Client.html) 將物件上傳至儲存貯體並設定索引標籤。
```
/**
* Puts tags on an Amazon S3 object.
*
* @param s3 An {@link S3Client} object that represents the Amazon S3 client.
* @param bucketName The name of the Amazon S3 bucket.
* @param objectKey The key of the Amazon S3 object.
* @param objectPath The file path of the object to be uploaded.
*/
public static void putS3ObjectTags(S3Client s3, String bucketName, String objectKey, String objectPath) {
try {
Tag tag1 = Tag.builder()
.key("Tag 1")
.value("This is tag 1")
.build();
Tag tag2 = Tag.builder()
.key("Tag 2")
.value("This is tag 2")
.build();
List