Optional
accountOptional
accountDefines if the AWS AccountId will be used for endpoint routing.
Optional
Readonly
Internal
apiThe API version set internally by the SDK, and is not planned to be used by customer code.
Optional
Internal
base64The function that will be used to convert a base64-encoded string to a byte array.
Optional
Internal
base64The function that will be used to convert binary data to a base64-encoded string.
Optional
batchDefault batch process options.
Optional
Internal
bodyA function that can calculate the length of a request body.
Optional
cacheDefault false.
When true, the client will only resolve the middleware stack once per Command class. This means modifying the middlewareStack of the command or client after requests have been made will not be recognized.
Calling client.destroy() also clears this cache.
Enable this only if needing the additional time saved (0-1ms per request) and not needing middleware modifications between requests.
Optional
Internal
credentialDefault credentials provider; Not available in browser runtime.
Optional
credentialsThe credentials used to sign requests.
Optional
customThe custom user agent header that would be appended to default one
Optional
defaultsThe @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK.
Optional
Internal
defaultThe provider populating default tracking information to be sent with user-agent
, x-amz-user-agent
header
Optional
disableDisable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation.
Optional
enableActivates AWS Xray for internal DynamoDb client when true
and running in a Lambda environment.
Optional
endpointThe fully qualified endpoint of the webservice. This is only for using a custom endpoint (for example, when using a local version of S3).
Endpoint transformations such as S3 applying a bucket to the hostname are still applicable to this custom endpoint.
Optional
endpointThe size of the client cache storing endpoints from endpoint discovery operations. Defaults to 1000.
Optional
endpointWhether to call operations with endpoints given by service dynamically.
Setting this config to true
will enable endpoint discovery for all applicable operations.
Setting it to false
will explicitly disable endpoint discovery even though operations that
require endpoint discovery will presumably fail. Leaving it to undefined means SDK only do
endpoint discovery when it's required. Defaults to undefined
.
Optional
Internal
endpointThe provider which populates default for endpointDiscoveryEnabled configuration, if it's not passed during client creation.
Optional
endpointProviding a custom endpointProvider will override built-in transformations of the endpoint such as S3 adding the bucket name to the hostname, since they are part of the default endpointProvider.
EntityManager
instance.
Optional
extensionsOptional extensions
Optional
Internal
httpConfiguration of an HttpAuthSchemeProvider for a client which resolves which HttpAuthScheme to use.
Optional
Internal
httpConfiguration of HttpAuthSchemes for a client which provides default identity providers and signers per auth scheme.
Optional
loggerInjected logger object. Must support debug
and error
methods. Default: console
Optional
maxValue for how many times a request will be made at most in case of retry.
Optional
regionThe AWS region to which this client will send requests
Optional
requestThe HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.
Optional
retrySpecifies which retry algorithm to use.
Optional
retryThe strategy to retry the request. Using built-in exponential backoff strategy by default.
Optional
Internal
runtimeThe runtime environment.
Optional
Internal
serviceThis field is used internally so you should not fill any value to this field.
Optional
Internal
serviceUnique service identifier.
Optional
Internal
sha256A constructor for a class implementing the @smithy/types#ChecksumConstructor interface that computes the SHA-256 HMAC or checksum of a string or binary buffer.
Optional
signerThe signer to use when signing requests.
Optional
Internal
signerThe injectable SigV4-compatible signer class constructor. If not supplied, regular SignatureV4 constructor will be used.
Optional
signingWhether to escape request path when signing the request.
Optional
signingThe region where you want to sign your request against. This can be different to the region in the endpoint.
Optional
Internal
streamA function that converts a stream into an array of bytes.
Optional
systemAn offset value in milliseconds to apply to all signing times.
Table name.
Optional
tlsWhether TLS is enabled for requests.
Optional
Internal
urlThe function that will be used to convert strings into HTTP endpoints.
Optional
useEnables IPv6/IPv4 dualstack endpoint.
Optional
useEnables FIPS compatible endpoints.
Optional
userThe application ID used to identify the application.
Optional
Internal
utf8The function that will be used to convert a UTF8-encoded string to a byte array.
Optional
Internal
utf8The function that will be used to convert binary data to a UTF-8 encoded string.
DynamoDB EntityClient options. Extends
BaseEntityClientOptions
andDynamoDBClientConfig
with the following additional properties:[enableXray]
- Activates AWS Xray for internal DynamoDb client whentrue
and running in a Lambda environment.entityManager
-EntityManager
instance.tableName
- Table name.