@aws-sdk/types

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

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.

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

property hostName

hostName: string;

• The host name to resolve.

property service

service?: string;

• The service record of hostName.

property logger

logger?: Logger;

property logLevel

logLevel?: LogLevel;

property password

readonly password: string;

• Identity password

property username

readonly username: string;

• Identity username

property body

body: string;

property token

readonly token: string;

• The literal token string

member A

A = 'A'

• IPv4

member AAAA

AAAA = 'AAAA'

• IPv6