Há mais exemplos de AWS SDK disponíveis no repositório [AWS Doc SDK Examples](https://github.com/awsdocs/aws-doc-sdk-examples) GitHub .
As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.
# Exemplos de controle do Amazon S3 usando AWS CLI
Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o controle do AWS Command Line Interface Amazon S3.
*Ações* são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar perfis de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.
Cada exemplo inclui um link para o código-fonte completo, em que você pode encontrar instruções sobre como configurar e executar o código.
**Topics**
+ [Ações](#actions)
## Ações
### `create-access-point`
O código de exemplo a seguir mostra como usar `create-access-point`.
**AWS CLI**
**Para criar um ponto de acesso**
O exemplo `create-access-point` a seguir cria um ponto de acesso chamado `finance-ap` para o bucket `business-records` na conta 123456789012. Antes de executar esse exemplo, substitua o nome do ponto de acesso, o nome do bucket e o número da conta por valores apropriados para o caso de uso.
```
aws s3control create-access-point \
--account-id 123456789012 \
--bucket business-records \
--name finance-ap
```
Este comando não produz saída.
Para obter mais informações, acesse [Criar pontos de acesso](https://docs.aws.amazon.com/AmazonS3/latest/dev/creating-access-points.html) no *Guia do desenvolvedor do Amazon Simple Storage Service*.
+ Para obter detalhes da API, consulte [CreateAccessPoint](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3control/create-access-point.html)em *Referência de AWS CLI Comandos*.
### `create-job`
O código de exemplo a seguir mostra como usar `create-job`.
**AWS CLI**
**Para criar um novo trabalho de Operações em Lote do Amazon S3**
O exemplo `create-job` a seguir cria um trabalho de Operações em Lote do Amazon S3 para marcar objetos como `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
```
Saída:
```
{
"JobId": "93735294-df46-44d5-8638-6356f335324e"
}
```
+ Para obter detalhes da API, consulte [CreateJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3control/create-job.html)em *Referência de AWS CLI Comandos*.
### `delete-access-point-policy`
O código de exemplo a seguir mostra como usar `delete-access-point-policy`.
**AWS CLI**
**Para excluir uma política de ponto de acesso**
O exemplo `delete-access-point-policy` a seguir exclui a política de ponto de acesso do ponto de acesso chamado `finance-ap` na conta 123456789012. Antes de executar esse exemplo, substitua o nome do ponto de acesso e o número da conta por valores apropriados para o caso de uso.
```
aws s3control delete-access-point-policy \
--account-id 123456789012 \
--name finance-ap
```
Este comando não produz saída.
Para obter mais informações, consulte [Gerenciar o acesso a dados com Pontos de Acesso Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/access-points.html) no *Guia do desenvolvedor do Amazon Simple Storage Service*.
+ Para obter detalhes da API, consulte [DeleteAccessPointPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3control/delete-access-point-policy.html)em *Referência de AWS CLI Comandos*.
### `delete-access-point`
O código de exemplo a seguir mostra como usar `delete-access-point`.
**AWS CLI**
**Para excluir um ponto de acesso**
O exemplo `delete-access-point` a seguir exclui um ponto de acesso chamado `finance-ap` na conta 123456789012. Antes de executar esse exemplo, substitua o nome do ponto de acesso e o número da conta por valores apropriados para o caso de uso.
```
aws s3control delete-access-point \
--account-id 123456789012 \
--name finance-ap
```
Este comando não produz saída.
Para obter mais informações, consulte [Gerenciar o acesso a dados com Pontos de Acesso Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/access-points.html) no *Guia do desenvolvedor do Amazon Simple Storage Service*.
+ Para obter detalhes da API, consulte [DeleteAccessPoint](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3control/delete-access-point.html)em *Referência de AWS CLI Comandos*.
### `delete-public-access-block`
O código de exemplo a seguir mostra como usar `delete-public-access-block`.
**AWS CLI**
**Para excluir as configurações do bloqueio de acesso público de uma conta**
O exemplo `delete-public-access-block` a seguir exclui as configurações de bloqueio de acesso público da conta especificada.
```
aws s3control delete-public-access-block \
--account-id 123456789012
```
Este comando não produz saída.
+ Para obter detalhes da API, consulte [DeletePublicAccessBlock](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3control/delete-public-access-block.html)em *Referência de AWS CLI Comandos*.
### `describe-job`
O código de exemplo a seguir mostra como usar `describe-job`.
**AWS CLI**
**Para descrever um novo trabalho de Operações em Lote do Amazon S3**
O exemplo `describe-job` a seguir fornece os parâmetros de configuração e o status do trabalho de operações em lote especificado.
```
aws s3control describe-job \
--account-id 123456789012 \
--job-id 93735294-df46-44d5-8638-6356f335324e
```
Saída:
```
{
"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"
}
}
```
+ Para obter detalhes da API, consulte [DescribeJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3control/describe-job.html)em *Referência de AWS CLI Comandos*.
### `get-access-point-policy-status`
O código de exemplo a seguir mostra como usar `get-access-point-policy-status`.
**AWS CLI**
**Para recuperar o status da política do ponto de acesso**
O exemplo `get-access-point-policy-status` a seguir recupera o status da política de ponto de acesso do ponto de acesso chamado `finance-ap` na conta 123456789012. O status da política do ponto de acesso indica se a política do ponto de acesso permite acesso público. Antes de executar esse exemplo, substitua o nome do ponto de acesso e o número da conta por valores apropriados para o caso de uso.
```
aws s3control get-access-point-policy-status \
--account-id 123456789012 \
--name finance-ap
```
Saída:
```
{
"PolicyStatus": {
"IsPublic": false
}
}
```
Para obter mais informações sobre quando uma política de ponto de acesso é considerada público, consulte [O significado de “público”](https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status) no *Guia do desenvolvedor do Amazon Simple Storage Service*.
+ Para obter detalhes da API, consulte [GetAccessPointPolicyStatus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3control/get-access-point-policy-status.html)em *Referência de AWS CLI Comandos*.
### `get-access-point-policy`
O código de exemplo a seguir mostra como usar `get-access-point-policy`.
**AWS CLI**
**Para recuperar uma política do ponto de acesso**
O exemplo `get-access-point-policy` a seguir recupera a política de ponto de acesso a partir do ponto de acesso chamado `finance-ap` na conta 123456789012. Antes de executar esse exemplo, substitua o nome do ponto de acesso e o número da conta por valores apropriados para o caso de uso.
```
aws s3control get-access-point-policy \
--account-id 123456789012 \
--name finance-ap
```
Saída:
```
{
"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/*\"}]}"
}
```
Para obter mais informações, consulte [Gerenciar o acesso a dados com Pontos de Acesso Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/access-points.html) no *Guia do desenvolvedor do Amazon Simple Storage Service*.
+ Para obter detalhes da API, consulte [GetAccessPointPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3control/get-access-point-policy.html)em *Referência de AWS CLI Comandos*.
### `get-access-point`
O código de exemplo a seguir mostra como usar `get-access-point`.
**AWS CLI**
**Para recuperar detalhes da configuração do ponto de acesso**
O exemplo `get-access-point` a seguir recupera os detalhes de configuração do ponto de acesso chamado `finance-ap` na conta 123456789012. Antes de executar esse exemplo, substitua o nome do ponto de acesso e o número da conta por valores apropriados para o caso de uso.
```
aws s3control get-access-point \
--account-id 123456789012 \
--name finance-ap
```
Saída:
```
{
"Name": "finance-ap",
"Bucket": "business-records",
"NetworkOrigin": "Internet",
"PublicAccessBlockConfiguration": {
"BlockPublicAcls": false,
"IgnorePublicAcls": false,
"BlockPublicPolicy": false,
"RestrictPublicBuckets": false
},
"CreationDate": "2020-01-01T00:00:00Z"
}
```
Para obter mais informações, consulte [Gerenciar o acesso a dados com Pontos de Acesso Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/access-points.html) no *Guia do desenvolvedor do Amazon Simple Storage Service*.
+ Para obter detalhes da API, consulte [GetAccessPoint](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3control/get-access-point.html)em *Referência de AWS CLI Comandos*.
### `get-multi-region-access-point-routes`
O código de exemplo a seguir mostra como usar `get-multi-region-access-point-routes`.
**AWS CLI**
**Como consultar a configuração de roteamento do ponto de acesso multirregional atual**
O exemplo `get-multi-region-access-point-routes` a seguir retorna a configuração de roteamento atual do ponto de acesso multirregional especificado.
```
aws s3control get-multi-region-access-point-routes \
--region Region \
--account-id 111122223333 \
--mrap MultiRegionAccessPoint_ARN
```
Saída:
```
{
"Mrap": "arn:aws:s3::111122223333:accesspoint/0000000000000.mrap",
"Routes": [
{
"Bucket": "amzn-s3-demo-bucket1",
"Region": "ap-southeast-2",
"TrafficDialPercentage": 100
},
{
"Bucket": "amzn-s3-demo-bucket2",
"Region": "us-west-1",
"TrafficDialPercentage": 0
}
]
}
```
+ Para obter detalhes da API, consulte [GetMultiRegionAccessPointRoutes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3control/get-multi-region-access-point-routes.html)em *Referência de AWS CLI Comandos*.
### `get-public-access-block`
O código de exemplo a seguir mostra como usar `get-public-access-block`.
**AWS CLI**
**Para listar as configurações do bloqueio de acesso público de uma conta**
O exemplo `get-public-access-block` a seguir exibe as configurações de bloqueio de acesso público da conta especificada.
```
aws s3control get-public-access-block \
--account-id 123456789012
```
Saída:
```
{
"PublicAccessBlockConfiguration": {
"BlockPublicPolicy": true,
"RestrictPublicBuckets": true,
"IgnorePublicAcls": true,
"BlockPublicAcls": true
}
}
```
+ Para obter detalhes da API, consulte [GetPublicAccessBlock](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3control/get-public-access-block.html)em *Referência de AWS CLI Comandos*.
### `list-access-points`
O código de exemplo a seguir mostra como usar `list-access-points`.
**AWS CLI**
**Exemplo 1: recuperar uma lista de todos os pontos de acesso de uma conta**
O exemplo `list-access-points` a seguir exibe uma lista de todos os pontos de acesso conectados aos buckets pertencentes à conta 123456789012.
```
aws s3control list-access-points \
--account-id 123456789012
```
Saída:
```
{
"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"
}
]
}
```
**Exemplo 2: recuperar uma lista de todos os pontos de acesso de um bucket**
O exemplo `list-access-points` a seguir recupera uma lista de todos os pontos de acesso anexados ao bucket `external-docs` pertencentes à conta 123456789012.
```
aws s3control list-access-points \
--account-id 123456789012 \
--bucket external-docs
```
Saída:
```
{
"AccessPointList": [
{
"Name": "customer-ap",
"NetworkOrigin": "Internet",
"Bucket": "external-docs"
},
{
"Name": "public-ap",
"NetworkOrigin": "Internet",
"Bucket": "external-docs"
}
]
}
```
Para obter mais informações, consulte [Gerenciar o acesso a dados com Pontos de Acesso Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/access-points.html) no *Guia do desenvolvedor do Amazon Simple Storage Service*.
+ Para obter detalhes da API, consulte [ListAccessPoints](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3control/list-access-points.html)em *Referência de AWS CLI Comandos*.
### `list-jobs`
O código de exemplo a seguir mostra como usar `list-jobs`.
**AWS CLI**
**Para listar os trabalhos de Operações em lote do Amazon S3 de uma conta**
O exemplo `list-jobs` a seguir lista todos os trabalhos recentes de operações em lote da conta especificada.
```
aws s3control list-jobs \
--account-id 123456789012
```
Saída:
```
{
"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
},
]
}
```
+ Para obter detalhes da API, consulte [ListJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3control/list-jobs.html)em *Referência de AWS CLI Comandos*.
### `put-access-point-policy`
O código de exemplo a seguir mostra como usar `put-access-point-policy`.
**AWS CLI**
**Como definir uma política de ponto de acesso**
O exemplo `put-access-point-policy` a seguir coloca a política de ponto de acesso especificada para o ponto de acesso `finance-ap` na conta 123456789012. Se o do `finance-ap` ponto de acesso já tiver uma política, esse comando substituirá a política existente pela especificada nesse comando. Antes de executar esse exemplo, substitua o número da conta, o nome do ponto de acesso e as declarações de política por valores apropriados para o caso de uso.
```
aws s3control put-access-point-policy \
--account-id 123456789012 \
--name finance-ap \
--policy file://ap-policy.json
```
Conteúdo de `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/*"
}
]
}
```
Este comando não produz saída.
Para obter mais informações, consulte [Gerenciar o acesso a dados com Pontos de Acesso Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/access-points.html) no *Guia do desenvolvedor do Amazon Simple Storage Service*.
+ Para obter detalhes da API, consulte [PutAccessPointPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3control/put-access-point-policy.html)em *Referência de AWS CLI Comandos*.
### `put-public-access-block`
O código de exemplo a seguir mostra como usar `put-public-access-block`.
**AWS CLI**
**Como editar as configurações do bloqueio de acesso público de uma conta**
O exemplo `put-public-access-block` a seguir alterna todas as configurações de bloqueio de acesso público para `true` na conta especificada.
```
aws s3control put-public-access-block \
--account-id 123456789012 \
--public-access-block-configuration '{"BlockPublicAcls": true, "IgnorePublicAcls": true, "BlockPublicPolicy": true, "RestrictPublicBuckets": true}'
```
Este comando não produz saída.
+ Para obter detalhes da API, consulte [PutPublicAccessBlock](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3control/put-public-access-block.html)em *Referência de AWS CLI Comandos*.
### `submit-multi-region-access-point-routes`
O código de exemplo a seguir mostra como usar `submit-multi-region-access-point-routes`.
**AWS CLI**
**Para atualizar a configuração de roteamento de pontos de acesso multirregionais**
O exemplo `submit-multi-region-access-point-routes` a seguir atualiza os status de roteamento de `amzn-s3-demo-bucket1` e `amzn-s3-demo-bucket2` na região `ap-southeast-2` do seu ponto de acesso multirregional.
```
aws s3control submit-multi-region-access-point-routes \
--region ap-southeast-2 \
--account-id 111122223333 \
--mrap MultiRegionAccessPoint_ARN \
--route-updates Bucket=amzn-s3-demo-bucket1,TrafficDialPercentage=100 Bucket=amzn-s3-demo-bucket2,TrafficDialPercentage=0
```
Este comando não produz saída.
+ Para obter detalhes da API, consulte [SubmitMultiRegionAccessPointRoutes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3control/submit-multi-region-access-point-routes.html)em *Referência de AWS CLI Comandos*.
### `update-job-priority`
O código de exemplo a seguir mostra como usar `update-job-priority`.
**AWS CLI**
**Para atualizar a prioridade de um trabalho de Operações em Lote do Amazon S3**
O exemplo `update-job-priority` a seguir atualiza o trabalho especificado para uma nova prioridade.
```
aws s3control update-job-priority \
--account-id 123456789012 \
--job-id 8d9a18fe-c303-4d39-8ccc-860d372da386 \
--priority 52
```
Saída:
```
{
"JobId": "8d9a18fe-c303-4d39-8ccc-860d372da386",
"Priority": 52
}
```
+ Para obter detalhes da API, consulte [UpdateJobPriority](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3control/update-job-priority.html)em *Referência de AWS CLI Comandos*.
### `update-job-status`
O código de exemplo a seguir mostra como usar `update-job-status`.
**AWS CLI**
**Para atualizar o status de um trabalho de Operações em Lote do Amazon S3**
O exemplo `update-job-status` a seguir cancela o trabalho especificado que está aguardando aprovação.
```
aws s3control update-job-status \
--account-id 123456789012 \
--job-id 8d9a18fe-c303-4d39-8ccc-860d372da386 \
--requested-job-status Cancelled
```
Saída:
```
{
"Status": "Cancelled",
"JobId": "8d9a18fe-c303-4d39-8ccc-860d372da386"
}
```
O exemplo `update-job-status` a seguir confirma e executa o trabalho especificado que está aguardando aprovação.
```
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"
}
```
O exemplo `update-job-status` a seguir cancela o trabalho especificado que em execução.
```
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"
}
```
+ Para obter detalhes da API, consulte [UpdateJobStatus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3control/update-job-status.html)em *Referência de AWS CLI Comandos*.