

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á.

# Referência da API de gerenciamento de trabalhos
<a name="api-reference"></a>

A API de gerenciamento de tarefas para AWS Snowball Edge é um protocolo de rede baseado em HTTP (RFC 2616). Para obter mais informações sobre esse RFC, consulte [HTTP (RFC 2616)](https://www.ietf.org/rfc/rfc2616.txt) no site do IETF. Para cada chamada para a API de gerenciamento de trabalhos, é feita uma solicitação HTTP para o endpoint da API de gerenciamento de trabalhos específico da região para a Região da AWS em que você deseja gerenciar os trabalhos. A API usa documentos JSON (RFC 4627) para corpos HTTP. request/response 

**nota**  
Chamadas de API feitas nas regiões dos EUA para listagem de trabalhos ou descrições de endereços retornam todos os trabalhos ou endereços nos Estados Unidos para essa conta.

A API de gerenciamento de tarefas do Snowball Edge é um modelo RPC. Nesse modelo, há um conjunto fixo de operações, e os clientes conhecem a sintaxe de cada operação sem qualquer interação prévia. A seguir, você encontrará uma descrição de cada operação de API usando uma anotação abstrata de RPC, com um nome de operação que não aparece na rede. Para cada operação, o tópico especifica o mapeamento para elementos de solicitação de HTTP. 

A operação de gerenciamento de trabalhos específica para a qual certa solicitação é mapeada, é determinada por uma combinação entre métodos de solicitação (GET, PUT, POST ou DELETE) e diversos padrões aos quais seu URI de solicitação corresponde. Se a operação for PUT ou POST, o Snowball Edge extrairá argumentos de chamada do segmento de caminho do URI da solicitação, dos parâmetros da consulta e do objeto JSON no corpo da solicitação.

Embora o nome da operação, como`CreateJob`, não apareça na conexão, esses nomes de operação são significativos nas políticas AWS Identity and Access Management (IAM). O nome da operação também é usado para nomear comandos em ferramentas de linha de comando e elementos do AWS SDK. APIs Por exemplo, o comando AWS Command Line Interface (AWS CLI) `create-job` mapeia a `CreateJob` operação. O nome da operação também aparece nos CloudTrail registros das chamadas da API Snowball Edge.

Para obter informações sobre como instalar e configurar o AWS CLI, incluindo a especificação de quais regiões você deseja fazer AWS CLI chamadas, consulte o [Guia do AWS Command Line Interface usuário](https://docs.aws.amazon.com/cli/latest/userguide/).

**nota**  
A API de gerenciamento de tarefas fornece uma interface programática para a mesma funcionalidade disponível no [AWS Snowball Management](https://console.aws.amazon.com/importexport/home?region=us-west-2) Console, ou seja, criar e gerenciar tarefas para o Snowball Edge. Para transferir dados localmente com um dispositivo Snowball, use o cliente Snowball Edge ou o adaptador S3 SDK para Snowball Edge. Para obter mais informações, consulte [Transferência de dados com um Snowball](https://docs.aws.amazon.com/snowball/latest/ug/snowball-data-transfer.html) no *Guia do usuário do AWS Snowball*.  
Se você usa um Snowball Edge, use o cliente Snowball Edge para desbloquear o equipamento. Para obter mais informações, consulte [Usar o cliente do Snowball](https://docs.aws.amazon.com/snowball/latest/developer-guide/using-client.html) no *AWS Guia do desenvolvedor do Snowball*.

## Endpoint de API
<a name="api-reference-endpoint"></a>

O endpoint da API é o nome do Serviço de Nome de Domínio (DNS) usado como um host no URI de HTTP para as chamadas de API. Esses endpoints de API são específicos da região e usam o formulário a seguir.

```
snowball.aws-region.amazonaws.com
```

Por exemplo, o endpoint da API Snowball Edge para a região Oeste dos EUA (Oregon) é o seguinte.

```
snowball.us-west-2.amazonaws.com
```

Para obter uma lista do Regiões da AWS que o Snowball Edge suporta (onde você pode criar e gerenciar trabalhos), consulte [AWS Import/Export](https://docs.aws.amazon.com/general/latest/gr/rande.html#ie-region)no. *Referência geral da AWS*

O endpoint de API específico da região define o escopo dos recursos do Snowball Edge que são acessíveis quando você faz uma chamada de API. Por exemplo, ao chamar a operação `ListJobs` usando o endpoint mencionado anteriormente, você obtém uma lista de trabalhos na região Oeste dos EUA (Oregon) que foram criados em sua conta. 

## Versão da API
<a name="api-reference-version"></a>

A versão da API que está sendo usada para uma chamada é identificada pelo primeiro segmento do caminho do URI da solicitação e tem o formato de data ISO 8601. A documentação descreve a versão da API de 2016-06-30.

## Referência da política de permissões de APIs
<a name="api-reference-policies"></a>

As políticas a seguir são necessárias para criar trabalhos com a API de gerenciamento de trabalhos do Snowball Edge.

**Política de confiança de função para criar trabalhos**

A utilização da API de gerenciamento de trabalhos para criar trabalhos exige a política de confiança a seguir.

------
#### [ JSON ]

****  

```
{
  "Version":"2012-10-17",		 	 	 
  "Statement": [
    {
      "Sid": "",
      "Effect": "Allow",
      "Principal": {
        "Service": "importexport.amazonaws.com"
      },
      "Action": "sts:AssumeRole",
      "Condition": {
        "StringEquals": {
          "sts:ExternalId": "AWSIE"
        }
      }
    }
  ]
}
```

------

**nota**  
Para saber mais sobre políticas de confiança, consulte [Modificação de uma função](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_manage_modify.html) no Guia do usuário do IAM.

**Política de função para criação de trabalhos de importação**

A criação de um trabalho de importação exige a política de função a seguir.

------
#### [ JSON ]

****  

```
{
    "Version":"2012-10-17",		 	 	 
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "s3:GetBucketLocation",
                "s3:ListBucketMultipartUploads"
            ],
            "Resource": "arn:aws:s3:::*"
        },
        {
            "Effect": "Allow",
            "Action": [
                "s3:GetBucketPolicy",
                "s3:PutObject",
                "s3:AbortMultipartUpload",
                "s3:ListMultipartUploadParts",
                "s3:PutObjectAcl"
            ],
            "Resource": "arn:aws:s3:::*"
        },
        {
            "Effect": "Allow",
            "Action": [
                "snowball:*"
            ],
            "Resource": [
                "*"
            ]
        }
    ]
}
```

------

**Política de função para criação de trabalhos de exportação**

A criação de um trabalho de exportação exige a política de função a seguir.

------
#### [ JSON ]

****  

```
{
  "Version":"2012-10-17",		 	 	 
  "Statement": [
    {
      "Effect": "Allow",
      "Action": [
        "s3:GetBucketLocation",
        "s3:GetObject",
        "s3:ListBucket"
      ],
      "Resource": "arn:aws:s3:::*"
    },
    {
       "Effect": "Allow",
       "Action": [
         "snowball:*"
       ],
       "Resource": [
         "*"
       ]
    }
  ]
}
```

------

**Entidade principal da política de bucket do Amazon S3 para criação de trabalhos**

Em alguns casos, os buckets do Amazon S3 que você usa com o Snowball Edge têm políticas de bucket em vigor que exigem a listagem do nome da sessão de função da função assumida. Nesses casos, é necessário especificar uma entidade principal nessas políticas que identifique o `AWSImportExport-Validation`. O exemplo de política de bucket do Amazon S3 a seguir demonstra como fazer isso. 

**Example**    
****  

```
{
	"Version":"2012-10-17",		 	 	 
	"Statement": {
		"Sid": "AllowAWSSnowballToCreateJobs",
		"Effect": "Allow",
		"Principal": {
			"AWS": [
				"arn:aws:iam::111122223333:role/rolename",
				"arn:aws:sts::111122223333:assumed-role/rolename/AWSImportExport-Validation",
				"arn:aws:iam::111122223333:root"
			]
		},
		"Action": "S3:*",
		"Resource": ["arn:aws:s3:::examplebucket/*"]
	}
}
```
Neste exemplo de política, negamos acesso a todas as entidades principais, exceto aquela indicada no elemento `NotPrincipal`. Para obter mais informações sobre como usar`NotPrincipal`, consulte [NotPrincipal](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements.html#NotPrincipal)o *Guia do usuário do IAM*.

**nota**  
Para trabalhos em AWS GovCloud (US), o Snowball Edge usa `AWSIEJob` como função o nome da sessão da função assumida.

## Criação de uma função do IAM para o Snowball Edge e o Snowball Edge
<a name="create-iam-role"></a>

Uma política de perfil do IAM deve ser criada com permissões de leitura e gravação para os seus buckets do Amazon S3. A função do IAM também deve ter uma relação de confiança com o Snowball Edge. Ter uma relação de confiança significa que AWS você pode gravar os dados no Snowball e em seus buckets do Amazon S3, dependendo se você está importando ou exportando dados.

Quando você cria um trabalho no Console de Gerenciamento da família AWS Snow, a criação da função do IAM necessária ocorre na etapa 4 na seção **Permissão**. Esse processo é automático. A função do IAM que você permite que o Snowball Edge assuma só é usada para gravar seus dados em seu bucket quando o Snowball com seus dados transferidos chega. AWS O procedimento a seguir descreve esse processo.

**Para criar o perfil do IAM para seu trabalho de importação**

1. Faça login no Console de gerenciamento da AWS e abra o AWS Snowball Edge console em [https://console.aws.amazon.com/importexport/](https://console.aws.amazon.com/importexport/). 

1. Escolha **Criar trabalho**.

1. Na primeira etapa, preencha os detalhes do trabalho de importação no Amazon S3 e, em seguida, escolha **Avançar**.

1. Na segunda etapa, em **Permissão**, escolha **Criar/Selecionar perfil do IAM**.

   O Console de gerenciamento do IAM será aberto, mostrando o perfil do IAM que a AWS usa para copiar objetos em seus buckets do Amazon S3 especificados.

1. Revise os detalhes nessa página e, em seguida, selecione **Permitir**.

   Você retorna ao Console de Gerenciamento da família AWS Snow, onde o **ARN da função IAM selecionada** contém o Nome de recurso da Amazon (ARN) para a função do IAM que você acabou de criar.

1. Escolha **Avançar** para concluir a criação do seu perfil do IAM.

O procedimento anterior cria um perfil do IAM que tem permissões de gravação para os buckets do Amazon S3 para os quais planeja importar dados. O perfil do IAM criado tem uma das estruturas a seguir, dependendo se é para um trabalho de importação ou exportação.

** do perfil do IAM para um trabalho de importação **

------
#### [ JSON ]

****  

```
          {
  "Version":"2012-10-17",		 	 	 
  "Statement": [
    {
      "Effect": "Allow",
      "Action": [
        "s3:GetBucketLocation",
        "s3:ListBucketMultipartUploads"
      ],
      "Resource": "arn:aws:s3:::*"
    },
    {
      "Effect": "Allow",
      "Action": [
        "s3:GetBucketPolicy",
        "s3:PutObject",
        "s3:AbortMultipartUpload",
        "s3:ListMultipartUploadParts",
        "s3:PutObjectAcl"
      ],
      "Resource": "arn:aws:s3:::*"
    }
  ]
}
```

------

Se você usa criptografia do lado do servidor com chaves AWS KMS gerenciadas (SSE-KMS) para criptografar os buckets do Amazon S3 associados ao seu trabalho de importação, você também precisa adicionar a seguinte declaração à sua função do IAM.

```
{
     "Effect": "Allow",
     "Action": [
       "kms:GenerateDataKey"
     ],
     "Resource": "arn:aws:s3:::SSEKMSEncryptedBucketName"
}
```

** do perfil do IAM para um trabalho de exportação**

------
#### [ JSON ]

****  

```
{
  "Version":"2012-10-17",		 	 	 
  "Statement": [
    {
      "Effect": "Allow",
      "Action": [
        "s3:GetBucketLocation",
        "s3:GetBucketPolicy",
        "s3:GetObject",
        "s3:ListBucket"
      ],
      "Resource": "arn:aws:s3:::*"
    }
  ]
}
```

------

Se você usa criptografia do lado do servidor com chaves AWS KMS gerenciadas para criptografar os buckets do Amazon S3 associados ao seu trabalho de exportação, você também precisa adicionar a seguinte declaração à sua função do IAM.

```
{
     "Effect": "Allow",
     "Action": [
            “kms:Decrypt”
      ],
      "Resource": "arn:aws:s3:::SSEKMSEncryptedBucketName"
}
```