Exemples d’utilisation de l’AWS CLI avec Amazon S3 Control - AWS Command Line Interface
Actions

Exemples d’utilisation de l’AWS CLI avec Amazon S3 Control

Les exemples de code suivants montrent comment réaliser des actions et mettre en œuvre des scénarios courants en utilisant l’AWS Command Line Interface avec 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 indiquent comment appeler des fonctions de service individuelles, vous pouvez les voir en contexte dans leurs scénarios associés.

Chaque exemple inclut un lien vers le code source complet, où vous trouverez des instructions sur la configuration et l’exécution du code en contexte.

Rubriques

Actions

L’exemple de code suivant montre comment utiliser create-access-point.

AWS CLI

Pour créer un point d’accès

L’exemple create-access-point suivant crée un point d’accès nommé finance-ap pour le compartiment business-records dans le compte 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 pour votre cas d’utilisation.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Création de points d’accès dans le Manuel du développeur Amazon Simple Storage Service.

  • Pour plus de détails sur l’API, consultez CreateAccessPoint dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser create-job.

AWS CLI

Pour créer une tâche d’opérations par lot Amazon S3

L’exemple create-job suivant crée une tâche d’opérations par lot Amazon S3 pour baliser des objets comme 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

Sortie :

{
    "JobId": "93735294-df46-44d5-8638-6356f335324e"
}

  • Pour plus de détails sur l’API, consultez CreateJob dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser delete-access-point-policy.

AWS CLI

Pour supprimer une stratégie de point d’accès

L’exemple delete-access-point-policy suivant supprime la stratégie 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 les valeurs appropriées pour votre cas d’utilisation.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Gestion de l’accès aux données avec les points d’accès Amazon S3 dans le Manuel du développeur Amazon Simple Storage Service.

  • Pour plus de détails sur l’API, consultez DeleteAccessPointPolicy dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser delete-access-point.

AWS CLI

Pour supprimer un point d'accès

L’exemple delete-access-point 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 les valeurs appropriées pour votre cas d’utilisation.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Gestion de l’accès aux données avec les points d’accès Amazon S3 dans le Manuel du développeur Amazon Simple Storage Service.

  • Pour plus de détails sur l’API, consultez DeleteAccessPoint dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser delete-public-access-block.

AWS CLI

Pour supprimer les paramètres de blocage de l’accès public d’un compte

L’exemple delete-public-access-block suivant supprime les paramètres de blocage de l’accès public du compte spécifié.

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

Cette commande ne produit aucune sortie.

  • Pour plus de détails sur l’API, consultez DeletePublicAccessBlock dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser describe-job.

AWS CLI

Pour décrire une tâche d’opérations par lot Amazon S3

L’exemple describe-job suivant fournit les paramètres de configuration et le statut de la tâche d’opérations par lot spécifiée.

aws s3control describe-job \
    --account-id 123456789012 \
    --job-id 93735294-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 plus de détails sur l’API, consultez DescribeJob dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser get-access-point-policy-status.

AWS CLI

Pour récupérer le statut d’une stratégie de point d’accès

L’exemple get-access-point-policy-status suivant récupère le statut de la stratégie du point d’accès nommé finance-ap dans le compte 123456789012. Le statut indique si la stratégie 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 les valeurs appropriées pour votre cas d’utilisation.

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

Sortie :

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

Pour savoir quand une stratégie de point d’accès est considérée comme publique, consultez La signification du mot « public » dans le Manuel du développeur Amazon Simple Storage Service.

L’exemple de code suivant montre comment utiliser get-access-point-policy.

AWS CLI

Pour récupérer une stratégie de point d’accès

L’exemple get-access-point-policy suivant récupère la stratégie 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 les valeurs appropriées pour votre cas d’utilisation.

aws s3control get-access-point-policy \
    --account-id 123456789012 \
    --name finance-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 Gestion de l’accès aux données avec les points d’accès Amazon S3 dans le Manuel du développeur Amazon Simple Storage Service.

  • Pour plus de détails sur l’API, consultez GetAccessPointPolicy dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser get-access-point.

AWS CLI

Pour récupérer les détails de la configuration d’un point d’accès

L’exemple get-access-point suivant récupère les détails de la 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 les valeurs appropriées pour votre cas d’utilisation.

aws s3control get-access-point \
    --account-id 123456789012 \
    --name finance-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 Gestion de l’accès aux données avec les points d’accès Amazon S3 dans le Manuel du développeur Amazon Simple Storage Service.

  • Pour plus de détails sur l’API, consultez GetAccessPoint dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser get-multi-region-access-point-routes.

AWS CLI

Pour interroger la configuration de routage d’un point d’accès multi-région

L’exemple get-multi-region-access-point-routes suivant renvoie la configuration de routage en cours du point d’accès multi-région spécifié.

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

Sortie :

{
    "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
        }
    ]
}

L’exemple de code suivant montre comment utiliser get-public-access-block.

AWS CLI

Pour répertorier les paramètres de blocage de l’accès public d’un compte

L’exemple get-public-access-block suivant affiche les paramètres de blocage de l’accès public du compte spécifié.

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

Sortie :

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

  • Pour plus de détails sur l’API, consultez GetPublicAccessBlock dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser list-access-points.

AWS CLI

Exemple 1 : pour récupérer la liste de tous les points d’accès d’un compte

L’exemple list-access-points suivant affiche la liste de tous les points d’accès attachés aux compartiments 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 compartiment

L’exemple list-access-points suivant récupère la liste de tous les points d’accès attachés au compartiment external-docs appartenant au compte 123456789012.

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

Sortie :

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

Pour plus d’informations, consultez Gestion de l’accès aux données avec les points d’accès Amazon S3 dans le Manuel du développeur Amazon Simple Storage Service.

  • Pour plus de détails sur l’API, consultez ListAccessPoints dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser list-jobs.

AWS CLI

Pour répertorier les tâches d’opérations par lot Amazon S3 d’un compte

L’exemple list-jobs suivant répertorie toutes les tâches d’opérations par lot récentes du 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 plus de détails sur l’API, consultez ListJobs dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser put-access-point-policy.

AWS CLI

Pour définir une stratégie de point d’accès

L’exemple put-access-point-policy suivant associe la stratégie spécifiée au point d’accès finance-ap dans le compte 123456789012. Si le point d’accès finance-ap dispose déjà d’une stratégie, cette commande remplace la stratégie 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 instructions de la stratégie par les valeurs appropriées pour votre cas d’utilisation.

aws s3control put-access-point-policy \
    --account-id 123456789012 \
    --name finance-ap \
    --policy file://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 aucune sortie.

Pour plus d’informations, consultez Gestion de l’accès aux données avec les points d’accès Amazon S3 dans le Manuel du développeur Amazon Simple Storage Service.

  • Pour plus de détails sur l’API, consultez PutAccessPointPolicy dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser put-public-access-block.

AWS CLI

Pour modifier les paramètres de blocage de l’accès public d’un compte

L’exemple put-public-access-block suivant définit tous les paramètres de blocage de l’accès public sur true pour le 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 aucune sortie.

  • Pour plus de détails sur l’API, consultez PutPublicAccessBlock dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser submit-multi-region-access-point-routes.

AWS CLI

Pour mettre à jour la configuration de routage de votre point d’accès multi-région

L’exemple submit-multi-region-access-point-routes suivant met à jour les statuts de routage amzn-s3-demo-bucket1 et amzn-s3-demo-bucket2 dans la région ap-southeast-2 pour votre point d’accès multi-région.

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

Cette commande ne produit aucune sortie.

L’exemple de code suivant montre comment utiliser update-job-priority.

AWS CLI

Pour mettre à jour la priorité d’une tâche d’opérations par lot Amazon S3

L’exemple update-job-priority suivant met à jour la tâche spécifiée en fonction de la nouvelle priorité.

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

Sortie :

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

  • Pour plus de détails sur l’API, consultez UpdateJobPriority dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser update-job-status.

AWS CLI

Pour mettre à jour le statut d’une tâche d’opérations par lot Amazon S3

L’exemple update-job-status suivant annule la tâche spécifiée en attente d’approbation.

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

Sortie :

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

L’exemple update-job-status suivant confirme et exécute la tâche spécifiée en attente d’approbation.

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"
}

L’exemple update-job-status 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 plus de détails sur l’API, consultez UpdateJobStatus dans la Référence des commandes de l’AWS CLI.