CreateLocationS3 - AWS DataSync
Syntaxe de la requêteParamètres de demandeSyntaxe de la réponseEléments de réponseErreursExemplesVoir aussi

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.

CreateLocationS3

Crée un point de terminaison pour un compartiment Amazon S3.

Pour de plus amples informations, veuillez consulterCréation d'un emplacement Amazon S3dans le AWS DataSyncGuide de l'utilisateur.

Syntaxe de la requête

{
   "AgentArns": [ "string" ],
   "S3BucketArn": "string",
   "S3Config": { 
      "BucketAccessRoleArn": "string"
   },
   "S3StorageClass": "string",
   "Subdirectory": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}

Paramètres de demande

Pour plus d'informations sur les paramètres communs à toutes les actions, consultezParamètres courants.

Cette demande accepte les données suivantes au format JSON.

AgentArns

Si vous utilisez DataSync sur unAWSOutpost, spécifiez les ARN (Amazon Resource Name) de DataSync agents déployés sur votre avant-poste. Pour plus d'informations sur le lancement d'un DataSync Agent sur unAWSOutpost, consultezDéploiement DataSync Agent onAWS Outposts.

Type : Tableau de chaînes

Membres du tableau : Nombre minimum de 1 élément. Nombre maximum de 4 éléments.

Contraintes de longueur Longueur maximum de 128.

Modèle : ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$

Obligatoire : Non

S3BucketArn

ARN du compartiment Amazon S3. Si le bucket se trouve sur unAWSOutpost, il doit s'agir d'un ARN de point d'accès.

Type : Chaîne

Contraintes de longueur Longueur maximum de 156.

Modèle : ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):(s3|s3-outposts):[a-z\-0-9]*:[0-9]*:.*$

Obligatoire : Oui

S3Config

Amazon Resource Name (ARN) deAWS Identity and Access Management(IAM) utilisé pour accéder à un compartiment Amazon S3.

Pour plus d'informations sur l'utilisation d'un tel rôle, consultezCréation d'un emplacement pour Amazon S3dans le AWS DataSyncGuide de l'utilisateur.

Type : objet S3Config

Obligatoire : Oui

S3StorageClass

Classe de stockage Amazon S3 dans laquelle vous souhaitez stocker vos fichiers lorsque cet emplacement est utilisé comme destination de tâche. Pour les compartimentsRégions AWS, la classe de stockage est Standard par défaut. Pour les compartimentsAWS Outposts, la classe de stockage estAWSOutposts S3.

Pour de plus amples informations sur les classes de stockage S3, veuillez consulter Classes de stockage Amazon S3. Certaines classes de stockage ont des comportements qui peuvent avoir un impact sur votre coût de stockage S3. Pour plus d'informations, consultezRemarques sur l'utilisation des classes de stockage S3 dans DataSync.

Type : Chaîne

Valeurs valides : STANDARD | STANDARD_IA | ONEZONE_IA | INTELLIGENT_TIERING | GLACIER | DEEP_ARCHIVE | OUTPOSTS

Obligatoire : Non

Subdirectory

Sous-répertoire dans le compartiment Amazon S3. Il s'agit du sous-répertoire dans Amazon S3 qui est utilisé pour lire les données à partir de l'emplacement source S3 ou écrire des données vers la destination S3.

Type : Chaîne

Contraintes de longueur Longueur maximum de 4096.

Modèle : ^[a-zA-Z0-9_\-\+\./\(\)\p{Zs}]*$

Obligatoire : Non

Tags

Paire clé-valeur qui représente la balise que vous souhaitez ajouter à l'emplacement. La valeur peut être une chaîne vide. Nous vous recommandons d'utiliser des balises pour nommer vos ressources.

Type : Grappe deTagListEntryobjets

Membres du tableau : Nombre minimal de 0 éléments. Nombre maximal de 50 éléments.

Obligatoire : Non

Syntaxe de la réponse

{
   "LocationArn": "string"
}

Eléments de réponse

Si l’action aboutit, le service renvoie une réponse HTTP 200.

Les données suivantes sont renvoyées au format JSON par le service.

LocationArn

Amazon Resource Name (ARN) de l'emplacement du compartiment Amazon S3 source qui est créé.

Type : Chaîne

Contraintes de longueur Longueur maximum de 128.

Modèle : ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$

Erreurs

Pour plus d'informations sur les erreurs communes à toutes les actions, consultezErreurs courantes.

InternalException

Cette exception est renvoyée lorsqu'une erreur survient dansAWS DataSyncservice.

Code d'état HTTP : 500

InvalidRequestException

Cette exception est renvoyée lorsque le client envoie une demande mal formée.

Code d'état HTTP : 400

Exemples

Étape 1. Autoriser le rôle IAM requis pour écrire dans le compartiment

L'exemple suivant montre la stratégie la plus simple qui accorde les autorisations requises pourAWS DataSyncpour accéder à un compartiment Amazon S3 de destination, suivi d'un rôle IAM pour lequelcreate-location-s3-iam-rolepolicy has been policy.

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Effect": "Allow",
      "Principal": {
        "Service": "datasync.amazonaws.com"
      },
      "Action": "sts:AssumeRole"
    }
  ]
}
"Role": {
        "Path": "/",
        "RoleName": "MyBucketAccessRole",
        "RoleId": "role-id",
        "Arn": "arn:aws:iam::account-id:role/MyBucketAccessRole",
        "CreateDate": "2018-07-27T02:49:23.117Z",
        "AssumeRolePolicyDocument": {
            "Version": "2012-10-17",
            "Statement": [
                {
                    "Effect": "Allow",
                    "Principal": {
                        "Service": "datasync.amazonaws.com"
                    },
                    "Action": "sts:AssumeRole"
                }
            ]
        }
    }
}

Étape 2. Autoriser le rôle IAM créé à écrire dans le compartiment

Attachez une stratégie disposant d'autorisations suffisantes pour accéder au compartiment pour le rôle. Un exemple d'une telle politique est laAWSDataSyncFullAccessstratégie gérée par.

Pour de plus amples informations, veuillez consulterAWSDataSyncFullAccessdans la console IAM.

Vous n'avez pas besoin de créer cette stratégie. Il est géré parAWS, il vous suffit donc de spécifier son ARN dans le champattach-role-policycommande.

IAM_POLICY_ARN='arn:aws:iam::aws:policy/AWSDataSyncFullAccess'

Étape 3. Création d'un point de terminaison pour un compartiment Amazon S3

L'exemple suivant crée un point de terminaison pour un compartiment Amazon S3.

Lorsque le point de terminaison S3 est créé, une réponse similaire au deuxième exemple suivant renvoie l'Amazon Resource Name (ARN) pour le nouvel emplacement Amazon S3.

Exemple de demande

{
  "S3BucketArn": "arn:aws:s3:::MyBucket",
  "S3Config": {
     "BucketAccessRoleArn": "arn:aws:iam::111222333444:role/MyBucketAccessRole",
    },
    "S3StorageClass": "STANDARD",
    "Subdirectory": "/MyFolder",
    "Tags": [
       {
          "Key": "Name",
          "Value": "s3Bucket-1"
       }
     ]
}

Exemple de réponse

{
  "LocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-07db7abfc326c50s3"
}

Voir aussi

Pour plus d’informations sur l’utilisation de cette API dans l’un des kits SDK AWS spécifiques au langage, consultez les ressources suivantes :