A {Date} object, a unix (epoch) timestamp in seconds, or a string that can be understood by the JavaScript {Date} constructor.
Option determining how certain default configuration options are resolved in the SDK. It can be one of the value listed below:
"standard": The STANDARD mode provides the latest recommended default values that should be safe to run in most scenarios
Note that the default values vended from this mode might change as best practices may evolve. As a result, it is encouraged to perform tests when upgrading the SDK
"in-region": The IN_REGION mode builds on the standard mode and includes optimization tailored for applications which call AWS services from within the same AWS region
Note that the default values vended from this mode might change as best practices may evolve. As a result, it is encouraged to perform tests when upgrading the SDK
"cross-region": The CROSS_REGION mode builds on the standard mode and includes optimization tailored for applications which call AWS services in a different region
Note that the default values vended from this mode might change as best practices may evolve. As a result, it is encouraged to perform tests when upgrading the SDK
"mobile": The MOBILE mode builds on the standard mode and includes optimization tailored for mobile applications
Note that the default values vended from this mode might change as best practices may evolve. As a result, it is encouraged to perform tests when upgrading the SDK
"auto": The AUTO mode is an experimental mode that builds on the standard mode. The SDK will attempt to discover the execution environment to determine the appropriate settings automatically.
Note that the auto detection is heuristics-based and does not guarantee 100% accuracy. STANDARD mode will be used if the execution environment cannot be determined. The auto detection might query EC2 Instance Metadata service, which might introduce latency. Therefore we recommend choosing an explicit defaults_mode instead if startup latency is critical to your application
"legacy": The LEGACY mode provides default settings that vary per SDK and were used prior to establishment of defaults_mode
A document type represents an untyped JSON-like value. Not all protocols support document types, and the serialization format of a document type is protocol specific. All JSON protocols SHOULD support document types and they SHOULD serialize document types inline as normal JSON values.
Provides hostname information for specific host label.
The tag which mentions which area variant is providing information for. Can be either "fips" or "dualstack".
Filter is considered passed if
Supplies the filter check but not against any value as input.
A mapping of header names to string values. Multiple values for the same
header should be represented as a single string with values separated by
, .
Keys should be considered case insensitive, even if this is not enforced by a
particular implementation. For example, given the following HeaderBag, where
keys differ only in case:
{
'x-amz-date': '2000-01-01T00:00:00Z',
'X-Amz-Date': '2001-01-01T00:00:00Z'
}
The SDK may at any point during processing remove one of the object
properties in favor of the other. The headers may or may not be combined, and
the SDK will not deterministically select which header candidate to use.
A list of logger's log level. These levels are sorted in order of increasing severity. Each log level includes itself and all the levels behind itself.
An instruction set for assigning a value to a target object.
A set of instructions for multiple keys. The aim is to provide a concise yet readable way to map and filter values onto a target object.
Expected type definition of a paginator.
The hash of partition with the information specific to that partition. The information includes the list of regions belonging to that partition, and the hostname to be used for the partition.
A mapping of query parameter names to strings or arrays of strings, with the second being used when a parameter contains a list of values. Value can be set to null when query is not in key-value pairs shape
The hash of region with the information specific to that region. The information can include hostname, signingService and signingRegion.
The type describing a runtime-specific stream implementation with mix-in utility functions.
non-array
User agent data that to be put into the request's user agent.
A tuple that represents an API name and optional version of a library built using the AWS SDK.
A non-function value.
Filter check with the given value.
Supplies the value for lazy evaluation.
(optional) Indicates a reason for why a waiter has reached its state.
Indicates that the member of type T with key StreamKey have been extended with the SdkStreamMixin helper methods.
The default value for how many HTTP requests an SDK should make for a single SDK operation invocation before giving up
The base number of milliseconds to use in calculating a suitable cool-down time when a retryable error is encountered.
The default retry algorithm to use.
Initial number of retry tokens in Retry Quota
Header name for SDK invocation ID
The maximum amount of time (in milliseconds) that will be used as a delay between retry attempts.
Config to load useArnRegion from environment variables and shared INI files
The total amount of retry token to be incremented from retry token balance if an SDK operation invocation succeeds without requiring a retry request.
Header name for request retry information.
The total amount of retry tokens to be decremented from retry token balance.
Because of https://github.com/microsoft/tslib/issues/95, TS 'extends' shim doesn't support extending native types like String. So here we create StringWrapper that duplicate everything from String class including its prototype chain. So we can extend from here.
The retry delay base (in milliseconds) to use when a throttling error is encountered.
The total amount of retry tokens to be decremented from retry token balance when a throttling error is encountered.
Build an ARN with service, partition, region, accountId, and resources strings
Handles and throws exceptions resulting from the waiterResult
Create a string describing the scope of credentials used to sign a request.
Calculate a capped, fully-jittered exponential backoff time.
Creates a credential provider that will attempt to find credentials from the following sources (listed in order of precedence):
process.envAWS_ACCESS_KEY_ID and
AWS_SECRET_ACCESS_KEY environment variables, the files at
~/.aws/credentials and ~/.aws/config will not be read, nor will any
messages be sent to the Instance Metadata Service.Default provider to the user agent in browsers. It's a best effort to infer the device information. It uses bowser library to detect the browser and version
Emits warning if the provided Node.js version string is pending deprecation.
browser event stream serde utils provider
Asserts a value is a boolean and returns it. Casts strings and numbers with a warning if there is evidence that they were intended to be booleans.
Asserts a value is an 8-bit integer and returns it.
Asserts a value is a 32-bit float and returns it.
Asserts a value is a 32-bit integer and returns it.
Asserts a value is an integer and returns it.
Asserts a value is not null or undefined and returns it, or throws an error.
Asserts a value is a number and returns it. Casts strings with a warning if the string is a parseable number. This is to unblock slight API definition/implementation inconsistencies.
Asserts a value is an JSON-like object and returns it. This is expected to be used with values parsed from JSON (arrays, objects, numbers, strings, booleans).
Asserts a value is a 16-bit integer and returns it.
Asserts a value is a string and returns it. Numbers and boolean will be cast to strings with a warning.
Asserts a value is a JSON-like object with only one non-null/non-undefined key and returns it.
Converts a base-64 encoded string to a Uint8Array of bytes using Node.JS's
buffer module.
Creates a credential provider that will source credentials from the ECS Container Metadata Service
Get config value given the environment variable name or getter from environment variable.
Creates a credential provider that will read from ini files and supports role assumption and multi-factor authentication.
Creates a credential provider that will source credentials from the EC2 Instance Metadata Service
Creates a credential provider that will read from a credential_process specified in ini files.
Creates a credential provider that will read from a credential_process specified in ini files. The SSO credential provider must support both
Get config value from the shared config files with inferred profile name.
Represents OIDC credentials from a file on disk.
The XML parser will set one K:V for a member that could return multiple entries but only has one.
The default role assumer that used by credential providers when sts:AssumeRole API is needed.
The default role assumer that used by credential providers when sts:AssumeRoleWithWebIdentity API is needed.
Returns the filepath of the file where SSO token is stored.
Derive a signing key from its composite parts
Recursively parses object and populates value is node from "#text" key if it's available
A util function converting async iterable to a ReadableStream.
Asserts a value is a number and returns it. If the value is a string representation of a non-numeric number type (NaN, Infinity, -Infinity), the value will be parsed. Any other string value will result in an exception being thrown. Null or undefined will be returned as undefined. Any other type will result in an exception being thrown.
Asserts a value is a 32-bit float and returns it. If the value is a string representation of a non-numeric number type (NaN, Infinity, -Infinity), the value will be parsed. Any other string value will result in an exception being thrown. Null or undefined will be returned as undefined. Any other type will result in an exception being thrown.
Parse an ARN string into structure with partition, service, region, accountId and resource values
Give an input string, strictly parses a boolean value.
Parses a value into a Date. Returns undefined if the input is null or undefined, throws an error if the input is not a number or a parseable string. Input strings must be an integer or floating point number. Fractional seconds are supported.
Parses a value into a Date. Returns undefined if the input is null or undefined, throws an error if the input is not a string that can be parsed as an RFC 3339 date. Input strings must conform to RFC3339 section 5.6, and cannot have a UTC offset. Fractional precision is supported. {@see https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14}
Parses a value into a Date. Returns undefined if the input is null or undefined, throws an error if the input is not a string that can be parsed as an RFC 3339 date. Input strings must conform to RFC3339 section 5.6, and can have a UTC offset. Fractional precision is supported. {@see https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14}
Parses a value into a Date. Returns undefined if the input is null or undefined, throws an error if the input is not a string that can be parsed as an RFC 7231 IMF-fixdate or obs-date. Input strings must conform to RFC7231 section 7.1.1.1. Fractional seconds are supported. {@see https://datatracker.ietf.org/doc/html/rfc7231.html#section-7.1.1.1}
Evaluates a single string argument value as a region, and matches the string value to an AWS partition. The matcher MUST always return a successful object describing the partition that the region has been determined to be a part of.
A util function converting ReadableStream into an async iterable. Reference: https://jakearchibald.com/2017/async-iterators-and-generators/#making-streams-iterate
Resolves an endpoint URL by processing the endpoints ruleset and options.
Set STS client constructor to stsClientCtor config parameter. It is used
for role assumers for STS client internally. See clients/client-sts/defaultStsRoleAssumers.ts
and clients/client-sts/STSClient.ts.
Serializes a number, turning non-numeric values into strings.
Parses a value into an 8-bit integer. If the value is null or undefined, undefined will be returned. If the value is a string, it will be parsed by parseFloat and the result will be asserted to be an integer. If the parsed value is not an integer, or the raw value is any type other than a string or number, an exception will be thrown.
Parses a value into a double. If the value is null or undefined, undefined will be returned. If the value is a string, it will be parsed by the standard parseFloat with one exception: NaN may only be explicitly set as the string "NaN", any implicit Nan values will result in an error being thrown. If any other type is provided, an exception will be thrown.
Parses a value into a float. If the value is null or undefined, undefined will be returned. If the value is a string, it will be parsed by the standard parseFloat with one exception: NaN may only be explicitly set as the string "NaN", any implicit Nan values will result in an error being thrown. If any other type is provided, an exception will be thrown.
Parses a value into a 32-bit integer. If the value is null or undefined, undefined will be returned. If the value is a string, it will be parsed by parseFloat and the result will be asserted to be an integer. If the parsed value is not an integer, or the raw value is any type other than a string or number, an exception will be thrown.
Parses a value into an integer. If the value is null or undefined, undefined will be returned. If the value is a string, it will be parsed by parseFloat and the result will be asserted to be an integer. If the parsed value is not an integer, or the raw value is any type other than a string or number, an exception will be thrown.
Parses a value into a 16-bit integer. If the value is null or undefined, undefined will be returned. If the value is a string, it will be parsed by parseFloat and the result will be asserted to be an integer. If the parsed value is not an integer, or the raw value is any type other than a string or number, an exception will be thrown.
Converts a Uint8Array of binary data to a base-64 encoded string using
Node.JS's buffer module.
Build user agent header sections from:
customUserAgent client config;x-amz-user-agent header for ALL the
runtimes.
Please note that any override to the user-agent or x-amz-user-agent header
in the HTTP request is discouraged. Please use customUserAgent client
config or middleware setting the userAgent context to generate desired user
agent.Validate whether a string is an ARN.
Builds a proper UTC HttpDate timestamp from a Date object since not all environments will have this as the expected format.
See: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toUTCString
Prior to ECMAScript 2018, the format of the return value varied according to the platform. The most common return value was an RFC-1123 formatted date stamp, which is a slightly updated version of RFC-822 date stamps.
Function that wraps encodeURIComponent to encode additional characters to fully adhere to RFC 3986.
This middleware modifies the input on S3 CreateBucket requests. If the LocationConstraint has not been set, this middleware will set a LocationConstraint to match the configured region. The CreateBucketConfiguration will be removed entirely on requests to the us-east-1 region.
Given an input string, splits based on the delimiter after a given number of delimiters has been encountered.
The input string to split.
The delimiter to split on.
The number of delimiters to have encountered to split.
Waiter configuration options.
The input to HeadBucketCommand for polling.
Waiter configuration options.
The input to HeadBucketCommand for polling.
Waiter configuration options.
The input to HeadObjectCommand for polling.
Waiter configuration options.
The input to HeadObjectCommand for polling.
Use {@AwsCredentialIdentityProvider}