

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

# Referencia de la API de administración de trabajos
<a name="api-reference"></a>

La API de administración de trabajos AWS Snowball Edge es un protocolo de red basado en HTTP (RFC 2616). Para obtener más información sobre esta RFC, consulte [HTTP (RFC 2616)](https://www.ietf.org/rfc/rfc2616.txt) en el sitio web de IETF. Para cada llamada a la API de administración de trabajos, debe llevar a cabo una solicitud HTTP al punto de conexión de la API de administración de trabajos específica de la región de Región de AWS en la que desea administrar los trabajos. La API utiliza documentos JSON (RFC 4627) para los cuerpos HTTP. request/response 

**nota**  
Las llamadas a las API realizadas en las regiones de los Estados Unidos para publicar los trabajos o describir las direcciones devuelve todos los trabajos o direcciones de los Estados Unidos para esa cuenta.

La API de administración de trabajos de Snowball Edge es un modelo de RPC. En este modelo, hay un conjunto fijo de operaciones y los clientes conocen la sintaxis de cada operación sin ninguna interacción anterior. A continuación, encontrará una descripción de cada operación de la API en la notación RPC abstracta, con un nombre de operación que no aparece en la ruta. Para cada operación, el tema especifica el mapeo a los elementos de solicitud HTTP. 

La operación de administración del trabajo concreta a la que se asigna una solicitud concreta se determina mediante una combinación del método de la solicitud (GET, PUT, POST o DELETE) y de cuáles de los distintos patrones coincide con su URI de solicitud. Si la operación es PUT o POST, Snowball Edge extrae los argumentos de llamada del segmento de ruta URI de la solicitud, los parámetros de consulta y el objeto JSON del cuerpo de la solicitud.

Aunque el nombre de la operación, por ejemplo`CreateJob`, no aparece en el cable, estos nombres de operación son significativos en las políticas AWS Identity and Access Management (de IAM). El nombre de la operación también se usa para nombrar los comandos de las herramientas de línea de comandos y los elementos del SDK. AWS APIs Por ejemplo, el comando AWS Command Line Interface (AWS CLI) se `create-job` asigna a la `CreateJob` operación. El nombre de la operación también aparece en CloudTrail los registros de las llamadas a la API de Snowball Edge.

Para obtener información sobre la instalación y configuración de AWS CLI, incluida la especificación de las regiones contra las que quiere realizar AWS CLI llamadas, consulte la [Guía del AWS Command Line Interface usuario](https://docs.aws.amazon.com/cli/latest/userguide/).

**nota**  
La API de administración de trabajos proporciona una interfaz programática para la misma funcionalidad disponible en la consola de [administración de AWS Snowball](https://console.aws.amazon.com/importexport/home?region=us-west-2), a saber, crear y administrar trabajos para Snowball Edge. Para transferir datos localmente con un dispositivo Snowball, utilice el cliente Snowball Edge o el adaptador S3 SDK para Snowball Edge. Para obtener más información, consulte [Transferencia de datos con un dispositivo Snowball](https://docs.aws.amazon.com/snowball/latest/ug/snowball-data-transfer.html) en la *Guía del usuario de AWS Snowball*.  
Si utiliza un Snowball Edge, utilice el cliente Snowball Edge para desbloquear el dispositivo. Para obtener más información, consulte [Uso del cliente Snowball](https://docs.aws.amazon.com/snowball/latest/developer-guide/using-client.html) en la *Guía para desarrolladores de AWS Snowball*.

## Punto de conexión de la API
<a name="api-reference-endpoint"></a>

El punto de enlace de la API es el servicio de nombres de dominio (DNS) que se utiliza como host en el URI de HTTP de las llamadas a la API. Estos puntos de enlace de la API son específicas de cada región y adoptan el siguiente formato.

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

Por ejemplo, el punto final de la API de Snowball Edge para la región EE.UU. Oeste (Oregón) es el siguiente.

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

Para obtener una lista de las Regiones de AWS aplicaciones compatibles con Snowball Edge (donde puede crear y gestionar trabajos), consulte [AWS Import/Export](https://docs.aws.amazon.com/general/latest/gr/rande.html#ie-region)en la. *Referencia general de AWS*

El punto final de la API específico de la región define el alcance de los recursos de Snowball Edge a los que se puede acceder cuando se realiza una llamada a la API. Por ejemplo, si llama a la operación `ListJobs` mediante el punto de conexión anterior, obtendrá una lista de los trabajos de la región del Oeste de EE. UU. (Oregón) que se han creado en su cuenta. 

## Versión de API
<a name="api-reference-version"></a>

La versión de API utilizada en una llamada se identifica mediante el primer segmento de la ruta de la URI de la solicitud y su formato es una fecha ISO 8601. En la documentación se describe la versión 2016-06-30 de la API.

## Referencia de políticas de permisos de API
<a name="api-reference-policies"></a>

Se necesitan las siguientes políticas para crear trabajos con la API de administración de trabajos de Snowball Edge.

**Política de confianza de roles para crear trabajos**

Si utiliza la API de administración de trabajos para crear trabajos, se requiere la siguiente política de confianza.

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

****  

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

------

**nota**  
Para obtener más información acerca de las políticas de confianza, consulte [Modificación de un rol](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_manage_modify.html) en la Guía del usuario de IAM.

**Política de roles para crear trabajos de importación**

Para crear un trabajo de importación se requiere la siguiente política de roles.

------
#### [ 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 roles para crear trabajos de exportación**

Para crear un trabajo de exportación se requiere la siguiente política de roles.

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

****  

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

------

**Entidad principal en la política de buckets de Amazon S3 para crear trabajos**

En algunos casos, los buckets de Amazon S3 que utiliza con Snowball Edge cuentan con políticas de bucket que obligan a incluir el nombre de sesión del rol asumido. En estos casos, debe especificar una entidad principal en las políticas que identifique `AWSImportExport-Validation`. En el siguiente ejemplo de política de buckets de Amazon S3 se muestra cómo hacerlo. 

**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/*"]
	}
}
```
En este ejemplo de política, denegamos acceso a todas las entidades principales, excepto la que se nombra en el elemento `NotPrincipal`. Para obtener más información sobre cómo usarlo`NotPrincipal`, consulte la Guía del [NotPrincipal](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements.html#NotPrincipal)usuario de *IAM.*

**nota**  
Para los trabajos en AWS GovCloud (US), Snowball Edge utiliza el nombre de sesión del rol asumido `AWSIEJob` como nombre de sesión.

## Creación de un rol de IAM para Snowball Edge y Snowball Edge
<a name="create-iam-role"></a>

La política de roles de IAM debe crearse con permisos de lectura y escritura para los buckets de Amazon S3. El rol de IAM también debe tener una relación de confianza con Snowball Edge. Tener una relación de confianza significa que AWS puede escribir los datos en Snowball y en sus buckets de Amazon S3, en función de si está importando o exportando datos.

**Al crear un trabajo en Consola de administración de la familia de productos Snow de AWS, la creación del rol de IAM necesario se realiza en el paso 4 de la sección de permisos.** Este proceso es automático. La función de IAM que permite que asuma Snowball Edge solo se utiliza para escribir los datos en el bucket cuando llega la bola de nieve con los datos transferidos. AWS A continuación se describe ese proceso.

**Para crear el rol de IAM para el trabajo de importación**

1. Inicie sesión en Consola de administración de AWS y abra la consola en AWS Snowball Edge . [https://console.aws.amazon.com/importexport/](https://console.aws.amazon.com/importexport/) 

1. Seleccione **Crear trabajo**.

1. En el primer paso, rellene los detalles del trabajo de importación en Amazon S3 y, a continuación, elija **Siguiente**.

1. En el segundo paso, en **Permiso**, seleccione **Crear o seleccionar rol de IAM**.

   Se abrirá la Consola de administración de IAM, que mostrará el rol de IAM que AWS utiliza para copiar objetos en los buckets de Amazon S3 especificados.

1. Revise los detalles de esta página y elija **Permitir**.

   Vuelve a Consola de administración de la familia de productos Snow de AWS, donde el ARN del **rol de IAM seleccionado contiene** el nombre del recurso de Amazon (ARN) del rol de IAM que acaba de crear.

1. Elija **Siguiente** para terminar de crear el rol de IAM.

El procedimiento anterior crea un rol de IAM que tiene permisos de escritura para los buckets de Amazon S3 en los que tiene previsto importar los datos. El rol de IAM que se crea posee una de las siguientes estructuras, según sea para un trabajo de importación o de exportación.

**Rol de IAM para un trabajo de importación**

------
#### [ 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:::*"
    }
  ]
}
```

------

Si utiliza el cifrado del lado del servidor con claves AWS KMS administradas (SSE-KMS) para cifrar los buckets de Amazon S3 asociados a su trabajo de importación, también debe añadir la siguiente declaración a su función de IAM.

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

**Rol de IAM para un trabajo de exportación**

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

****  

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

------

Si utiliza el cifrado del lado del servidor con claves AWS KMS administradas para cifrar los buckets de Amazon S3 asociados a su trabajo de exportación, también debe añadir la siguiente declaración a su función de IAM.

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