Amazon S3 控制示例使用 AWS CLI - AWS Command Line Interface

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

Amazon S3 控制示例使用 AWS CLI

下列程式碼範例說明如何透過使用 Amazon S3 控制項來執行動作和實作常見案例。 AWS Command Line Interface

Actions 是大型程式的程式碼摘錄,必須在內容中執行。雖然動作會告訴您如何呼叫個別服務函數,但您可以在其相關情境和跨服務範例中查看內容中的動作。

Scenarios (案例) 是向您展示如何呼叫相同服務中的多個函數來完成特定任務的程式碼範例。

每個範例都包含一個連結 GitHub,您可以在其中找到如何在內容中設定和執行程式碼的指示。

主題

動作

下列程式碼範例會示範如何使用create-access-point

AWS CLI

若要建立存取點

下列create-access-point範例會business-records在帳戶 123456789012 中建立finance-ap為值區命名的存取點。在執行此範例之前,請先將存取點名稱、值區名稱和帳戶號碼取代為您的使用案例適當的值。

aws s3control create-access-point \ --account-id 123456789012 \ --bucket business-records \ --name finance-ap

此命令不會產生輸出。

如需詳細資訊,請參Amazon 簡單儲存服務開發人員指南中的建立存取點

下列程式碼範例會示範如何使用create-job

AWS CLI

若要建立 Amazon S3 批次操作任務

下列create-job範例會建立 Amazon S3 批次操作任務,將物件標記為confidential` in the bucket ``employee-records

aws s3control create-job \ --account-id 123456789012 \ --operation '{"S3PutObjectTagging": { "TagSet": [{"Key":"confidential", "Value":"true"}] }}' \ --report '{"Bucket":"arn:aws:s3:::employee-records-logs","Prefix":"batch-op-create-job", "Format":"Report_CSV_20180820","Enabled":true,"ReportScope":"AllTasks"}' \ --manifest '{"Spec":{"Format":"S3BatchOperations_CSV_20180820","Fields":["Bucket","Key"]},"Location":{"ObjectArn":"arn:aws:s3:::employee-records-logs/inv-report/7a6a9be4-072c-407e-85a2-ec3e982f773e.csv","ETag":"69f52a4e9f797e987155d9c8f5880897"}}' \ --priority 42 \ --role-arn arn:aws:iam::123456789012:role/S3BatchJobRole

輸出:

{ "JobId": "93735294-df46-44d5-8638-6356f335324e" }
  • 如需 API 詳細資訊,請參閱AWS CLI 命令參考CreateJob中的。

下列程式碼範例會示範如何使用delete-access-point-policy

AWS CLI

刪除存取點原則

下列delete-access-point-policy範例會從帳戶 123456789012 finance-ap 中指定的存取點刪除存取點原則。執行此範例之前,請先以適合您使用案例的適當值取代存取點名稱和帳戶號碼。

aws s3control delete-access-point-policy \ --account-id 123456789012 \ --name finance-ap

此命令不會產生輸出。

如需詳細資訊,請參閱 Amazon 簡單儲存服務開發人員指南中的使用 Amazon S3 存取點管理資料存取。

下列程式碼範例會示範如何使用delete-access-point

AWS CLI

若要刪除存取點

下列delete-access-point範例會刪除帳戶 123456789012 finance-ap 中指定的存取點。執行此範例之前,請先以適合您使用案例的適當值取代存取點名稱和帳戶號碼。

aws s3control delete-access-point \ --account-id 123456789012 \ --name finance-ap

此命令不會產生輸出。

如需詳細資訊,請參閱 Amazon 簡單儲存服務開發人員指南中的使用 Amazon S3 存取點管理資料存取。

下列程式碼範例會示範如何使用delete-public-access-block

AWS CLI

刪除帳戶的封鎖公開存取設定

下列delete-public-access-block範例會刪除指定帳戶的封鎖公用存取設定。

aws s3control delete-public-access-block \ --account-id 123456789012

此命令不會產生輸出。

下列程式碼範例會示範如何使用describe-job

AWS CLI

描述 Amazon S3 批次操作任務

以下describe-job提供指定批次作業工作的組態參數和狀態。

aws s3control describe-job \ --account-id 123456789012 \ --job-id 93735294-df46-44d5-8638-6356f335324e

輸出:

{ "Job": { "TerminationDate": "2019-10-03T21:49:53.944Z", "JobId": "93735294-df46-44d5-8638-6356f335324e", "FailureReasons": [], "Manifest": { "Spec": { "Fields": [ "Bucket", "Key" ], "Format": "S3BatchOperations_CSV_20180820" }, "Location": { "ETag": "69f52a4e9f797e987155d9c8f5880897", "ObjectArn": "arn:aws:s3:::employee-records-logs/inv-report/7a6a9be4-072c-407e-85a2-ec3e982f773e.csv" } }, "Operation": { "S3PutObjectTagging": { "TagSet": [ { "Value": "true", "Key": "confidential" } ] } }, "RoleArn": "arn:aws:iam::123456789012:role/S3BatchJobRole", "ProgressSummary": { "TotalNumberOfTasks": 8, "NumberOfTasksFailed": 0, "NumberOfTasksSucceeded": 8 }, "Priority": 42, "Report": { "ReportScope": "AllTasks", "Format": "Report_CSV_20180820", "Enabled": true, "Prefix": "batch-op-create-job", "Bucket": "arn:aws:s3:::employee-records-logs" }, "JobArn": "arn:aws:s3:us-west-2:123456789012:job/93735294-df46-44d5-8638-6356f335324e", "CreationTime": "2019-10-03T21:48:48.048Z", "Status": "Complete" } }
  • 如需 API 詳細資訊,請參閱AWS CLI 命令參考DescribeJob中的。

下列程式碼範例會示範如何使用get-access-point-policy-status

AWS CLI

擷取存取點原則狀態

下列get-access-point-policy-status範例會擷取帳戶 123456789012 finance-ap 中指定之存取點的存取點原則狀態。存取點原則狀態會指出存取點的原則是否允許公用存取。執行此範例之前,請先以適合您使用案例的適當值取代存取點名稱和帳戶號碼。

aws s3control get-access-point-policy-status \ --account-id 123456789012 \ --name finance-ap

輸出:

{ "PolicyStatus": { "IsPublic": false } }

如需有關存取點政策何時被視為公開的詳細資訊,請參閱 Amazon 簡單儲存服務開發人員指南中的 「公用」意義

下列程式碼範例會示範如何使用get-access-point-policy

AWS CLI

擷取存取點原則

下列get-access-point-policy範例會從帳戶 123456789012 finance-ap 中指定的存取點擷取存取點原則。執行此範例之前,請先以適合您使用案例的適當值取代存取點名稱和帳戶號碼。

aws s3control get-access-point-policy \ --account-id 123456789012 \ --name finance-ap

輸出:

{ "Policy": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::123456789012:role/Admin\"},\"Action\":\"s3:GetObject\",\"Resource\":\"arn:aws:s3:us-west-2:123456789012:accesspoint/finance-ap/object/records/*\"}]}" }

如需詳細資訊,請參閱 Amazon 簡單儲存服務開發人員指南中的使用 Amazon S3 存取點管理資料存取。

下列程式碼範例會示範如何使用get-access-point

AWS CLI

擷取存取點組態詳細資訊

下列get-access-point範例會擷取帳戶 123456789012 finance-ap 中指定之存取點的組態詳細資料。執行此範例之前,請先以適合您使用案例的適當值取代存取點名稱和帳戶號碼。

aws s3control get-access-point \ --account-id 123456789012 \ --name finance-ap

輸出:

{ "Name": "finance-ap", "Bucket": "business-records", "NetworkOrigin": "Internet", "PublicAccessBlockConfiguration": { "BlockPublicAcls": false, "IgnorePublicAcls": false, "BlockPublicPolicy": false, "RestrictPublicBuckets": false }, "CreationDate": "2020-01-01T00:00:00Z" }

如需詳細資訊,請參閱 Amazon 簡單儲存服務開發人員指南中的使用 Amazon S3 存取點管理資料存取。

  • 如需 API 詳細資訊,請參閱AWS CLI 命令參考GetAccessPoint中的。

下列程式碼範例會示範如何使用get-multi-region-access-point-routes

AWS CLI

查詢目前的多區域存取點路由組態

下列get-multi-region-access-point-routes範例會傳回指定「多區域存取點」的目前路由組態。

aws s3control get-multi-region-access-point-routes \ --region Region \ --account-id 111122223333 \ --mrap MultiRegionAccessPoint_ARN

輸出:

{ "Mrap": "arn:aws:s3::111122223333:accesspoint/0000000000000.mrap", "Routes": [ { "Bucket": "DOC-EXAMPLE-BUCKET-1", "Region": "ap-southeast-2", "TrafficDialPercentage": 100 }, { "Bucket": "DOC-EXAMPLE-BUCKET-2", "Region": "us-west-1", "TrafficDialPercentage": 0 } ] }

下列程式碼範例會示範如何使用get-public-access-block

AWS CLI

列出帳號的公開封鎖存取設定

下列get-public-access-block範例會顯示指定帳戶的封鎖公用存取設定。

aws s3control get-public-access-block \ --account-id 123456789012

輸出:

{ "PublicAccessBlockConfiguration": { "BlockPublicPolicy": true, "RestrictPublicBuckets": true, "IgnorePublicAcls": true, "BlockPublicAcls": true } }

下列程式碼範例會示範如何使用list-access-points

AWS CLI

範例 1:擷取帳戶的所有存取點清單

下列list-access-points範例會顯示附加至帳戶 123456789012 擁有之值區的所有存取點清單。

aws s3control list-access-points \ --account-id 123456789012

輸出:

{ "AccessPointList": [ { "Name": "finance-ap", "NetworkOrigin": "Internet", "Bucket": "business-records" }, { "Name": "managers-ap", "NetworkOrigin": "Internet", "Bucket": "business-records" }, { "Name": "private-network-ap", "NetworkOrigin": "VPC", "VpcConfiguration": { "VpcId": "1a2b3c" }, "Bucket": "business-records" }, { "Name": "customer-ap", "NetworkOrigin": "Internet", "Bucket": "external-docs" }, { "Name": "public-ap", "NetworkOrigin": "Internet", "Bucket": "external-docs" } ] }

範例 2:擷取值區中所有存取點的清單

下列list-access-points範例會擷取附加至帳戶 123456789012 所external-docs擁有之值區的所有存取點清單。

aws s3control list-access-points \ --account-id 123456789012 \ --bucket external-docs

輸出:

{ "AccessPointList": [ { "Name": "customer-ap", "NetworkOrigin": "Internet", "Bucket": "external-docs" }, { "Name": "public-ap", "NetworkOrigin": "Internet", "Bucket": "external-docs" } ] }

如需詳細資訊,請參閱 Amazon 簡單儲存服務開發人員指南中的使用 Amazon S3 存取點管理資料存取。

  • 如需 API 詳細資訊,請參閱AWS CLI 命令參考ListAccessPoints中的。

下列程式碼範例會示範如何使用list-jobs

AWS CLI

列出帳戶 Amazon S3 批次操作任務

下列list-jobs範例會列出指定帳戶的所有最近批次作業工作。

aws s3control list-jobs \ --account-id 123456789012

輸出:

{ "Jobs": [ { "Operation": "S3PutObjectTagging", "ProgressSummary": { "NumberOfTasksFailed": 0, "NumberOfTasksSucceeded": 8, "TotalNumberOfTasks": 8 }, "CreationTime": "2019-10-03T21:48:48.048Z", "Status": "Complete", "JobId": "93735294-df46-44d5-8638-6356f335324e", "Priority": 42 }, { "Operation": "S3PutObjectTagging", "ProgressSummary": { "NumberOfTasksFailed": 0, "NumberOfTasksSucceeded": 0, "TotalNumberOfTasks": 0 }, "CreationTime": "2019-10-03T21:46:07.084Z", "Status": "Failed", "JobId": "3f3c7619-02d3-4779-97f6-1d98dd313108", "Priority": 42 }, ] }
  • 如需 API 詳細資訊,請參閱AWS CLI 命令參考ListJobs中的。

下列程式碼範例會示範如何使用put-access-point-policy

AWS CLI

設定存取點原則

下列put-access-point-policy範例會將存取點的指定存取點原則置於帳戶 123456789012 finance-ap 中。如果存取點finance-ap已有原則,此命令會以此命令中指定的原則取代現有的原則。在執行此範例之前,請先將帳戶號碼、存取點名稱和政策陳述式取代為您的使用案例的適當值。

aws s3control put-access-point-policy \ --account-id 123456789012 \ --name finance-ap \ --policy file://ap-policy.json

ap-policy.json 的內容:

{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "AWS": "arn:aws:iam::123456789012:user/Alice" }, "Action": "s3:GetObject", "Resource": "arn:aws:s3:us-west-2:123456789012:accesspoint/finance-ap/object/Alice/*" } ] }

此命令不會產生輸出。

如需詳細資訊,請參閱 Amazon 簡單儲存服務開發人員指南中的使用 Amazon S3 存取點管理資料存取。

下列程式碼範例會示範如何使用put-public-access-block

AWS CLI

編輯帳戶的封鎖公開存取設定

下列put-public-access-block範例會將指定帳戶的所有封鎖公true用存取設定切換為。

aws s3control put-public-access-block \ --account-id 123456789012 \ --public-access-block-configuration '{"BlockPublicAcls": true, "IgnorePublicAcls": true, "BlockPublicPolicy": true, "RestrictPublicBuckets": true}'

此命令不會產生輸出。

下列程式碼範例會示範如何使用submit-multi-region-access-point-routes

AWS CLI

更新您的多區域存取點路由組態

下列submit-multi-region-access-point-routes範例會更新「多區域存取點」的「區域」DOC-EXAMPLE-BUCKET-1 和「ap-southeast-2區域」DOC-EXAMPLE-BUCKET-2 中的路由狀態。

aws s3control submit-multi-region-access-point-routes \ --region ap-southeast-2 \ --account-id 111122223333 \ --mrap MultiRegionAccessPoint_ARN \ --route-updates Bucket=DOC-EXAMPLE-BUCKET-1,TrafficDialPercentage=100 Bucket=DOC-EXAMPLE-BUCKET-2,TrafficDialPercentage=0

此命令不會產生輸出。

下列程式碼範例會示範如何使用update-job-priority

AWS CLI

更新 Amazon S3 批次操作任務的任務優先順序

下列update-job-priority範例會將指定的工作更新為新的優先順序。

aws s3control update-job-priority \ --account-id 123456789012 \ --job-id 8d9a18fe-c303-4d39-8ccc-860d372da386 \ --priority 52

輸出:

{ "JobId": "8d9a18fe-c303-4d39-8ccc-860d372da386", "Priority": 52 }

下列程式碼範例會示範如何使用update-job-status

AWS CLI

若要更新 Amazon S3 批次操作任務的狀態

下列update-job-status範例會取消正在等待核准的指定工作。

aws s3control update-job-status \ --account-id 123456789012 \ --job-id 8d9a18fe-c303-4d39-8ccc-860d372da386 \ --requested-job-status Cancelled

輸出:

{ "Status": "Cancelled", "JobId": "8d9a18fe-c303-4d39-8ccc-860d372da386" }

下列update-job-status範例會確認並執行正在等待核准的指定項目。

aws s3control update-job-status \ --account-id 123456789012 \ --job-id 5782949f-3301-4fb3-be34-8d5bab54dbca \ --requested-job-status Ready Output:: { "Status": "Ready", "JobId": "5782949f-3301-4fb3-be34-8d5bab54dbca" }

下面的update-job-status例子取消正在運行的指定作業。

aws s3control update-job-status \ --account-id 123456789012 \ --job-id 5782949f-3301-4fb3-be34-8d5bab54dbca \ --requested-job-status Cancelled Output:: { "Status": "Cancelling", "JobId": "5782949f-3301-4fb3-be34-8d5bab54dbca" }
  • 如需 API 詳細資訊,請參閱AWS CLI 命令參考UpdateJobStatus中的。