Options
All
  • Public
  • Public/Protected
  • All
Menu

CodePipeline Client - AWS SDK for JavaScript v3

Index

Namespaces

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

AwsCredentialIdentityProvider

AwsCredentialIdentityProvider: IdentityProvider<AwsCredentialIdentity>

ClientResolvedEndpointParameters

ClientResolvedEndpointParameters: ClientInputEndpointParameters & { defaultSigningName: string }

CodePipelineClientConfigType

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

CodePipelineClientResolvedConfigType

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

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

DefaultsMode

DefaultsMode: "standard" | "in-region" | "cross-region" | "mobile" | "auto" | "legacy"

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.

EndpointObject

EndpointObject: { headers?: EndpointObjectHeaders; properties?: EndpointObjectProperties; url: Expression }

Type declaration

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

Optional 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

EndpointRuleObject

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

Type declaration

EndpointVariant

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

Provides hostname information for specific host label.

Type declaration

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

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

  1. It is a boolean true.
  2. It is not undefined and is itself truthy.
  3. 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

  • T

FunctionArgv

FunctionArgv: Array<Expression | boolean | number>

FunctionObject

FunctionObject: { argv: FunctionArgv; fn: string }

Type declaration

FunctionReturn

FunctionReturn: string | boolean | number | {}

GetterFromConfig

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

Type parameters

  • T

Type declaration

    • (profile: Profile): T | undefined
    • Parameters

      Returns T | undefined

GetterFromEnv

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

Type parameters

  • T

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

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

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

LoginIdentityProvider

LoginIdentityProvider: IdentityProvider<LoginIdentity>

LowerCaseKey

LowerCaseKey<T>: {}

Type parameters

  • T

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

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

  • T

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

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

RuleSetRules

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

ServiceInputTypes: AcknowledgeJobCommandInput | AcknowledgeThirdPartyJobCommandInput | CreateCustomActionTypeCommandInput | CreatePipelineCommandInput | DeleteCustomActionTypeCommandInput | DeletePipelineCommandInput | DeleteWebhookCommandInput | DeregisterWebhookWithThirdPartyCommandInput | DisableStageTransitionCommandInput | EnableStageTransitionCommandInput | GetActionTypeCommandInput | GetJobDetailsCommandInput | GetPipelineCommandInput | GetPipelineExecutionCommandInput | GetPipelineStateCommandInput | GetThirdPartyJobDetailsCommandInput | ListActionExecutionsCommandInput | ListActionTypesCommandInput | ListPipelineExecutionsCommandInput | ListPipelinesCommandInput | ListTagsForResourceCommandInput | ListWebhooksCommandInput | PollForJobsCommandInput | PollForThirdPartyJobsCommandInput | PutActionRevisionCommandInput | PutApprovalResultCommandInput | PutJobFailureResultCommandInput | PutJobSuccessResultCommandInput | PutThirdPartyJobFailureResultCommandInput | PutThirdPartyJobSuccessResultCommandInput | PutWebhookCommandInput | RegisterWebhookWithThirdPartyCommandInput | RetryStageExecutionCommandInput | StartPipelineExecutionCommandInput | StopPipelineExecutionCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateActionTypeCommandInput | UpdatePipelineCommandInput

ServiceOutputTypes

ServiceOutputTypes: AcknowledgeJobCommandOutput | AcknowledgeThirdPartyJobCommandOutput | CreateCustomActionTypeCommandOutput | CreatePipelineCommandOutput | DeleteCustomActionTypeCommandOutput | DeletePipelineCommandOutput | DeleteWebhookCommandOutput | DeregisterWebhookWithThirdPartyCommandOutput | DisableStageTransitionCommandOutput | EnableStageTransitionCommandOutput | GetActionTypeCommandOutput | GetJobDetailsCommandOutput | GetPipelineCommandOutput | GetPipelineExecutionCommandOutput | GetPipelineStateCommandOutput | GetThirdPartyJobDetailsCommandOutput | ListActionExecutionsCommandOutput | ListActionTypesCommandOutput | ListPipelineExecutionsCommandOutput | ListPipelinesCommandOutput | ListTagsForResourceCommandOutput | ListWebhooksCommandOutput | PollForJobsCommandOutput | PollForThirdPartyJobsCommandOutput | PutActionRevisionCommandOutput | PutApprovalResultCommandOutput | PutJobFailureResultCommandOutput | PutJobSuccessResultCommandOutput | PutThirdPartyJobFailureResultCommandOutput | PutThirdPartyJobSuccessResultCommandOutput | PutWebhookCommandOutput | RegisterWebhookWithThirdPartyCommandOutput | RetryStageExecutionCommandOutput | StartPipelineExecutionCommandOutput | StopPipelineExecutionCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateActionTypeCommandOutput | UpdatePipelineCommandOutput

SimpleValueInstruction

SimpleValueInstruction: [FilterStatus, Value]

SmithyResolvedConfiguration

SmithyResolvedConfiguration<HandlerOptions>: SmithyConfiguration<HandlerOptions>

Type parameters

  • HandlerOptions

SourceData

SourceData: string | ArrayBuffer | ArrayBufferView

Step

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

TokenIdentityProvider

TokenIdentityProvider: IdentityProvider<TokenIdentity>

TokenProvider

TokenProvider: Provider<Token>
deprecated

Use {@TokenIdentityProvider}

TreeRuleObject

TreeRuleObject: { conditions?: ConditionObject[]; documentation?: undefined | string; rules: RuleSetRules; type: "tree" }

Type declaration

UnfilteredValue

UnfilteredValue: any

non-array

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.

V1OrV2Endpoint

V1OrV2Endpoint: { endpoint?: Provider<Endpoint>; urlParser?: UrlParser }

Type declaration

Value

Value: any

A non-function value.

ValueFilteringFunction

ValueFilteringFunction: (value: any) => boolean

Filter check with the given value.

Type declaration

    • (value: any): boolean
    • Parameters

      • value: any

      Returns boolean

ValueSupplier

ValueSupplier: () => any

Supplies the value for lazy evaluation.

Type declaration

    • (): any
    • Returns any

WithSdkStreamMixin

WithSdkStreamMixin<T, StreamKey>: {}

Indicates that the member of type T with key StreamKey have been extended with the SdkStreamMixin helper methods.

Type parameters

  • T

  • StreamKey: keyof T

Type declaration

Variables

Const CONFIG_MAX_ATTEMPTS

CONFIG_MAX_ATTEMPTS: "max_attempts" = "max_attempts"

Const CONFIG_RETRY_MODE

CONFIG_RETRY_MODE: "retry_mode" = "retry_mode"

Const CONFIG_USE_DUALSTACK_ENDPOINT

CONFIG_USE_DUALSTACK_ENDPOINT: "use_dualstack_endpoint" = "use_dualstack_endpoint"

Const CONFIG_USE_FIPS_ENDPOINT

CONFIG_USE_FIPS_ENDPOINT: "use_fips_endpoint" = "use_fips_endpoint"

Const DEFAULT_MAX_ATTEMPTS

DEFAULT_MAX_ATTEMPTS: 3 = 3

The default value for how many HTTP requests an SDK should make for a single SDK operation invocation before giving up

Const DEFAULT_MAX_RETRIES

DEFAULT_MAX_RETRIES: 0 = 0

Const DEFAULT_PROFILE

DEFAULT_PROFILE: "default" = "default"

Const DEFAULT_RETRY_MODE

DEFAULT_RETRY_MODE: STANDARD = RETRY_MODES.STANDARD

The default retry algorithm to use.

Const DEFAULT_TIMEOUT

DEFAULT_TIMEOUT: 1000 = 1000

Const DEFAULT_USE_DUALSTACK_ENDPOINT

DEFAULT_USE_DUALSTACK_ENDPOINT: false = false

Const DEFAULT_USE_FIPS_ENDPOINT

DEFAULT_USE_FIPS_ENDPOINT: false = false

Const ENV_CMDS_AUTH_TOKEN

ENV_CMDS_AUTH_TOKEN: "AWS_CONTAINER_AUTHORIZATION_TOKEN" = "AWS_CONTAINER_AUTHORIZATION_TOKEN"

Const ENV_CMDS_FULL_URI

ENV_CMDS_FULL_URI: "AWS_CONTAINER_CREDENTIALS_FULL_URI" = "AWS_CONTAINER_CREDENTIALS_FULL_URI"

Const ENV_CMDS_RELATIVE_URI

ENV_CMDS_RELATIVE_URI: "AWS_CONTAINER_CREDENTIALS_RELATIVE_URI" = "AWS_CONTAINER_CREDENTIALS_RELATIVE_URI"

Const ENV_MAX_ATTEMPTS

ENV_MAX_ATTEMPTS: "AWS_MAX_ATTEMPTS" = "AWS_MAX_ATTEMPTS"

Const ENV_PROFILE

ENV_PROFILE: "AWS_PROFILE" = "AWS_PROFILE"

Const ENV_RETRY_MODE

ENV_RETRY_MODE: "AWS_RETRY_MODE" = "AWS_RETRY_MODE"

Const ENV_USE_DUALSTACK_ENDPOINT

ENV_USE_DUALSTACK_ENDPOINT: "AWS_USE_DUALSTACK_ENDPOINT" = "AWS_USE_DUALSTACK_ENDPOINT"

Const ENV_USE_FIPS_ENDPOINT

ENV_USE_FIPS_ENDPOINT: "AWS_USE_FIPS_ENDPOINT" = "AWS_USE_FIPS_ENDPOINT"

Const NODE_MAX_ATTEMPT_CONFIG_OPTIONS

NODE_MAX_ATTEMPT_CONFIG_OPTIONS: LoadedConfigSelectors<number>

Const NODE_REGION_CONFIG_FILE_OPTIONS

NODE_REGION_CONFIG_FILE_OPTIONS: LocalConfigOptions

Const NODE_REGION_CONFIG_OPTIONS

NODE_REGION_CONFIG_OPTIONS: LoadedConfigSelectors<string>

Const NODE_RETRY_MODE_CONFIG_OPTIONS

NODE_RETRY_MODE_CONFIG_OPTIONS: LoadedConfigSelectors<string>

Const NODE_USE_DUALSTACK_ENDPOINT_CONFIG_OPTIONS

NODE_USE_DUALSTACK_ENDPOINT_CONFIG_OPTIONS: LoadedConfigSelectors<boolean>

Const NODE_USE_FIPS_ENDPOINT_CONFIG_OPTIONS

NODE_USE_FIPS_ENDPOINT_CONFIG_OPTIONS: LoadedConfigSelectors<boolean>

Const REGION_ENV_NAME

REGION_ENV_NAME: "AWS_REGION" = "AWS_REGION"

Const REGION_INI_NAME

REGION_INI_NAME: "region" = "region"

Const SENSITIVE_STRING

SENSITIVE_STRING: "***SensitiveInformation***" = "***SensitiveInformation***"

Const StringWrapper

StringWrapper: StringWrapper

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.

Const UA_APP_ID_ENV_NAME

UA_APP_ID_ENV_NAME: "AWS_SDK_UA_APP_ID" = "AWS_SDK_UA_APP_ID"

Const UA_APP_ID_INI_NAME

UA_APP_ID_INI_NAME: "sdk-ua-app-id" = "sdk-ua-app-id"

Const addRecursionDetectionMiddlewareOptions

addRecursionDetectionMiddlewareOptions: BuildHandlerOptions & AbsoluteLocation

Const awsAuthMiddleware

awsAuthMiddleware: <Input, Output>(options: AwsAuthResolvedConfig) => FinalizeRequestMiddleware<Input, Output>

Type declaration

Const awsAuthMiddlewareOptions

awsAuthMiddlewareOptions: RelativeMiddlewareOptions

Const calculateBodyLength

calculateBodyLength: (body: any) => number | undefined

Type declaration

    • (body: any): number | undefined
    • Parameters

      • body: any

      Returns number | undefined

Const contentLengthMiddlewareOptions

contentLengthMiddlewareOptions: BuildHandlerOptions

Const createScope

createScope: (shortDate: string, region: string, service: string) => string

Create a string describing the scope of credentials used to sign a request.

param

The current calendar date in the form YYYYMMDD.

param

The AWS region in which the service resides.

param

The service to which the signed request is being sent.

Type declaration

    • (shortDate: string, region: string, service: string): string
    • Parameters

      • shortDate: string
      • region: string
      • service: string

      Returns string

Const defaultDelayDecider

defaultDelayDecider: (delayBase: number, attempts: number) => number

Calculate a capped, fully-jittered exponential backoff time.

Type declaration

    • (delayBase: number, attempts: number): number
    • Parameters

      • delayBase: number
      • attempts: number

      Returns number

Const defaultProvider

Creates a credential provider that will attempt to find credentials from the following sources (listed in order of precedence):

  • Environment variables exposed via process.env
  • SSO credentials from token cache
  • Web identity token credentials
  • Shared credentials and config ini files
  • The EC2/ECS Instance Metadata Service The default credential provider will invoke one provider at a time and only continue to the next if no credentials have been located. For example, if the process finds values defined via the AWS_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.
param

Configuration that is passed to each individual provider

see

fromEnv The function used to source credentials from environment variables

see

fromSSO The function used to source credentials from resolved SSO token cache

see

fromTokenFile The function used to source credentials from token file

see

fromIni The function used to source credentials from INI files

see

fromProcess The function used to sources credentials from credential_process in INI files

see

fromInstanceMetadata The function used to source credentials from the EC2 Instance Metadata Service

see

fromContainerMetadata The function used to source credentials from the ECS Container Metadata Service

Const defaultRetryDecider

defaultRetryDecider: (error: SdkError) => boolean

Type declaration

Const defaultUserAgent

defaultUserAgent: (__namedParameters: { clientVersion: string; serviceId: undefined | string }) => Provider<UserAgent>

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

Type declaration

    • (__namedParameters: { clientVersion: string; serviceId: undefined | string }): Provider<UserAgent>
    • Parameters

      • __namedParameters: { clientVersion: string; serviceId: undefined | string }
        • clientVersion: string
        • serviceId: undefined | string

      Returns Provider<UserAgent>

Const deserializerMiddleware

deserializerMiddleware: <Input, Output, RuntimeUtils>(options: RuntimeUtils, deserializer: ResponseDeserializer<any, any, RuntimeUtils>) => DeserializeMiddleware<Input, Output>

Type declaration

Const deserializerMiddlewareOption

deserializerMiddlewareOption: DeserializeHandlerOptions

Const emitWarningIfUnsupportedVersion

emitWarningIfUnsupportedVersion: (version: string) => void

Emits warning if the provided Node.js version string is pending deprecation.

param

The Node.js version string.

Type declaration

    • (version: string): void
    • Parameters

      • version: string

      Returns void

Const endpointMiddlewareOptions

Const expectBoolean

expectBoolean: (value: any) => boolean | undefined

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.

param

A value that is expected to be a boolean.

returns

The value if it's a boolean, undefined if it's null/undefined, otherwise an error is thrown.

Type declaration

    • (value: any): boolean | undefined
    • Parameters

      • value: any

      Returns boolean | undefined

Const expectByte

expectByte: (value: any) => number | undefined

Asserts a value is an 8-bit integer and returns it.

param

A value that is expected to be an integer.

returns

The value if it's an integer, undefined if it's null/undefined, otherwise an error is thrown.

Type declaration

    • (value: any): number | undefined
    • Parameters

      • value: any

      Returns number | undefined

Const expectFloat32

expectFloat32: (value: any) => number | undefined

Asserts a value is a 32-bit float and returns it.

param

A value that is expected to be a 32-bit float.

returns

The value if it's a float, undefined if it's null/undefined, otherwise an error is thrown.

Type declaration

    • (value: any): number | undefined
    • Parameters

      • value: any

      Returns number | undefined

Const expectInt

expectInt: (value: any) => number | undefined
deprecated

Use expectLong

Type declaration

    • (value: any): number | undefined
    • Parameters

      • value: any

      Returns number | undefined

Const expectInt32

expectInt32: (value: any) => number | undefined

Asserts a value is a 32-bit integer and returns it.

param

A value that is expected to be an integer.

returns

The value if it's an integer, undefined if it's null/undefined, otherwise an error is thrown.

Type declaration

    • (value: any): number | undefined
    • Parameters

      • value: any

      Returns number | undefined

Const expectLong

expectLong: (value: any) => number | undefined

Asserts a value is an integer and returns it.

param

A value that is expected to be an integer.

returns

The value if it's an integer, undefined if it's null/undefined, otherwise an error is thrown.

Type declaration

    • (value: any): number | undefined
    • Parameters

      • value: any

      Returns number | undefined

Const expectNonNull

expectNonNull: <T>(value: T | null | undefined, location?: string | undefined) => T

Asserts a value is not null or undefined and returns it, or throws an error.

param

A value that is expected to be defined

param

The location where we're expecting to find a defined object (optional)

returns

The value if it's not undefined, otherwise throws an error

Type declaration

    • <T>(value: T | null | undefined, location?: string | undefined): T
    • Type parameters

      • T

      Parameters

      • value: T | null | undefined
      • Optional location: string | undefined

      Returns T

Const expectNumber

expectNumber: (value: any) => number | undefined

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.

param

A value that is expected to be a number.

returns

The value if it's a number, undefined if it's null/undefined, otherwise an error is thrown.

Type declaration

    • (value: any): number | undefined
    • Parameters

      • value: any

      Returns number | undefined

Const expectObject

expectObject: (value: any) => Record<string, any> | undefined

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).

param

A value that is expected to be an object

returns

The value if it's an object, undefined if it's null/undefined, otherwise an error is thrown.

Type declaration

    • (value: any): Record<string, any> | undefined
    • Parameters

      • value: any

      Returns Record<string, any> | undefined

Const expectShort

expectShort: (value: any) => number | undefined

Asserts a value is a 16-bit integer and returns it.

param

A value that is expected to be an integer.

returns

The value if it's an integer, undefined if it's null/undefined, otherwise an error is thrown.

Type declaration

    • (value: any): number | undefined
    • Parameters

      • value: any

      Returns number | undefined

Const expectString

expectString: (value: any) => string | undefined

Asserts a value is a string and returns it. Numbers and boolean will be cast to strings with a warning.

param

A value that is expected to be a string.

returns

The value if it's a string, undefined if it's null/undefined, otherwise an error is thrown.

Type declaration

    • (value: any): string | undefined
    • Parameters

      • value: any

      Returns string | undefined

Const expectUnion

expectUnion: (value: unknown) => Record<string, any> | undefined

Asserts a value is a JSON-like object with only one non-null/non-undefined key and returns it.

param

A value that is expected to be an object with exactly one non-null, non-undefined key.

returns

the value if it's a union, undefined if it's null/undefined, otherwise an error is thrown.

Type declaration

    • (value: unknown): Record<string, any> | undefined
    • Parameters

      • value: unknown

      Returns Record<string, any> | undefined

Const fromBase64

fromBase64: (input: string) => Uint8Array

Converts a base-64 encoded string to a Uint8Array of bytes using Node.JS's buffer module.

param

The base-64 encoded string

Type declaration

    • (input: string): Uint8Array
    • Parameters

      • input: string

      Returns Uint8Array

Const fromContainerMetadata

fromContainerMetadata: (init?: RemoteProviderInit) => AwsCredentialIdentityProvider

Creates a credential provider that will source credentials from the ECS Container Metadata Service

Type declaration

Const fromEnv

fromEnv: <T>(envVarSelector: GetterFromEnv<T>) => Provider<T>

Get config value given the environment variable name or getter from environment variable.

Type declaration

Const fromIni

Creates a credential provider that will read from ini files and supports role assumption and multi-factor authentication.

Type declaration

Const fromInstanceMetadata

fromInstanceMetadata: (init?: RemoteProviderInit) => Provider<InstanceMetadataCredentials>

Creates a credential provider that will source credentials from the EC2 Instance Metadata Service

Const fromProcess

Creates a credential provider that will read from a credential_process specified in ini files.

Type declaration

Const fromSSO

Creates a credential provider that will read from a credential_process specified in ini files. The SSO credential provider must support both

  1. the legacy profile format,
example
[profile sample-profile]
sso_account_id = 012345678901
sso_region = us-east-1
sso_role_name = SampleRole
sso_start_url = https://www.....com/start
  1. and the profile format for SSO Token Providers.
example
[profile sso-profile]
sso_session = dev
sso_account_id = 012345678901
sso_role_name = SampleRole
[sso-session dev]
sso_region = us-east-1
sso_start_url = https://www.....com/start

Type declaration

Const fromSharedConfigFiles

fromSharedConfigFiles: <T>(configSelector: GetterFromConfig<T>, __namedParameters?: { init: init; preferredFile: undefined | "config" | "credentials" }) => Provider<T>

Get config value from the shared config files with inferred profile name.

Type declaration

    • <T>(configSelector: GetterFromConfig<T>, __namedParameters?: { init: init; preferredFile: undefined | "config" | "credentials" }): Provider<T>
    • Type parameters

      • T = string

      Parameters

      • configSelector: GetterFromConfig<T>
      • Optional __namedParameters: { init: init; preferredFile: undefined | "config" | "credentials" }
        • init: init
        • preferredFile: undefined | "config" | "credentials"

      Returns Provider<T>

Const fromStatic

fromStatic: <T>(defaultValue: FromStaticConfig<T>) => Provider<T>

Type declaration

Const fromTokenFile

Represents OIDC credentials from a file on disk.

Type declaration

Const fromUtf8

fromUtf8: (input: string) => Uint8Array

Type declaration

    • (input: string): Uint8Array
    • Parameters

      • input: string

      Returns Uint8Array

Const fromWebToken

Const getArrayIfSingleItem

getArrayIfSingleItem: <T>(mayBeArray: T) => T | T[]

The XML parser will set one K:V for a member that could return multiple entries but only has one.

Type declaration

    • <T>(mayBeArray: T): T | T[]
    • Type parameters

      • T

      Parameters

      • mayBeArray: T

      Returns T | T[]

Const getAwsAuthPlugin

getAwsAuthPlugin: (options: AwsAuthResolvedConfig) => Pluggable<any, any>

Type declaration

Const getContentLengthPlugin

getContentLengthPlugin: (options: { bodyLengthChecker: BodyLengthCalculator }) => Pluggable<any, any>

Type declaration

Const getDefaultRoleAssumer

getDefaultRoleAssumer: (stsOptions?: Pick<STSClientConfig, "logger" | "region" | "requestHandler">, stsPlugins?: Pluggable<ServiceInputTypes, ServiceOutputTypes>[] | undefined) => RoleAssumer

The default role assumer that used by credential providers when sts:AssumeRole API is needed.

Type declaration

Const getDefaultRoleAssumerWithWebIdentity

getDefaultRoleAssumerWithWebIdentity: (stsOptions?: Pick<STSClientConfig, "logger" | "region" | "requestHandler">, stsPlugins?: Pluggable<ServiceInputTypes, ServiceOutputTypes>[] | undefined) => RoleAssumerWithWebIdentity

The default role assumer that used by credential providers when sts:AssumeRoleWithWebIdentity API is needed.

Type declaration

Const getEndpointPlugin

getEndpointPlugin: <T>(config: EndpointResolvedConfig<T>, instructions: EndpointParameterInstructions) => Pluggable<any, any>

Type declaration

Const getHostHeaderPlugin

getHostHeaderPlugin: (options: HostHeaderResolvedConfig) => Pluggable<any, any>

Type declaration

Const getLoggerPlugin

getLoggerPlugin: (options: any) => Pluggable<any, any>

Type declaration

Const getOmitRetryHeadersPlugin

getOmitRetryHeadersPlugin: (options: unknown) => Pluggable<any, any>

Type declaration

    • Parameters

      • options: unknown

      Returns Pluggable<any, any>

Const getProfileName

getProfileName: (init: { profile?: undefined | string }) => string

Type declaration

    • (init: { profile?: undefined | string }): string
    • Parameters

      • init: { profile?: undefined | string }
        • Optional profile?: undefined | string

      Returns string

Const getRecursionDetectionPlugin

getRecursionDetectionPlugin: (options: PreviouslyResolved) => Pluggable<any, any>

Type declaration

Const getRegionInfo

getRegionInfo: (region: string, __namedParameters: { partitionHash: PartitionHash; regionHash: RegionHash; signingService: string; useDualstackEndpoint: undefined | false | true; useFipsEndpoint: undefined | false | true }) => RegionInfo

Type declaration

    • (region: string, __namedParameters: { partitionHash: PartitionHash; regionHash: RegionHash; signingService: string; useDualstackEndpoint: undefined | false | true; useFipsEndpoint: undefined | false | true }): RegionInfo
    • Parameters

      • region: string
      • __namedParameters: { partitionHash: PartitionHash; regionHash: RegionHash; signingService: string; useDualstackEndpoint: undefined | false | true; useFipsEndpoint: undefined | false | true }
        • partitionHash: PartitionHash
        • regionHash: RegionHash
        • signingService: string
        • useDualstackEndpoint: undefined | false | true
        • useFipsEndpoint: undefined | false | true

      Returns RegionInfo

Const getRetryPlugin

getRetryPlugin: (options: RetryResolvedConfig) => Pluggable<any, any>

Type declaration

Const getSSOTokenFilepath

getSSOTokenFilepath: (id: string) => string

Returns the filepath of the file where SSO token is stored.

Type declaration

    • (id: string): string
    • Parameters

      • id: string

      Returns string

Const getSSOTokenFromFile

getSSOTokenFromFile: (id: string) => Promise<SSOToken>
param

can be either a start URL or the SSO session name. Returns the SSO token from the file system.

Type declaration

    • Parameters

      • id: string

      Returns Promise<SSOToken>

Const getSigV4AuthPlugin

getSigV4AuthPlugin: (options: AwsAuthResolvedConfig) => Pluggable<any, any>

Type declaration

Const getSigningKey

getSigningKey: (sha256Constructor: HashConstructor, credentials: AwsCredentialIdentity, shortDate: string, region: string, service: string) => Promise<Uint8Array>

Derive a signing key from its composite parts

param

A constructor function that can instantiate SHA-256 hash objects.

param

The credentials with which the request will be signed.

param

The current calendar date in the form YYYYMMDD.

param

The AWS region in which the service resides.

param

The service to which the signed request is being sent.

Type declaration

Const getUserAgentMiddlewareOptions

getUserAgentMiddlewareOptions: BuildHandlerOptions & AbsoluteLocation

Const getUserAgentPlugin

getUserAgentPlugin: (config: UserAgentResolvedConfig) => Pluggable<any, any>

Type declaration

Const getValueFromTextNode

getValueFromTextNode: (obj: any) => any

Recursively parses object and populates value is node from "#text" key if it's available

Type declaration

    • (obj: any): any
    • Parameters

      • obj: any

      Returns any

Const handleFloat

handleFloat: (value: string | number) => number | undefined
deprecated

Use limitedParseDouble

Type declaration

    • (value: string | number): number | undefined
    • Parameters

      • value: string | number

      Returns number | undefined

Const hostHeaderMiddleware

hostHeaderMiddleware: <Input, Output>(options: HostHeaderResolvedConfig) => BuildMiddleware<Input, Output>

Type declaration

Const hostHeaderMiddlewareOptions

hostHeaderMiddlewareOptions: BuildHandlerOptions & AbsoluteLocation

Const invalidFunction

invalidFunction: (message: string) => () => never

Type declaration

    • (message: string): () => never
    • Parameters

      • message: string

      Returns () => never

        • (): never
        • Returns never

Const invalidProvider

invalidProvider: (message: string) => Provider<any>

Type declaration

    • Parameters

      • message: string

      Returns Provider<any>

Const isAssumeRoleProfile

isAssumeRoleProfile: (arg: any) => boolean

Type declaration

    • (arg: any): boolean
    • Parameters

      • arg: any

      Returns boolean

Const limitedParseDouble

limitedParseDouble: (value: string | number) => number | undefined

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.

param

A number or string representation of a non-numeric float.

returns

The value as a number, or undefined if it's null/undefined.

Type declaration

    • (value: string | number): number | undefined
    • Parameters

      • value: string | number

      Returns number | undefined

Const limitedParseFloat

limitedParseFloat: (value: string | number) => number | undefined
deprecated

Use limitedParseDouble

Type declaration

    • (value: string | number): number | undefined
    • Parameters

      • value: string | number

      Returns number | undefined

Const limitedParseFloat32

limitedParseFloat32: (value: string | number) => number | undefined

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.

param

A number or string representation of a non-numeric float.

returns

The value as a number, or undefined if it's null/undefined.

Type declaration

    • (value: string | number): number | undefined
    • Parameters

      • value: string | number

      Returns number | undefined

Const loadConfig

loadConfig: <T>(__namedParameters: { configFileSelector: GetterFromConfig<T>; defaultValue: FromStaticConfig<T>; environmentVariableSelector: GetterFromEnv<T> }, configuration?: LocalConfigOptions) => Provider<T>

Type declaration

Const loadSharedConfigFiles

loadSharedConfigFiles: (init?: SharedConfigInit) => Promise<SharedConfigFiles>

Type declaration

Const loadSsoSessionData

loadSsoSessionData: (init?: SsoSessionInit) => Promise<ParsedIniData>

Type declaration

Const loggerMiddleware

loggerMiddleware: () => <Output>(next: InitializeHandler<any, Output>, context: HandlerExecutionContext) => InitializeHandler<any, Output>

Type declaration

Const loggerMiddlewareOptions

loggerMiddlewareOptions: InitializeHandlerOptions & AbsoluteLocation

Const omitRetryHeadersMiddleware

omitRetryHeadersMiddleware: () => <Output>(next: FinalizeHandler<any, Output>) => FinalizeHandler<any, Output>

Type declaration

Const omitRetryHeadersMiddlewareOptions

omitRetryHeadersMiddlewareOptions: RelativeMiddlewareOptions

Const parseBoolean

parseBoolean: (value: string) => boolean

Give an input string, strictly parses a boolean value.

param

The boolean string to parse.

returns

true for "true", false for "false", otherwise an error is thrown.

Type declaration

    • (value: string): boolean
    • Parameters

      • value: string

      Returns boolean

Const parseEpochTimestamp

parseEpochTimestamp: (value: unknown) => Date | undefined

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.

param

the value to parse

returns

a Date or undefined

Type declaration

    • (value: unknown): Date | undefined
    • Parameters

      • value: unknown

      Returns Date | undefined

Const parseRfc3339DateTime

parseRfc3339DateTime: (value: unknown) => Date | undefined

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}

param

the value to parse

returns

a Date or undefined

Type declaration

    • (value: unknown): Date | undefined
    • Parameters

      • value: unknown

      Returns Date | undefined

Const parseRfc7231DateTime

parseRfc7231DateTime: (value: unknown) => Date | undefined

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}

param

the value to parse

returns

a Date or undefined

Type declaration

    • (value: unknown): Date | undefined
    • Parameters

      • value: unknown

      Returns Date | undefined

Const parseUrl

parseUrl: UrlParser

Const partition

partition: (value: string) => EndpointPartition

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.

Type declaration

Const providerConfigFromInit

providerConfigFromInit: (__namedParameters: { maxRetries: undefined | number; timeout: undefined | number }) => RemoteProviderConfig

Type declaration

    • (__namedParameters: { maxRetries: undefined | number; timeout: undefined | number }): RemoteProviderConfig
    • Parameters

      • __namedParameters: { maxRetries: undefined | number; timeout: undefined | number }
        • maxRetries: undefined | number
        • timeout: undefined | number

      Returns RemoteProviderConfig

Const resolveAssumeRoleCredentials

resolveAssumeRoleCredentials: (profileName: string, profiles: ParsedIniData, options: FromIniInit, visitedProfiles?: Record<string, true>) => Promise<AwsCredentialIdentity>

Type declaration

Const resolveAwsAuthConfig

resolveAwsAuthConfig: <T>(input: T & AwsAuthInputConfig & PreviouslyResolved) => T & AwsAuthResolvedConfig

Type declaration

Const resolveCustomEndpointsConfig

resolveCustomEndpointsConfig: <T>(input: T & CustomEndpointsInputConfig & PreviouslyResolved) => T & CustomEndpointsResolvedConfig

Type declaration

Const resolveEndpoint

resolveEndpoint: (ruleSetObject: RuleSetObject, options: EndpointResolverOptions) => EndpointV2

Resolves an endpoint URL by processing the endpoints ruleset and options.

Type declaration

Const resolveEndpointConfig

resolveEndpointConfig: <T, P>(input: T & EndpointInputConfig<P> & PreviouslyResolved<P>) => T & EndpointResolvedConfig<P>

Type declaration

Const resolveEndpointsConfig

resolveEndpointsConfig: <T>(input: T & EndpointsInputConfig & PreviouslyResolved) => T & EndpointsResolvedConfig

Type declaration

Const resolveParams

resolveParams: <T, CommandInput, Config>(commandInput: CommandInput, instructionsSupplier: EndpointParameterInstructionsSupplier, clientConfig: Partial<EndpointResolvedConfig<T>> & Config) => Promise<EndpointParameters>

Type declaration

Const resolveRegionConfig

resolveRegionConfig: <T>(input: T & RegionInputConfig & PreviouslyResolved) => T & RegionResolvedConfig

Type declaration

Const resolveRetryConfig

resolveRetryConfig: <T>(input: T & PreviouslyResolved & RetryInputConfig) => T & RetryResolvedConfig

Type declaration

Const resolveSigV4AuthConfig

resolveSigV4AuthConfig: <T>(input: T & SigV4AuthInputConfig & SigV4PreviouslyResolved) => T & SigV4AuthResolvedConfig

Type declaration

Const resolveStsAuthConfig

resolveStsAuthConfig: <T>(input: T & PreviouslyResolved & StsAuthInputConfig, __namedParameters: { stsClientCtor: {} }) => T & StsAuthResolvedConfig

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.

Type declaration

Const resolvedPath

resolvedPath: (resolvedPath: string, input: unknown, memberName: string, labelValueProvider: () => string | undefined, uriLabel: string, isGreedyLabel: boolean) => string

Type declaration

    • (resolvedPath: string, input: unknown, memberName: string, labelValueProvider: () => string | undefined, uriLabel: string, isGreedyLabel: boolean): string
    • Parameters

      • resolvedPath: string
      • input: unknown
      • memberName: string
      • labelValueProvider: () => string | undefined
          • (): string | undefined
          • Returns string | undefined

      • uriLabel: string
      • isGreedyLabel: boolean

      Returns string

Const retryMiddleware

retryMiddleware: (options: RetryResolvedConfig) => <Output>(next: FinalizeHandler<any, Output>, context: HandlerExecutionContext) => FinalizeHandler<any, Output>

Type declaration

Const retryMiddlewareOptions

Const serializeFloat

serializeFloat: (value: number) => string | number

Serializes a number, turning non-numeric values into strings.

param

The number to serialize.

returns

A number, or a string if the given number was non-numeric.

Type declaration

    • (value: number): string | number
    • Parameters

      • value: number

      Returns string | number

Const serializerMiddleware

serializerMiddleware: <Input, Output, RuntimeUtils>(options: V1OrV2Endpoint, serializer: RequestSerializer<any, RuntimeUtils>) => SerializeMiddleware<Input, Output>

Type declaration

Const serializerMiddlewareOption

serializerMiddlewareOption: SerializeHandlerOptions

Const streamCollector

streamCollector: StreamCollector

Const strictParseByte

strictParseByte: (value: string | number) => number | undefined

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.

param

A number or string representation of an 8-bit integer.

returns

The value as a number, or undefined if it's null/undefined.

Type declaration

    • (value: string | number): number | undefined
    • Parameters

      • value: string | number

      Returns number | undefined

Const strictParseDouble

strictParseDouble: (value: string | number) => number | undefined

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.

param

A number or string representation of a double.

returns

The value as a number, or undefined if it's null/undefined.

Type declaration

    • (value: string | number): number | undefined
    • Parameters

      • value: string | number

      Returns number | undefined

Const strictParseFloat

strictParseFloat: (value: string | number) => number | undefined
deprecated

Use strictParseDouble

Type declaration

    • (value: string | number): number | undefined
    • Parameters

      • value: string | number

      Returns number | undefined

Const strictParseFloat32

strictParseFloat32: (value: string | number) => number | undefined

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.

param

A number or string representation of a float.

returns

The value as a number, or undefined if it's null/undefined.

Type declaration

    • (value: string | number): number | undefined
    • Parameters

      • value: string | number

      Returns number | undefined

Const strictParseInt

strictParseInt: (value: string | number) => number | undefined
deprecated

Use strictParseLong

Type declaration

    • (value: string | number): number | undefined
    • Parameters

      • value: string | number

      Returns number | undefined

Const strictParseInt32

strictParseInt32: (value: string | number) => number | undefined

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.

param

A number or string representation of a 32-bit integer.

returns

The value as a number, or undefined if it's null/undefined.

Type declaration

    • (value: string | number): number | undefined
    • Parameters

      • value: string | number

      Returns number | undefined

Const strictParseLong

strictParseLong: (value: string | number) => number | undefined

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.

param

A number or string representation of an integer.

returns

The value as a number, or undefined if it's null/undefined.

Type declaration

    • (value: string | number): number | undefined
    • Parameters

      • value: string | number

      Returns number | undefined

Const strictParseShort

strictParseShort: (value: string | number) => number | undefined

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.

param

A number or string representation of a 16-bit integer.

returns

The value as a number, or undefined if it's null/undefined.

Type declaration

    • (value: string | number): number | undefined
    • Parameters

      • value: string | number

      Returns number | undefined

Const toBase64

toBase64: (input: Uint8Array) => string

Converts a Uint8Array of binary data to a base-64 encoded string using Node.JS's buffer module.

param

The binary data to encode

Type declaration

    • (input: Uint8Array): string
    • Parameters

      • input: Uint8Array

      Returns string

Const toEndpointV1

toEndpointV1: (endpoint: string | Endpoint | EndpointV2) => Endpoint

Type declaration

Const toUtf8

toUtf8: (input: Uint8Array) => string

Type declaration

    • (input: Uint8Array): string
    • Parameters

      • input: Uint8Array

      Returns string

Const userAgentMiddleware

userAgentMiddleware: (options: UserAgentResolvedConfig) => <Output>(next: BuildHandler<any, any>, context: HandlerExecutionContext) => BuildHandler<any, any>

Build user agent header sections from:

  1. runtime-specific default user agent provider;
  2. custom user agent from customUserAgent client config;
  3. handler execution context set by internal SDK components; The built user agent will be set to 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.

Type declaration

Functions

contentLengthMiddleware

dateToUtcString

  • dateToUtcString(date: Date): string
  • 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.

    Parameters

    • date: Date

    Returns string

Const defaultEndpointResolver

  • defaultEndpointResolver(endpointParams: EndpointParameters, context?: { logger?: Logger }): EndpointV2

extendedEncodeURIComponent

  • extendedEncodeURIComponent(str: string): string
  • Function that wraps encodeURIComponent to encode additional characters to fully adhere to RFC 3986.

    Parameters

    • str: string

    Returns string

getSerdePlugin

isValidHostname

  • isValidHostname(hostname: string): boolean
  • Parameters

    • hostname: string

    Returns boolean

paginateListAccountRoles

paginateListAccounts

paginateListActionExecutions

paginateListActionTypes

paginateListPipelineExecutions

paginateListPipelines

paginateListTagsForResource

paginateListWebhooks

Const resolveClientEndpointParameters

resolveHostHeaderConfig

resolveUserAgentConfig

splitEvery

  • splitEvery(value: string, delimiter: string, numDelimiters: number): Array<string>
  • Given an input string, splits based on the delimiter after a given number of delimiters has been encountered.

    Parameters

    • value: string

      The input string to split.

    • delimiter: string

      The delimiter to split on.

    • numDelimiters: number

      The number of delimiters to have encountered to split.

    Returns Array<string>

Object literals

Const ruleSet

ruleSet: object

rules

rules: { conditions: { argv: { ref: string }[]; assign: string; fn: string }[]; rules: ({ conditions: ({ argv: { ref: string }[]; fn: string } | { argv: { ref: string }[]; assign: string; fn: string })[]; rules: ({ conditions: { argv: (true | { ref: string })[]; fn: string }[]; error: string; type: "error" } | { conditions: never[]; rules: ({ conditions: { argv: (true | { ref: string })[]; fn: string }[]; error: string; type: "error" } | { conditions: never[]; type: "endpoint"; endpoint: object })[]; type: "tree" })[]; type: "tree" } | { conditions: { argv: (true | { ref: string })[]; fn: string }[]; rules: ({ conditions: { argv: (true | { argv: (string | { ref: string })[]; fn: string })[]; fn: string }[]; rules: { conditions: never[]; type: "endpoint"; endpoint: object }[]; type: "tree" } | { conditions: never[]; error: string; type: "error" })[]; type: "tree" } | { conditions: { argv: (true | { ref: string })[]; fn: string }[]; rules: ({ conditions: { argv: (true | { argv: (string | { ref: string })[]; fn: string })[]; fn: string }[]; rules: { conditions: never[]; rules: { conditions: never[]; type: "endpoint"; endpoint: object }[]; type: "tree" }[]; type: "tree" } | { conditions: never[]; error: string; type: "error" })[]; type: "tree" } | { conditions: never[]; type: "endpoint"; endpoint: object })[]; type: "tree" }[] = [{conditions: [{fn: "aws.partition",argv: [{ref: "Region",},],assign: "PartitionResult",},],type: "tree",rules: [{conditions: [{fn: "isSet",argv: [{ref: "Endpoint",},],},{fn: "parseURL",argv: [{ref: "Endpoint",},],assign: "url",},],type: "tree",rules: [{conditions: [{fn: "booleanEquals",argv: [{ref: "UseFIPS",},true,],},],error: "Invalid Configuration: FIPS and custom endpoint are not supported",type: "error",},{conditions: [],type: "tree",rules: [{conditions: [{fn: "booleanEquals",argv: [{ref: "UseDualStack",},true,],},],error: "Invalid Configuration: Dualstack and custom endpoint are not supported",type: "error",},{conditions: [],endpoint: {url: {ref: "Endpoint",},properties: {},headers: {},},type: "endpoint",},],},],},{conditions: [{fn: "booleanEquals",argv: [{ref: "UseFIPS",},true,],},{fn: "booleanEquals",argv: [{ref: "UseDualStack",},true,],},],type: "tree",rules: [{conditions: [{fn: "booleanEquals",argv: [true,{fn: "getAttr",argv: [{ref: "PartitionResult",},"supportsFIPS",],},],},{fn: "booleanEquals",argv: [true,{fn: "getAttr",argv: [{ref: "PartitionResult",},"supportsDualStack",],},],},],type: "tree",rules: [{conditions: [],endpoint: {url: "https://codepipeline-fips.{Region}.{PartitionResult#dualStackDnsSuffix}",properties: {},headers: {},},type: "endpoint",},],},{conditions: [],error: "FIPS and DualStack are enabled, but this partition does not support one or both",type: "error",},],},{conditions: [{fn: "booleanEquals",argv: [{ref: "UseFIPS",},true,],},],type: "tree",rules: [{conditions: [{fn: "booleanEquals",argv: [true,{fn: "getAttr",argv: [{ref: "PartitionResult",},"supportsFIPS",],},],},],type: "tree",rules: [{conditions: [],type: "tree",rules: [{conditions: [],endpoint: {url: "https://codepipeline-fips.{Region}.{PartitionResult#dnsSuffix}",properties: {},headers: {},},type: "endpoint",},],},],},{conditions: [],error: "FIPS is enabled but this partition does not support FIPS",type: "error",},],},{conditions: [{fn: "booleanEquals",argv: [{ref: "UseDualStack",},true,],},],type: "tree",rules: [{conditions: [{fn: "booleanEquals",argv: [true,{fn: "getAttr",argv: [{ref: "PartitionResult",},"supportsDualStack",],},],},],type: "tree",rules: [{conditions: [],endpoint: {url: "https://codepipeline.{Region}.{PartitionResult#dualStackDnsSuffix}",properties: {},headers: {},},type: "endpoint",},],},{conditions: [],error: "DualStack is enabled but this partition does not support DualStack",type: "error",},],},{conditions: [],endpoint: {url: "https://codepipeline.{Region}.{PartitionResult#dnsSuffix}",properties: {},headers: {},},type: "endpoint",},],},]

version

version: string = "1.0"

parameters

parameters: object

Endpoint

Endpoint: object

builtIn

builtIn: string = "SDK::Endpoint"

documentation

documentation: string = "Override the endpoint used to send this request"

required

required: false = false

type

type: "String" = "String"

Region

Region: object

builtIn

builtIn: string = "AWS::Region"

documentation

documentation: string = "The AWS region used to dispatch the request."

required

required: false = false

type

type: "String" = "String"

UseDualStack

UseDualStack: object

builtIn

builtIn: string = "AWS::UseDualStack"

default

default: false = false

documentation

documentation: string = "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error."

required

required: true = true

type

type: "Boolean" = "Boolean"

UseFIPS

UseFIPS: object

builtIn

builtIn: string = "AWS::UseFIPS"

default

default: false = false

documentation

documentation: string = "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error."

required

required: true = true

type

type: "Boolean" = "Boolean"