Constructores de clientes - AWS SDK para JavaScript

La Guía de referencia de la API de AWS SDK for JavaScript V3 describe en detalle todas las operaciones de la API para la versión 3 (V3) de AWS SDK for JavaScript.

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.

Constructores de clientes

Esta lista está indexada por parámetros de configuración de v2.

  • computeChecksums

    • v2: si se deben calcular las sumas de comprobación MD5 para los cuerpos de carga útil cuando el servicio lo acepta (actualmente solo compatible con S3).

    • v3: los comandos aplicables de S3 (PutObject, PutBucketCors, etc.) calcularán automáticamente las sumas de comprobación MD5 para la carga útil de la solicitud. También puede especificar un algoritmo de suma de comprobación diferente en el parámetro ChecksumAlgorithm de los comandos para utilizar un algoritmo de suma de comprobación diferente. Puede encontrar más información en el anuncio de la característica de S3.

  • convertResponseTypes

    • v2: si los tipos se convierten al analizar los datos de respuesta.

    • v3: obsoleto. Se considera que esta opción no es segura en cuanto al tipo, ya que no convierte los tipos como marcas de tiempo o binarios base64 de la respuesta JSON.

  • correctClockSkew

    • v2: si se debe aplicar una corrección del sesgo del reloj y reintentar las solicitudes erróneas debido a un reloj del cliente sesgado.

    • v3: obsoleto. El SDK siempre aplica una corrección del sesgo del reloj.

  • systemClockOffset

    • v2: un valor de desplazamiento en milisegundos que se aplica a todos los tiempos de firma.

    • v3: sin cambios.

  • credentials

  • endpointCacheSize

    • v2: el tamaño de la caché global que almacena los puntos de conexión de las operaciones de detección de puntos de conexión.

    • v3: sin cambios.

  • endpointDiscoveryEnabled

    • v2: si se deben llamar a las operaciones con puntos de conexión proporcionados por el servicio de forma dinámica.

    • v3: sin cambios.

  • hostPrefixEnabled

    • v2: si se deben serializar los parámetros de solicitud según el prefijo del nombre de host.

    • v3: obsoleto. El SDK siempre inyecta el prefijo del nombre de host cuando es necesario.

  • httpOptions

    Un conjunto de opciones para pasar a la solicitud HTTP de bajo nivel. Estas opciones se agregan de forma diferente en v3. Puede configurarlas proporcionando un nuevo requestHandler. A continuación, se muestra un ejemplo de cómo configurar las opciones http en el tiempo de ejecución de Node.js. Puede encontrar más información en la referencia de la API v3 para NodeHttpHandler.

    Todas las solicitudes de v3 utilizan HTTPS de forma predeterminada. Solo es necesario proporcionar un 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*/
    }),
});

    Si se pasa un punto de conexión personalizado que utiliza http, es necesario proporcionar un 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",
});

    Si el cliente se ejecuta en navegadores, hay disponible un conjunto diferente de opciones. Puede encontrar más información en la referencia de la API v3 para FetchHttpHandler. 

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

    A continuación, se especifican las distintas opciones de httpOptions:

    • proxy

    • agent

      • v2: el objeto de agente con el que se realizan las solicitudes HTTP. Se utiliza para la agrupación de conexiones.

      • v3: puede configurar httpAgent o httpsAgent como se muestra en los ejemplos anteriores.

    • connectTimeout

      • v2: establece el tiempo de espera del socket después de no poder establecer una conexión con el servidor tras milisegundos especificados en connectTimeout.

      • v3: connectionTimeout está disponible en las opciones de NodeHttpHandler.

    • timeout

      • v2: el número de milisegundos que puede tardar una solicitud antes de que se cancele automáticamente.

      • v3: socketTimeout está disponible en las opciones de NodeHttpHandler.

    • xhrAsync

      • v2: si el SDK enviará solicitudes HTTP asíncronas.

      • v3: obsoleto. Las solicitudes son siempre asíncronas.

    • xhrWithCredentials

  • logger

    • v2: un objeto que responde a .write() (como un flujo) o .log() (como el objeto de la consola) para registrar información sobre las solicitudes.

    • v3: sin cambios. En v3 hay disponibles registros más detallados.

  • maxRedirects

    • v2: número máximo de redireccionamientos que se pueden seguir para una solicitud de servicio.

    • v3: obsoleto. El SDK no sigue los redireccionamientos para evitar solicitudes involuntarias entre regiones.

  • maxRetries

    • v2: número máximo de reintentos que se pueden realizar para una solicitud de servicio.

    • v3: se ha cambiado a maxAttempts. Consulte más información en la referencia de la API v3 para RetryInputConfig. Tenga en cuenta que maxAttempts debe ser maxRetries + 1.

  • paramValidation

    • v2: si los parámetros de entrada deben validarse con respecto a la descripción de la operación antes de enviar la solicitud.

    • v3: obsoleto. El SDK no realiza validaciones del cliente en tiempo de ejecución.

  • region

    • v2: la región a la que enviar las solicitudes de servicio.

    • v3: sin cambios. También puede ser una función asíncrona que devuelva una cadena de región.

  • retryDelayOptions

    • v2: conjunto de opciones para configurar el retardo de reintentos en errores reintentables.

    • v3: obsoleto. El SDK admite una estrategia de reintento más flexible con la opción de constructor de clientes retryStrategy. Consulte más información en la referencia de la API v3.

  • s3BucketEndpoint

    • v2: si el punto de conexión proporcionado se refiere a un bucket individual (falso si se refiere al punto de conexión de la API raíz).

    • v3: se ha cambiado a bucketEndpoint. Consulte más información en la referencia de la API v3 para bucketEndpoint. Tenga en cuenta que si se establece en true, se especifica el punto de conexión de la solicitud en el parámetro de solicitud Bucket y se sobrescribe el punto de conexión original. Mientras que en v2, el punto de conexión de la solicitud del constructor del cliente sobrescribe el parámetro de solicitud Bucket.

  • s3DisableBodySigning

    • v2: si se debe deshabilitar la firma del cuerpo de S3 al usar la versión de firma v4.

    • v3: se cambia el nombre a applyChecksum.

  • s3ForcePathStyle

    • v2: si se deben forzar las URL con estilo de ruta para los objetos de S3.

    • v3: se cambia el nombre a forcePathStyle.

  • s3UseArnRegion

    • v2: si se debe anular la región de la solicitud con la región inferida a partir del ARN del recurso solicitado.

    • v3: se cambia el nombre a useArnRegion.

  • s3UsEast1RegionalEndpoint

    • v2: cuando la región está configurada en “us-east-1”, si se debe enviar una solicitud de s3 a puntos de conexión globales o a puntos de conexión regionales “us-east-1”.

    • v3: obsoleto. El cliente de S3 siempre utilizará el punto de conexión regional si la región está configurada en us-east-1. Puede establecer la región en aws-global para enviar solicitudes al punto de conexión global de S3.

  • signatureCache

    • v2: si se almacena en caché la firma con la que se firman las solicitudes (lo que anula la configuración de la API).

    • v3: obsoleto. El SDK siempre almacena en caché las claves de firma con hash.

  • signatureVersion

    • v2: la versión de firma con la que se firman las solicitudes (anula la configuración de la API).

    • v3: obsoleto. La firma de V2, compatible con el SDK de v2, ha quedado obsoleta debido a AWS. La v3 solo es compatible con la firma v4.

  • sslEnabled

    • v2: si SSL está habilitado para las solicitudes.

    • v3: se cambia el nombre a tls.

  • stsRegionalEndpoints

    • v2: si se envía la solicitud de sts a puntos de conexión globales o regionales.

    • v3: obsoleto. El cliente de STS siempre utilizará puntos de conexión regionales si se establece en una región específica. Puede establecer la región en aws-global para enviar solicitudes al punto de conexión global de STS.

  • useAccelerateEndpoint

    • v2: si se utiliza el punto de conexión de Accelerate con el servicio de S3.

    • v3: sin cambios.