Options
All
  • Public
  • Public/Protected
  • All
Menu

Module @aws-sdk/types

Index

References

Interfaces

Type aliases

References

AbortController

Re-exports AbortController

AbortHandler

Re-exports AbortHandler

AbortSignal

Re-exports AbortSignal

AbsoluteLocation

Re-exports AbsoluteLocation

BinaryHeaderValue

Re-exports BinaryHeaderValue

BodyLengthCalculator

Re-exports BodyLengthCalculator

BooleanHeaderValue

Re-exports BooleanHeaderValue

BuildHandler

Re-exports BuildHandler

BuildHandlerArguments

Re-exports BuildHandlerArguments

BuildHandlerOptions

Re-exports BuildHandlerOptions

BuildHandlerOutput

Re-exports BuildHandlerOutput

BuildMiddleware

Re-exports BuildMiddleware

ByteHeaderValue

Re-exports ByteHeaderValue

Client

Re-exports Client

Command

Re-exports Command

CredentialProvider

Re-exports CredentialProvider

Credentials

Re-exports Credentials

DateInput

Re-exports DateInput

Decoder

Re-exports Decoder

DeserializeHandler

Re-exports DeserializeHandler

DeserializeHandlerArguments

Re-exports DeserializeHandlerArguments

DeserializeHandlerOptions

Re-exports DeserializeHandlerOptions

DeserializeHandlerOutput

Re-exports DeserializeHandlerOutput

DeserializeMiddleware

Re-exports DeserializeMiddleware

DocumentType

Re-exports DocumentType

Encoder

Re-exports Encoder

Endpoint

Re-exports Endpoint

EndpointBearer

Re-exports EndpointBearer

EventSigner

Re-exports EventSigner

EventSigningArguments

Re-exports EventSigningArguments

EventStreamMarshaller

Re-exports EventStreamMarshaller

EventStreamPayloadHandler

Re-exports EventStreamPayloadHandler

EventStreamPayloadHandlerProvider

Re-exports EventStreamPayloadHandlerProvider

EventStreamRequestSigner

Re-exports EventStreamRequestSigner

EventStreamSerdeContext

Re-exports EventStreamSerdeContext

EventStreamSerdeProvider

Re-exports EventStreamSerdeProvider

EventStreamSignerProvider

Re-exports EventStreamSignerProvider

FinalizeHandler

Re-exports FinalizeHandler

FinalizeHandlerArguments

Re-exports FinalizeHandlerArguments

FinalizeHandlerOutput

Re-exports FinalizeHandlerOutput

FinalizeRequestHandlerOptions

Re-exports FinalizeRequestHandlerOptions

FinalizeRequestMiddleware

Re-exports FinalizeRequestMiddleware

FormattedEvent

Re-exports FormattedEvent

Handler

Re-exports Handler

HandlerExecutionContext

Re-exports HandlerExecutionContext

HandlerOptions

Re-exports HandlerOptions

Hash

Re-exports Hash

HashConstructor

Re-exports HashConstructor

HeaderBag

Re-exports HeaderBag

Headers

Re-exports Headers

HttpHandlerOptions

Re-exports HttpHandlerOptions

HttpMessage

Re-exports HttpMessage

HttpRequest

Re-exports HttpRequest

HttpResponse

Re-exports HttpResponse

InitializeHandler

Re-exports InitializeHandler

InitializeHandlerArguments

Re-exports InitializeHandlerArguments

InitializeHandlerOptions

Re-exports InitializeHandlerOptions

InitializeHandlerOutput

Re-exports InitializeHandlerOutput

InitializeMiddleware

Re-exports InitializeMiddleware

Int64

Re-exports Int64

IntegerHeaderValue

Re-exports IntegerHeaderValue

LogLevel

Re-exports LogLevel

Logger

Re-exports Logger

LoggerOptions

Re-exports LoggerOptions

LongHeaderValue

Re-exports LongHeaderValue

Message

Re-exports Message

MessageHeaderValue

Re-exports MessageHeaderValue

MessageHeaders

Re-exports MessageHeaders

MetadataBearer

Re-exports MetadataBearer

MiddlewareStack

Re-exports MiddlewareStack

MiddlewareType

Re-exports MiddlewareType

PaginationConfiguration

Re-exports PaginationConfiguration

Paginator

Re-exports Paginator

Pluggable

Re-exports Pluggable

Priority

Re-exports Priority

Provider

Re-exports Provider

QueryParameterBag

Re-exports QueryParameterBag

RegionInfo

Re-exports RegionInfo

RegionInfoProvider

Re-exports RegionInfoProvider

RegionInfoProviderOptions

Re-exports RegionInfoProviderOptions

Relation

Re-exports Relation

RelativeLocation

Re-exports RelativeLocation

RelativeMiddlewareOptions

Re-exports RelativeMiddlewareOptions

RequestHandler

Re-exports RequestHandler

RequestHandlerMetadata

Re-exports RequestHandlerMetadata

RequestHandlerOutput

Re-exports RequestHandlerOutput

RequestPresigner

Re-exports RequestPresigner

RequestPresigningArguments

Re-exports RequestPresigningArguments

RequestSerializer

Re-exports RequestSerializer

RequestSigner

Re-exports RequestSigner

RequestSigningArguments

Re-exports RequestSigningArguments

ResolvedHttpResponse

Re-exports ResolvedHttpResponse

ResponseDeserializer

Re-exports ResponseDeserializer

ResponseMetadata

Re-exports ResponseMetadata

RetryStrategy

Re-exports RetryStrategy

RetryableTrait

Re-exports RetryableTrait

SdkError

Re-exports SdkError

SerdeContext

Re-exports SerdeContext

SerializeHandler

Re-exports SerializeHandler

SerializeHandlerArguments

Re-exports SerializeHandlerArguments

SerializeHandlerOptions

Re-exports SerializeHandlerOptions

SerializeHandlerOutput

Re-exports SerializeHandlerOutput

SerializeMiddleware

Re-exports SerializeMiddleware

ShortHeaderValue

Re-exports ShortHeaderValue

SigningArguments

Re-exports SigningArguments

SmithyException

Re-exports SmithyException

SourceData

Re-exports SourceData

Step

Re-exports Step

StreamCollector

Re-exports StreamCollector

StreamHasher

Re-exports StreamHasher

StringHeaderValue

Re-exports StringHeaderValue

StringSigner

Re-exports StringSigner

Terminalware

Re-exports Terminalware

TimestampHeaderValue

Re-exports TimestampHeaderValue

UrlParser

Re-exports UrlParser

UserAgent

Re-exports UserAgent

UserAgentPair

Re-exports UserAgentPair

UuidHeaderValue

Re-exports UuidHeaderValue

WaiterConfiguration

Re-exports WaiterConfiguration

randomValues

Re-exports randomValues

Type aliases

CredentialProvider

CredentialProvider: Provider<Credentials>

DateInput

DateInput: number | string | Date

A {Date} object, a unix (epoch) timestamp in seconds, or a string that can be understood by the JavaScript {Date} constructor.

DocumentType

DocumentType: null | boolean | number | string | DocumentType[] | {}

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.

Handler

Handler<Input, Output>: InitializeHandler<Input, Output>

Type parameters

  • Input: object

  • Output: object

LogLevel

LogLevel: "all" | "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

new Logger({logLevel: 'warn'}) will print all the warn and error message.

MessageHeaderValue

MiddlewareType

MiddlewareType<Input, Output>: InitializeMiddleware<Input, Output> | SerializeMiddleware<Input, Output> | BuildMiddleware<Input, Output> | FinalizeRequestMiddleware<Input, Output> | DeserializeMiddleware<Input, Output>

Type parameters

  • Input: object

  • Output: object

Paginator

Paginator<T>: AsyncGenerator<T, T, unknown>

Expected type definition of a paginator.

Type parameters

  • T

Priority

Priority: "high" | "normal" | "low"

Relation

Relation: "before" | "after"

RelativeMiddlewareOptions

RelativeMiddlewareOptions: RelativeLocation & Omit<HandlerOptions, "step">

RequestHandlerOutput

RequestHandlerOutput<ResponseType>: { response: ResponseType }

Type parameters

  • ResponseType

Type declaration

  • response: ResponseType

SdkError

SdkError: Error & Partial<SmithyException> & Partial<MetadataBearer>

SourceData

SourceData: string | ArrayBuffer | ArrayBufferView

Step

Step: "initialize" | "serialize" | "build" | "finalizeRequest" | "deserialize"

UserAgent

UserAgent: UserAgentPair[]

User agent data that to be put into the request's user agent.

UserAgentPair

UserAgentPair: [name: string, version?: string]

A tuple that represents an API name and optional version of a library built using the AWS SDK.