Uso de APIs de gerenciamento de trabalhos - AWS Snowcone Guia do usuário

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

Uso de APIs de gerenciamento de trabalhos

A API de gerenciamento de trabalhos (JMAPI) fornece acesso programático à mesma funcionalidade disponível no Console de Gerenciamento da família AWS Snow. Isso permite que você automatize a funcionalidade do trabalho. Usando o JMAPI, você pode ver o status do trabalho, criar trabalhos, baixar o arquivo manifesto, desbloquear o código e visualizar relatórios de conclusão do trabalho. Como as chamadas são feitas por meio da API, você pode integrá-las a um aplicativo personalizado ou front-end da Web.

Usos comuns do JMAPI

  • Automatizando pedidos de dispositivos Snowcone

  • Baixando o arquivo manifesto

  • Baixando o arquivo de desbloqueio

  • Listando os trabalhos atuais de Snowcone

  • Baixando o relatório de conclusão de trabalhos do Snowcone

Cadeias de caracteres obrigatórias do JMAPI

Ao fazer um pedido por meio da API de gerenciamento de tarefas, você usa os seguintes parâmetros obrigatórios, que são mostrados com exemplos.

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

Endpoints JMAPI

Endpoint de API

Para fazer chamadas para cada endpoint, o formato é snowballEdge.region.amazonaws.com. Aqui estão algumas sugestões para ajudar a entender a divisão do endpoint.

Região Endpoint
Leste dos EUA (Norte da Virgínia) snowball.us-east-1.amazonaws.com
Oeste dos EUA (Oregon) snowball.us-west-2.amazonaws.com

Comandos da JMAPI CLI

CLI de gerenciamento de trabalhos

A seguir estão as chamadas de CLI que você pode fazer na API de gerenciamento de trabalhos.

Command Exemplo
Listar os trabalhos aws snowball list-jobs
Descrever trabalho aws snowball describe-job --job-id [JOB ID]
Descrever endereço aws snowball describe-address --address-id
Criar endereço aws snowball create-address --cli-input-json file://create-address.json
Criar trabalho aws snowball create-job --cli-input-json file://create-job.json
Cancelar trabalho aws snowball cancel-job --job-id [JOB ID]

Exemplos

Veja a seguir exemplos de comandos usando a API de gerenciamento de trabalhos.

Exemplo de KMS JSON

O exemplo de JSON a seguir é um arquivo JSON formatado corretamente para usar o arquivo de política do AWS KMS .

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

Exemplo de criação de endereço

Os exemplos a seguir mostram como você formataria o comando para criar seu endereço e qual seria a resposta quando ele fosse bem-sucedido.

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

Exemplos de resultado

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

Exemplo de criação de trabalho

O comando a seguir mostra um exemplo de comando para executar o comando create-job.

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

O comando create-job acima criará uma tarefa de importação na região us-east-1 com um dispositivo Snowcone do tipo SNC1_SSD com preferência de capacidade T14 com uma opção de envio SECOND_DAY.