Hay más AWS SDK ejemplos disponibles en el GitHub repositorio de AWS Doc SDK Examples
Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.
Ejemplos de Amazon S3 Control que utilizan AWS CLI
Los siguientes ejemplos de código muestran cómo realizar acciones e implementar situaciones comunes mediante el uso AWS Command Line Interface de Amazon S3 Control.
Las acciones son extractos de código de programas más grandes y deben ejecutarse en contexto. Mientras las acciones muestran cómo llamar a las funciones de servicio individuales, es posible ver las acciones en contexto en los escenarios relacionados.
Cada ejemplo incluye un enlace al código fuente completo, donde puede encontrar instrucciones sobre cómo configurar y ejecutar el código en su contexto.
Temas
Acciones
En el siguiente ejemplo de código se muestra cómo usar create-access-point
.
- AWS CLI
-
Para crear un punto de acceso
En el siguiente
create-access-point
ejemplo, se crea un punto de acceso con el nombrefinance-ap
del depósitobusiness-records
de la cuenta 123456789012. Antes de ejecutar este ejemplo, sustituya el nombre del punto de acceso, el nombre del depósito y el número de cuenta por los valores adecuados para su caso de uso.aws s3control create-access-point \ --account-id
123456789012
\ --bucketbusiness-records
\ --namefinance-ap
Este comando no genera ninguna salida.
Para obtener más información, consulte Creación de puntos de acceso en la Guía para desarrolladores de Amazon Simple Storage Service.
-
Para API obtener más información, consulte CreateAccessPoint
la Referencia de AWS CLI comandos.
-
En el siguiente ejemplo de código se muestra cómo usar create-job
.
- AWS CLI
-
Para crear un trabajo de operaciones por lotes en Amazon S3
El siguiente
create-job
ejemplo crea un trabajo de operaciones por lotes de Amazon S3 para etiquetar objetos comoconfidential` 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"}}
' \ --priority42
\ --role-arnarn:aws:iam::123456789012:role/S3BatchJobRole
Salida:
{ "JobId": "93735294-df46-44d5-8638-6356f335324e" }
-
Para API obtener más información, consulte CreateJob
la Referencia de AWS CLI comandos.
-
En el siguiente ejemplo de código se muestra cómo usar delete-access-point-policy
.
- AWS CLI
-
Para eliminar una política de puntos de acceso
En el siguiente
delete-access-point-policy
ejemplo, se elimina la política de puntos de acceso del punto de acceso nombradofinance-ap
en la cuenta 123456789012. Antes de ejecutar este ejemplo, sustituya el nombre y el número de cuenta del punto de acceso por los valores adecuados para su caso de uso.aws s3control delete-access-point-policy \ --account-id
123456789012
\ --namefinance-ap
Este comando no genera ninguna salida.
Para obtener más información, consulte Gestión del acceso a los datos con puntos de acceso de Amazon S3 en la Guía para desarrolladores de Amazon Simple Storage Service.
-
Para API obtener más información, consulte DeleteAccessPointPolicy
la Referencia de AWS CLI comandos.
-
En el siguiente ejemplo de código se muestra cómo usar delete-access-point
.
- AWS CLI
-
Para eliminar un punto de acceso
En el siguiente
delete-access-point
ejemplo, se elimina un punto de acceso denominadofinance-ap
en la cuenta 123456789012. Antes de ejecutar este ejemplo, sustituya el nombre y el número de cuenta del punto de acceso por los valores adecuados para su caso de uso.aws s3control delete-access-point \ --account-id
123456789012
\ --namefinance-ap
Este comando no genera ninguna salida.
Para obtener más información, consulte Gestión del acceso a los datos con puntos de acceso de Amazon S3 en la Guía para desarrolladores de Amazon Simple Storage Service.
-
Para API obtener más información, consulte DeleteAccessPoint
la Referencia de AWS CLI comandos.
-
En el siguiente ejemplo de código se muestra cómo usar delete-public-access-block
.
- AWS CLI
-
Para eliminar la configuración de bloqueo de acceso público de una cuenta
En el siguiente
delete-public-access-block
ejemplo, se elimina la configuración de bloqueo de acceso público de la cuenta especificada.aws s3control delete-public-access-block \ --account-id
123456789012
Este comando no genera ninguna salida.
-
Para API obtener más información, consulte DeletePublicAccessBlock
la Referencia de AWS CLI comandos.
-
En el siguiente ejemplo de código se muestra cómo usar describe-job
.
- AWS CLI
-
Para describir un trabajo de operaciones por lotes de Amazon S3
A continuación, se
describe-job
proporcionan los parámetros de configuración y el estado del trabajo de operaciones por lotes especificado.aws s3control describe-job \ --account-id
123456789012
\ --job-id93735294-df46-44d5-8638-6356f335324e
Salida:
{ "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 API obtener más información, consulte DescribeJob
la Referencia de AWS CLI comandos.
-
En el siguiente ejemplo de código se muestra cómo usar get-access-point-policy-status
.
- AWS CLI
-
Para recuperar el estado de la política del punto de acceso
El siguiente
get-access-point-policy-status
ejemplo recupera el estado de la política del punto de acceso del punto de acceso nombradofinance-ap
en la cuenta 123456789012. El estado de la política del punto de acceso indica si la política del punto de acceso permite el acceso público. Antes de ejecutar este ejemplo, sustituya el nombre y el número de cuenta del punto de acceso por los valores adecuados para su caso de uso.aws s3control get-access-point-policy-status \ --account-id
123456789012
\ --namefinance-ap
Salida:
{ "PolicyStatus": { "IsPublic": false } }
Para obtener más información sobre cuándo una política de puntos de acceso se considera pública, consulte El significado de «público» en la Guía para desarrolladores de Amazon Simple Storage Service.
-
Para API obtener más información, consulte GetAccessPointPolicyStatus
la Referencia de AWS CLI comandos.
-
En el siguiente ejemplo de código se muestra cómo usar get-access-point-policy
.
- AWS CLI
-
Para recuperar una política de puntos de acceso
En el siguiente
get-access-point-policy
ejemplo, se recupera la política de puntos de acceso del punto de acceso nombradofinance-ap
en la cuenta 123456789012. Antes de ejecutar este ejemplo, sustituya el nombre y el número de cuenta del punto de acceso por los valores adecuados para su caso de uso.aws s3control get-access-point-policy \ --account-id
123456789012
\ --namefinance-ap
Salida:
{ "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 obtener más información, consulte Gestión del acceso a los datos con puntos de acceso de Amazon S3 en la Guía para desarrolladores de Amazon Simple Storage Service.
-
Para API obtener más información, consulte GetAccessPointPolicy
la Referencia de AWS CLI comandos.
-
En el siguiente ejemplo de código se muestra cómo usar get-access-point
.
- AWS CLI
-
Para recuperar los detalles de configuración del punto de acceso
En el siguiente
get-access-point
ejemplo, se recuperan los detalles de configuración del punto de acceso nombradofinance-ap
en la cuenta 123456789012. Antes de ejecutar este ejemplo, sustituya el nombre y el número de cuenta del punto de acceso por los valores adecuados para su caso de uso.aws s3control get-access-point \ --account-id
123456789012
\ --namefinance-ap
Salida:
{ "Name": "finance-ap", "Bucket": "business-records", "NetworkOrigin": "Internet", "PublicAccessBlockConfiguration": { "BlockPublicAcls": false, "IgnorePublicAcls": false, "BlockPublicPolicy": false, "RestrictPublicBuckets": false }, "CreationDate": "2020-01-01T00:00:00Z" }
Para obtener más información, consulte Gestión del acceso a los datos con puntos de acceso de Amazon S3 en la Guía para desarrolladores de Amazon Simple Storage Service.
-
Para API obtener más información, consulte GetAccessPoint
la Referencia de AWS CLI comandos.
-
En el siguiente ejemplo de código se muestra cómo usar get-multi-region-access-point-routes
.
- AWS CLI
-
Para consultar la configuración actual de la ruta del punto de acceso multirregional
El siguiente
get-multi-region-access-point-routes
ejemplo devuelve la configuración de enrutamiento actual del punto de acceso multirregional especificado.aws s3control get-multi-region-access-point-routes \ --region
Region
\ --account-id111122223333
\ --mrapMultiRegionAccessPoint_ARN
Salida:
{ "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 } ] }
-
Para API obtener más información, consulte GetMultiRegionAccessPointRoutes
la Referencia de AWS CLI comandos.
-
En el siguiente ejemplo de código se muestra cómo usar get-public-access-block
.
- AWS CLI
-
Para ver una lista de la configuración de acceso público por bloqueo de una cuenta
En el siguiente
get-public-access-block
ejemplo, se muestra la configuración de bloqueo del acceso público de la cuenta especificada.aws s3control get-public-access-block \ --account-id
123456789012
Salida:
{ "PublicAccessBlockConfiguration": { "BlockPublicPolicy": true, "RestrictPublicBuckets": true, "IgnorePublicAcls": true, "BlockPublicAcls": true } }
-
Para API obtener más información, consulte GetPublicAccessBlock
la Referencia de AWS CLI comandos.
-
En el siguiente ejemplo de código se muestra cómo usar list-access-points
.
- AWS CLI
-
Ejemplo 1: Para recuperar una lista de todos los puntos de acceso de una cuenta
En el siguiente
list-access-points
ejemplo, se muestra una lista de todos los puntos de acceso asociados a los depósitos propiedad de la cuenta 123456789012.aws s3control list-access-points \ --account-id
123456789012
Salida:
{ "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" } ] }
Ejemplo 2: Para recuperar una lista de todos los puntos de acceso de un bucket
En el siguiente
list-access-points
ejemplo, se recupera una lista de todos los puntos de acceso adjuntos al depósitoexternal-docs
propiedad de la cuenta 123456789012.aws s3control list-access-points \ --account-id
123456789012
\ --bucketexternal-docs
Salida:
{ "AccessPointList": [ { "Name": "customer-ap", "NetworkOrigin": "Internet", "Bucket": "external-docs" }, { "Name": "public-ap", "NetworkOrigin": "Internet", "Bucket": "external-docs" } ] }
Para obtener más información, consulte Gestión del acceso a los datos con puntos de acceso de Amazon S3 en la Guía para desarrolladores de Amazon Simple Storage Service.
-
Para API obtener más información, consulte ListAccessPoints
la Referencia de AWS CLI comandos.
-
En el siguiente ejemplo de código se muestra cómo usar list-jobs
.
- AWS CLI
-
Para enumerar los trabajos de operaciones por lotes de Amazon S3 de una cuenta
El siguiente
list-jobs
ejemplo muestra todos los trabajos de operaciones por lotes recientes de la cuenta especificada.aws s3control list-jobs \ --account-id
123456789012
Salida:
{ "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 API obtener más información, consulte ListJobs
la Referencia de AWS CLI comandos.
-
En el siguiente ejemplo de código se muestra cómo usar put-access-point-policy
.
- AWS CLI
-
Para establecer una política de puntos de acceso
El siguiente
put-access-point-policy
ejemplo coloca la política de punto de acceso especificada para el punto de accesofinance-ap
en la cuenta 123456789012. Si el punto de accesofinance-ap
ya tiene una política, este comando reemplaza la política existente por la especificada en este comando. Antes de ejecutar este ejemplo, sustituya el número de cuenta, el nombre del punto de acceso y las declaraciones de política por los valores adecuados para su caso de uso.aws s3control put-access-point-policy \ --account-id
123456789012
\ --namefinance-ap
\ --policyfile://ap-policy.json
Contenidos 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 no genera ninguna salida.
Para obtener más información, consulte Gestión del acceso a los datos con puntos de acceso de Amazon S3 en la Guía para desarrolladores de Amazon Simple Storage Service.
-
Para API obtener más información, consulte PutAccessPointPolicy
la Referencia de AWS CLI comandos.
-
En el siguiente ejemplo de código se muestra cómo usar put-public-access-block
.
- AWS CLI
-
Para editar la configuración de bloqueo de acceso público de una cuenta
En el siguiente
put-public-access-block
ejemplo, se cambian todas las configuraciones de bloqueo del acceso público a lastrue
de la cuenta especificada.aws s3control put-public-access-block \ --account-id
123456789012
\ --public-access-block-configuration '{"BlockPublicAcls": true, "IgnorePublicAcls": true, "BlockPublicPolicy": true, "RestrictPublicBuckets": true}
'Este comando no genera ninguna salida.
-
Para API obtener más información, consulte PutPublicAccessBlock
la Referencia de AWS CLI comandos.
-
En el siguiente ejemplo de código se muestra cómo usar submit-multi-region-access-point-routes
.
- AWS CLI
-
Para actualizar la configuración de enrutamiento de su punto de acceso multirregional
El siguiente
submit-multi-region-access-point-routes
ejemplo actualiza los estados de enrutamiento deDOC-EXAMPLE-BUCKET-1
y dentro de laDOC-EXAMPLE-BUCKET-2
ap-southeast-2
región para su punto de acceso multirregional.aws s3control submit-multi-region-access-point-routes \ --region
ap-southeast-2
\ --account-id111122223333
\ --mrapMultiRegionAccessPoint_ARN
\ --route-updatesBucket=DOC-EXAMPLE-BUCKET-1,TrafficDialPercentage=100
Bucket=DOC-EXAMPLE-BUCKET-2,TrafficDialPercentage=0
Este comando no genera ninguna salida.
-
Para API obtener más información, consulte la Referencia SubmitMultiRegionAccessPointRoutes
de AWS CLI comandos.
-
En el siguiente ejemplo de código se muestra cómo usar update-job-priority
.
- AWS CLI
-
Para actualizar la prioridad de un trabajo de operaciones por lotes de Amazon S3
El siguiente
update-job-priority
ejemplo actualiza el trabajo especificado a una nueva prioridad.aws s3control update-job-priority \ --account-id
123456789012
\ --job-id8d9a18fe-c303-4d39-8ccc-860d372da386
\ --priority52
Salida:
{ "JobId": "8d9a18fe-c303-4d39-8ccc-860d372da386", "Priority": 52 }
-
Para API obtener más información, consulte UpdateJobPriority
la Referencia de AWS CLI comandos.
-
En el siguiente ejemplo de código se muestra cómo usar update-job-status
.
- AWS CLI
-
Para actualizar el estado de un trabajo de operaciones por lotes de Amazon S3
El siguiente
update-job-status
ejemplo cancela el trabajo especificado que está pendiente de aprobación.aws s3control update-job-status \ --account-id
123456789012
\ --job-id8d9a18fe-c303-4d39-8ccc-860d372da386
\ --requested-job-statusCancelled
Salida:
{ "Status": "Cancelled", "JobId": "8d9a18fe-c303-4d39-8ccc-860d372da386" }
El siguiente
update-job-status
ejemplo confirma y ejecuta el especificado que está pendiente de aprobación.aws s3control update-job-status \ --account-id
123456789012
\ --job-id5782949f-3301-4fb3-be34-8d5bab54dbca
\ --requested-job-statusReady
Output::
{
"Status": "Ready", "JobId":"5782949f-3301-4fb3-be34-8d5bab54dbca"
}
En el
update-job-status
ejemplo siguiente se cancela el trabajo especificado que se está ejecutando.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 API obtener más información, consulte UpdateJobStatus
la Referencia de AWS CLI comandos.
-