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:

Defined Under Namespace

Modules: keys

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.

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.

  • 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 returns the amount of time to delay in milliseconds. The base option will be ignored if this option is supplied.
  • 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.

Property Details

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:

alexaforbusinessAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.AlexaForBusiness.

Examples:

Bind parameters to all newly created AlexaForBusiness objects

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

Override default endpoint URI for all newly created AlexaForBusiness objects

AWS.config.alexaforbusiness = { 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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

codestarAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.CodeStar.

Examples:

Bind parameters to all newly created CodeStar objects

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

Override default endpoint URI for all newly created CodeStar objects

AWS.config.codestar = { 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:

computeChecksumsBoolean (readwrite)

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

Returns:

  • (Boolean)

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

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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. 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 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] — 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.

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. 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 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] — 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.

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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

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:

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:

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.

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:

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:

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:

mobileAWS.Config, map (readwrite)

Returns Service-specific configuration options for AWS.Mobile.

Examples:

Bind parameters to all newly created Mobile objects

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

Override default endpoint URI for all newly created Mobile objects

AWS.config.mobile = { 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:

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:

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.

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:

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:

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:

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:

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:

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 returns the amount of time to delay in milliseconds. The base option will be ignored if this option is supplied.

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) {
  // 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 returns the amount of time to delay in milliseconds. The base option will be ignored if this option is supplied.

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:

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

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

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:

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:

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:

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:

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:

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

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:

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:

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:

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:

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:

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:

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.

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:

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.

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:

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:

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:

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.

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: