We announced the upcoming end-of-support for AWS SDK for JavaScript v2.
We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Class: AWS.Config

Inherits:
Object
  • Object
show all
Defined in:
lib/config.js

Overview

The main configuration class used by all service objects to set the region, credentials, and other options for requests.

By default, credentials and region settings are left unconfigured. This should be configured by the application before using any AWS service APIs.

In order to set global configuration options, properties should be assigned to the global AWS.config object.

See Also:

Constructor Summary collapse

General Configuration Options collapse

Service-Specific Config Options collapse

Managing Credentials collapse

Loading and Setting Configuration Options collapse

Constructor Details

new AWS.Config(options) ⇒ void

Creates a new configuration object. This is the object that passes option data along to service requests, including credentials, security, region information, and some service specific settings.

config to true will enable endpoint discovery for all applicable operations. Setting it to false will explicitly disable endpoint discovery even though operations that require endpoint discovery will presumably fail. Leaving it to undefined means SDK will only do endpoint discovery when it's required. Defaults to undefined

Examples:

Creating a new configuration object with credentials and region

var config = new AWS.Config({
  accessKeyId: 'AKID', secretAccessKey: 'SECRET', region: 'us-west-2'
});

Options Hash (options):

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional')

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean)

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean)

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean)

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined)

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number)

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean)

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional')

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

  • useFipsEndpoint (Boolean)

    Enables FIPS compatible endpoints. Defaults to false.

  • useDualstackEndpoint (Boolean)

    Enables IPv6 dualstack endpoint. Defaults to false.

Property Details

accessanalyzerAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.AccessAnalyzer.

Examples:

Bind parameters to all newly created AccessAnalyzer objects

AWS.config.accessanalyzer = { params: { /* ... */ } };

Override default endpoint URI for all newly created AccessAnalyzer objects

AWS.config.accessanalyzer = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

accountAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.Account.

Examples:

Bind parameters to all newly created Account objects

AWS.config.account = { params: { /* ... */ } };

Override default endpoint URI for all newly created Account objects

AWS.config.account = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

acmAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.ACM.

Examples:

Bind parameters to all newly created ACM objects

AWS.config.acm = { params: { /* ... */ } };

Override default endpoint URI for all newly created ACM objects

AWS.config.acm = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

acmpcaAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.ACMPCA.

Examples:

Bind parameters to all newly created ACMPCA objects

AWS.config.acmpca = { params: { /* ... */ } };

Override default endpoint URI for all newly created ACMPCA objects

AWS.config.acmpca = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

ampAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.Amp.

Examples:

Bind parameters to all newly created Amp objects

AWS.config.amp = { params: { /* ... */ } };

Override default endpoint URI for all newly created Amp objects

AWS.config.amp = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

amplifyAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.Amplify.

Examples:

Bind parameters to all newly created Amplify objects

AWS.config.amplify = { params: { /* ... */ } };

Override default endpoint URI for all newly created Amplify objects

AWS.config.amplify = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

amplifybackendAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.AmplifyBackend.

Examples:

Bind parameters to all newly created AmplifyBackend objects

AWS.config.amplifybackend = { params: { /* ... */ } };

Override default endpoint URI for all newly created AmplifyBackend objects

AWS.config.amplifybackend = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

amplifyuibuilderAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.AmplifyUIBuilder.

Examples:

Bind parameters to all newly created AmplifyUIBuilder objects

AWS.config.amplifyuibuilder = { params: { /* ... */ } };

Override default endpoint URI for all newly created AmplifyUIBuilder objects

AWS.config.amplifyuibuilder = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

apigatewayAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.APIGateway.

Examples:

Bind parameters to all newly created APIGateway objects

AWS.config.apigateway = { params: { /* ... */ } };

Override default endpoint URI for all newly created APIGateway objects

AWS.config.apigateway = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

apigatewaymanagementapiAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.ApiGatewayManagementApi.

Examples:

Bind parameters to all newly created ApiGatewayManagementApi objects

AWS.config.apigatewaymanagementapi = { params: { /* ... */ } };

Override default endpoint URI for all newly created ApiGatewayManagementApi objects

AWS.config.apigatewaymanagementapi = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

apigatewayv2AWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.ApiGatewayV2.

Examples:

Bind parameters to all newly created ApiGatewayV2 objects

AWS.config.apigatewayv2 = { params: { /* ... */ } };

Override default endpoint URI for all newly created ApiGatewayV2 objects

AWS.config.apigatewayv2 = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

appconfigAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.AppConfig.

Examples:

Bind parameters to all newly created AppConfig objects

AWS.config.appconfig = { params: { /* ... */ } };

Override default endpoint URI for all newly created AppConfig objects

AWS.config.appconfig = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

appconfigdataAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.AppConfigData.

Examples:

Bind parameters to all newly created AppConfigData objects

AWS.config.appconfigdata = { params: { /* ... */ } };

Override default endpoint URI for all newly created AppConfigData objects

AWS.config.appconfigdata = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

appfabricAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.AppFabric.

Examples:

Bind parameters to all newly created AppFabric objects

AWS.config.appfabric = { params: { /* ... */ } };

Override default endpoint URI for all newly created AppFabric objects

AWS.config.appfabric = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

appflowAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.Appflow.

Examples:

Bind parameters to all newly created Appflow objects

AWS.config.appflow = { params: { /* ... */ } };

Override default endpoint URI for all newly created Appflow objects

AWS.config.appflow = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

appintegrationsAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.AppIntegrations.

Examples:

Bind parameters to all newly created AppIntegrations objects

AWS.config.appintegrations = { params: { /* ... */ } };

Override default endpoint URI for all newly created AppIntegrations objects

AWS.config.appintegrations = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

applicationautoscalingAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.ApplicationAutoScaling.

Examples:

Bind parameters to all newly created ApplicationAutoScaling objects

AWS.config.applicationautoscaling = { params: { /* ... */ } };

Override default endpoint URI for all newly created ApplicationAutoScaling objects

AWS.config.applicationautoscaling = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

applicationcostprofilerAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.ApplicationCostProfiler.

Examples:

Bind parameters to all newly created ApplicationCostProfiler objects

AWS.config.applicationcostprofiler = { params: { /* ... */ } };

Override default endpoint URI for all newly created ApplicationCostProfiler objects

AWS.config.applicationcostprofiler = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

applicationinsightsAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.ApplicationInsights.

Examples:

Bind parameters to all newly created ApplicationInsights objects

AWS.config.applicationinsights = { params: { /* ... */ } };

Override default endpoint URI for all newly created ApplicationInsights objects

AWS.config.applicationinsights = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

applicationsignalsAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.ApplicationSignals.

Examples:

Bind parameters to all newly created ApplicationSignals objects

AWS.config.applicationsignals = { params: { /* ... */ } };

Override default endpoint URI for all newly created ApplicationSignals objects

AWS.config.applicationsignals = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

appmeshAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.AppMesh.

Examples:

Bind parameters to all newly created AppMesh objects

AWS.config.appmesh = { params: { /* ... */ } };

Override default endpoint URI for all newly created AppMesh objects

AWS.config.appmesh = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

apprunnerAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.AppRunner.

Examples:

Bind parameters to all newly created AppRunner objects

AWS.config.apprunner = { params: { /* ... */ } };

Override default endpoint URI for all newly created AppRunner objects

AWS.config.apprunner = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

appstreamAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.AppStream.

Examples:

Bind parameters to all newly created AppStream objects

AWS.config.appstream = { params: { /* ... */ } };

Override default endpoint URI for all newly created AppStream objects

AWS.config.appstream = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

appsyncAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.AppSync.

Examples:

Bind parameters to all newly created AppSync objects

AWS.config.appsync = { params: { /* ... */ } };

Override default endpoint URI for all newly created AppSync objects

AWS.config.appsync = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

apptestAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.AppTest.

Examples:

Bind parameters to all newly created AppTest objects

AWS.config.apptest = { params: { /* ... */ } };

Override default endpoint URI for all newly created AppTest objects

AWS.config.apptest = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

arczonalshiftAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.ARCZonalShift.

Examples:

Bind parameters to all newly created ARCZonalShift objects

AWS.config.arczonalshift = { params: { /* ... */ } };

Override default endpoint URI for all newly created ARCZonalShift objects

AWS.config.arczonalshift = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

artifactAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.Artifact.

Examples:

Bind parameters to all newly created Artifact objects

AWS.config.artifact = { params: { /* ... */ } };

Override default endpoint URI for all newly created Artifact objects

AWS.config.artifact = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

athenaAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.Athena.

Examples:

Bind parameters to all newly created Athena objects

AWS.config.athena = { params: { /* ... */ } };

Override default endpoint URI for all newly created Athena objects

AWS.config.athena = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

auditmanagerAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.AuditManager.

Examples:

Bind parameters to all newly created AuditManager objects

AWS.config.auditmanager = { params: { /* ... */ } };

Override default endpoint URI for all newly created AuditManager objects

AWS.config.auditmanager = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

augmentedairuntimeAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.AugmentedAIRuntime.

Examples:

Bind parameters to all newly created AugmentedAIRuntime objects

AWS.config.augmentedairuntime = { params: { /* ... */ } };

Override default endpoint URI for all newly created AugmentedAIRuntime objects

AWS.config.augmentedairuntime = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

autoscalingAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.AutoScaling.

Examples:

Bind parameters to all newly created AutoScaling objects

AWS.config.autoscaling = { params: { /* ... */ } };

Override default endpoint URI for all newly created AutoScaling objects

AWS.config.autoscaling = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

autoscalingplansAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.AutoScalingPlans.

Examples:

Bind parameters to all newly created AutoScalingPlans objects

AWS.config.autoscalingplans = { params: { /* ... */ } };

Override default endpoint URI for all newly created AutoScalingPlans objects

AWS.config.autoscalingplans = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

b2biAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.B2bi.

Examples:

Bind parameters to all newly created B2bi objects

AWS.config.b2bi = { params: { /* ... */ } };

Override default endpoint URI for all newly created B2bi objects

AWS.config.b2bi = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

backupAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.Backup.

Examples:

Bind parameters to all newly created Backup objects

AWS.config.backup = { params: { /* ... */ } };

Override default endpoint URI for all newly created Backup objects

AWS.config.backup = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

backupgatewayAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.BackupGateway.

Examples:

Bind parameters to all newly created BackupGateway objects

AWS.config.backupgateway = { params: { /* ... */ } };

Override default endpoint URI for all newly created BackupGateway objects

AWS.config.backupgateway = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

batchAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.Batch.

Examples:

Bind parameters to all newly created Batch objects

AWS.config.batch = { params: { /* ... */ } };

Override default endpoint URI for all newly created Batch objects

AWS.config.batch = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

bcmdataexportsAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.BCMDataExports.

Examples:

Bind parameters to all newly created BCMDataExports objects

AWS.config.bcmdataexports = { params: { /* ... */ } };

Override default endpoint URI for all newly created BCMDataExports objects

AWS.config.bcmdataexports = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

bedrockAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.Bedrock.

Examples:

Bind parameters to all newly created Bedrock objects

AWS.config.bedrock = { params: { /* ... */ } };

Override default endpoint URI for all newly created Bedrock objects

AWS.config.bedrock = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

bedrockagentAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.BedrockAgent.

Examples:

Bind parameters to all newly created BedrockAgent objects

AWS.config.bedrockagent = { params: { /* ... */ } };

Override default endpoint URI for all newly created BedrockAgent objects

AWS.config.bedrockagent = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

bedrockagentruntimeAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.BedrockAgentRuntime.

Examples:

Bind parameters to all newly created BedrockAgentRuntime objects

AWS.config.bedrockagentruntime = { params: { /* ... */ } };

Override default endpoint URI for all newly created BedrockAgentRuntime objects

AWS.config.bedrockagentruntime = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

bedrockruntimeAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.BedrockRuntime.

Examples:

Bind parameters to all newly created BedrockRuntime objects

AWS.config.bedrockruntime = { params: { /* ... */ } };

Override default endpoint URI for all newly created BedrockRuntime objects

AWS.config.bedrockruntime = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

billingconductorAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.Billingconductor.

Examples:

Bind parameters to all newly created Billingconductor objects

AWS.config.billingconductor = { params: { /* ... */ } };

Override default endpoint URI for all newly created Billingconductor objects

AWS.config.billingconductor = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

braketAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.Braket.

Examples:

Bind parameters to all newly created Braket objects

AWS.config.braket = { params: { /* ... */ } };

Override default endpoint URI for all newly created Braket objects

AWS.config.braket = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

budgetsAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.Budgets.

Examples:

Bind parameters to all newly created Budgets objects

AWS.config.budgets = { params: { /* ... */ } };

Override default endpoint URI for all newly created Budgets objects

AWS.config.budgets = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

chatbotAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.Chatbot.

Examples:

Bind parameters to all newly created Chatbot objects

AWS.config.chatbot = { params: { /* ... */ } };

Override default endpoint URI for all newly created Chatbot objects

AWS.config.chatbot = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

chimeAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.Chime.

Examples:

Bind parameters to all newly created Chime objects

AWS.config.chime = { params: { /* ... */ } };

Override default endpoint URI for all newly created Chime objects

AWS.config.chime = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

chimesdkidentityAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.ChimeSDKIdentity.

Examples:

Bind parameters to all newly created ChimeSDKIdentity objects

AWS.config.chimesdkidentity = { params: { /* ... */ } };

Override default endpoint URI for all newly created ChimeSDKIdentity objects

AWS.config.chimesdkidentity = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

chimesdkmediapipelinesAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.ChimeSDKMediaPipelines.

Examples:

Bind parameters to all newly created ChimeSDKMediaPipelines objects

AWS.config.chimesdkmediapipelines = { params: { /* ... */ } };

Override default endpoint URI for all newly created ChimeSDKMediaPipelines objects

AWS.config.chimesdkmediapipelines = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

chimesdkmeetingsAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.ChimeSDKMeetings.

Examples:

Bind parameters to all newly created ChimeSDKMeetings objects

AWS.config.chimesdkmeetings = { params: { /* ... */ } };

Override default endpoint URI for all newly created ChimeSDKMeetings objects

AWS.config.chimesdkmeetings = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

chimesdkmessagingAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.ChimeSDKMessaging.

Examples:

Bind parameters to all newly created ChimeSDKMessaging objects

AWS.config.chimesdkmessaging = { params: { /* ... */ } };

Override default endpoint URI for all newly created ChimeSDKMessaging objects

AWS.config.chimesdkmessaging = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

chimesdkvoiceAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.ChimeSDKVoice.

Examples:

Bind parameters to all newly created ChimeSDKVoice objects

AWS.config.chimesdkvoice = { params: { /* ... */ } };

Override default endpoint URI for all newly created ChimeSDKVoice objects

AWS.config.chimesdkvoice = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

cleanroomsAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.CleanRooms.

Examples:

Bind parameters to all newly created CleanRooms objects

AWS.config.cleanrooms = { params: { /* ... */ } };

Override default endpoint URI for all newly created CleanRooms objects

AWS.config.cleanrooms = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

cleanroomsmlAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.CleanRoomsML.

Examples:

Bind parameters to all newly created CleanRoomsML objects

AWS.config.cleanroomsml = { params: { /* ... */ } };

Override default endpoint URI for all newly created CleanRoomsML objects

AWS.config.cleanroomsml = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

cloud9AWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.Cloud9.

Examples:

Bind parameters to all newly created Cloud9 objects

AWS.config.cloud9 = { params: { /* ... */ } };

Override default endpoint URI for all newly created Cloud9 objects

AWS.config.cloud9 = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

cloudcontrolAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.CloudControl.

Examples:

Bind parameters to all newly created CloudControl objects

AWS.config.cloudcontrol = { params: { /* ... */ } };

Override default endpoint URI for all newly created CloudControl objects

AWS.config.cloudcontrol = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

clouddirectoryAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.CloudDirectory.

Examples:

Bind parameters to all newly created CloudDirectory objects

AWS.config.clouddirectory = { params: { /* ... */ } };

Override default endpoint URI for all newly created CloudDirectory objects

AWS.config.clouddirectory = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

cloudformationAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.CloudFormation.

Examples:

Bind parameters to all newly created CloudFormation objects

AWS.config.cloudformation = { params: { /* ... */ } };

Override default endpoint URI for all newly created CloudFormation objects

AWS.config.cloudformation = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

cloudfrontAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.CloudFront.

Examples:

Bind parameters to all newly created CloudFront objects

AWS.config.cloudfront = { params: { /* ... */ } };

Override default endpoint URI for all newly created CloudFront objects

AWS.config.cloudfront = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

cloudhsmAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.CloudHSM.

Examples:

Bind parameters to all newly created CloudHSM objects

AWS.config.cloudhsm = { params: { /* ... */ } };

Override default endpoint URI for all newly created CloudHSM objects

AWS.config.cloudhsm = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

cloudhsmv2AWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.CloudHSMV2.

Examples:

Bind parameters to all newly created CloudHSMV2 objects

AWS.config.cloudhsmv2 = { params: { /* ... */ } };

Override default endpoint URI for all newly created CloudHSMV2 objects

AWS.config.cloudhsmv2 = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

cloudsearchAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.CloudSearch.

Examples:

Bind parameters to all newly created CloudSearch objects

AWS.config.cloudsearch = { params: { /* ... */ } };

Override default endpoint URI for all newly created CloudSearch objects

AWS.config.cloudsearch = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

cloudsearchdomainAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.CloudSearchDomain.

Examples:

Bind parameters to all newly created CloudSearchDomain objects

AWS.config.cloudsearchdomain = { params: { /* ... */ } };

Override default endpoint URI for all newly created CloudSearchDomain objects

AWS.config.cloudsearchdomain = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

cloudtrailAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.CloudTrail.

Examples:

Bind parameters to all newly created CloudTrail objects

AWS.config.cloudtrail = { params: { /* ... */ } };

Override default endpoint URI for all newly created CloudTrail objects

AWS.config.cloudtrail = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

cloudtraildataAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.CloudTrailData.

Examples:

Bind parameters to all newly created CloudTrailData objects

AWS.config.cloudtraildata = { params: { /* ... */ } };

Override default endpoint URI for all newly created CloudTrailData objects

AWS.config.cloudtraildata = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

cloudwatchAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.CloudWatch.

Examples:

Bind parameters to all newly created CloudWatch objects

AWS.config.cloudwatch = { params: { /* ... */ } };

Override default endpoint URI for all newly created CloudWatch objects

AWS.config.cloudwatch = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

cloudwatcheventsAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.CloudWatchEvents.

Examples:

Bind parameters to all newly created CloudWatchEvents objects

AWS.config.cloudwatchevents = { params: { /* ... */ } };

Override default endpoint URI for all newly created CloudWatchEvents objects

AWS.config.cloudwatchevents = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

cloudwatchlogsAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.CloudWatchLogs.

Examples:

Bind parameters to all newly created CloudWatchLogs objects

AWS.config.cloudwatchlogs = { params: { /* ... */ } };

Override default endpoint URI for all newly created CloudWatchLogs objects

AWS.config.cloudwatchlogs = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

codeartifactAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.CodeArtifact.

Examples:

Bind parameters to all newly created CodeArtifact objects

AWS.config.codeartifact = { params: { /* ... */ } };

Override default endpoint URI for all newly created CodeArtifact objects

AWS.config.codeartifact = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

codebuildAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.CodeBuild.

Examples:

Bind parameters to all newly created CodeBuild objects

AWS.config.codebuild = { params: { /* ... */ } };

Override default endpoint URI for all newly created CodeBuild objects

AWS.config.codebuild = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

codecatalystAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.CodeCatalyst.

Examples:

Bind parameters to all newly created CodeCatalyst objects

AWS.config.codecatalyst = { params: { /* ... */ } };

Override default endpoint URI for all newly created CodeCatalyst objects

AWS.config.codecatalyst = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

codecommitAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.CodeCommit.

Examples:

Bind parameters to all newly created CodeCommit objects

AWS.config.codecommit = { params: { /* ... */ } };

Override default endpoint URI for all newly created CodeCommit objects

AWS.config.codecommit = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

codeconnectionsAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.CodeConnections.

Examples:

Bind parameters to all newly created CodeConnections objects

AWS.config.codeconnections = { params: { /* ... */ } };

Override default endpoint URI for all newly created CodeConnections objects

AWS.config.codeconnections = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

codedeployAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.CodeDeploy.

Examples:

Bind parameters to all newly created CodeDeploy objects

AWS.config.codedeploy = { params: { /* ... */ } };

Override default endpoint URI for all newly created CodeDeploy objects

AWS.config.codedeploy = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

codeguruprofilerAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.CodeGuruProfiler.

Examples:

Bind parameters to all newly created CodeGuruProfiler objects

AWS.config.codeguruprofiler = { params: { /* ... */ } };

Override default endpoint URI for all newly created CodeGuruProfiler objects

AWS.config.codeguruprofiler = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

codegurureviewerAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.CodeGuruReviewer.

Examples:

Bind parameters to all newly created CodeGuruReviewer objects

AWS.config.codegurureviewer = { params: { /* ... */ } };

Override default endpoint URI for all newly created CodeGuruReviewer objects

AWS.config.codegurureviewer = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

codegurusecurityAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.CodeGuruSecurity.

Examples:

Bind parameters to all newly created CodeGuruSecurity objects

AWS.config.codegurusecurity = { params: { /* ... */ } };

Override default endpoint URI for all newly created CodeGuruSecurity objects

AWS.config.codegurusecurity = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

codepipelineAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.CodePipeline.

Examples:

Bind parameters to all newly created CodePipeline objects

AWS.config.codepipeline = { params: { /* ... */ } };

Override default endpoint URI for all newly created CodePipeline objects

AWS.config.codepipeline = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

codestarconnectionsAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.CodeStarconnections.

Examples:

Bind parameters to all newly created CodeStarconnections objects

AWS.config.codestarconnections = { params: { /* ... */ } };

Override default endpoint URI for all newly created CodeStarconnections objects

AWS.config.codestarconnections = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

codestarnotificationsAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.CodeStarNotifications.

Examples:

Bind parameters to all newly created CodeStarNotifications objects

AWS.config.codestarnotifications = { params: { /* ... */ } };

Override default endpoint URI for all newly created CodeStarNotifications objects

AWS.config.codestarnotifications = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

cognitoidentityAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.CognitoIdentity.

Examples:

Bind parameters to all newly created CognitoIdentity objects

AWS.config.cognitoidentity = { params: { /* ... */ } };

Override default endpoint URI for all newly created CognitoIdentity objects

AWS.config.cognitoidentity = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

cognitoidentityserviceproviderAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.CognitoIdentityServiceProvider.

Examples:

Bind parameters to all newly created CognitoIdentityServiceProvider objects

AWS.config.cognitoidentityserviceprovider = { params: { /* ... */ } };

Override default endpoint URI for all newly created CognitoIdentityServiceProvider objects

AWS.config.cognitoidentityserviceprovider = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

cognitosyncAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.CognitoSync.

Examples:

Bind parameters to all newly created CognitoSync objects

AWS.config.cognitosync = { params: { /* ... */ } };

Override default endpoint URI for all newly created CognitoSync objects

AWS.config.cognitosync = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

comprehendAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.Comprehend.

Examples:

Bind parameters to all newly created Comprehend objects

AWS.config.comprehend = { params: { /* ... */ } };

Override default endpoint URI for all newly created Comprehend objects

AWS.config.comprehend = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

comprehendmedicalAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.ComprehendMedical.

Examples:

Bind parameters to all newly created ComprehendMedical objects

AWS.config.comprehendmedical = { params: { /* ... */ } };

Override default endpoint URI for all newly created ComprehendMedical objects

AWS.config.comprehendmedical = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

computeChecksumsBoolean (readwrite)

Returns whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 and SQS only).

Returns:

  • (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 and SQS only).

computeoptimizerAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.ComputeOptimizer.

Examples:

Bind parameters to all newly created ComputeOptimizer objects

AWS.config.computeoptimizer = { params: { /* ... */ } };

Override default endpoint URI for all newly created ComputeOptimizer objects

AWS.config.computeoptimizer = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

configserviceAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.ConfigService.

Examples:

Bind parameters to all newly created ConfigService objects

AWS.config.configservice = { params: { /* ... */ } };

Override default endpoint URI for all newly created ConfigService objects

AWS.config.configservice = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

connectAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.Connect.

Examples:

Bind parameters to all newly created Connect objects

AWS.config.connect = { params: { /* ... */ } };

Override default endpoint URI for all newly created Connect objects

AWS.config.connect = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

connectcampaignsAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.ConnectCampaigns.

Examples:

Bind parameters to all newly created ConnectCampaigns objects

AWS.config.connectcampaigns = { params: { /* ... */ } };

Override default endpoint URI for all newly created ConnectCampaigns objects

AWS.config.connectcampaigns = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

connectcasesAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.ConnectCases.

Examples:

Bind parameters to all newly created ConnectCases objects

AWS.config.connectcases = { params: { /* ... */ } };

Override default endpoint URI for all newly created ConnectCases objects

AWS.config.connectcases = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

connectcontactlensAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.ConnectContactLens.

Examples:

Bind parameters to all newly created ConnectContactLens objects

AWS.config.connectcontactlens = { params: { /* ... */ } };

Override default endpoint URI for all newly created ConnectContactLens objects

AWS.config.connectcontactlens = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

connectparticipantAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.ConnectParticipant.

Examples:

Bind parameters to all newly created ConnectParticipant objects

AWS.config.connectparticipant = { params: { /* ... */ } };

Override default endpoint URI for all newly created ConnectParticipant objects

AWS.config.connectparticipant = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

controlcatalogAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.ControlCatalog.

Examples:

Bind parameters to all newly created ControlCatalog objects

AWS.config.controlcatalog = { params: { /* ... */ } };

Override default endpoint URI for all newly created ControlCatalog objects

AWS.config.controlcatalog = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

controltowerAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.ControlTower.

Examples:

Bind parameters to all newly created ControlTower objects

AWS.config.controltower = { params: { /* ... */ } };

Override default endpoint URI for all newly created ControlTower objects

AWS.config.controltower = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

convertResponseTypesBoolean (readwrite)

Returns whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

Returns:

  • (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

correctClockSkewBoolean (readwrite)

Returns whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

Returns:

  • (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

costexplorerAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.CostExplorer.

Examples:

Bind parameters to all newly created CostExplorer objects

AWS.config.costexplorer = { params: { /* ... */ } };

Override default endpoint URI for all newly created CostExplorer objects

AWS.config.costexplorer = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

costoptimizationhubAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.CostOptimizationHub.

Examples:

Bind parameters to all newly created CostOptimizationHub objects

AWS.config.costoptimizationhub = { params: { /* ... */ } };

Override default endpoint URI for all newly created CostOptimizationHub objects

AWS.config.costoptimizationhub = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

credentialsAWS.Credentials (readwrite)

Returns the AWS credentials to sign requests with.

Returns:

curAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.CUR.

Examples:

Bind parameters to all newly created CUR objects

AWS.config.cur = { params: { /* ... */ } };

Override default endpoint URI for all newly created CUR objects

AWS.config.cur = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

customerprofilesAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.CustomerProfiles.

Examples:

Bind parameters to all newly created CustomerProfiles objects

AWS.config.customerprofiles = { params: { /* ... */ } };

Override default endpoint URI for all newly created CustomerProfiles objects

AWS.config.customerprofiles = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

databrewAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.DataBrew.

Examples:

Bind parameters to all newly created DataBrew objects

AWS.config.databrew = { params: { /* ... */ } };

Override default endpoint URI for all newly created DataBrew objects

AWS.config.databrew = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

dataexchangeAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.DataExchange.

Examples:

Bind parameters to all newly created DataExchange objects

AWS.config.dataexchange = { params: { /* ... */ } };

Override default endpoint URI for all newly created DataExchange objects

AWS.config.dataexchange = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

datapipelineAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.DataPipeline.

Examples:

Bind parameters to all newly created DataPipeline objects

AWS.config.datapipeline = { params: { /* ... */ } };

Override default endpoint URI for all newly created DataPipeline objects

AWS.config.datapipeline = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

datasyncAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.DataSync.

Examples:

Bind parameters to all newly created DataSync objects

AWS.config.datasync = { params: { /* ... */ } };

Override default endpoint URI for all newly created DataSync objects

AWS.config.datasync = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

datazoneAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.DataZone.

Examples:

Bind parameters to all newly created DataZone objects

AWS.config.datazone = { params: { /* ... */ } };

Override default endpoint URI for all newly created DataZone objects

AWS.config.datazone = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

daxAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.DAX.

Examples:

Bind parameters to all newly created DAX objects

AWS.config.dax = { params: { /* ... */ } };

Override default endpoint URI for all newly created DAX objects

AWS.config.dax = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

deadlineAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.Deadline.

Examples:

Bind parameters to all newly created Deadline objects

AWS.config.deadline = { params: { /* ... */ } };

Override default endpoint URI for all newly created Deadline objects

AWS.config.deadline = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

detectiveAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.Detective.

Examples:

Bind parameters to all newly created Detective objects

AWS.config.detective = { params: { /* ... */ } };

Override default endpoint URI for all newly created Detective objects

AWS.config.detective = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

devicefarmAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.DeviceFarm.

Examples:

Bind parameters to all newly created DeviceFarm objects

AWS.config.devicefarm = { params: { /* ... */ } };

Override default endpoint URI for all newly created DeviceFarm objects

AWS.config.devicefarm = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

devopsguruAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.DevOpsGuru.

Examples:

Bind parameters to all newly created DevOpsGuru objects

AWS.config.devopsguru = { params: { /* ... */ } };

Override default endpoint URI for all newly created DevOpsGuru objects

AWS.config.devopsguru = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

directconnectAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.DirectConnect.

Examples:

Bind parameters to all newly created DirectConnect objects

AWS.config.directconnect = { params: { /* ... */ } };

Override default endpoint URI for all newly created DirectConnect objects

AWS.config.directconnect = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

directoryserviceAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.DirectoryService.

Examples:

Bind parameters to all newly created DirectoryService objects

AWS.config.directoryservice = { params: { /* ... */ } };

Override default endpoint URI for all newly created DirectoryService objects

AWS.config.directoryservice = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

discoveryAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.Discovery.

Examples:

Bind parameters to all newly created Discovery objects

AWS.config.discovery = { params: { /* ... */ } };

Override default endpoint URI for all newly created Discovery objects

AWS.config.discovery = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

dlmAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.DLM.

Examples:

Bind parameters to all newly created DLM objects

AWS.config.dlm = { params: { /* ... */ } };

Override default endpoint URI for all newly created DLM objects

AWS.config.dlm = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

dmsAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.DMS.

Examples:

Bind parameters to all newly created DMS objects

AWS.config.dms = { params: { /* ... */ } };

Override default endpoint URI for all newly created DMS objects

AWS.config.dms = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

docdbAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.DocDB.

Examples:

Bind parameters to all newly created DocDB objects

AWS.config.docdb = { params: { /* ... */ } };

Override default endpoint URI for all newly created DocDB objects

AWS.config.docdb = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

docdbelasticAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.DocDBElastic.

Examples:

Bind parameters to all newly created DocDBElastic objects

AWS.config.docdbelastic = { params: { /* ... */ } };

Override default endpoint URI for all newly created DocDBElastic objects

AWS.config.docdbelastic = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

drsAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.Drs.

Examples:

Bind parameters to all newly created Drs objects

AWS.config.drs = { params: { /* ... */ } };

Override default endpoint URI for all newly created Drs objects

AWS.config.drs = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

dynamodbAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.DynamoDB.

Examples:

Bind parameters to all newly created DynamoDB objects

AWS.config.dynamodb = { params: { /* ... */ } };

Override default endpoint URI for all newly created DynamoDB objects

AWS.config.dynamodb = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

dynamodbstreamsAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.DynamoDBStreams.

Examples:

Bind parameters to all newly created DynamoDBStreams objects

AWS.config.dynamodbstreams = { params: { /* ... */ } };

Override default endpoint URI for all newly created DynamoDBStreams objects

AWS.config.dynamodbstreams = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

ebsAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.EBS.

Examples:

Bind parameters to all newly created EBS objects

AWS.config.ebs = { params: { /* ... */ } };

Override default endpoint URI for all newly created EBS objects

AWS.config.ebs = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

ec2AWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.EC2.

Examples:

Bind parameters to all newly created EC2 objects

AWS.config.ec2 = { params: { /* ... */ } };

Override default endpoint URI for all newly created EC2 objects

AWS.config.ec2 = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

ec2instanceconnectAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.EC2InstanceConnect.

Examples:

Bind parameters to all newly created EC2InstanceConnect objects

AWS.config.ec2instanceconnect = { params: { /* ... */ } };

Override default endpoint URI for all newly created EC2InstanceConnect objects

AWS.config.ec2instanceconnect = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

ecrAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.ECR.

Examples:

Bind parameters to all newly created ECR objects

AWS.config.ecr = { params: { /* ... */ } };

Override default endpoint URI for all newly created ECR objects

AWS.config.ecr = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

ecrpublicAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.ECRPUBLIC.

Examples:

Bind parameters to all newly created ECRPUBLIC objects

AWS.config.ecrpublic = { params: { /* ... */ } };

Override default endpoint URI for all newly created ECRPUBLIC objects

AWS.config.ecrpublic = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

ecsAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.ECS.

Examples:

Bind parameters to all newly created ECS objects

AWS.config.ecs = { params: { /* ... */ } };

Override default endpoint URI for all newly created ECS objects

AWS.config.ecs = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

efsAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.EFS.

Examples:

Bind parameters to all newly created EFS objects

AWS.config.efs = { params: { /* ... */ } };

Override default endpoint URI for all newly created EFS objects

AWS.config.efs = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

eksAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.EKS.

Examples:

Bind parameters to all newly created EKS objects

AWS.config.eks = { params: { /* ... */ } };

Override default endpoint URI for all newly created EKS objects

AWS.config.eks = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

eksauthAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.EKSAuth.

Examples:

Bind parameters to all newly created EKSAuth objects

AWS.config.eksauth = { params: { /* ... */ } };

Override default endpoint URI for all newly created EKSAuth objects

AWS.config.eksauth = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

elasticacheAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.ElastiCache.

Examples:

Bind parameters to all newly created ElastiCache objects

AWS.config.elasticache = { params: { /* ... */ } };

Override default endpoint URI for all newly created ElastiCache objects

AWS.config.elasticache = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

elasticbeanstalkAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.ElasticBeanstalk.

Examples:

Bind parameters to all newly created ElasticBeanstalk objects

AWS.config.elasticbeanstalk = { params: { /* ... */ } };

Override default endpoint URI for all newly created ElasticBeanstalk objects

AWS.config.elasticbeanstalk = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

elasticinferenceAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.ElasticInference.

Examples:

Bind parameters to all newly created ElasticInference objects

AWS.config.elasticinference = { params: { /* ... */ } };

Override default endpoint URI for all newly created ElasticInference objects

AWS.config.elasticinference = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

elastictranscoderAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.ElasticTranscoder.

Examples:

Bind parameters to all newly created ElasticTranscoder objects

AWS.config.elastictranscoder = { params: { /* ... */ } };

Override default endpoint URI for all newly created ElasticTranscoder objects

AWS.config.elastictranscoder = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

elbAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.ELB.

Examples:

Bind parameters to all newly created ELB objects

AWS.config.elb = { params: { /* ... */ } };

Override default endpoint URI for all newly created ELB objects

AWS.config.elb = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

elbv2AWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.ELBv2.

Examples:

Bind parameters to all newly created ELBv2 objects

AWS.config.elbv2 = { params: { /* ... */ } };

Override default endpoint URI for all newly created ELBv2 objects

AWS.config.elbv2 = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

emrAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.EMR.

Examples:

Bind parameters to all newly created EMR objects

AWS.config.emr = { params: { /* ... */ } };

Override default endpoint URI for all newly created EMR objects

AWS.config.emr = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

emrcontainersAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.EMRcontainers.

Examples:

Bind parameters to all newly created EMRcontainers objects

AWS.config.emrcontainers = { params: { /* ... */ } };

Override default endpoint URI for all newly created EMRcontainers objects

AWS.config.emrcontainers = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

emrserverlessAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.EMRServerless.

Examples:

Bind parameters to all newly created EMRServerless objects

AWS.config.emrserverless = { params: { /* ... */ } };

Override default endpoint URI for all newly created EMRServerless objects

AWS.config.emrserverless = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

endpointCacheSizeNumber (readwrite)

Returns the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000.

Returns:

  • (Number)

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

endpointDiscoveryEnabledBoolean|undefined (readwrite)

Returns whether to call operations with endpoints given by service dynamically. Setting this config to true will enable endpoint discovery for all applicable operations. Setting it to false will explicitly disable endpoint discovery even though operations that require endpoint discovery will presumably fail. Leaving it to undefined means SDK only do endpoint discovery when it's required. Defaults to undefined.

Returns:

  • (Boolean|undefined)

    whether to call operations with endpoints given by service dynamically. Setting this config to true will enable endpoint discovery for all applicable operations. Setting it to false will explicitly disable endpoint discovery even though operations that require endpoint discovery will presumably fail. Leaving it to undefined means SDK only do endpoint discovery when it's required. Defaults to undefined

entityresolutionAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.EntityResolution.

Examples:

Bind parameters to all newly created EntityResolution objects

AWS.config.entityresolution = { params: { /* ... */ } };

Override default endpoint URI for all newly created EntityResolution objects

AWS.config.entityresolution = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

esAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.ES.

Examples:

Bind parameters to all newly created ES objects

AWS.config.es = { params: { /* ... */ } };

Override default endpoint URI for all newly created ES objects

AWS.config.es = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

eventbridgeAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.EventBridge.

Examples:

Bind parameters to all newly created EventBridge objects

AWS.config.eventbridge = { params: { /* ... */ } };

Override default endpoint URI for all newly created EventBridge objects

AWS.config.eventbridge = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

evidentlyAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.Evidently.

Examples:

Bind parameters to all newly created Evidently objects

AWS.config.evidently = { params: { /* ... */ } };

Override default endpoint URI for all newly created Evidently objects

AWS.config.evidently = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

finspaceAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.Finspace.

Examples:

Bind parameters to all newly created Finspace objects

AWS.config.finspace = { params: { /* ... */ } };

Override default endpoint URI for all newly created Finspace objects

AWS.config.finspace = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

finspacedataAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.Finspacedata.

Examples:

Bind parameters to all newly created Finspacedata objects

AWS.config.finspacedata = { params: { /* ... */ } };

Override default endpoint URI for all newly created Finspacedata objects

AWS.config.finspacedata = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

firehoseAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.Firehose.

Examples:

Bind parameters to all newly created Firehose objects

AWS.config.firehose = { params: { /* ... */ } };

Override default endpoint URI for all newly created Firehose objects

AWS.config.firehose = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

fisAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.Fis.

Examples:

Bind parameters to all newly created Fis objects

AWS.config.fis = { params: { /* ... */ } };

Override default endpoint URI for all newly created Fis objects

AWS.config.fis = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

fmsAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.FMS.

Examples:

Bind parameters to all newly created FMS objects

AWS.config.fms = { params: { /* ... */ } };

Override default endpoint URI for all newly created FMS objects

AWS.config.fms = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

forecastqueryserviceAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.ForecastQueryService.

Examples:

Bind parameters to all newly created ForecastQueryService objects

AWS.config.forecastqueryservice = { params: { /* ... */ } };

Override default endpoint URI for all newly created ForecastQueryService objects

AWS.config.forecastqueryservice = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

forecastserviceAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.ForecastService.

Examples:

Bind parameters to all newly created ForecastService objects

AWS.config.forecastservice = { params: { /* ... */ } };

Override default endpoint URI for all newly created ForecastService objects

AWS.config.forecastservice = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

frauddetectorAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.FraudDetector.

Examples:

Bind parameters to all newly created FraudDetector objects

AWS.config.frauddetector = { params: { /* ... */ } };

Override default endpoint URI for all newly created FraudDetector objects

AWS.config.frauddetector = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

freetierAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.FreeTier.

Examples:

Bind parameters to all newly created FreeTier objects

AWS.config.freetier = { params: { /* ... */ } };

Override default endpoint URI for all newly created FreeTier objects

AWS.config.freetier = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

fsxAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.FSx.

Examples:

Bind parameters to all newly created FSx objects

AWS.config.fsx = { params: { /* ... */ } };

Override default endpoint URI for all newly created FSx objects

AWS.config.fsx = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

gameliftAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.GameLift.

Examples:

Bind parameters to all newly created GameLift objects

AWS.config.gamelift = { params: { /* ... */ } };

Override default endpoint URI for all newly created GameLift objects

AWS.config.gamelift = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

glacierAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.Glacier.

Examples:

Bind parameters to all newly created Glacier objects

AWS.config.glacier = { params: { /* ... */ } };

Override default endpoint URI for all newly created Glacier objects

AWS.config.glacier = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

globalacceleratorAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.GlobalAccelerator.

Examples:

Bind parameters to all newly created GlobalAccelerator objects

AWS.config.globalaccelerator = { params: { /* ... */ } };

Override default endpoint URI for all newly created GlobalAccelerator objects

AWS.config.globalaccelerator = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

glueAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.Glue.

Examples:

Bind parameters to all newly created Glue objects

AWS.config.glue = { params: { /* ... */ } };

Override default endpoint URI for all newly created Glue objects

AWS.config.glue = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

grafanaAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.Grafana.

Examples:

Bind parameters to all newly created Grafana objects

AWS.config.grafana = { params: { /* ... */ } };

Override default endpoint URI for all newly created Grafana objects

AWS.config.grafana = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

greengrassAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.Greengrass.

Examples:

Bind parameters to all newly created Greengrass objects

AWS.config.greengrass = { params: { /* ... */ } };

Override default endpoint URI for all newly created Greengrass objects

AWS.config.greengrass = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

greengrassv2AWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.GreengrassV2.

Examples:

Bind parameters to all newly created GreengrassV2 objects

AWS.config.greengrassv2 = { params: { /* ... */ } };

Override default endpoint URI for all newly created GreengrassV2 objects

AWS.config.greengrassv2 = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

groundstationAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.GroundStation.

Examples:

Bind parameters to all newly created GroundStation objects

AWS.config.groundstation = { params: { /* ... */ } };

Override default endpoint URI for all newly created GroundStation objects

AWS.config.groundstation = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

guarddutyAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.GuardDuty.

Examples:

Bind parameters to all newly created GuardDuty objects

AWS.config.guardduty = { params: { /* ... */ } };

Override default endpoint URI for all newly created GuardDuty objects

AWS.config.guardduty = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

healthAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.Health.

Examples:

Bind parameters to all newly created Health objects

AWS.config.health = { params: { /* ... */ } };

Override default endpoint URI for all newly created Health objects

AWS.config.health = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

healthlakeAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.HealthLake.

Examples:

Bind parameters to all newly created HealthLake objects

AWS.config.healthlake = { params: { /* ... */ } };

Override default endpoint URI for all newly created HealthLake objects

AWS.config.healthlake = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

hostPrefixEnabledBoolean (readwrite)

Returns whether to marshal request parameters to the prefix of hostname. Defaults to true.

Returns:

  • (Boolean)

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

httpOptionsmap (readwrite)

Returns A set of options to pass to the low-level HTTP request. Currently supported options are:

  • proxy [String] — the URL to proxy requests through
  • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only supported in the Node.js environment.
  • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
  • timeout [Integer] — The number of milliseconds a request can take before automatically being terminated. Defaults to two minutes (120000).
  • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
  • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.

Returns:

  • (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only supported in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — The number of milliseconds a request can take before automatically being terminated. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.

iamAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.IAM.

Examples:

Bind parameters to all newly created IAM objects

AWS.config.iam = { params: { /* ... */ } };

Override default endpoint URI for all newly created IAM objects

AWS.config.iam = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

identitystoreAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.IdentityStore.

Examples:

Bind parameters to all newly created IdentityStore objects

AWS.config.identitystore = { params: { /* ... */ } };

Override default endpoint URI for all newly created IdentityStore objects

AWS.config.identitystore = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

imagebuilderAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.Imagebuilder.

Examples:

Bind parameters to all newly created Imagebuilder objects

AWS.config.imagebuilder = { params: { /* ... */ } };

Override default endpoint URI for all newly created Imagebuilder objects

AWS.config.imagebuilder = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

importexportAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.ImportExport.

Examples:

Bind parameters to all newly created ImportExport objects

AWS.config.importexport = { params: { /* ... */ } };

Override default endpoint URI for all newly created ImportExport objects

AWS.config.importexport = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

inspectorAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.Inspector.

Examples:

Bind parameters to all newly created Inspector objects

AWS.config.inspector = { params: { /* ... */ } };

Override default endpoint URI for all newly created Inspector objects

AWS.config.inspector = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

inspector2AWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.Inspector2.

Examples:

Bind parameters to all newly created Inspector2 objects

AWS.config.inspector2 = { params: { /* ... */ } };

Override default endpoint URI for all newly created Inspector2 objects

AWS.config.inspector2 = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

inspectorscanAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.InspectorScan.

Examples:

Bind parameters to all newly created InspectorScan objects

AWS.config.inspectorscan = { params: { /* ... */ } };

Override default endpoint URI for all newly created InspectorScan objects

AWS.config.inspectorscan = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

internetmonitorAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.InternetMonitor.

Examples:

Bind parameters to all newly created InternetMonitor objects

AWS.config.internetmonitor = { params: { /* ... */ } };

Override default endpoint URI for all newly created InternetMonitor objects

AWS.config.internetmonitor = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

iotAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.Iot.

Examples:

Bind parameters to all newly created Iot objects

AWS.config.iot = { params: { /* ... */ } };

Override default endpoint URI for all newly created Iot objects

AWS.config.iot = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

iot1clickdevicesserviceAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.IoT1ClickDevicesService.

Examples:

Bind parameters to all newly created IoT1ClickDevicesService objects

AWS.config.iot1clickdevicesservice = { params: { /* ... */ } };

Override default endpoint URI for all newly created IoT1ClickDevicesService objects

AWS.config.iot1clickdevicesservice = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

iot1clickprojectsAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.IoT1ClickProjects.

Examples:

Bind parameters to all newly created IoT1ClickProjects objects

AWS.config.iot1clickprojects = { params: { /* ... */ } };

Override default endpoint URI for all newly created IoT1ClickProjects objects

AWS.config.iot1clickprojects = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

iotanalyticsAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.IoTAnalytics.

Examples:

Bind parameters to all newly created IoTAnalytics objects

AWS.config.iotanalytics = { params: { /* ... */ } };

Override default endpoint URI for all newly created IoTAnalytics objects

AWS.config.iotanalytics = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

iotdataAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.IotData.

Examples:

Bind parameters to all newly created IotData objects

AWS.config.iotdata = { params: { /* ... */ } };

Override default endpoint URI for all newly created IotData objects

AWS.config.iotdata = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

iotdeviceadvisorAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.IotDeviceAdvisor.

Examples:

Bind parameters to all newly created IotDeviceAdvisor objects

AWS.config.iotdeviceadvisor = { params: { /* ... */ } };

Override default endpoint URI for all newly created IotDeviceAdvisor objects

AWS.config.iotdeviceadvisor = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

ioteventsAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.IoTEvents.

Examples:

Bind parameters to all newly created IoTEvents objects

AWS.config.iotevents = { params: { /* ... */ } };

Override default endpoint URI for all newly created IoTEvents objects

AWS.config.iotevents = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

ioteventsdataAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.IoTEventsData.

Examples:

Bind parameters to all newly created IoTEventsData objects

AWS.config.ioteventsdata = { params: { /* ... */ } };

Override default endpoint URI for all newly created IoTEventsData objects

AWS.config.ioteventsdata = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

iotfleethubAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.IoTFleetHub.

Examples:

Bind parameters to all newly created IoTFleetHub objects

AWS.config.iotfleethub = { params: { /* ... */ } };

Override default endpoint URI for all newly created IoTFleetHub objects

AWS.config.iotfleethub = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

iotfleetwiseAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.IoTFleetWise.

Examples:

Bind parameters to all newly created IoTFleetWise objects

AWS.config.iotfleetwise = { params: { /* ... */ } };

Override default endpoint URI for all newly created IoTFleetWise objects

AWS.config.iotfleetwise = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

iotjobsdataplaneAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.IoTJobsDataPlane.

Examples:

Bind parameters to all newly created IoTJobsDataPlane objects

AWS.config.iotjobsdataplane = { params: { /* ... */ } };

Override default endpoint URI for all newly created IoTJobsDataPlane objects

AWS.config.iotjobsdataplane = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

iotsecuretunnelingAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.IoTSecureTunneling.

Examples:

Bind parameters to all newly created IoTSecureTunneling objects

AWS.config.iotsecuretunneling = { params: { /* ... */ } };

Override default endpoint URI for all newly created IoTSecureTunneling objects

AWS.config.iotsecuretunneling = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

iotsitewiseAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.IoTSiteWise.

Examples:

Bind parameters to all newly created IoTSiteWise objects

AWS.config.iotsitewise = { params: { /* ... */ } };

Override default endpoint URI for all newly created IoTSiteWise objects

AWS.config.iotsitewise = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

iotthingsgraphAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.IoTThingsGraph.

Examples:

Bind parameters to all newly created IoTThingsGraph objects

AWS.config.iotthingsgraph = { params: { /* ... */ } };

Override default endpoint URI for all newly created IoTThingsGraph objects

AWS.config.iotthingsgraph = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

iottwinmakerAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.IoTTwinMaker.

Examples:

Bind parameters to all newly created IoTTwinMaker objects

AWS.config.iottwinmaker = { params: { /* ... */ } };

Override default endpoint URI for all newly created IoTTwinMaker objects

AWS.config.iottwinmaker = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

iotwirelessAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.IoTWireless.

Examples:

Bind parameters to all newly created IoTWireless objects

AWS.config.iotwireless = { params: { /* ... */ } };

Override default endpoint URI for all newly created IoTWireless objects

AWS.config.iotwireless = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

ivsAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.IVS.

Examples:

Bind parameters to all newly created IVS objects

AWS.config.ivs = { params: { /* ... */ } };

Override default endpoint URI for all newly created IVS objects

AWS.config.ivs = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

ivschatAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.Ivschat.

Examples:

Bind parameters to all newly created Ivschat objects

AWS.config.ivschat = { params: { /* ... */ } };

Override default endpoint URI for all newly created Ivschat objects

AWS.config.ivschat = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

ivsrealtimeAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.IVSRealTime.

Examples:

Bind parameters to all newly created IVSRealTime objects

AWS.config.ivsrealtime = { params: { /* ... */ } };

Override default endpoint URI for all newly created IVSRealTime objects

AWS.config.ivsrealtime = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

kafkaAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.Kafka.

Examples:

Bind parameters to all newly created Kafka objects

AWS.config.kafka = { params: { /* ... */ } };

Override default endpoint URI for all newly created Kafka objects

AWS.config.kafka = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

kafkaconnectAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.KafkaConnect.

Examples:

Bind parameters to all newly created KafkaConnect objects

AWS.config.kafkaconnect = { params: { /* ... */ } };

Override default endpoint URI for all newly created KafkaConnect objects

AWS.config.kafkaconnect = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

kendraAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.Kendra.

Examples:

Bind parameters to all newly created Kendra objects

AWS.config.kendra = { params: { /* ... */ } };

Override default endpoint URI for all newly created Kendra objects

AWS.config.kendra = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

kendrarankingAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.KendraRanking.

Examples:

Bind parameters to all newly created KendraRanking objects

AWS.config.kendraranking = { params: { /* ... */ } };

Override default endpoint URI for all newly created KendraRanking objects

AWS.config.kendraranking = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

keyspacesAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.Keyspaces.

Examples:

Bind parameters to all newly created Keyspaces objects

AWS.config.keyspaces = { params: { /* ... */ } };

Override default endpoint URI for all newly created Keyspaces objects

AWS.config.keyspaces = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

kinesisAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.Kinesis.

Examples:

Bind parameters to all newly created Kinesis objects

AWS.config.kinesis = { params: { /* ... */ } };

Override default endpoint URI for all newly created Kinesis objects

AWS.config.kinesis = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

kinesisanalyticsAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.KinesisAnalytics.

Examples:

Bind parameters to all newly created KinesisAnalytics objects

AWS.config.kinesisanalytics = { params: { /* ... */ } };

Override default endpoint URI for all newly created KinesisAnalytics objects

AWS.config.kinesisanalytics = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

kinesisanalyticsv2AWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.KinesisAnalyticsV2.

Examples:

Bind parameters to all newly created KinesisAnalyticsV2 objects

AWS.config.kinesisanalyticsv2 = { params: { /* ... */ } };

Override default endpoint URI for all newly created KinesisAnalyticsV2 objects

AWS.config.kinesisanalyticsv2 = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

kinesisvideoAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.KinesisVideo.

Examples:

Bind parameters to all newly created KinesisVideo objects

AWS.config.kinesisvideo = { params: { /* ... */ } };

Override default endpoint URI for all newly created KinesisVideo objects

AWS.config.kinesisvideo = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

kinesisvideoarchivedmediaAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.KinesisVideoArchivedMedia.

Examples:

Bind parameters to all newly created KinesisVideoArchivedMedia objects

AWS.config.kinesisvideoarchivedmedia = { params: { /* ... */ } };

Override default endpoint URI for all newly created KinesisVideoArchivedMedia objects

AWS.config.kinesisvideoarchivedmedia = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

kinesisvideomediaAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.KinesisVideoMedia.

Examples:

Bind parameters to all newly created KinesisVideoMedia objects

AWS.config.kinesisvideomedia = { params: { /* ... */ } };

Override default endpoint URI for all newly created KinesisVideoMedia objects

AWS.config.kinesisvideomedia = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

kinesisvideosignalingchannelsAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.KinesisVideoSignalingChannels.

Examples:

Bind parameters to all newly created KinesisVideoSignalingChannels objects

AWS.config.kinesisvideosignalingchannels = { params: { /* ... */ } };

Override default endpoint URI for all newly created KinesisVideoSignalingChannels objects

AWS.config.kinesisvideosignalingchannels = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

kinesisvideowebrtcstorageAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.KinesisVideoWebRTCStorage.

Examples:

Bind parameters to all newly created KinesisVideoWebRTCStorage objects

AWS.config.kinesisvideowebrtcstorage = { params: { /* ... */ } };

Override default endpoint URI for all newly created KinesisVideoWebRTCStorage objects

AWS.config.kinesisvideowebrtcstorage = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

kmsAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.KMS.

Examples:

Bind parameters to all newly created KMS objects

AWS.config.kms = { params: { /* ... */ } };

Override default endpoint URI for all newly created KMS objects

AWS.config.kms = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

lakeformationAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.LakeFormation.

Examples:

Bind parameters to all newly created LakeFormation objects

AWS.config.lakeformation = { params: { /* ... */ } };

Override default endpoint URI for all newly created LakeFormation objects

AWS.config.lakeformation = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

lambdaAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.Lambda.

Examples:

Bind parameters to all newly created Lambda objects

AWS.config.lambda = { params: { /* ... */ } };

Override default endpoint URI for all newly created Lambda objects

AWS.config.lambda = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

launchwizardAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.LaunchWizard.

Examples:

Bind parameters to all newly created LaunchWizard objects

AWS.config.launchwizard = { params: { /* ... */ } };

Override default endpoint URI for all newly created LaunchWizard objects

AWS.config.launchwizard = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

lexmodelbuildingserviceAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.LexModelBuildingService.

Examples:

Bind parameters to all newly created LexModelBuildingService objects

AWS.config.lexmodelbuildingservice = { params: { /* ... */ } };

Override default endpoint URI for all newly created LexModelBuildingService objects

AWS.config.lexmodelbuildingservice = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

lexmodelsv2AWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.LexModelsV2.

Examples:

Bind parameters to all newly created LexModelsV2 objects

AWS.config.lexmodelsv2 = { params: { /* ... */ } };

Override default endpoint URI for all newly created LexModelsV2 objects

AWS.config.lexmodelsv2 = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

lexruntimeAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.LexRuntime.

Examples:

Bind parameters to all newly created LexRuntime objects

AWS.config.lexruntime = { params: { /* ... */ } };

Override default endpoint URI for all newly created LexRuntime objects

AWS.config.lexruntime = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

lexruntimev2AWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.LexRuntimeV2.

Examples:

Bind parameters to all newly created LexRuntimeV2 objects

AWS.config.lexruntimev2 = { params: { /* ... */ } };

Override default endpoint URI for all newly created LexRuntimeV2 objects

AWS.config.lexruntimev2 = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

licensemanagerAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.LicenseManager.

Examples:

Bind parameters to all newly created LicenseManager objects

AWS.config.licensemanager = { params: { /* ... */ } };

Override default endpoint URI for all newly created LicenseManager objects

AWS.config.licensemanager = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

licensemanagerlinuxsubscriptionsAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.LicenseManagerLinuxSubscriptions.

Examples:

Bind parameters to all newly created LicenseManagerLinuxSubscriptions objects

AWS.config.licensemanagerlinuxsubscriptions = { params: { /* ... */ } };

Override default endpoint URI for all newly created LicenseManagerLinuxSubscriptions objects

AWS.config.licensemanagerlinuxsubscriptions = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

licensemanagerusersubscriptionsAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.LicenseManagerUserSubscriptions.

Examples:

Bind parameters to all newly created LicenseManagerUserSubscriptions objects

AWS.config.licensemanagerusersubscriptions = { params: { /* ... */ } };

Override default endpoint URI for all newly created LicenseManagerUserSubscriptions objects

AWS.config.licensemanagerusersubscriptions = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

lightsailAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.Lightsail.

Examples:

Bind parameters to all newly created Lightsail objects

AWS.config.lightsail = { params: { /* ... */ } };

Override default endpoint URI for all newly created Lightsail objects

AWS.config.lightsail = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

locationAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.Location.

Examples:

Bind parameters to all newly created Location objects

AWS.config.location = { params: { /* ... */ } };

Override default endpoint URI for all newly created Location objects

AWS.config.location = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

logger#write, #log (readwrite)

Returns an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests.

Returns:

  • (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

lookoutequipmentAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.LookoutEquipment.

Examples:

Bind parameters to all newly created LookoutEquipment objects

AWS.config.lookoutequipment = { params: { /* ... */ } };

Override default endpoint URI for all newly created LookoutEquipment objects

AWS.config.lookoutequipment = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

lookoutmetricsAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.LookoutMetrics.

Examples:

Bind parameters to all newly created LookoutMetrics objects

AWS.config.lookoutmetrics = { params: { /* ... */ } };

Override default endpoint URI for all newly created LookoutMetrics objects

AWS.config.lookoutmetrics = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

lookoutvisionAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.LookoutVision.

Examples:

Bind parameters to all newly created LookoutVision objects

AWS.config.lookoutvision = { params: { /* ... */ } };

Override default endpoint URI for all newly created LookoutVision objects

AWS.config.lookoutvision = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

m2AWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.M2.

Examples:

Bind parameters to all newly created M2 objects

AWS.config.m2 = { params: { /* ... */ } };

Override default endpoint URI for all newly created M2 objects

AWS.config.m2 = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

machinelearningAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.MachineLearning.

Examples:

Bind parameters to all newly created MachineLearning objects

AWS.config.machinelearning = { params: { /* ... */ } };

Override default endpoint URI for all newly created MachineLearning objects

AWS.config.machinelearning = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

macie2AWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.Macie2.

Examples:

Bind parameters to all newly created Macie2 objects

AWS.config.macie2 = { params: { /* ... */ } };

Override default endpoint URI for all newly created Macie2 objects

AWS.config.macie2 = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

mailmanagerAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.MailManager.

Examples:

Bind parameters to all newly created MailManager objects

AWS.config.mailmanager = { params: { /* ... */ } };

Override default endpoint URI for all newly created MailManager objects

AWS.config.mailmanager = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

managedblockchainAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.ManagedBlockchain.

Examples:

Bind parameters to all newly created ManagedBlockchain objects

AWS.config.managedblockchain = { params: { /* ... */ } };

Override default endpoint URI for all newly created ManagedBlockchain objects

AWS.config.managedblockchain = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

managedblockchainqueryAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.ManagedBlockchainQuery.

Examples:

Bind parameters to all newly created ManagedBlockchainQuery objects

AWS.config.managedblockchainquery = { params: { /* ... */ } };

Override default endpoint URI for all newly created ManagedBlockchainQuery objects

AWS.config.managedblockchainquery = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

marketplaceagreementAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.MarketplaceAgreement.

Examples:

Bind parameters to all newly created MarketplaceAgreement objects

AWS.config.marketplaceagreement = { params: { /* ... */ } };

Override default endpoint URI for all newly created MarketplaceAgreement objects

AWS.config.marketplaceagreement = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

marketplacecatalogAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.MarketplaceCatalog.

Examples:

Bind parameters to all newly created MarketplaceCatalog objects

AWS.config.marketplacecatalog = { params: { /* ... */ } };

Override default endpoint URI for all newly created MarketplaceCatalog objects

AWS.config.marketplacecatalog = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

marketplacecommerceanalyticsAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.MarketplaceCommerceAnalytics.

Examples:

Bind parameters to all newly created MarketplaceCommerceAnalytics objects

AWS.config.marketplacecommerceanalytics = { params: { /* ... */ } };

Override default endpoint URI for all newly created MarketplaceCommerceAnalytics objects

AWS.config.marketplacecommerceanalytics = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

marketplacedeploymentAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.MarketplaceDeployment.

Examples:

Bind parameters to all newly created MarketplaceDeployment objects

AWS.config.marketplacedeployment = { params: { /* ... */ } };

Override default endpoint URI for all newly created MarketplaceDeployment objects

AWS.config.marketplacedeployment = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

marketplaceentitlementserviceAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.MarketplaceEntitlementService.

Examples:

Bind parameters to all newly created MarketplaceEntitlementService objects

AWS.config.marketplaceentitlementservice = { params: { /* ... */ } };

Override default endpoint URI for all newly created MarketplaceEntitlementService objects

AWS.config.marketplaceentitlementservice = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

marketplacemeteringAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.MarketplaceMetering.

Examples:

Bind parameters to all newly created MarketplaceMetering objects

AWS.config.marketplacemetering = { params: { /* ... */ } };

Override default endpoint URI for all newly created MarketplaceMetering objects

AWS.config.marketplacemetering = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

maxRedirectsInteger (readwrite)

Returns the maximum amount of redirects to follow for a service request. Defaults to 10.

Returns:

  • (Integer)

    the maximum amount of redirects to follow for a service request. Defaults to 10.

maxRetriesInteger (readwrite)

Returns the maximum amount of retries to perform for a service request. By default this value is calculated by the specific service object that the request is being made to.

Returns:

  • (Integer)

    the maximum amount of retries to perform for a service request. By default this value is calculated by the specific service object that the request is being made to.

mediaconnectAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.MediaConnect.

Examples:

Bind parameters to all newly created MediaConnect objects

AWS.config.mediaconnect = { params: { /* ... */ } };

Override default endpoint URI for all newly created MediaConnect objects

AWS.config.mediaconnect = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

mediaconvertAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.MediaConvert.

Examples:

Bind parameters to all newly created MediaConvert objects

AWS.config.mediaconvert = { params: { /* ... */ } };

Override default endpoint URI for all newly created MediaConvert objects

AWS.config.mediaconvert = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

medialiveAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.MediaLive.

Examples:

Bind parameters to all newly created MediaLive objects

AWS.config.medialive = { params: { /* ... */ } };

Override default endpoint URI for all newly created MediaLive objects

AWS.config.medialive = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

mediapackageAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.MediaPackage.

Examples:

Bind parameters to all newly created MediaPackage objects

AWS.config.mediapackage = { params: { /* ... */ } };

Override default endpoint URI for all newly created MediaPackage objects

AWS.config.mediapackage = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

mediapackagev2AWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.MediaPackageV2.

Examples:

Bind parameters to all newly created MediaPackageV2 objects

AWS.config.mediapackagev2 = { params: { /* ... */ } };

Override default endpoint URI for all newly created MediaPackageV2 objects

AWS.config.mediapackagev2 = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

mediapackagevodAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.MediaPackageVod.

Examples:

Bind parameters to all newly created MediaPackageVod objects

AWS.config.mediapackagevod = { params: { /* ... */ } };

Override default endpoint URI for all newly created MediaPackageVod objects

AWS.config.mediapackagevod = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

mediastoreAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.MediaStore.

Examples:

Bind parameters to all newly created MediaStore objects

AWS.config.mediastore = { params: { /* ... */ } };

Override default endpoint URI for all newly created MediaStore objects

AWS.config.mediastore = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

mediastoredataAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.MediaStoreData.

Examples:

Bind parameters to all newly created MediaStoreData objects

AWS.config.mediastoredata = { params: { /* ... */ } };

Override default endpoint URI for all newly created MediaStoreData objects

AWS.config.mediastoredata = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

mediatailorAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.MediaTailor.

Examples:

Bind parameters to all newly created MediaTailor objects

AWS.config.mediatailor = { params: { /* ... */ } };

Override default endpoint URI for all newly created MediaTailor objects

AWS.config.mediatailor = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

medicalimagingAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.MedicalImaging.

Examples:

Bind parameters to all newly created MedicalImaging objects

AWS.config.medicalimaging = { params: { /* ... */ } };

Override default endpoint URI for all newly created MedicalImaging objects

AWS.config.medicalimaging = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

memorydbAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.MemoryDB.

Examples:

Bind parameters to all newly created MemoryDB objects

AWS.config.memorydb = { params: { /* ... */ } };

Override default endpoint URI for all newly created MemoryDB objects

AWS.config.memorydb = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

mgnAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.Mgn.

Examples:

Bind parameters to all newly created Mgn objects

AWS.config.mgn = { params: { /* ... */ } };

Override default endpoint URI for all newly created Mgn objects

AWS.config.mgn = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

migrationhubAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.MigrationHub.

Examples:

Bind parameters to all newly created MigrationHub objects

AWS.config.migrationhub = { params: { /* ... */ } };

Override default endpoint URI for all newly created MigrationHub objects

AWS.config.migrationhub = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

migrationhubconfigAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.MigrationHubConfig.

Examples:

Bind parameters to all newly created MigrationHubConfig objects

AWS.config.migrationhubconfig = { params: { /* ... */ } };

Override default endpoint URI for all newly created MigrationHubConfig objects

AWS.config.migrationhubconfig = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

migrationhuborchestratorAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.MigrationHubOrchestrator.

Examples:

Bind parameters to all newly created MigrationHubOrchestrator objects

AWS.config.migrationhuborchestrator = { params: { /* ... */ } };

Override default endpoint URI for all newly created MigrationHubOrchestrator objects

AWS.config.migrationhuborchestrator = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

migrationhubrefactorspacesAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.MigrationHubRefactorSpaces.

Examples:

Bind parameters to all newly created MigrationHubRefactorSpaces objects

AWS.config.migrationhubrefactorspaces = { params: { /* ... */ } };

Override default endpoint URI for all newly created MigrationHubRefactorSpaces objects

AWS.config.migrationhubrefactorspaces = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

migrationhubstrategyAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.MigrationHubStrategy.

Examples:

Bind parameters to all newly created MigrationHubStrategy objects

AWS.config.migrationhubstrategy = { params: { /* ... */ } };

Override default endpoint URI for all newly created MigrationHubStrategy objects

AWS.config.migrationhubstrategy = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

mobileanalyticsAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.MobileAnalytics.

Examples:

Bind parameters to all newly created MobileAnalytics objects

AWS.config.mobileanalytics = { params: { /* ... */ } };

Override default endpoint URI for all newly created MobileAnalytics objects

AWS.config.mobileanalytics = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

mqAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.MQ.

Examples:

Bind parameters to all newly created MQ objects

AWS.config.mq = { params: { /* ... */ } };

Override default endpoint URI for all newly created MQ objects

AWS.config.mq = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

mturkAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.MTurk.

Examples:

Bind parameters to all newly created MTurk objects

AWS.config.mturk = { params: { /* ... */ } };

Override default endpoint URI for all newly created MTurk objects

AWS.config.mturk = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

mwaaAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.MWAA.

Examples:

Bind parameters to all newly created MWAA objects

AWS.config.mwaa = { params: { /* ... */ } };

Override default endpoint URI for all newly created MWAA objects

AWS.config.mwaa = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

neptuneAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.Neptune.

Examples:

Bind parameters to all newly created Neptune objects

AWS.config.neptune = { params: { /* ... */ } };

Override default endpoint URI for all newly created Neptune objects

AWS.config.neptune = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

neptunedataAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.Neptunedata.

Examples:

Bind parameters to all newly created Neptunedata objects

AWS.config.neptunedata = { params: { /* ... */ } };

Override default endpoint URI for all newly created Neptunedata objects

AWS.config.neptunedata = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

networkfirewallAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.NetworkFirewall.

Examples:

Bind parameters to all newly created NetworkFirewall objects

AWS.config.networkfirewall = { params: { /* ... */ } };

Override default endpoint URI for all newly created NetworkFirewall objects

AWS.config.networkfirewall = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

networkmanagerAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.NetworkManager.

Examples:

Bind parameters to all newly created NetworkManager objects

AWS.config.networkmanager = { params: { /* ... */ } };

Override default endpoint URI for all newly created NetworkManager objects

AWS.config.networkmanager = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

networkmonitorAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.NetworkMonitor.

Examples:

Bind parameters to all newly created NetworkMonitor objects

AWS.config.networkmonitor = { params: { /* ... */ } };

Override default endpoint URI for all newly created NetworkMonitor objects

AWS.config.networkmonitor = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

nimbleAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.Nimble.

Examples:

Bind parameters to all newly created Nimble objects

AWS.config.nimble = { params: { /* ... */ } };

Override default endpoint URI for all newly created Nimble objects

AWS.config.nimble = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

oamAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.OAM.

Examples:

Bind parameters to all newly created OAM objects

AWS.config.oam = { params: { /* ... */ } };

Override default endpoint URI for all newly created OAM objects

AWS.config.oam = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

omicsAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.Omics.

Examples:

Bind parameters to all newly created Omics objects

AWS.config.omics = { params: { /* ... */ } };

Override default endpoint URI for all newly created Omics objects

AWS.config.omics = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

opensearchAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.OpenSearch.

Examples:

Bind parameters to all newly created OpenSearch objects

AWS.config.opensearch = { params: { /* ... */ } };

Override default endpoint URI for all newly created OpenSearch objects

AWS.config.opensearch = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

opensearchserverlessAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.OpenSearchServerless.

Examples:

Bind parameters to all newly created OpenSearchServerless objects

AWS.config.opensearchserverless = { params: { /* ... */ } };

Override default endpoint URI for all newly created OpenSearchServerless objects

AWS.config.opensearchserverless = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

opsworksAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.OpsWorks.

Examples:

Bind parameters to all newly created OpsWorks objects

AWS.config.opsworks = { params: { /* ... */ } };

Override default endpoint URI for all newly created OpsWorks objects

AWS.config.opsworks = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

opsworkscmAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.OpsWorksCM.

Examples:

Bind parameters to all newly created OpsWorksCM objects

AWS.config.opsworkscm = { params: { /* ... */ } };

Override default endpoint URI for all newly created OpsWorksCM objects

AWS.config.opsworkscm = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

organizationsAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.Organizations.

Examples:

Bind parameters to all newly created Organizations objects

AWS.config.organizations = { params: { /* ... */ } };

Override default endpoint URI for all newly created Organizations objects

AWS.config.organizations = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

osisAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.OSIS.

Examples:

Bind parameters to all newly created OSIS objects

AWS.config.osis = { params: { /* ... */ } };

Override default endpoint URI for all newly created OSIS objects

AWS.config.osis = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

outpostsAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.Outposts.

Examples:

Bind parameters to all newly created Outposts objects

AWS.config.outposts = { params: { /* ... */ } };

Override default endpoint URI for all newly created Outposts objects

AWS.config.outposts = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

panoramaAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.Panorama.

Examples:

Bind parameters to all newly created Panorama objects

AWS.config.panorama = { params: { /* ... */ } };

Override default endpoint URI for all newly created Panorama objects

AWS.config.panorama = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

paramValidationBoolean|map (readwrite)

Returns whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

  • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
  • max [Boolean] — Validates that a value meets the max constraint.
  • pattern [Boolean] — Validates that a string value matches a regular expression.
  • enum [Boolean] — Validates that a string value matches one of the allowable enum values.

Returns:

  • (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.

paymentcryptographyAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.PaymentCryptography.

Examples:

Bind parameters to all newly created PaymentCryptography objects

AWS.config.paymentcryptography = { params: { /* ... */ } };

Override default endpoint URI for all newly created PaymentCryptography objects

AWS.config.paymentcryptography = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

paymentcryptographydataAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.PaymentCryptographyData.

Examples:

Bind parameters to all newly created PaymentCryptographyData objects

AWS.config.paymentcryptographydata = { params: { /* ... */ } };

Override default endpoint URI for all newly created PaymentCryptographyData objects

AWS.config.paymentcryptographydata = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

pcaconnectoradAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.PcaConnectorAd.

Examples:

Bind parameters to all newly created PcaConnectorAd objects

AWS.config.pcaconnectorad = { params: { /* ... */ } };

Override default endpoint URI for all newly created PcaConnectorAd objects

AWS.config.pcaconnectorad = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

pcaconnectorscepAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.PcaConnectorScep.

Examples:

Bind parameters to all newly created PcaConnectorScep objects

AWS.config.pcaconnectorscep = { params: { /* ... */ } };

Override default endpoint URI for all newly created PcaConnectorScep objects

AWS.config.pcaconnectorscep = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

pcsAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.PCS.

Examples:

Bind parameters to all newly created PCS objects

AWS.config.pcs = { params: { /* ... */ } };

Override default endpoint URI for all newly created PCS objects

AWS.config.pcs = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

personalizeAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.Personalize.

Examples:

Bind parameters to all newly created Personalize objects

AWS.config.personalize = { params: { /* ... */ } };

Override default endpoint URI for all newly created Personalize objects

AWS.config.personalize = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

personalizeeventsAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.PersonalizeEvents.

Examples:

Bind parameters to all newly created PersonalizeEvents objects

AWS.config.personalizeevents = { params: { /* ... */ } };

Override default endpoint URI for all newly created PersonalizeEvents objects

AWS.config.personalizeevents = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

personalizeruntimeAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.PersonalizeRuntime.

Examples:

Bind parameters to all newly created PersonalizeRuntime objects

AWS.config.personalizeruntime = { params: { /* ... */ } };

Override default endpoint URI for all newly created PersonalizeRuntime objects

AWS.config.personalizeruntime = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

piAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.PI.

Examples:

Bind parameters to all newly created PI objects

AWS.config.pi = { params: { /* ... */ } };

Override default endpoint URI for all newly created PI objects

AWS.config.pi = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

pinpointAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.Pinpoint.

Examples:

Bind parameters to all newly created Pinpoint objects

AWS.config.pinpoint = { params: { /* ... */ } };

Override default endpoint URI for all newly created Pinpoint objects

AWS.config.pinpoint = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

pinpointemailAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.PinpointEmail.

Examples:

Bind parameters to all newly created PinpointEmail objects

AWS.config.pinpointemail = { params: { /* ... */ } };

Override default endpoint URI for all newly created PinpointEmail objects

AWS.config.pinpointemail = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

pinpointsmsvoiceAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.PinpointSMSVoice.

Examples:

Bind parameters to all newly created PinpointSMSVoice objects

AWS.config.pinpointsmsvoice = { params: { /* ... */ } };

Override default endpoint URI for all newly created PinpointSMSVoice objects

AWS.config.pinpointsmsvoice = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

pinpointsmsvoicev2AWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.PinpointSMSVoiceV2.

Examples:

Bind parameters to all newly created PinpointSMSVoiceV2 objects

AWS.config.pinpointsmsvoicev2 = { params: { /* ... */ } };

Override default endpoint URI for all newly created PinpointSMSVoiceV2 objects

AWS.config.pinpointsmsvoicev2 = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

pipesAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.Pipes.

Examples:

Bind parameters to all newly created Pipes objects

AWS.config.pipes = { params: { /* ... */ } };

Override default endpoint URI for all newly created Pipes objects

AWS.config.pipes = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

pollyAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.Polly.

Examples:

Bind parameters to all newly created Polly objects

AWS.config.polly = { params: { /* ... */ } };

Override default endpoint URI for all newly created Polly objects

AWS.config.polly = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

pricingAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.Pricing.

Examples:

Bind parameters to all newly created Pricing objects

AWS.config.pricing = { params: { /* ... */ } };

Override default endpoint URI for all newly created Pricing objects

AWS.config.pricing = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

privatenetworksAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.PrivateNetworks.

Examples:

Bind parameters to all newly created PrivateNetworks objects

AWS.config.privatenetworks = { params: { /* ... */ } };

Override default endpoint URI for all newly created PrivateNetworks objects

AWS.config.privatenetworks = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

protonAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.Proton.

Examples:

Bind parameters to all newly created Proton objects

AWS.config.proton = { params: { /* ... */ } };

Override default endpoint URI for all newly created Proton objects

AWS.config.proton = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

qappsAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.QApps.

Examples:

Bind parameters to all newly created QApps objects

AWS.config.qapps = { params: { /* ... */ } };

Override default endpoint URI for all newly created QApps objects

AWS.config.qapps = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

qbusinessAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.QBusiness.

Examples:

Bind parameters to all newly created QBusiness objects

AWS.config.qbusiness = { params: { /* ... */ } };

Override default endpoint URI for all newly created QBusiness objects

AWS.config.qbusiness = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

qconnectAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.QConnect.

Examples:

Bind parameters to all newly created QConnect objects

AWS.config.qconnect = { params: { /* ... */ } };

Override default endpoint URI for all newly created QConnect objects

AWS.config.qconnect = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

qldbAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.QLDB.

Examples:

Bind parameters to all newly created QLDB objects

AWS.config.qldb = { params: { /* ... */ } };

Override default endpoint URI for all newly created QLDB objects

AWS.config.qldb = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

qldbsessionAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.QLDBSession.

Examples:

Bind parameters to all newly created QLDBSession objects

AWS.config.qldbsession = { params: { /* ... */ } };

Override default endpoint URI for all newly created QLDBSession objects

AWS.config.qldbsession = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

quicksightAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.QuickSight.

Examples:

Bind parameters to all newly created QuickSight objects

AWS.config.quicksight = { params: { /* ... */ } };

Override default endpoint URI for all newly created QuickSight objects

AWS.config.quicksight = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

ramAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.RAM.

Examples:

Bind parameters to all newly created RAM objects

AWS.config.ram = { params: { /* ... */ } };

Override default endpoint URI for all newly created RAM objects

AWS.config.ram = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

rbinAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.Rbin.

Examples:

Bind parameters to all newly created Rbin objects

AWS.config.rbin = { params: { /* ... */ } };

Override default endpoint URI for all newly created Rbin objects

AWS.config.rbin = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

rdsAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.RDS.

Examples:

Bind parameters to all newly created RDS objects

AWS.config.rds = { params: { /* ... */ } };

Override default endpoint URI for all newly created RDS objects

AWS.config.rds = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

rdsdataserviceAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.RDSDataService.

Examples:

Bind parameters to all newly created RDSDataService objects

AWS.config.rdsdataservice = { params: { /* ... */ } };

Override default endpoint URI for all newly created RDSDataService objects

AWS.config.rdsdataservice = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

redshiftAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.Redshift.

Examples:

Bind parameters to all newly created Redshift objects

AWS.config.redshift = { params: { /* ... */ } };

Override default endpoint URI for all newly created Redshift objects

AWS.config.redshift = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

redshiftdataAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.RedshiftData.

Examples:

Bind parameters to all newly created RedshiftData objects

AWS.config.redshiftdata = { params: { /* ... */ } };

Override default endpoint URI for all newly created RedshiftData objects

AWS.config.redshiftdata = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

redshiftserverlessAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.RedshiftServerless.

Examples:

Bind parameters to all newly created RedshiftServerless objects

AWS.config.redshiftserverless = { params: { /* ... */ } };

Override default endpoint URI for all newly created RedshiftServerless objects

AWS.config.redshiftserverless = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

regionAWS.Credentials (readwrite)

Returns The region to send service requests to.

Examples:

Set the global region setting to us-west-2

AWS.config.update({region: 'us-west-2'});

Returns:

See Also:

rekognitionAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.Rekognition.

Examples:

Bind parameters to all newly created Rekognition objects

AWS.config.rekognition = { params: { /* ... */ } };

Override default endpoint URI for all newly created Rekognition objects

AWS.config.rekognition = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

repostspaceAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.Repostspace.

Examples:

Bind parameters to all newly created Repostspace objects

AWS.config.repostspace = { params: { /* ... */ } };

Override default endpoint URI for all newly created Repostspace objects

AWS.config.repostspace = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

resiliencehubAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.Resiliencehub.

Examples:

Bind parameters to all newly created Resiliencehub objects

AWS.config.resiliencehub = { params: { /* ... */ } };

Override default endpoint URI for all newly created Resiliencehub objects

AWS.config.resiliencehub = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

resourceexplorer2AWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.ResourceExplorer2.

Examples:

Bind parameters to all newly created ResourceExplorer2 objects

AWS.config.resourceexplorer2 = { params: { /* ... */ } };

Override default endpoint URI for all newly created ResourceExplorer2 objects

AWS.config.resourceexplorer2 = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

resourcegroupsAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.ResourceGroups.

Examples:

Bind parameters to all newly created ResourceGroups objects

AWS.config.resourcegroups = { params: { /* ... */ } };

Override default endpoint URI for all newly created ResourceGroups objects

AWS.config.resourcegroups = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

resourcegroupstaggingapiAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.ResourceGroupsTaggingAPI.

Examples:

Bind parameters to all newly created ResourceGroupsTaggingAPI objects

AWS.config.resourcegroupstaggingapi = { params: { /* ... */ } };

Override default endpoint URI for all newly created ResourceGroupsTaggingAPI objects

AWS.config.resourcegroupstaggingapi = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

retryDelayOptionsmap (readwrite)

Returns A set of options to configure the retry delay on retryable errors. Currently supported options are:

  • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.

  • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.

Examples:

Set the base retry delay for all services to 300 ms

AWS.config.update({retryDelayOptions: {base: 300}});
// Delays with maxRetries = 3: 300, 600, 1200

Set a custom backoff function to provide delay values on retries

AWS.config.update({retryDelayOptions: {customBackoff: function(retryCount, err) {
  // returns delay in ms
}}});

Returns:

  • (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.

    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.

robomakerAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.RoboMaker.

Examples:

Bind parameters to all newly created RoboMaker objects

AWS.config.robomaker = { params: { /* ... */ } };

Override default endpoint URI for all newly created RoboMaker objects

AWS.config.robomaker = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

rolesanywhereAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.RolesAnywhere.

Examples:

Bind parameters to all newly created RolesAnywhere objects

AWS.config.rolesanywhere = { params: { /* ... */ } };

Override default endpoint URI for all newly created RolesAnywhere objects

AWS.config.rolesanywhere = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

route53AWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.Route53.

Examples:

Bind parameters to all newly created Route53 objects

AWS.config.route53 = { params: { /* ... */ } };

Override default endpoint URI for all newly created Route53 objects

AWS.config.route53 = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

route53domainsAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.Route53Domains.

Examples:

Bind parameters to all newly created Route53Domains objects

AWS.config.route53domains = { params: { /* ... */ } };

Override default endpoint URI for all newly created Route53Domains objects

AWS.config.route53domains = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

route53profilesAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.Route53Profiles.

Examples:

Bind parameters to all newly created Route53Profiles objects

AWS.config.route53profiles = { params: { /* ... */ } };

Override default endpoint URI for all newly created Route53Profiles objects

AWS.config.route53profiles = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

route53recoveryclusterAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.Route53RecoveryCluster.

Examples:

Bind parameters to all newly created Route53RecoveryCluster objects

AWS.config.route53recoverycluster = { params: { /* ... */ } };

Override default endpoint URI for all newly created Route53RecoveryCluster objects

AWS.config.route53recoverycluster = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

route53recoverycontrolconfigAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.Route53RecoveryControlConfig.

Examples:

Bind parameters to all newly created Route53RecoveryControlConfig objects

AWS.config.route53recoverycontrolconfig = { params: { /* ... */ } };

Override default endpoint URI for all newly created Route53RecoveryControlConfig objects

AWS.config.route53recoverycontrolconfig = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

route53recoveryreadinessAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.Route53RecoveryReadiness.

Examples:

Bind parameters to all newly created Route53RecoveryReadiness objects

AWS.config.route53recoveryreadiness = { params: { /* ... */ } };

Override default endpoint URI for all newly created Route53RecoveryReadiness objects

AWS.config.route53recoveryreadiness = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

route53resolverAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.Route53Resolver.

Examples:

Bind parameters to all newly created Route53Resolver objects

AWS.config.route53resolver = { params: { /* ... */ } };

Override default endpoint URI for all newly created Route53Resolver objects

AWS.config.route53resolver = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

rumAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.RUM.

Examples:

Bind parameters to all newly created RUM objects

AWS.config.rum = { params: { /* ... */ } };

Override default endpoint URI for all newly created RUM objects

AWS.config.rum = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

s3AWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.S3.

Examples:

Bind parameters to all newly created S3 objects

AWS.config.s3 = { params: { /* ... */ } };

Override default endpoint URI for all newly created S3 objects

AWS.config.s3 = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Use IPv6/IPv4 dualstack endpoint for all newly created S3 objects

AWS.config.s3 = { useDualstack: true };

Returns:

s3BucketEndpointBoolean (readwrite)

Note:

Setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

Returns whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint).

Returns:

  • (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint).

s3controlAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.S3Control.

Examples:

Bind parameters to all newly created S3Control objects

AWS.config.s3control = { params: { /* ... */ } };

Override default endpoint URI for all newly created S3Control objects

AWS.config.s3control = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Use IPv6/IPv4 dualstack endpoint for all newly created S3Control objects

AWS.config.s3control = { useDualstack: true };

Returns:

s3DisableBodySigningBoolean (readwrite)

Returns whether to disable S3 body signing when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

Returns:

  • (Boolean)

    whether to disable S3 body signing when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

s3ForcePathStyleBoolean (readwrite)

Returns whether to force path style URLs for S3 objects.

Returns:

  • (Boolean)

    whether to force path style URLs for S3 objects

s3outpostsAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.S3Outposts.

Examples:

Bind parameters to all newly created S3Outposts objects

AWS.config.s3outposts = { params: { /* ... */ } };

Override default endpoint URI for all newly created S3Outposts objects

AWS.config.s3outposts = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

s3UseArnRegionBoolean (readwrite)

Returns whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true.

Returns:

  • (Boolean)

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

s3UsEast1RegionalEndpoint'legacy'|'regional' (readwrite)

Returns when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client; Defaults to 'legacy'.

Returns:

  • ('legacy'|'regional')

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client; Defaults to 'legacy'

sagemakerAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.SageMaker.

Examples:

Bind parameters to all newly created SageMaker objects

AWS.config.sagemaker = { params: { /* ... */ } };

Override default endpoint URI for all newly created SageMaker objects

AWS.config.sagemaker = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

sagemakeredgeAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.SagemakerEdge.

Examples:

Bind parameters to all newly created SagemakerEdge objects

AWS.config.sagemakeredge = { params: { /* ... */ } };

Override default endpoint URI for all newly created SagemakerEdge objects

AWS.config.sagemakeredge = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

sagemakerfeaturestoreruntimeAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.SageMakerFeatureStoreRuntime.

Examples:

Bind parameters to all newly created SageMakerFeatureStoreRuntime objects

AWS.config.sagemakerfeaturestoreruntime = { params: { /* ... */ } };

Override default endpoint URI for all newly created SageMakerFeatureStoreRuntime objects

AWS.config.sagemakerfeaturestoreruntime = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

sagemakergeospatialAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.SageMakerGeospatial.

Examples:

Bind parameters to all newly created SageMakerGeospatial objects

AWS.config.sagemakergeospatial = { params: { /* ... */ } };

Override default endpoint URI for all newly created SageMakerGeospatial objects

AWS.config.sagemakergeospatial = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

sagemakermetricsAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.SageMakerMetrics.

Examples:

Bind parameters to all newly created SageMakerMetrics objects

AWS.config.sagemakermetrics = { params: { /* ... */ } };

Override default endpoint URI for all newly created SageMakerMetrics objects

AWS.config.sagemakermetrics = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

sagemakerruntimeAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.SageMakerRuntime.

Examples:

Bind parameters to all newly created SageMakerRuntime objects

AWS.config.sagemakerruntime = { params: { /* ... */ } };

Override default endpoint URI for all newly created SageMakerRuntime objects

AWS.config.sagemakerruntime = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

savingsplansAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.SavingsPlans.

Examples:

Bind parameters to all newly created SavingsPlans objects

AWS.config.savingsplans = { params: { /* ... */ } };

Override default endpoint URI for all newly created SavingsPlans objects

AWS.config.savingsplans = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

schedulerAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.Scheduler.

Examples:

Bind parameters to all newly created Scheduler objects

AWS.config.scheduler = { params: { /* ... */ } };

Override default endpoint URI for all newly created Scheduler objects

AWS.config.scheduler = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

schemasAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.Schemas.

Examples:

Bind parameters to all newly created Schemas objects

AWS.config.schemas = { params: { /* ... */ } };

Override default endpoint URI for all newly created Schemas objects

AWS.config.schemas = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

secretsmanagerAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.SecretsManager.

Examples:

Bind parameters to all newly created SecretsManager objects

AWS.config.secretsmanager = { params: { /* ... */ } };

Override default endpoint URI for all newly created SecretsManager objects

AWS.config.secretsmanager = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

securityhubAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.SecurityHub.

Examples:

Bind parameters to all newly created SecurityHub objects

AWS.config.securityhub = { params: { /* ... */ } };

Override default endpoint URI for all newly created SecurityHub objects

AWS.config.securityhub = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

securitylakeAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.SecurityLake.

Examples:

Bind parameters to all newly created SecurityLake objects

AWS.config.securitylake = { params: { /* ... */ } };

Override default endpoint URI for all newly created SecurityLake objects

AWS.config.securitylake = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

serverlessapplicationrepositoryAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.ServerlessApplicationRepository.

Examples:

Bind parameters to all newly created ServerlessApplicationRepository objects

AWS.config.serverlessapplicationrepository = { params: { /* ... */ } };

Override default endpoint URI for all newly created ServerlessApplicationRepository objects

AWS.config.serverlessapplicationrepository = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

servicecatalogAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.ServiceCatalog.

Examples:

Bind parameters to all newly created ServiceCatalog objects

AWS.config.servicecatalog = { params: { /* ... */ } };

Override default endpoint URI for all newly created ServiceCatalog objects

AWS.config.servicecatalog = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

servicecatalogappregistryAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.ServiceCatalogAppRegistry.

Examples:

Bind parameters to all newly created ServiceCatalogAppRegistry objects

AWS.config.servicecatalogappregistry = { params: { /* ... */ } };

Override default endpoint URI for all newly created ServiceCatalogAppRegistry objects

AWS.config.servicecatalogappregistry = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

servicediscoveryAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.ServiceDiscovery.

Examples:

Bind parameters to all newly created ServiceDiscovery objects

AWS.config.servicediscovery = { params: { /* ... */ } };

Override default endpoint URI for all newly created ServiceDiscovery objects

AWS.config.servicediscovery = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

servicequotasAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.ServiceQuotas.

Examples:

Bind parameters to all newly created ServiceQuotas objects

AWS.config.servicequotas = { params: { /* ... */ } };

Override default endpoint URI for all newly created ServiceQuotas objects

AWS.config.servicequotas = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

sesAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.SES.

Examples:

Bind parameters to all newly created SES objects

AWS.config.ses = { params: { /* ... */ } };

Override default endpoint URI for all newly created SES objects

AWS.config.ses = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

sesv2AWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.SESV2.

Examples:

Bind parameters to all newly created SESV2 objects

AWS.config.sesv2 = { params: { /* ... */ } };

Override default endpoint URI for all newly created SESV2 objects

AWS.config.sesv2 = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

shieldAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.Shield.

Examples:

Bind parameters to all newly created Shield objects

AWS.config.shield = { params: { /* ... */ } };

Override default endpoint URI for all newly created Shield objects

AWS.config.shield = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

signatureCacheBoolean (readwrite)

Returns whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

Returns:

  • (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

signatureVersionString (readwrite)

Returns the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

Returns:

  • (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

signerAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.Signer.

Examples:

Bind parameters to all newly created Signer objects

AWS.config.signer = { params: { /* ... */ } };

Override default endpoint URI for all newly created Signer objects

AWS.config.signer = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

simpledbAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.SimpleDB.

Examples:

Bind parameters to all newly created SimpleDB objects

AWS.config.simpledb = { params: { /* ... */ } };

Override default endpoint URI for all newly created SimpleDB objects

AWS.config.simpledb = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

simspaceweaverAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.SimSpaceWeaver.

Examples:

Bind parameters to all newly created SimSpaceWeaver objects

AWS.config.simspaceweaver = { params: { /* ... */ } };

Override default endpoint URI for all newly created SimSpaceWeaver objects

AWS.config.simspaceweaver = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

smsAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.SMS.

Examples:

Bind parameters to all newly created SMS objects

AWS.config.sms = { params: { /* ... */ } };

Override default endpoint URI for all newly created SMS objects

AWS.config.sms = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

snowballAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.Snowball.

Examples:

Bind parameters to all newly created Snowball objects

AWS.config.snowball = { params: { /* ... */ } };

Override default endpoint URI for all newly created Snowball objects

AWS.config.snowball = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

snowdevicemanagementAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.SnowDeviceManagement.

Examples:

Bind parameters to all newly created SnowDeviceManagement objects

AWS.config.snowdevicemanagement = { params: { /* ... */ } };

Override default endpoint URI for all newly created SnowDeviceManagement objects

AWS.config.snowdevicemanagement = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

snsAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.SNS.

Examples:

Bind parameters to all newly created SNS objects

AWS.config.sns = { params: { /* ... */ } };

Override default endpoint URI for all newly created SNS objects

AWS.config.sns = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

sqsAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.SQS.

Examples:

Bind parameters to all newly created SQS objects

AWS.config.sqs = { params: { /* ... */ } };

Override default endpoint URI for all newly created SQS objects

AWS.config.sqs = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

sslEnabledBoolean (readwrite)

Returns whether SSL is enabled for requests.

Returns:

  • (Boolean)

    whether SSL is enabled for requests

ssmAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.SSM.

Examples:

Bind parameters to all newly created SSM objects

AWS.config.ssm = { params: { /* ... */ } };

Override default endpoint URI for all newly created SSM objects

AWS.config.ssm = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

ssmcontactsAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.SSMContacts.

Examples:

Bind parameters to all newly created SSMContacts objects

AWS.config.ssmcontacts = { params: { /* ... */ } };

Override default endpoint URI for all newly created SSMContacts objects

AWS.config.ssmcontacts = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

ssmincidentsAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.SSMIncidents.

Examples:

Bind parameters to all newly created SSMIncidents objects

AWS.config.ssmincidents = { params: { /* ... */ } };

Override default endpoint URI for all newly created SSMIncidents objects

AWS.config.ssmincidents = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

ssmquicksetupAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.SSMQuickSetup.

Examples:

Bind parameters to all newly created SSMQuickSetup objects

AWS.config.ssmquicksetup = { params: { /* ... */ } };

Override default endpoint URI for all newly created SSMQuickSetup objects

AWS.config.ssmquicksetup = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

ssmsapAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.SsmSap.

Examples:

Bind parameters to all newly created SsmSap objects

AWS.config.ssmsap = { params: { /* ... */ } };

Override default endpoint URI for all newly created SsmSap objects

AWS.config.ssmsap = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

ssoAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.SSO.

Examples:

Bind parameters to all newly created SSO objects

AWS.config.sso = { params: { /* ... */ } };

Override default endpoint URI for all newly created SSO objects

AWS.config.sso = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

ssoadminAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.SSOAdmin.

Examples:

Bind parameters to all newly created SSOAdmin objects

AWS.config.ssoadmin = { params: { /* ... */ } };

Override default endpoint URI for all newly created SSOAdmin objects

AWS.config.ssoadmin = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

ssooidcAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.SSOOIDC.

Examples:

Bind parameters to all newly created SSOOIDC objects

AWS.config.ssooidc = { params: { /* ... */ } };

Override default endpoint URI for all newly created SSOOIDC objects

AWS.config.ssooidc = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

stepfunctionsAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.StepFunctions.

Examples:

Bind parameters to all newly created StepFunctions objects

AWS.config.stepfunctions = { params: { /* ... */ } };

Override default endpoint URI for all newly created StepFunctions objects

AWS.config.stepfunctions = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

storagegatewayAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.StorageGateway.

Examples:

Bind parameters to all newly created StorageGateway objects

AWS.config.storagegateway = { params: { /* ... */ } };

Override default endpoint URI for all newly created StorageGateway objects

AWS.config.storagegateway = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

stsAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.STS.

Examples:

Bind parameters to all newly created STS objects

AWS.config.sts = { params: { /* ... */ } };

Override default endpoint URI for all newly created STS objects

AWS.config.sts = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

stsRegionalEndpoints'legacy'|'regional' (readwrite)

Returns whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

Returns:

  • ('legacy'|'regional')

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

supplychainAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.SupplyChain.

Examples:

Bind parameters to all newly created SupplyChain objects

AWS.config.supplychain = { params: { /* ... */ } };

Override default endpoint URI for all newly created SupplyChain objects

AWS.config.supplychain = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

supportAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.Support.

Examples:

Bind parameters to all newly created Support objects

AWS.config.support = { params: { /* ... */ } };

Override default endpoint URI for all newly created Support objects

AWS.config.support = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

supportappAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.SupportApp.

Examples:

Bind parameters to all newly created SupportApp objects

AWS.config.supportapp = { params: { /* ... */ } };

Override default endpoint URI for all newly created SupportApp objects

AWS.config.supportapp = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

swfAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.SWF.

Examples:

Bind parameters to all newly created SWF objects

AWS.config.swf = { params: { /* ... */ } };

Override default endpoint URI for all newly created SWF objects

AWS.config.swf = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

syntheticsAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.Synthetics.

Examples:

Bind parameters to all newly created Synthetics objects

AWS.config.synthetics = { params: { /* ... */ } };

Override default endpoint URI for all newly created Synthetics objects

AWS.config.synthetics = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

systemClockOffsetNumber (readwrite)

Returns an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

Returns:

  • (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

taxsettingsAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.TaxSettings.

Examples:

Bind parameters to all newly created TaxSettings objects

AWS.config.taxsettings = { params: { /* ... */ } };

Override default endpoint URI for all newly created TaxSettings objects

AWS.config.taxsettings = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

textractAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.Textract.

Examples:

Bind parameters to all newly created Textract objects

AWS.config.textract = { params: { /* ... */ } };

Override default endpoint URI for all newly created Textract objects

AWS.config.textract = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

timestreaminfluxdbAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.TimestreamInfluxDB.

Examples:

Bind parameters to all newly created TimestreamInfluxDB objects

AWS.config.timestreaminfluxdb = { params: { /* ... */ } };

Override default endpoint URI for all newly created TimestreamInfluxDB objects

AWS.config.timestreaminfluxdb = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

timestreamqueryAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.TimestreamQuery.

Examples:

Bind parameters to all newly created TimestreamQuery objects

AWS.config.timestreamquery = { params: { /* ... */ } };

Override default endpoint URI for all newly created TimestreamQuery objects

AWS.config.timestreamquery = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

timestreamwriteAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.TimestreamWrite.

Examples:

Bind parameters to all newly created TimestreamWrite objects

AWS.config.timestreamwrite = { params: { /* ... */ } };

Override default endpoint URI for all newly created TimestreamWrite objects

AWS.config.timestreamwrite = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

tnbAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.Tnb.

Examples:

Bind parameters to all newly created Tnb objects

AWS.config.tnb = { params: { /* ... */ } };

Override default endpoint URI for all newly created Tnb objects

AWS.config.tnb = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

transcribeserviceAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.TranscribeService.

Examples:

Bind parameters to all newly created TranscribeService objects

AWS.config.transcribeservice = { params: { /* ... */ } };

Override default endpoint URI for all newly created TranscribeService objects

AWS.config.transcribeservice = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

transferAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.Transfer.

Examples:

Bind parameters to all newly created Transfer objects

AWS.config.transfer = { params: { /* ... */ } };

Override default endpoint URI for all newly created Transfer objects

AWS.config.transfer = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

translateAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.Translate.

Examples:

Bind parameters to all newly created Translate objects

AWS.config.translate = { params: { /* ... */ } };

Override default endpoint URI for all newly created Translate objects

AWS.config.translate = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

trustedadvisorAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.TrustedAdvisor.

Examples:

Bind parameters to all newly created TrustedAdvisor objects

AWS.config.trustedadvisor = { params: { /* ... */ } };

Override default endpoint URI for all newly created TrustedAdvisor objects

AWS.config.trustedadvisor = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

useAccelerateEndpointBoolean (readwrite)

Note:

This configuration option is only compatible with S3 while accessing dns-compatible buckets.

Returns Whether to use the Accelerate endpoint with the S3 service. Defaults to false.

Returns:

  • (Boolean)

    Whether to use the Accelerate endpoint with the S3 service. Defaults to false.

useDualstackEndpointBoolean (readwrite)

Returns Enables IPv6 dualstack endpoint. Defaults to false.

Returns:

  • (Boolean)

    Enables IPv6 dualstack endpoint. Defaults to false.

useFipsEndpointBoolean (readwrite)

Returns Enables FIPS compatible endpoints. Defaults to false.

Returns:

  • (Boolean)

    Enables FIPS compatible endpoints. Defaults to false.

verifiedpermissionsAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.VerifiedPermissions.

Examples:

Bind parameters to all newly created VerifiedPermissions objects

AWS.config.verifiedpermissions = { params: { /* ... */ } };

Override default endpoint URI for all newly created VerifiedPermissions objects

AWS.config.verifiedpermissions = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

voiceidAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.VoiceID.

Examples:

Bind parameters to all newly created VoiceID objects

AWS.config.voiceid = { params: { /* ... */ } };

Override default endpoint URI for all newly created VoiceID objects

AWS.config.voiceid = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

vpclatticeAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.VPCLattice.

Examples:

Bind parameters to all newly created VPCLattice objects

AWS.config.vpclattice = { params: { /* ... */ } };

Override default endpoint URI for all newly created VPCLattice objects

AWS.config.vpclattice = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

wafAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.WAF.

Examples:

Bind parameters to all newly created WAF objects

AWS.config.waf = { params: { /* ... */ } };

Override default endpoint URI for all newly created WAF objects

AWS.config.waf = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

wafregionalAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.WAFRegional.

Examples:

Bind parameters to all newly created WAFRegional objects

AWS.config.wafregional = { params: { /* ... */ } };

Override default endpoint URI for all newly created WAFRegional objects

AWS.config.wafregional = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

wafv2AWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.WAFV2.

Examples:

Bind parameters to all newly created WAFV2 objects

AWS.config.wafv2 = { params: { /* ... */ } };

Override default endpoint URI for all newly created WAFV2 objects

AWS.config.wafv2 = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

wellarchitectedAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.WellArchitected.

Examples:

Bind parameters to all newly created WellArchitected objects

AWS.config.wellarchitected = { params: { /* ... */ } };

Override default endpoint URI for all newly created WellArchitected objects

AWS.config.wellarchitected = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

wisdomAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.Wisdom.

Examples:

Bind parameters to all newly created Wisdom objects

AWS.config.wisdom = { params: { /* ... */ } };

Override default endpoint URI for all newly created Wisdom objects

AWS.config.wisdom = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

workdocsAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.WorkDocs.

Examples:

Bind parameters to all newly created WorkDocs objects

AWS.config.workdocs = { params: { /* ... */ } };

Override default endpoint URI for all newly created WorkDocs objects

AWS.config.workdocs = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

Returns Service-specific configuration options for AWS.WorkLink.

Examples:

Bind parameters to all newly created WorkLink objects

AWS.config.worklink = { params: { /* ... */ } };

Override default endpoint URI for all newly created WorkLink objects

AWS.config.worklink = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

workmailAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.WorkMail.

Examples:

Bind parameters to all newly created WorkMail objects

AWS.config.workmail = { params: { /* ... */ } };

Override default endpoint URI for all newly created WorkMail objects

AWS.config.workmail = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

workmailmessageflowAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.WorkMailMessageFlow.

Examples:

Bind parameters to all newly created WorkMailMessageFlow objects

AWS.config.workmailmessageflow = { params: { /* ... */ } };

Override default endpoint URI for all newly created WorkMailMessageFlow objects

AWS.config.workmailmessageflow = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

workspacesAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.WorkSpaces.

Examples:

Bind parameters to all newly created WorkSpaces objects

AWS.config.workspaces = { params: { /* ... */ } };

Override default endpoint URI for all newly created WorkSpaces objects

AWS.config.workspaces = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

workspacesthinclientAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.WorkSpacesThinClient.

Examples:

Bind parameters to all newly created WorkSpacesThinClient objects

AWS.config.workspacesthinclient = { params: { /* ... */ } };

Override default endpoint URI for all newly created WorkSpacesThinClient objects

AWS.config.workspacesthinclient = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

workspaceswebAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.WorkSpacesWeb.

Examples:

Bind parameters to all newly created WorkSpacesWeb objects

AWS.config.workspacesweb = { params: { /* ... */ } };

Override default endpoint URI for all newly created WorkSpacesWeb objects

AWS.config.workspacesweb = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

xrayAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.XRay.

Examples:

Bind parameters to all newly created XRay objects

AWS.config.xray = { params: { /* ... */ } };

Override default endpoint URI for all newly created XRay objects

AWS.config.xray = { endpoint: 'https://{service}.{region}.amazonaws.com' };

Returns:

Method Details

getCredentials(callback) ⇒ void

Note:

If you configure the SDK with static or environment credentials, the credential data should already be present in credentials attribute. This method is primarily necessary to load credentials from asynchronous sources, or sources that can refresh credentials periodically.

Loads credentials from the configuration object. This is used internally by the SDK to ensure that refreshable AWS.Credentials objects are properly refreshed and loaded when sending a request. If you want to ensure that your credentials are loaded prior to a request, you can use this method directly to provide accurate credential data stored in the object.

Examples:

Getting your access key

AWS.config.getCredentials(function(err) {
  if (err) console.log(err.stack); // credentials not loaded
  else console.log("Access Key:", AWS.config.credentials.accessKeyId);
})

Callback (callback):

  • function(err) { ... }

    Called when the credentials have been properly set on the configuration object.

    Parameters:

    • err (Error)

      if this is set, credentials were not successfully loaded and this error provides information why.

See Also:

getPromisesDependency() ⇒ void

Gets the promise dependency set by AWS.config.setPromisesDependency.

getToken(callback) ⇒ void

Note:

If you configure the SDK with static token, the token data should already be present in AWS.Config.token attribute. This method is primarily necessary to load token from asynchronous sources, or sources that can refresh token periodically.

Loads token from the configuration object. This is used internally by the SDK to ensure that refreshable AWS.Token objects are properly refreshed and loaded when sending a request. If you want to ensure that your token is loaded prior to a request, you can use this method directly to provide accurate token data stored in the object.

Examples:

Getting your access token

AWS.config.getToken(function(err) {
  if (err) console.log(err.stack); // token not loaded
  else console.log("Token:", AWS.config.token.token);
})

Callback (callback):

  • function(err) { ... }

    Called when the AWS.Config.token have been properly set on the configuration object.

    Parameters:

    • err (Error)

      if this is set, token was not successfully loaded and this error provides information why.

See Also:

  • AWS.Config.token

loadFromPath(path) ⇒ AWS.Config

Note:

Loading configuration will reset all existing configuration on the object.

Note:

This feature is not supported in the browser environment of the SDK.

Loads configuration data from a JSON file into this config object.

Parameters:

  • path (String)

    the path relative to your process's current working directory to load configuration from.

Returns:

  • (AWS.Config)

    the same configuration object

setPromisesDependency(dep) ⇒ void

Sets the promise dependency the SDK will use wherever Promises are returned. Passing null will force the SDK to use native Promises if they are available. If native Promises are not available, passing null will have no effect.

Parameters:

  • dep (Constructor)

    A reference to a Promise constructor

update(options, allowUnknownKeys = false) ⇒ void

Updates the current configuration object with new options.

Examples:

Update maxRetries property of a configuration object

config.update({maxRetries: 10});

Parameters:

  • options (Object)

    a map of option keys and values.

  • allowUnknownKeys (Boolean) (defaults to: false)

    whether unknown keys can be set on the configuration object. Defaults to false.

See Also: