Construtores do cliente - AWS SDK para JavaScript

O Guia de referência da API do AWS SDK para JavaScript V3 descreve em detalhes todas as operações da API para o AWS SDK para JavaScript versão 3 (V3).

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

Construtores do cliente

Essa lista é indexada pelos parâmetros de configuração v2.

  • computeChecksums

    • v2: se as somas de verificação MD5 devem ser calculadas para corpos de carga útil quando o serviço as aceita (atualmente compatível somente no S3).

    • v3: os comandos aplicáveis do S3 (PutObject, PutBucketCors etc.) calcularão automaticamente as somas de verificação MD5 da carga útil da solicitação. Você também pode especificar um algoritmo de soma de verificação diferente no parâmetro ChecksumAlgorithm dos comandos para usar um algoritmo de soma de verificação diferente. Você pode encontrar mais informações no anúncio dos recursos do S3.

  • convertResponseTypes

    • v2: se os tipos são convertidos ao analisar dados de resposta.

    • v3: obsoleto. Essa opção é considerada insegura porque não converte tipos como timestamp ou binários base64 da resposta JSON.

  • correctClockSkew

    • v2: se deve aplicar uma correção de distorção de relógio e repetir as solicitações que falham devido a um relógio distorcido do cliente.

    • v3: obsoleto. O SDK sempre aplica uma correção de distorção de relógio.

  • systemClockOffset

    • v2: um valor de deslocamento em milissegundos a ser aplicado a todos os horários de assinatura.

    • v3: sem alteração.

  • credentials

    • v2: as credenciais da AWS com as quais assinar as solicitações.

    • v3: sem alteração. Também pode ser uma função assíncrona que retorna credenciais. Se a função retornar um expiration (Date), a função será chamada novamente quando a data e hora de expiração se aproximar. Consulte a referência da API v3 para credenciais AwsAuthInputConfig.

  • endpointCacheSize

    • v2: o tamanho do cache global que armazena os endpoints das operações de descoberta de endpoints.

    • v3: sem alteração.

  • endpointDiscoveryEnabled

    • v2: se deve chamar operações com endpoints fornecidos pelo serviço dinamicamente.

    • v3: sem alteração.

  • hostPrefixEnabled

    • v2: se os parâmetros da solicitação devem ser agrupados com o prefixo do nome do host.

    • v3: obsoleto. O SDK sempre injeta o prefixo do nome do host quando necessário.

  • httpOptions

    Um conjunto de opções para passar para a solicitação HTTP de baixo nível. Essas opções são agregadas de forma diferente na v3. Você pode configurá-los fornecendo um novo requestHandler. Veja o exemplo de configuração de opções http no runtime do Node.js. Você pode encontrar mais informações na referência da API v3 para NodeHttpHandler.

    Todas as solicitações v3 usam HTTPS por padrão. Só é necessário fornecer um httpsAgent personalizado. 

    const { Agent } = require("https");
const { Agent: HttpAgent } = require("http");
const { NodeHttpHandler } = require("@smithy/node-http-handler");
const dynamodbClient = new DynamoDBClient({
    requestHandler: new NodeHttpHandler({
        httpsAgent: new Agent({
            /*params*/
        }),
        connectionTimeout: /*number in milliseconds*/,
        socketTimeout: /*number in milliseconds*/
    }),
});

    Se estiver passando um endpoint personalizado que usa http, precisará fornecer o httpAgent. 

    const { Agent } = require("http");
const { NodeHttpHandler } = require("@smithy/node-http-handler");

const dynamodbClient = new DynamoDBClient({
    requestHandler: new NodeHttpHandler({
        httpAgent: new Agent({
            /*params*/
        }),
    }),
    endpoint: "http://example.com",
});

    Se o cliente estiver sendo executado em navegadores, um conjunto diferente de opções estará disponível. Você pode encontrar mais informações na referência da API v3 para FetchHttpHandler. 

    const { FetchHttpHandler } = require("@smithy/fetch-http-handler");
const dynamodbClient = new DynamoDBClient({
    requestHandler: new FetchHttpHandler({
        requestTimeout: /* number in milliseconds */
    }),
});

    Cada opção de httpOptions é especificada abaixo:

    • proxy

      • v2: o URL pelo qual as solicitações de proxy serão encaminhadas.

      • v3: você pode configurar um proxy com um agente seguindo as instruções em Como configurar proxies para Node.js.

    • agent

      • v2: o objeto Agent com o qual realizar solicitações HTTP. Usado para o agrupamento de conexões.

      • v3: você pode configurar httpAgent ou httpsAgent conforme mostrado nos exemplos acima.

    • connectTimeout

      • v2: define o soquete para expirar após não conseguir estabelecer uma conexão com o servidor após connectTimeout milissegundos.

      • v3: connectionTimeout está disponível em opções de NodeHttpHandler.

    • timeout

      • v2: o número de milissegundos que uma solicitação pode levar antes de ser encerrada automaticamente.

      • v3: socketTimeout está disponível em opções de NodeHttpHandler.

    • xhrAsync

      • v2: se o SDK enviará solicitações HTTP assíncronas.

      • v3: obsoleto. As solicitações são sempre assíncronas.

    • xhrWithCredentials

  • logger

    • v2: um objeto que responde .write() (como um fluxo) ou .log() (como o objeto do console) para registrar informações sobre solicitações.

    • v3: sem alteração. Logs mais granulares estão disponíveis na v3.

  • maxRedirects

    • v2: a quantidade máxima de redirecionamentos a serem seguidos para uma solicitação de serviço.

    • v3: obsoleto. O SDK não segue redirecionamentos para evitar solicitações não intencionais entre regiões.

  • maxRetries

    • v2: a quantidade máxima de novas tentativas a serem realizadas para uma solicitação de serviço.

    • v3: alterado para maxAttempts. Veja mais na referência da API v3 para RetryInputConfig. Observe que maxAttempts deveria ser maxRetries + 1.

  • paramValidation

    • v2: se os parâmetros de entrada devem ser validados em relação à descrição da operação antes de enviar a solicitação.

    • v3: obsoleto. O SDK não faz validação no lado do cliente em runtime.

  • region

    • v2: a região para a qual enviar solicitações de serviço.

    • v3: sem alteração. Também pode ser uma função assíncrona que retorna uma string de região.

  • retryDelayOptions

    • v2: um conjunto de opções para configurar o atraso da nova tentativa em erros que podem ser repetidos.

    • v3: obsoleto. O SDK oferece suporte a uma estratégia de repetição mais flexível com a opção de construtor retryStrategy do cliente. Veja mais na referência da API v3.

  • s3BucketEndpoint

    • v2: se o endpoint fornecido aborda um bucket individual (falso se abordar o endpoint raiz da API).

    • v3: alterado para bucketEndpoint. Veja mais na referência da API v3 para bucketEndpoint. Observe que, quando definido como true, é preciso especificar o endpoint da solicitação no parâmetro Bucket da solicitação. O endpoint original será sobrescrito. Já na v2, o endpoint da solicitação no construtor do cliente sobrescreve o parâmetro Bucket da solicitação.

  • s3DisableBodySigning

    • v2: se a assinatura corporal do S3 deve ser desativada ao usar a versão v4 da assinatura.

    • v3: renomeado para applyChecksum.

  • s3ForcePathStyle

    • v2: se os URLs de estilo de caminho devem ser forçados para objetos do S3.

    • v3: renomeado para forcePathStyle.

  • s3UseArnRegion

    • v2: se a região solicitada deve ser substituída pela região inferida do ARN do recurso solicitado.

    • v3: renomeado para useArnRegion.

  • s3UsEast1RegionalEndpoint

    • v2: quando a região é definida como “us-east-1”, seja para enviar a solicitação s3 para endpoints globais ou endpoints regionais “us-east-1”.

    • v3: obsoleto. O cliente do S3 sempre usará o endpoint regional se a região estiver definida como us-east-1. Você pode definir a região para aws-global para enviar solicitações ao endpoint global do S3.

  • signatureCache

    • v2: se a assinatura com a qual assinar solicitações (substituindo a configuração da API) é armazenada em cache.

    • v3: obsoleto. O SDK sempre armazena em cache as chaves de assinatura com hash.

  • signatureVersion

    • v2: a versão da assinatura com a qual assinar solicitações (substituindo a configuração da API).

    • v3: obsoleto. A assinatura V2 compatível com SDK v2 foi descontinuada pela AWS. A v3 é compatível somente com a assinatura v4.

  • sslEnabled

    • v2: se o SSL está habilitado para solicitações.

    • v3: renomeado para tls.

  • stsRegionalEndpoints

    • v2: se deve enviar uma solicitação sts para endpoints globais ou endpoints regionais.

    • v3: obsoleto. O cliente STS sempre usará endpoints regionais se definido para uma região específica. Você pode definir a região para aws-global para enviar a solicitação ao endpoint global STS.

  • useAccelerateEndpoint

    • v2: se deve usar o endpoint Accelerate com o serviço S3.

    • v3: sem alteração.