OptionalaccountOptionalaccountDefines if the AWS AccountId will be used for endpoint routing.
Optional Readonly InternalapiThe API version set internally by the SDK, and is not planned to be used by customer code.
OptionalauthA comma-separated list of case-sensitive auth scheme names. An auth scheme name is a fully qualified auth scheme ID with the namespace prefix trimmed. For example, the auth scheme with ID aws.auth#sigv4 is named sigv4.
Optional Internalbase64The function that will be used to convert a base64-encoded string to a byte array.
Optional Internalbase64The function that will be used to convert binary data to a base64-encoded string.
OptionalbatchDefault batch process options.
Optional InternalbodyA function that can calculate the length of a request body.
OptionalcacheDefault 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 InternalcredentialDefault credentials provider; Not available in browser runtime.
OptionalcredentialsThe credentials used to sign requests.
OptionalcustomThe custom user agent header that would be appended to default one
OptionaldefaultsThe @smithy/smithy-client!DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK.
Optional InternaldefaultThe provider populating default tracking information to be sent with user-agent, x-amz-user-agent header
OptionaldisableDisable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation.
OptionalenableActivates AWS Xray for internal DynamoDb client when true and running in a Lambda environment.
OptionalendpointThe 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.
OptionalendpointThe size of the client cache storing endpoints from endpoint discovery operations. Defaults to 1000.
OptionalendpointWhether 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 InternalendpointThe provider which populates default for endpointDiscoveryEnabled configuration, if it's not passed during client creation.
OptionalendpointProviding 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.
OptionalextensionsOptional extensions
Optional InternalhttpConfiguration of an HttpAuthSchemeProvider for a client which resolves which HttpAuthScheme to use.
Optional InternalhttpConfiguration of HttpAuthSchemes for a client which provides default identity providers and signers per auth scheme.
OptionalloggerInjected logger object. Must support debug and error methods. Default: console
OptionalmaxValue for how many times a request will be made at most in case of retry.
OptionalprofileSetting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.
When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.
For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options.
Optional AlphaprotocolThe protocol controlling the message type (e.g. HTTP) and format (e.g. JSON) may be overridden. A default will always be set by the client. Available options depend on the service's supported protocols and will not be validated by the client.
OptionalregionThe AWS region to which this client will send requests
OptionalrequestThe HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.
OptionalretrySpecifies which retry algorithm to use.
OptionalretryThe strategy to retry the request. Using built-in exponential backoff strategy by default.
Optional InternalruntimeThe runtime environment.
Optional InternalserviceThis field is used internally so you should not fill any value to this field.
Optional InternalserviceUnique service identifier.
Optional Internalsha256A constructor for a class implementing the @smithy/types!ChecksumConstructor interface that computes the SHA-256 HMAC or checksum of a string or binary buffer.
OptionalsignerThe signer to use when signing requests.
Optional InternalsignerThe injectable SigV4-compatible signer class constructor. If not supplied, regular SignatureV4 constructor will be used.
OptionalsigningWhether to escape request path when signing the request.
OptionalsigningThe region where you want to sign your request against. This can be different to the region in the endpoint.
Optional InternalstreamA function that converts a stream into an array of bytes.
OptionalsystemAn offset value in milliseconds to apply to all signing times.
Table name.
OptionaltlsWhether TLS is enabled for requests.
Optional InternalurlThe function that will be used to convert strings into HTTP endpoints.
OptionaluseEnables IPv6/IPv4 dualstack endpoint.
OptionaluseEnables FIPS compatible endpoints.
OptionaluserThe application ID used to identify the application.
Optional Internalutf8The function that will be used to convert a UTF8-encoded string to a byte array.
Optional Internalutf8The function that will be used to convert binary data to a UTF-8 encoded string.
DynamoDB EntityClient options. Extends
BaseEntityClientOptionsandDynamoDBClientConfigwith the following additional properties:[enableXray]- Activates AWS Xray for internal DynamoDb client whentrueand running in a Lambda environment.entityManager-EntityManagerinstance.tableName- Table name.