Cette documentation concerne AWS CLI uniquement la version 1. Pour la documentation relative à la version 2 du AWS CLI, consultez le guide de l'utilisateur de la version 2.
Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.
Exemples d'Amazon S3 Control utilisant AWS CLI
Les exemples de code suivants vous montrent comment effectuer des actions et implémenter des scénarios courants à l' AWS Command Line Interface aide d'Amazon S3 Control.
Les actions sont des extraits de code de programmes plus larges et doivent être exécutées dans leur contexte. Alors que les actions vous montrent comment appeler des fonctions de service individuelles, vous pouvez les visualiser dans leur contexte dans leurs scénarios associés.
Chaque exemple inclut un lien vers le code source complet, où vous trouverez des instructions sur la façon de configurer et d'exécuter le code en contexte.
Rubriques
Actions
L'exemple de code suivant montre comment utilisercreate-access-point
.
- AWS CLI
-
Pour créer un point d'accès
L'
create-access-point
exemple suivant crée un point d'accès nomméfinance-ap
d'après le bucket du comptebusiness-records
123456789012. Avant d'exécuter cet exemple, remplacez le nom du point d'accès, le nom du compartiment et le numéro de compte par les valeurs appropriées à votre cas d'utilisation.aws s3control create-access-point \ --account-id
123456789012
\ --bucketbusiness-records
\ --namefinance-ap
Cette commande ne produit aucun résultat.
Pour plus d'informations, consultez la section Création de points d'accès dans le manuel Amazon Simple Storage Service Developer Guide.
-
Pour API plus de détails, voir CreateAccessPoint
la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utilisercreate-job
.
- AWS CLI
-
Pour créer une tâche d'opérations par lots Amazon S3
L'
create-job
exemple suivant crée une tâche d'opérations par lots Amazon S3 pour étiqueter les objets comme telsconfidential` 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
Sortie :
{ "JobId": "93735294-df46-44d5-8638-6356f335324e" }
-
Pour API plus de détails, voir CreateJob
la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserdelete-access-point-policy
.
- AWS CLI
-
Pour supprimer une politique de point d'accès
L'
delete-access-point-policy
exemple suivant supprime la politique de point d'accès du point d'accès nomméfinance-ap
dans le compte 123456789012. Avant d'exécuter cet exemple, remplacez le nom du point d'accès et le numéro de compte par des valeurs adaptées à votre cas d'utilisation.aws s3control delete-access-point-policy \ --account-id
123456789012
\ --namefinance-ap
Cette commande ne produit aucun résultat.
Pour plus d'informations, consultez la section Gestion de l'accès aux données avec les points d'accès Amazon S3 dans le guide du développeur Amazon Simple Storage Service.
-
Pour API plus de détails, voir DeleteAccessPointPolicy
la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserdelete-access-point
.
- AWS CLI
-
Pour supprimer un point d'accès
L'
delete-access-point
exemple suivant supprime un point d'accès nomméfinance-ap
dans le compte 123456789012. Avant d'exécuter cet exemple, remplacez le nom du point d'accès et le numéro de compte par des valeurs adaptées à votre cas d'utilisation.aws s3control delete-access-point \ --account-id
123456789012
\ --namefinance-ap
Cette commande ne produit aucun résultat.
Pour plus d'informations, consultez la section Gestion de l'accès aux données avec les points d'accès Amazon S3 dans le guide du développeur Amazon Simple Storage Service.
-
Pour API plus de détails, voir DeleteAccessPoint
la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserdelete-public-access-block
.
- AWS CLI
-
Pour supprimer les paramètres de blocage de l'accès public d'un compte
L'
delete-public-access-block
exemple suivant supprime les paramètres de blocage de l'accès public pour le compte spécifié.aws s3control delete-public-access-block \ --account-id
123456789012
Cette commande ne produit aucun résultat.
-
Pour API plus de détails, voir DeletePublicAccessBlock
la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserdescribe-job
.
- AWS CLI
-
Pour décrire une tâche d'opérations par lots Amazon S3
Vous trouverez ci-dessous
describe-job
les paramètres de configuration et le statut de la tâche d'opérations par lots spécifiée.aws s3control describe-job \ --account-id
123456789012
\ --job-id93735294-df46-44d5-8638-6356f335324e
Sortie :
{ "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" } }
-
Pour API plus de détails, voir DescribeJob
la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserget-access-point-policy-status
.
- AWS CLI
-
Pour récupérer l'état de la politique du point d'accès
L'
get-access-point-policy-status
exemple suivant récupère l'état de la politique de point d'accès pour le point d'accès nomméfinance-ap
dans le compte 123456789012. L'état de la politique du point d'accès indique si la politique du point d'accès autorise l'accès public. Avant d'exécuter cet exemple, remplacez le nom du point d'accès et le numéro de compte par des valeurs adaptées à votre cas d'utilisation.aws s3control get-access-point-policy-status \ --account-id
123456789012
\ --namefinance-ap
Sortie :
{ "PolicyStatus": { "IsPublic": false } }
Pour plus d'informations sur les cas dans lesquels une politique de point d'accès est considérée comme publique, consultez La signification du terme « public » dans le manuel Amazon Simple Storage Service Developer Guide.
-
Pour API plus de détails, voir GetAccessPointPolicyStatus
la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserget-access-point-policy
.
- AWS CLI
-
Pour récupérer une politique de point d'accès
L'
get-access-point-policy
exemple suivant extrait la politique du point d'accès depuis le point d'accès nomméfinance-ap
dans le compte 123456789012. Avant d'exécuter cet exemple, remplacez le nom du point d'accès et le numéro de compte par des valeurs adaptées à votre cas d'utilisation.aws s3control get-access-point-policy \ --account-id
123456789012
\ --namefinance-ap
Sortie :
{ "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/*\"}]}" }
Pour plus d'informations, consultez la section Gestion de l'accès aux données avec les points d'accès Amazon S3 dans le guide du développeur Amazon Simple Storage Service.
-
Pour API plus de détails, voir GetAccessPointPolicy
la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserget-access-point
.
- AWS CLI
-
Pour récupérer les détails de configuration du point d'accès
L'
get-access-point
exemple suivant extrait les détails de configuration du point d'accès nomméfinance-ap
dans le compte 123456789012. Avant d'exécuter cet exemple, remplacez le nom du point d'accès et le numéro de compte par des valeurs adaptées à votre cas d'utilisation.aws s3control get-access-point \ --account-id
123456789012
\ --namefinance-ap
Sortie :
{ "Name": "finance-ap", "Bucket": "business-records", "NetworkOrigin": "Internet", "PublicAccessBlockConfiguration": { "BlockPublicAcls": false, "IgnorePublicAcls": false, "BlockPublicPolicy": false, "RestrictPublicBuckets": false }, "CreationDate": "2020-01-01T00:00:00Z" }
Pour plus d'informations, consultez la section Gestion de l'accès aux données avec les points d'accès Amazon S3 dans le guide du développeur Amazon Simple Storage Service.
-
Pour API plus de détails, voir GetAccessPoint
la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserget-multi-region-access-point-routes
.
- AWS CLI
-
Pour demander la configuration actuelle de l'itinéraire du point d'accès multirégional
L'
get-multi-region-access-point-routes
exemple suivant renvoie la configuration de routage actuelle pour le point d'accès multirégional spécifié.aws s3control get-multi-region-access-point-routes \ --region
Region
\ --account-id111122223333
\ --mrapMultiRegionAccessPoint_ARN
Sortie :
{ "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 } ] }
-
Pour API plus de détails, voir GetMultiRegionAccessPointRoutes
la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserget-public-access-block
.
- AWS CLI
-
Pour répertorier les paramètres d'accès public bloqués pour un compte
L'
get-public-access-block
exemple suivant affiche les paramètres de blocage de l'accès public pour le compte spécifié.aws s3control get-public-access-block \ --account-id
123456789012
Sortie :
{ "PublicAccessBlockConfiguration": { "BlockPublicPolicy": true, "RestrictPublicBuckets": true, "IgnorePublicAcls": true, "BlockPublicAcls": true } }
-
Pour API plus de détails, voir GetPublicAccessBlock
la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserlist-access-points
.
- AWS CLI
-
Exemple 1 : Pour récupérer la liste de tous les points d'accès d'un compte
L'
list-access-points
exemple suivant affiche une liste de tous les points d'accès associés aux buckets appartenant au compte 123456789012.aws s3control list-access-points \ --account-id
123456789012
Sortie :
{ "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" } ] }
Exemple 2 : pour récupérer la liste de tous les points d'accès d'un bucket
L'
list-access-points
exemple suivant extrait une liste de tous les points d'accès attachés au bucketexternal-docs
appartenant au compte 123456789012.aws s3control list-access-points \ --account-id
123456789012
\ --bucketexternal-docs
Sortie :
{ "AccessPointList": [ { "Name": "customer-ap", "NetworkOrigin": "Internet", "Bucket": "external-docs" }, { "Name": "public-ap", "NetworkOrigin": "Internet", "Bucket": "external-docs" } ] }
Pour plus d'informations, consultez la section Gestion de l'accès aux données avec les points d'accès Amazon S3 dans le guide du développeur Amazon Simple Storage Service.
-
Pour API plus de détails, voir ListAccessPoints
la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserlist-jobs
.
- AWS CLI
-
Pour répertorier les tâches d'opérations par lots d'Amazon S3 d'un compte
L'
list-jobs
exemple suivant répertorie toutes les tâches d'opérations par lots récentes pour le compte spécifié.aws s3control list-jobs \ --account-id
123456789012
Sortie :
{ "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 }, ] }
-
Pour API plus de détails, voir ListJobs
la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserput-access-point-policy
.
- AWS CLI
-
Pour définir une politique de point d'accès
L'
put-access-point-policy
exemple suivant place la politique de point d'accès spécifiée pour le point d'accèsfinance-ap
dans le compte 123456789012. Si le point d'accès disposefinance-ap
déjà d'une politique, cette commande remplace la politique existante par celle spécifiée dans cette commande. Avant d'exécuter cet exemple, remplacez le numéro de compte, le nom du point d'accès et les déclarations de politique par des valeurs adaptées à votre cas d'utilisation.aws s3control put-access-point-policy \ --account-id
123456789012
\ --namefinance-ap
\ --policyfile://ap-policy.json
Contenu 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/*" } ] }
Cette commande ne produit aucun résultat.
Pour plus d'informations, consultez la section Gestion de l'accès aux données avec les points d'accès Amazon S3 dans le guide du développeur Amazon Simple Storage Service.
-
Pour API plus de détails, voir PutAccessPointPolicy
la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserput-public-access-block
.
- AWS CLI
-
Pour modifier les paramètres de blocage de l'accès public d'un compte
L'
put-public-access-block
exemple suivant fait passer tous les paramètres de blocage de l'accès publictrue
au compte spécifié.aws s3control put-public-access-block \ --account-id
123456789012
\ --public-access-block-configuration '{"BlockPublicAcls": true, "IgnorePublicAcls": true, "BlockPublicPolicy": true, "RestrictPublicBuckets": true}
'Cette commande ne produit aucun résultat.
-
Pour API plus de détails, voir PutPublicAccessBlock
la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utilisersubmit-multi-region-access-point-routes
.
- AWS CLI
-
Pour mettre à jour la configuration de routage de votre point d'accès multirégional
L'
submit-multi-region-access-point-routes
exemple suivant met à jour les états de routage deDOC-EXAMPLE-BUCKET-1
etDOC-EXAMPLE-BUCKET-2
dans laap-southeast-2
région pour votre point d'accès multirégional.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
Cette commande ne produit aucun résultat.
-
Pour API plus de détails, voir SubmitMultiRegionAccessPointRoutes
la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserupdate-job-priority
.
- AWS CLI
-
Pour mettre à jour la priorité d'une tâche d'opérations par lots Amazon S3
L'
update-job-priority
exemple suivant met à jour la tâche spécifiée selon une nouvelle priorité.aws s3control update-job-priority \ --account-id
123456789012
\ --job-id8d9a18fe-c303-4d39-8ccc-860d372da386
\ --priority52
Sortie :
{ "JobId": "8d9a18fe-c303-4d39-8ccc-860d372da386", "Priority": 52 }
-
Pour API plus de détails, voir UpdateJobPriority
la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserupdate-job-status
.
- AWS CLI
-
Pour mettre à jour le statut d'une tâche d'opérations par lots Amazon S3
L'
update-job-status
exemple suivant annule la tâche spécifiée en attente d'approbation.aws s3control update-job-status \ --account-id
123456789012
\ --job-id8d9a18fe-c303-4d39-8ccc-860d372da386
\ --requested-job-statusCancelled
Sortie :
{ "Status": "Cancelled", "JobId": "8d9a18fe-c303-4d39-8ccc-860d372da386" }
L'
update-job-status
exemple suivant confirme et exécute le paramètre spécifié en attente d'approbation.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"
}
L'
update-job-status
exemple suivant annule la tâche spécifiée en cours d'exécution.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" }
-
Pour API plus de détails, voir UpdateJobStatus
la section Référence des AWS CLI commandes.
-