@aws-sdk/types
- Version 3.413.0
- Published
- 41.1 kB
- 2 dependencies
- Apache-2.0 license
Install
npm i @aws-sdk/types
yarn add @aws-sdk/types
pnpm add @aws-sdk/types
Overview
Types for the AWS SDK
Index
Interfaces
Enums
Type Aliases
Interfaces
interface AnonymousIdentity
interface AnonymousIdentity extends Identity {}
Modifiers
@public
interface Credentials
interface Credentials extends AwsCredentialIdentity {}
An object representing temporary or permanent AWS credentials.
Modifiers
@public
Deprecated
interface Headers
interface Headers extends Map<string, string> {}
A collection of key/value pairs with case-insensitive keys.
Modifiers
@public
method withHeader
withHeader: (headerName: string, headerValue: string) => Headers;
Returns a new instance of Headers with the specified header set to the provided value. Does not modify the original Headers instance.
Parameter headerName
The name of the header to add or overwrite
Parameter headerValue
The value to which the header should be set
method withoutHeader
withoutHeader: (headerName: string) => Headers;
Returns a new instance of Headers without the specified header. Does not modify the original Headers instance.
Parameter headerName
The name of the header to remove
interface HostAddress
interface HostAddress {}
Modifiers
@public
property address
address: string;
The resolved numerical address represented as a string.
property addressType
addressType: HostAddressType;
The HostAddressType of the host address.
property hostName
hostName: string;
The host name the address was resolved from.
property service
service?: string;
The service record of hostName.
interface HostResolver
interface HostResolver {}
Host Resolver interface for DNS queries
Modifiers
@public
method purgeCache
purgeCache: (args?: HostResolverArguments) => void;
Empties the cache (if implemented) for a HostResolverArguments.hostName. If HostResolverArguments.hostName is not provided, the cache (if implemented) is emptied for all host names.
Parameter args
optional arguments to empty the cache for
method reportFailureOnAddress
reportFailureOnAddress: (addr: HostAddress) => void;
Reports a failure on a HostAddress so that the cache (if implemented) can accomodate the failure and likely not return the address until it recovers.
Parameter addr
host address to report a failure on
method resolveAddress
resolveAddress: (args: HostResolverArguments) => Promise<HostAddress[]>;
Resolves the address(es) for HostResolverArguments and returns a list of addresses with (most likely) two addresses, one HostAddressType.AAAA and one HostAddressType.A. Calls to this function will likely alter the cache (if implemented) so that if there's multiple addresses, a different set will be returned on the next call. In the case of multi-answer, still only a maximum of two records should be returned. The resolver implementation is responsible for caching and rotation of the multiple addresses that get returned. Implementations don't have to explictly call getaddrinfo(), they can use high level abstractions provided in their language runtimes/libraries.
Parameter args
arguments with host name query addresses for
Returns
promise with a list of HostAddress
interface HostResolverArguments
interface HostResolverArguments {}
Modifiers
@public
interface LoggerOptions
interface LoggerOptions {}
An object consumed by Logger constructor to initiate a logger object.
Modifiers
@public
interface LoginIdentity
interface LoginIdentity extends Identity {}
Modifiers
@public
interface ResolvedHttpResponse
interface ResolvedHttpResponse extends HttpResponse {}
Represents HTTP message whose body has been resolved to a string. This is used in parsing http message.
Modifiers
@public
property body
body: string;
interface Token
interface Token extends TokenIdentity {}
interface TokenIdentity
interface TokenIdentity extends Identity {}
Modifiers
@public
property token
readonly token: string;
The literal token string
Enums
enum HostAddressType
enum HostAddressType { AAAA = 'AAAA', A = 'A',}
DNS record types
Modifiers
@public
Type Aliases
type CredentialProvider
type CredentialProvider = Provider<Credentials>;
type LoginIdentityProvider
type LoginIdentityProvider = IdentityProvider<LoginIdentity>;
Modifiers
@public
type LogLevel
type LogLevel = | 'all' | 'trace' | 'debug' | 'log' | 'info' | 'warn' | 'error' | 'off';
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.
Example 1
new Logger({logLevel: 'warn'})
will print all the warn and error message.Modifiers
@public
type TokenIdentityProvider
type TokenIdentityProvider = IdentityProvider<TokenIdentity>;
Modifiers
@public
type TokenProvider
type TokenProvider = Provider<Token>;
Package Files (9)
Dependencies (2)
Dev Dependencies (6)
Peer Dependencies (0)
No peer dependencies.
Badge
To add a badge like this oneto your package's README, use the codes available below.
You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@aws-sdk/types
.
- Markdown[](https://www.jsdocs.io/package/@aws-sdk/types)
- HTML<a href="https://www.jsdocs.io/package/@aws-sdk/types"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>
- Updated .
Package analyzed in 1697 ms. - Missing or incorrect documentation? Open an issue for this package.