EC2 Client - AWS SDK for JavaScript v3

Index

Namespaces

__global

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

ruleSet

Type aliases

AwsCredentialIdentityProvider

AwsCredentialIdentityProvider: IdentityProvider<AwsCredentialIdentity>

ClientResolvedEndpointParameters

ClientResolvedEndpointParameters: ClientInputEndpointParameters & { defaultSigningName: string }

ConditionObject

ConditionObject: FunctionObject & { assign?: undefined | string }

ConditionalLazyValueInstruction

ConditionalLazyValueInstruction: [FilterStatusSupplier, ValueSupplier]

ConditionalValueInstruction

ConditionalValueInstruction: [ValueFilteringFunction, Value]

CredentialProvider

CredentialProvider: Provider<Credentials>

deprecated: Use {@AwsCredentialIdentityProvider}

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.

DefaultProviderInit

DefaultProviderInit: FromIniInit & RemoteProviderInit & FromProcessInit & FromSSOInit & FromTokenFileInit

DefaultsMode

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

default: "legacy"

DeprecatedObject

DeprecatedObject: { message?: undefined | string; since?: undefined | string }

Type declaration

Optional message?: undefined | string
Optional since?: undefined | string

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.

EC2ClientConfigType

EC2ClientConfigType: Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters

EndpointObjectHeaders

EndpointObjectHeaders: Record<string, Expression[]>

EndpointObjectProperties

EndpointObjectProperties: Record<string, EndpointObjectProperty>

EndpointObjectProperty

EndpointObjectProperty: string | boolean | {} | EndpointObjectProperty[]

EndpointParameterInstructionsSupplier

EndpointParameterInstructionsSupplier: Partial<{ getEndpointParameterInstructions: any }>

EndpointParameters

EndpointParameters: {}

Type declaration

[name: string]: undefined | string | boolean

Optional Endpoint

Endpoint: undefined | string

Region

Region: undefined | string

Optional UseDualStack

UseDualStack: undefined | false | true

Optional UseFIPS

UseFIPS: undefined | false | true

Optional UseGlobalEndpoint

UseGlobalEndpoint: undefined | false | true

EndpointParams

EndpointParams: Record<string, string | boolean>

EndpointResolverOptions

EndpointResolverOptions: { endpointParams: EndpointParams; logger?: Logger }

Type declaration

endpointParams: EndpointParams
Optional logger?: Logger

EndpointRuleObject

EndpointRuleObject: { conditions?: ConditionObject[]; documentation?: undefined | string; endpoint: EndpointObject; type: "endpoint" }

Type declaration

Optional conditions?: ConditionObject[]
Optional documentation?: undefined | string
endpoint: EndpointObject
type: "endpoint"

EndpointVariant

EndpointVariant: { hostname: string; tags: EndpointVariantTag[] }

Provides hostname information for specific host label.

Type declaration

hostname: string
tags: EndpointVariantTag[]

EndpointVariantTag

EndpointVariantTag: "fips" | "dualstack"

The tag which mentions which area variant is providing information for. Can be either "fips" or "dualstack".

ErrorRuleObject

ErrorRuleObject: { conditions?: ConditionObject[]; documentation?: undefined | string; error: Expression; type: "error" }

Type declaration

Optional conditions?: ConditionObject[]
Optional documentation?: undefined | string
error: Expression
type: "error"

EvaluateOptions

EvaluateOptions: EndpointResolverOptions & { referenceRecord: ReferenceRecord }

ExponentialBackoffJitterType

ExponentialBackoffJitterType: "DEFAULT" | "NONE" | "FULL" | "DECORRELATED"

Expression

Expression: string | ReferenceObject | FunctionObject

FilterStatus

FilterStatus: boolean | unknown | void

Filter is considered passed if

It is a boolean true.
It is not undefined and is itself truthy.
It is undefined and the corresponding value is neither null nor undefined.

FilterStatusSupplier

FilterStatusSupplier: () => boolean

Supplies the filter check but not against any value as input.

Type declaration

- (): boolean
- Returns boolean

FromStaticConfig

FromStaticConfig<T>: T | (() => T) | Provider<T>

Type parameters

FunctionArgv

FunctionArgv: Array<Expression | boolean | number>

FunctionObject

FunctionObject: { argv: FunctionArgv; fn: string }

Type declaration

argv: FunctionArgv
fn: string

FunctionReturn

FunctionReturn: string | boolean | number | {}

GetterFromConfig

GetterFromConfig<T>: (profile: Profile) => T | undefined

Type parameters

Type declaration

- (profile: Profile): T | undefined
- Parameters
  - profile: Profile
  Returns T | undefined

GetterFromEnv

GetterFromEnv<T>: (env: ProcessEnv) => T | undefined

Type parameters

Type declaration

- (env: ProcessEnv): T | undefined
- Parameters
  - env: ProcessEnv
  Returns T | undefined

Handler

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

Type parameters

Input: object
Output: object

HeaderBag

HeaderBag: Record<string, string>

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.

HttpHandler

HttpHandler: RequestHandler<HttpRequest, HttpResponse, HttpHandlerOptions>

HttpRequestOptions

HttpRequestOptions: Partial<HttpMessage> & Partial<Endpoint> & { method?: undefined | string }

HttpResponseOptions

HttpResponseOptions: Partial<HttpMessage> & { statusCode: number }

IniSection

IniSection: Record<string, string | undefined>

LazyValueInstruction

LazyValueInstruction: [FilterStatus, ValueSupplier]

LocalConfigOptions

LocalConfigOptions: SharedConfigInit

LogLevel

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.

LoginIdentityProvider

LoginIdentityProvider: IdentityProvider<LoginIdentity>

LowerCaseKey

LowerCaseKey<T>: {}

Type parameters

Type declaration

MessageHeaderValue

MessageHeaders

MessageHeaders: Record<string, 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

ObjectMappingInstruction

ObjectMappingInstruction: LazyValueInstruction | ConditionalLazyValueInstruction | SimpleValueInstruction | ConditionalValueInstruction | UnfilteredValue

An instruction set for assigning a value to a target object.

ObjectMappingInstructions

ObjectMappingInstructions: Record<string, ObjectMappingInstruction>

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.

example

const example: ObjectMappingInstructions = {
  lazyValue1: [, () => 1],
  lazyValue2: [, () => 2],
  lazyValue3: [, () => 3],
  lazyConditionalValue1: [() => true, () => 4],
  lazyConditionalValue2: [() => true, () => 5],
  lazyConditionalValue3: [true, () => 6],
  lazyConditionalValue4: [false, () => 44],
  lazyConditionalValue5: [() => false, () => 55],
  lazyConditionalValue6: ["", () => 66],
  simpleValue1: [, 7],
  simpleValue2: [, 8],
  simpleValue3: [, 9],
  conditionalValue1: [() => true, 10],
  conditionalValue2: [() => true, 11],
  conditionalValue3: [{}, 12],
  conditionalValue4: [false, 110],
  conditionalValue5: [() => false, 121],
  conditionalValue6: ["", 132],
};
const exampleResult: Record<string, any> = {
  lazyValue1: 1,
  lazyValue2: 2,
  lazyValue3: 3,
  lazyConditionalValue1: 4,
  lazyConditionalValue2: 5,
  lazyConditionalValue3: 6,
  simpleValue1: 7,
  simpleValue2: 8,
  simpleValue3: 9,
  conditionalValue1: 10,
  conditionalValue2: 11,
  conditionalValue3: 12,
};

Paginator

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

Expected type definition of a paginator.

Type parameters

ParameterObject

ParameterObject: { builtIn?: undefined | string; default?: string | boolean; deprecated?: DeprecatedObject; documentation?: undefined | string; required?: undefined | false | true; type: "String" | "Boolean" }

Type declaration

Optional builtIn?: undefined | string
Optional default?: string | boolean
Optional deprecated?: DeprecatedObject
Optional documentation?: undefined | string
Optional required?: undefined | false | true
type: "String" | "Boolean"

ParsedIniData

ParsedIniData: __ParsedIniData

deprecated: Use ParsedIniData from "@aws-sdk/types" instead

PartitionHash

PartitionHash: Record<string, { endpoint?: undefined | string; regionRegex: string; regions: string[]; variants: EndpointVariant[] }>

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.

Priority

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

QueryParameterBag

QueryParameterBag: Record<string, string | Array<string> | null>

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

RIProductDescription

RIProductDescription: "Linux/UNIX" | "Linux/UNIX (Amazon VPC)" | "Windows" | "Windows (Amazon VPC)"

ReferenceObject

ReferenceObject: { ref: string }

Type declaration

ref: string

ReferenceRecord

ReferenceRecord: Record<string, FunctionReturn>

RegionHash

RegionHash: Record<string, { signingRegion?: undefined | string; signingService?: undefined | string; variants: EndpointVariant[] }>

The hash of region with the information specific to that region. The information can include hostname, signingService and signingRegion.

Relation

Relation: "before" | "after"

RelativeMiddlewareOptions

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

RequestHandlerOutput

RequestHandlerOutput<ResponseType>: { response: ResponseType }

Type parameters

ResponseType

Type declaration

response: ResponseType

RetryErrorType

RetryErrorType: "TRANSIENT" | "THROTTLING" | "SERVER_ERROR" | "CLIENT_ERROR"

RuleSetObject

RuleSetObject: { parameters: Record<string, ParameterObject>; rules: RuleSetRules; serviceId?: undefined | string; version: string }

Type declaration

parameters: Record<string, ParameterObject>
rules: RuleSetRules
Optional serviceId?: undefined | string
version: string

RuleSetRules

RuleSetRules: Array<EndpointRuleObject | ErrorRuleObject | TreeRuleObject>

SSOClientConfigType

SSOClientConfigType: Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & UserAgentInputConfig & ClientInputEndpointParameters

SSOClientResolvedConfigType

SSOClientResolvedConfigType: __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters

STSClientConfigType

STSClientConfigType: Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & StsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters

STSClientResolvedConfigType

STSClientResolvedConfigType: __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & StsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters

SdkError

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

deprecated

SdkStream

SdkStream<BaseStream>: BaseStream & SdkStreamMixin

The type describing a runtime-specific stream implementation with mix-in utility functions.

Type parameters

BaseStream

ServiceInputTypes

ServiceOutputTypes

Index

Namespaces

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

AwsCredentialIdentityProvider

ClientResolvedEndpointParameters

ConditionObject

ConditionalLazyValueInstruction

ConditionalValueInstruction

CredentialProvider

DateInput

DefaultProviderInit

DefaultsMode

DeprecatedObject

Type declaration

Optional message?: undefined | string

Optional since?: undefined | string

DocumentType

EC2ClientConfigType

EC2ClientResolvedConfigType

EndpointObject

Type declaration

Optional headers?: EndpointObjectHeaders

Optional properties?: EndpointObjectProperties

url: Expression

EndpointObjectHeaders

EndpointObjectProperties

EndpointObjectProperty

EndpointParameterInstructionsSupplier

EndpointParameters

Type declaration

[name: string]: undefined | string | boolean

Optional Endpoint

Region

Optional UseDualStack

Optional UseFIPS

Optional UseGlobalEndpoint

EndpointParams

EndpointResolverOptions

Type declaration

endpointParams: EndpointParams

Optional logger?: Logger

EndpointRuleObject

Type declaration

Optional conditions?: ConditionObject[]

Optional documentation?: undefined | string

endpoint: EndpointObject

type: "endpoint"

EndpointVariant

Type declaration

hostname: string

tags: EndpointVariantTag[]

EndpointVariantTag

ErrorRuleObject

Type declaration

Optional conditions?: ConditionObject[]

Optional documentation?: undefined | string

error: Expression

type: "error"

EvaluateOptions

ExponentialBackoffJitterType

Expression

FilterStatus

FilterStatusSupplier

Type declaration

Returns boolean

FromStaticConfig

Type parameters

T

FunctionArgv

FunctionObject

Type declaration

argv: FunctionArgv

fn: string