Utilizzo dell'API di gestione dei processi

Il processo di gestione API (JMAPI) fornisce l'accesso programmatico alla stessa funzionalità disponibile nelConsole di gestione della famiglia di servizi AWS Snow. Ciò consente di automatizzare la funzionalità del lavoro. Utilizzando JMAPI, è possibile visualizzare lo stato del processo, creare processi, scaricare il file manifesto, sbloccare il codice e visualizzare i rapporti di completamento del processo. Poiché le chiamate vengono effettuate tramite l'API, è possibile integrare queste chiamate in un'applicazione personalizzata o in un front-end web.

Usi comuni di JMAPI

• Automatizzazione dell'ordinazione dei dispositivi Snowcone

• Download del file manifest

• Download del file di sblocco

• Elenco degli attuali lavori Snowcone

• Scaricamento del rapporto di completamento del lavoro Snowcone

Stringhe richieste JMAPI

Quando si effettua un ordine tramite l'API di gestione dei processi, si utilizzano i seguenti parametri richiesti, che vengono mostrati con esempi.

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

Endpoint JMAPI

Endpoint API

Per effettuare chiamate a ciascun endpoint, il formato èsnowballEdge.region.amazonaws.com. Di seguito sono riportati alcuni esempi per aiutarti a capire la suddivisione dell'endpoint.

Regione	Endpoint
Stati Uniti orientali (Virginia settentrionale)	snowball.us-east-1.amazonaws.com
Stati Uniti occidentali (Oregon)	snowball.us-west-2.amazonaws.com

Comandi della CLI JMAPI

CLI di gestione dei Job

Di seguito sono riportate le chiamate CLI che è possibile effettuare contro l'API di gestione dei lavori.

Comando	Esempio
Elenchi di processi	aws snowball list-jobs
Describe Job	aws snowball describe-job --job-id [JOB ID]
Descrivi indirizzo	aws snowball describe-address --address-id
Crea indirizzo	aws snowball create-address --cli-input-json file://create-address.json
Creazione di un processo	aws snowball create-job --cli-input-json file://create-job.json
Annullamento di un processo	aws snowball cancel-job --job-id [JOB ID]

Esempi

Di seguito sono riportati esempi di comandi che utilizzano l'API di gestione dei processi.

Esempio JSON KMS

L'esempio JSON seguente è un file JSON formattato correttamente per l'utilizzo delAWS KMSfile policy.

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

Esempio di creazione indirizzo

Gli esempi seguenti mostrano come formattare il comando per creare il tuo indirizzo e qual è la risposta quando ha esito positivo.

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

Esempio di Output

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

Esempio di creazione di attività

Il seguente comando mostra un esempio di comando per l'esecuzione dicreate-jobcomando.

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

Quanto sopracreate-jobil comando creerà un processo di importazione nella regione us-east-1 con un dispositivo snowcone di tipo SNC1_SSD con preferenza di capacità T14 con un'opzione di spedizione SECOND_DAY.