Options
All
  • Public
  • Public/Protected
  • All
Menu

Chime SDK Media Pipelines Client - AWS SDK for JavaScript v3

Index

Namespaces

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

AwsCredentialIdentityProvider

AwsCredentialIdentityProvider: IdentityProvider<AwsCredentialIdentity>
public

ChimeSDKMediaPipelinesClientConfigType

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

ChimeSDKMediaPipelinesClientResolvedConfigType

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

ClientResolvedEndpointParameters

ClientResolvedEndpointParameters: ClientInputEndpointParameters & { defaultSigningName: string }

ConditionObject

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

CredentialProvider

CredentialProvider: Provider<Credentials>
public
deprecated

Use {@AwsCredentialIdentityProvider}

DateInput

DateInput: number | string | Date
public

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

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[] | {}
public

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[]
public

EndpointParameterInstructionsSupplier

EndpointParameterInstructionsSupplier: Partial<{ getEndpointParameterInstructions: any }>

EndpointParameters

EndpointParameters: {}
public

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"
public

Expression

Expression: string | ReferenceObject | FunctionObject

FieldOptions

FieldOptions: { kind?: FieldPosition; name: string; values?: string[] }

Type declaration

  • Optional kind?: FieldPosition
  • name: string
  • Optional values?: string[]

FieldsOptions

FieldsOptions: { encoding?: undefined | string; fields?: Field[] }

Type declaration

  • Optional encoding?: undefined | string
  • Optional fields?: Field[]

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: Record<string, string | undefined>) => T | undefined

Type parameters

  • T

Type declaration

    • (env: Record<string, string | undefined>): T | undefined

    • Parameters

      • env: Record<string, string | undefined>

      Returns T | undefined

Handler

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

Type parameters

  • Input: object

  • Output: object

HeaderBag

HeaderBag: Record<string, string>
public

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.

deprecated

Replaced by implementation Fields in @aws-sdk/protocol-http.

HttpHandler

HttpHandler: RequestHandler<HttpRequest, HttpResponse, HttpHandlerOptions>

HttpResponseOptions

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

IniSection

IniSection: Record<string, string | undefined>
public

LocalConfigOptions

LocalConfigOptions: SharedConfigInit

LogLevel

LogLevel: "all" | "trace" | "debug" | "log" | "info" | "warn" | "error" | "off"
public

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>
public

LowerCaseKey

LowerCaseKey<T>: {}

Type parameters

  • T

Type declaration

MessageHeaderValue

MessageHeaderValue: BooleanHeaderValue | ByteHeaderValue | ShortHeaderValue | IntegerHeaderValue | LongHeaderValue | BinaryHeaderValue | StringHeaderValue | TimestampHeaderValue | UuidHeaderValue
public

MessageHeaders

MessageHeaders: Record<string, MessageHeaderValue>
public

MiddlewareType

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

Type parameters

  • Input: object

  • Output: object

Paginator

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

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"
public

QueryParameterBag

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

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"
public

RelativeMiddlewareOptions

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

RequestHandlerOutput

RequestHandlerOutput<ResponseType>: { response: ResponseType }
public

Type parameters

  • ResponseType

Type declaration

  • response: ResponseType

RetryErrorType

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

RuleSetObject

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

Type declaration

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>
public
deprecated
see

https://aws.amazon.com/blogs/developer/service-error-handling-modular-aws-sdk-js/ This type should not be used in your application. Users of the AWS SDK for JavaScript v3 service clients should prefer to use the specific Exception classes corresponding to each operation. These can be found as code in the deserializer for the operation's Command class, or as declarations in the service model file in codegen/sdk-codegen/aws-models. If no exceptions are enumerated by a particular Command operation, the base exception for the service should be used. Each client exports a base ServiceException prefixed with the service name.

SdkStream

SdkStream<BaseStream>: BaseStream & SdkStreamMixin
public

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

Type parameters

  • BaseStream

ServiceInputTypes

ServiceInputTypes: CreateMediaCapturePipelineCommandInput | CreateMediaConcatenationPipelineCommandInput | CreateMediaLiveConnectorPipelineCommandInput | DeleteMediaCapturePipelineCommandInput | DeleteMediaPipelineCommandInput | GetMediaCapturePipelineCommandInput | GetMediaPipelineCommandInput | ListMediaCapturePipelinesCommandInput | ListMediaPipelinesCommandInput | ListTagsForResourceCommandInput | TagResourceCommandInput | UntagResourceCommandInput

ServiceOutputTypes

ServiceOutputTypes: CreateMediaCapturePipelineCommandOutput | CreateMediaConcatenationPipelineCommandOutput | CreateMediaLiveConnectorPipelineCommandOutput | DeleteMediaCapturePipelineCommandOutput | DeleteMediaPipelineCommandOutput | GetMediaCapturePipelineCommandOutput | GetMediaPipelineCommandOutput | ListMediaCapturePipelinesCommandOutput | ListMediaPipelinesCommandOutput | ListTagsForResourceCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput

SourceData

SourceData: string | ArrayBuffer | ArrayBufferView
public

Step

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

TokenIdentityProvider

TokenIdentityProvider: IdentityProvider<TokenIdentity>
public

TokenProvider

TokenProvider: Provider<Token>
public
deprecated

Use {@TokenIdentityProvider}

TreeRuleObject

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

Type declaration

UserAgent

UserAgent: UserAgentPair[]
public

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

UserAgentPair

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

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

WithSdkStreamMixin

WithSdkStreamMixin<T, StreamKey>: {}
public

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_DELAY_BASE

DEFAULT_RETRY_DELAY_BASE: 100 = 100

The base number of milliseconds to use in calculating a suitable cool-down time when a retryable error is encountered.

Const DEFAULT_RETRY_MODE

DEFAULT_RETRY_MODE: RETRY_MODES

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 INITIAL_RETRY_TOKENS

INITIAL_RETRY_TOKENS: 500 = 500

Initial number of retry tokens in Retry Quota

Const INVOCATION_ID_HEADER

INVOCATION_ID_HEADER: "amz-sdk-invocation-id" = "amz-sdk-invocation-id"

Header name for SDK invocation ID

Const MAXIMUM_RETRY_DELAY

MAXIMUM_RETRY_DELAY: number

The maximum amount of time (in milliseconds) that will be used as a delay between retry attempts.

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 NO_RETRY_INCREMENT

NO_RETRY_INCREMENT: 1 = 1

The total amount of retry token to be incremented from retry token balance if an SDK operation invocation succeeds without requiring a retry request.

Const REGION_ENV_NAME

REGION_ENV_NAME: "AWS_REGION" = "AWS_REGION"

Const REGION_INI_NAME

REGION_INI_NAME: "region" = "region"

Const REQUEST_HEADER

REQUEST_HEADER: "amz-sdk-request" = "amz-sdk-request"

Header name for request retry information.

Const RETRY_COST

RETRY_COST: 5 = 5

The total amount of retry tokens to be decremented from retry token balance.

Const THROTTLING_RETRY_DELAY_BASE

THROTTLING_RETRY_DELAY_BASE: 500 = 500

The retry delay base (in milliseconds) to use when a throttling error is encountered.

Const TIMEOUT_RETRY_COST

TIMEOUT_RETRY_COST: 10 = 10

The total amount of retry tokens to be decremented from retry token balance when a throttling error is encountered.

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

defaultProvider: (init?: DefaultProviderInit) => MemoizedProvider<AwsCredentialIdentity>

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

Type declaration

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 endpointMiddlewareOptions

endpointMiddlewareOptions: SerializeHandlerOptions & RelativeMiddlewareOptions

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

fromIni: (init?: FromIniInit) => AwsCredentialIdentityProvider

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

Type declaration

Const fromProcess

fromProcess: (init?: FromProcessInit) => AwsCredentialIdentityProvider

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

Type declaration

Const fromSSO

fromSSO: (init?: FromSSOInit & Partial<SsoCredentialsParameters>) => AwsCredentialIdentityProvider

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

fromTokenFile: (init?: FromTokenFileInit) => AwsCredentialIdentityProvider

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

fromWebToken: (init: FromWebTokenInit) => AwsCredentialIdentityProvider

Type declaration

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 getRetryAfterHint

getRetryAfterHint: (response: unknown) => Date | undefined

Type declaration

    • (response: unknown): Date | undefined

    • Parameters

      • response: unknown

      Returns Date | undefined

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: ChecksumConstructor | 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 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 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 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
deprecated

endpoints rulesets use @aws-sdk/middleware-endpoint resolveEndpointConfig. All generated clients should migrate to Endpoints 2.0 endpointRuleSet traits.

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 retryMiddleware

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

Type declaration

Const retryMiddlewareOptions

retryMiddlewareOptions: FinalizeRequestHandlerOptions & AbsoluteLocation

Const ruleSet

ruleSet: RuleSetObject

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 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 toUint8Array

toUint8Array: (data: string | ArrayBuffer | ArrayBufferView) => Uint8Array

Type declaration

    • (data: string | ArrayBuffer | ArrayBufferView): Uint8Array

    • Parameters

      • data: string | ArrayBuffer | ArrayBufferView

      Returns Uint8Array

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

Const defaultEndpointResolver

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

getSerdePlugin

isValidHostname

  • isValidHostname(hostname: string): boolean

  • Parameters

    • hostname: string

    Returns boolean

paginateListAccountRoles

paginateListAccounts

paginateListMediaCapturePipelines

paginateListMediaPipelines

Const resolveClientEndpointParameters

resolveHostHeaderConfig

resolveUserAgentConfig