We are excited to announce the developer preview of our new API documentation for AWS SDK for JavaScript v3. Please follow instructions on the landing page to leave us your feedback.
Optional
credentialsThe credentials used to sign requests.
Optional
customThe custom user agent header that would be appended to default one
Optional
defaultsThe @aws-sdk/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK.
Optional
disableDisable dyanamically changing the endpoint of the client based on the hostPrefix trait of an operation.
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
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.
Optional
context: { Optional
logger?: LoggerOptional
loggerOptional logger for logging debug/info/warn/error.
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. 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
signerThe signer to use when signing requests.
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
systemAn offset value in milliseconds to apply to all signing times.
Optional
tlsWhether TLS is enabled for requests.
Optional
useEnables IPv6/IPv4 dualstack endpoint.
Optional
useEnables FIPS compatible endpoints.
The configuration interface of PinpointEmailClient class constructor that set the region, credentials and other options.