CreateCluster - AWS Snowball
Sintaxe da SolicitaçãoParâmetros da solicitaçãoSintaxe da RespostaElementos de RespostaErrosConsulte também

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

CreateCluster

Cria um cluster vazio. Cada cluster oferece suporte a cinco nós. Você usa a ação CreateJob separadamente para criar os trabalhos para cada um desses nós. O cluster não é enviado até que esses trabalhos de cinco nós tenham sido criados.

Sintaxe da Solicitação

{
   "AddressId": "string",
   "Description": "string",
   "ForceCreateJobs": boolean,
   "ForwardingAddressId": "string",
   "InitialClusterSize": number,
   "JobType": "string",
   "KmsKeyARN": "string",
   "LongTermPricingIds": [ "string" ],
   "Notification": { 
      "DevicePickupSnsTopicARN": "string",
      "JobStatesToNotify": [ "string" ],
      "NotifyAll": boolean,
      "SnsTopicARN": "string"
   },
   "OnDeviceServiceConfiguration": { 
      "EKSOnDeviceService": { 
         "EKSAnywhereVersion": "string",
         "KubernetesVersion": "string"
      },
      "NFSOnDeviceService": { 
         "StorageLimit": number,
         "StorageUnit": "string"
      },
      "S3OnDeviceService": { 
         "FaultTolerance": number,
         "ServiceSize": number,
         "StorageLimit": number,
         "StorageUnit": "string"
      },
      "TGWOnDeviceService": { 
         "StorageLimit": number,
         "StorageUnit": "string"
      }
   },
   "RemoteManagement": "string",
   "Resources": { 
      "Ec2AmiResources": [ 
         { 
            "AmiId": "string",
            "SnowballAmiId": "string"
         }
      ],
      "LambdaResources": [ 
         { 
            "EventTriggers": [ 
               { 
                  "EventResourceARN": "string"
               }
            ],
            "LambdaArn": "string"
         }
      ],
      "S3Resources": [ 
         { 
            "BucketArn": "string",
            "KeyRange": { 
               "BeginMarker": "string",
               "EndMarker": "string"
            },
            "TargetOnDeviceServices": [ 
               { 
                  "ServiceName": "string",
                  "TransferOption": "string"
               }
            ]
         }
      ]
   },
   "RoleARN": "string",
   "ShippingOption": "string",
   "SnowballCapacityPreference": "string",
   "SnowballType": "string",
   "TaxDocuments": { 
      "IND": { 
         "GSTIN": "string"
      }
   }
}

Parâmetros da solicitação

Para obter informações sobre os parâmetros comuns a todas as ações, consulte Parâmetros Comuns.

A solicitação aceita os seguintes dados no JSON formato.

AddressId

O ID do endereço para o qual você deseja que o cluster seja enviado.

Tipo: string

Restrições de tamanho: tamanho fixo de 40.

Padrão: ADID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Exigido: Sim

Description

Uma descrição opcional desse cluster específico, por exemplo, Environmental Data Cluster-01.

Tipo: string

Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 1.024.

Padrão: .*

Obrigatório: Não

ForceCreateJobs

Force a criação de um cluster quando o usuário tentar superprovisionar ou subprovisionar um cluster. Um cluster é superprovisionado ou subprovisionado se o tamanho inicial do cluster é maior (superprovisionado) ou menor (subprovisionado) do que o necessário para atender aos requisitos de capacidade especificados em OnDeviceServiceConfiguration.

Tipo: booliano

Obrigatório: não

ForwardingAddressId

Esse campo não é compatível com a sua região.

Tipo: string

Restrições de tamanho: tamanho fixo de 40.

Padrão: ADID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Obrigatório: Não

InitialClusterSize

Se fornecido, cada trabalho será criado automaticamente e associado ao novo cluster. Se não for fornecido, será tratado como 0.

Tipo: número inteiro

Intervalo válido: valor mínimo de 0. Valor máximo de 16.

Obrigatório: Não

JobType

O tipo de trabalho desse cluster. Atualmente, o único tipo de trabalho compatível com clusters é LOCAL_USE.

Para obter informações sobre os tipos de dispositivos da Família Snow, consulte Snow Family Devices and Capacity no Snowcone User Guide ou Snow Family Devices and Capacity no Snowball Edge User Guide.

Tipo: string

Valores Válidos: IMPORT | EXPORT | LOCAL_USE

Obrigatório: Sim

KmsKeyARN

O KmsKeyARN valor que você deseja associar a esse cluster. KmsKeyARNos valores são criados usando a CreateKeyAPIação em AWS Key Management Service (AWS KMS).

Tipo: string

Restrições de tamanho: tamanho máximo de 255.

Padrão: arn:aws.*:kms:.*:[0-9]{12}:key/.*

Obrigatório: Não

LongTermPricingIds

Lista o ID de preço de longo prazo que será usado para associação aos trabalhos criados automaticamente para o novo cluster.

Tipo: Matriz de strings

Restrições de tamanho: tamanho fixo de 41.

Padrão: LTPID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Obrigatório: Não

Notification

As configurações de notificação do Amazon Simple Notification Service (AmazonSNS) para esse cluster.

Tipo: objeto Notification

Obrigatório: Não

OnDeviceServiceConfiguration

Especifica o serviço ou serviços no dispositivo da família Snow dos quais seus dados transferidos serão exportados ou importados. AWS Os clusters de dispositivos da família Snow oferecem suporte ao Amazon S3 e NFS (Network File System).

Tipo: objeto OnDeviceServiceConfiguration

Obrigatório: Não

RemoteManagement

Permite que você opere e gerencie dispositivos Snow de forma segura em um cluster remotamente, de fora da sua rede interna. Quando definido como INSTALLED_AUTOSTART, o gerenciamento remoto estará disponível automaticamente quando o dispositivo chegar ao seu local. Caso contrário, você precisará usar o Snowball Client para gerenciar o dispositivo.

Tipo: string

Valores Válidos: INSTALLED_ONLY | INSTALLED_AUTOSTART | NOT_INSTALLED

Obrigatório: Não

Resources

Os recursos associados ao trabalho do cluster. Esses recursos incluem buckets do Amazon S3 e AWS Lambda funções opcionais escritas na linguagem Python.

Tipo: objeto JobResource

Obrigatório: Não

RoleARN

O RoleARN que você deseja associar a esse cluster. RoleArnos valores são criados usando a CreateRoleAPIação em AWS Identity and Access Management (IAM).

Tipo: string

Restrições de tamanho: tamanho máximo de 255.

Padrão: arn:aws.*:iam::[0-9]{12}:role/.*

Obrigatório: Não

ShippingOption

A velocidade de envio de cada nó nesse cluster. Essa velocidade não determina em quanto tempo você receberá cada dispositivo Snowball Edge, mas representa a rapidez com que cada dispositivo se move até seu destino enquanto está em trânsito. As velocidades de envio regionais são as seguintes:

  • Na Austrália, você tem acesso ao frete expresso. Normalmente, os dispositivos Snow enviados de forma expressa são entregues em cerca de um dia.

  • Na União Europeia (UE), você tem acesso ao frete expresso. Normalmente, os dispositivos Snow enviados de forma expressa são entregues em cerca de um dia. Além disso, a maioria dos países na UE tem acesso ao envio padrão que geralmente leva menos de uma semana, só de envio.

  • Na Índia, os dispositivos Snow são entregues em um a sete dias.

  • Nos Estados Unidos da América (EUA), você tem acesso a envio em um dia e envio em dois dias.

  • Na Austrália, você tem acesso ao frete expresso. Normalmente, os dispositivos enviados de forma expressa são entregues em cerca de um dia.

  • Na União Europeia (UE), você tem acesso ao frete expresso. Normalmente, os dispositivos Snow enviados de forma expressa são entregues em cerca de um dia. Além disso, a maioria dos países na UE tem acesso ao envio padrão que geralmente leva menos de uma semana, só de envio.

  • Na Índia, os dispositivos Snow são entregues em um a sete dias.

  • Nos Estados Unidos, você tem acesso a envio em um dia e envio em dois dias.

Tipo: string

Valores Válidos: SECOND_DAY | NEXT_DAY | EXPRESS | STANDARD

Obrigatório: Sim

SnowballCapacityPreference

Se seu trabalho está sendo criado em uma das regiões dos EUA, você tem a opção de especificar o tamanho do dispositivo Snow que deseja para esse trabalho. Em todas as outras regiões, o Snowballs vem com 80 TB em capacidade de armazenamento.

Para obter informações sobre os tipos de dispositivos da Família Snow, consulte Snow Devices and Capacity no Snowcone User Guide ou Snow Devices and Capacity no Snowball Edge User Guide.

Tipo: string

Valores Válidos: T50 | T80 | T100 | T42 | T98 | T8 | T14 | T32 | NoPreference | T240 | T13

Obrigatório: Não

SnowballType

O tipo de dispositivos da Família Snow a ser usado para esse cluster.

nota

Para trabalhos em cluster, o AWS Snow Family atualmente suporta somente o tipo de EDGE dispositivo.

Para obter informações sobre os tipos de dispositivos da Família Snow, consulte Snow Family Devices and Capacity no Snowcone User Guide ou Snow Family Devices and Capacity no Snowball Edge User Guide.

Tipo: string

Valores Válidos: STANDARD | EDGE | EDGE_C | EDGE_CG | EDGE_S | SNC1_HDD | SNC1_SSD | V3_5C | V3_5S | RACK_5U_C

Obrigatório: Sim

TaxDocuments

Os documentos fiscais exigidos em seu Região da AWS.

Tipo: objeto TaxDocuments

Obrigatório: Não

Sintaxe da Resposta

{
   "ClusterId": "string",
   "JobListEntries": [ 
      { 
         "CreationDate": number,
         "Description": "string",
         "IsMaster": boolean,
         "JobId": "string",
         "JobState": "string",
         "JobType": "string",
         "SnowballType": "string"
      }
   ]
}

Elementos de Resposta

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP de 200.

Os dados a seguir são retornados em JSON formato pelo serviço.

ClusterId

O ID gerado automaticamente para um cluster.

Tipo: string

Restrições de tamanho: tamanho fixo de 39.

Padrão: CID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

JobListEntries

Lista de trabalhos criados para esse cluster. Para obter a sintaxe, consulte ListJobsResult$ JobListEntries neste guia.

Tipo: matriz de objetos JobListEntry

Erros

Para obter informações sobre os erros comuns retornados pelas ações, consulte Erros comuns.

Ec2RequestFailedException

Seu usuário não tem as EC2 permissões necessárias da Amazon para realizar a tentativa de ação.

HTTPCódigo de status: 400

InvalidInputCombinationException

Falha na criação do trabalho ou do cluster. Uma ou mais entradas eram inválidas. Confirme se o SnowballType valor CreateCluster: é compatível com seu CreateJob: JobType e tente novamente.

HTTPCódigo de status: 400

InvalidResourceException

Não foi possível encontrar o recurso especificado. Confira as informações fornecidas na última solicitação e tente novamente.

HTTPCódigo de status: 400

KMSRequestFailedException

A AWS Key Management Service chave fornecida não tem as permissões para realizar a CreateJob UpdateJob ação especificada.

HTTPCódigo de status: 400

Consulte também

Para obter mais informações sobre como usar isso API em um idioma específico AWS SDKs, consulte o seguinte: