Utilisation de l'API de gestion des Job

L'API de gestion des tâches (JAPI) fournit un accès par programme aux mêmes fonctionnalités que celles disponibles dans laAWS Snow Family Management Console. Cela vous permet d'automatiser la fonctionnalité des tâches. En utilisant le JMAPI, vous pouvez voir l'état de la tâche, créer des tâches, télécharger le fichier manifeste, déverrouiller le code et afficher les rapports d'achèvement de travaux. Étant donné que les appels sont effectués via l'API, vous pouvez intégrer ces appels dans une application personnalisée ou une interface frontale Web.

Utilisations courantes de JMAPI

• Automatisation de la commande des appareils Snowcone

• Téléchargement du fichier manifeste

• Téléchargement du fichier de déverrouillage

• Liste des offres d'emploi Snowcone actuelles

• Téléchargement du rapport d'achèvement des travaux Snowcone

Cordes JMAPI obligatoires

Lorsque vous passez une commande via l'API de gestion des tâches, vous utilisez les paramètres obligatoires suivants, qui sont présentés avec des exemples.

--job-type
--resources
--address-id
--region
--role-arn
--kms-key-arn
--shipping-option
--device-type
--description
    

Points de terminaison JAPI

Point de terminaison API

Pour passer des appels vers chaque point de terminaison, le format estsnowballEdge.region.amazonaws.com. Voici quelques exemples qui vous aideront à comprendre la ventilation du point de terminaison.

Région	Point de terminaison
USA Est (Virginie du Nord)	snowball.us-east-1.amazonaws.com
USA Ouest (Oregon)	snowball.us-west-2.amazonaws.com

Commandes de l'interface de ligne de commande JAPI

CLI de gestion des Job

Voici les appels CLI que vous pouvez passer contre l'API de gestion des tâches.

Commande	Example (Exemple)
Liste des tâches	aws snowball list-jobs
Description de la tâche	aws snowball describe-job --job-id [JOB ID]
Décrire l'adresse	aws snowball describe-address --address-id
Créer une adresse	aws snowball create-address --cli-input-json file://create-address.json
Créer une tâche	aws snowball create-job --cli-input-json file://create-job.json
Annuler une tâche	aws snowball cancel-job --job-id [JOB ID]

Exemples

Voici des exemples de commandes utilisant l'API de gestion des tâches.

Exemple JSON KMS

L'exemple JSON suivant est un fichier JSON correctement formaté pour utiliser leAWS KMSfichier de stratégie.

{
    "KeyMetadata": {
        "Origin": "AWS_KMS",
        "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab",
        "Description": "",
        "KeyManager": "CUSTOMER",
        "Enabled": true,
        "KeyUsage": "ENCRYPT_DECRYPT",
        "KeyState": "Enabled",
        "CreationDate": 1502910355.475,
        "Arn": "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
        "AWSAccountId": "111122223333"
    }
}

Exemple de création d'adresse

Les exemples suivants montrent comment formater la commande pour créer votre adresse et quelle est la réponse en cas de succès.

aws snowball create-address --address "Name=Bob,Company=AWS,Street1=1234 Fake St.,City=All,StateOrProvince=Any,Country=US,PostalCode=12345,PhoneNumber=1234567890"

Exemple de sortie

{
    "AddressId": "ADID3be640c8-1111-1111-1111-917f201ffa42"
}

Exemple de Job

La commande suivante présente un exemple de commande permettant d'exécuter la commandecreate-jobcommande.

aws snowball create-job --job-type IMPORT --resources file://path/to/resources.json --address-id ADID3be640c8-1111-1111-1111-917f201ffa42 --region us-east-1 --role-arn arn:aws:iam::123456789123:role/example_role --kms-key-arn arn:aws:kms:us-west-2:000000000000:key/Example --snowball-capacity-preference T14 --device-configuration file://path/to/configuration.json --shipping-option SECOND_DAY --snowball-type SNC1_SSD

Ce qui précèdecreate-jobva créer une tâche d'importation dans la région us-east-1 avec un périphérique Snowcone de type SNC1_SSD ayant une préférence de capacité T14 avec une option d'expédition SECOND_DAY.