You are viewing the documentation for an older major version of the AWS SDK for JavaScript.
The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

Module: AWS

Defined in:
lib/core.js

Overview

The main AWS namespace

Defined Under Namespace

Modules: EventListeners Classes: ACM, ACMPCA, APIGateway, AccessAnalyzer, Account, AlexaForBusiness, Amp, Amplify, AmplifyBackend, ApiGatewayManagementApi, ApiGatewayV2, AppConfig, AppIntegrations, AppMesh, AppMesh, AppRunner, AppStream, AppSync, Appflow, ApplicationAutoScaling, ApplicationCostProfiler, ApplicationInsights, Athena, AuditManager, AugmentedAIRuntime, AutoScaling, AutoScalingPlans, Backup, Batch, Braket, Budgets, CUR, ChainableTemporaryCredentials, Chime, ChimeSDKIdentity, ChimeSDKMeetings, ChimeSDKMessaging, Cloud9, CloudControl, CloudDirectory, CloudDirectory, CloudFormation, CloudFront, CloudFront, CloudFront, CloudFront, CloudFront, CloudFront, CloudFront, CloudHSM, CloudHSMV2, CloudSearch, CloudSearchDomain, CloudSearch, CloudTrail, CloudWatch, CloudWatchEvents, CloudWatchLogs, CodeArtifact, CodeBuild, CodeCommit, CodeDeploy, CodeGuruProfiler, CodeGuruReviewer, CodePipeline, CodeStar, CodeStarNotifications, CodeStarconnections, CognitoIdentity, CognitoIdentityCredentials, CognitoIdentityServiceProvider, CognitoSync, Comprehend, ComprehendMedical, ComputeOptimizer, Config, ConfigService, Connect, ConnectContactLens, ConnectParticipant, CostExplorer, CredentialProviderChain, Credentials, CustomerProfiles, DAX, DLM, DMS, DataBrew, DataExchange, DataPipeline, DataSync, Detective, DevOpsGuru, DeviceFarm, DirectConnect, DirectoryService, Discovery, DocDB, DynamoDB, DynamoDBStreams, DynamoDB, EBS, EC2, EC2InstanceConnect, EC2MetadataCredentials, ECR, ECRPUBLIC, ECS, EFS, EKS, ELB, ELBv2, EMR, EMRcontainers, ES, ElastiCache, ElasticBeanstalk, ElasticInference, ElasticTranscoder, Endpoint, EnvironmentCredentials, EventBridge, FMS, FSx, FileSystemCredentials, Finspace, Finspacedata, Firehose, Fis, ForecastQueryService, ForecastService, FraudDetector, GameLift, Glacier, GlobalAccelerator, Glue, Grafana, Greengrass, GreengrassV2, GroundStation, GuardDuty, Health, HealthLake, Honeycode, HttpClient, HttpRequest, HttpResponse, IAM, IVS, IdentityStore, Imagebuilder, ImportExport, IniLoader, Inspector, IoT1ClickDevicesService, IoT1ClickProjects, IoTAnalytics, IoTEvents, IoTEventsData, IoTFleetHub, IoTJobsDataPlane, IoTSecureTunneling, IoTSiteWise, IoTThingsGraph, IoTWireless, Iot, IotData, IotDeviceAdvisor, KMS, Kafka, KafkaConnect, Kendra, Kinesis, KinesisAnalytics, KinesisAnalyticsV2, KinesisVideo, KinesisVideoArchivedMedia, KinesisVideoMedia, KinesisVideoSignalingChannels, LakeFormation, Lambda, Lambda, LexModelBuildingService, LexModelsV2, LexRuntime, LexRuntimeV2, LicenseManager, Lightsail, Location, LookoutEquipment, LookoutMetrics, LookoutVision, MQ, MTurk, MWAA, MachineLearning, Macie, Macie2, ManagedBlockchain, MarketplaceCatalog, MarketplaceCommerceAnalytics, MarketplaceEntitlementService, MarketplaceMetering, MediaConnect, MediaConvert, MediaLive, MediaPackage, MediaPackageVod, MediaStore, MediaStoreData, MediaTailor, MemoryDB, MetadataService, Mgn, MigrationHub, MigrationHubConfig, Mobile, MobileAnalytics, Neptune, NetworkFirewall, NetworkManager, Nimble, OpenSearch, OpsWorks, OpsWorksCM, Organizations, Outposts, PI, Panorama, Personalize, PersonalizeEvents, PersonalizeRuntime, Pinpoint, PinpointEmail, PinpointSMSVoice, Polly, Pricing, ProcessCredentials, Proton, QLDB, QLDBSession, QuickSight, RAM, RDS, RDSDataService, RDS, RDS, RDS, RDS, Redshift, RedshiftData, Rekognition, RemoteCredentials, Request, Resiliencehub, ResourceGroups, ResourceGroupsTaggingAPI, Response, RoboMaker, Route53, Route53Domains, Route53RecoveryCluster, Route53RecoveryControlConfig, Route53RecoveryReadiness, Route53Resolver, S3, S3Control, S3Outposts, SAMLCredentials, SES, SESV2, SMS, SNS, SQS, SSM, SSMContacts, SSMIncidents, SSO, SSOAdmin, SSOOIDC, STS, SWF, SageMaker, SageMakerFeatureStoreRuntime, SageMakerRuntime, SagemakerEdge, SavingsPlans, Schemas, SecretsManager, SecurityHub, ServerlessApplicationRepository, Service, ServiceCatalog, ServiceCatalogAppRegistry, ServiceDiscovery, ServiceQuotas, SharedIniFileCredentials, Shield, Signer, SimpleDB, SnowDeviceManagement, Snowball, StepFunctions, StorageGateway, Support, Synthetics, TemporaryCredentials, Textract, TimestreamQuery, TimestreamWrite, TokenFileWebIdentityCredentials, TranscribeService, Transfer, Translate, VoiceID, WAF, WAFRegional, WAFV2, WebIdentityCredentials, WellArchitected, Wisdom, WorkDocs, WorkLink, WorkMail, WorkMailMessageFlow, WorkSpaces, XRay

Constant Summary collapse

SimpleWorkflow =

Backwards compatibility for access to the AWS.SWF service class.

AWS.SWF
VERSION = 
'2.1026.0'

Loading and Setting Configuration Options collapse

Property Summary collapse

Property Details

config ⇒ AWS.Config (static, readonly)

Returns The global configuration object singleton instance.

Default Value:

AWS.config = new AWS.Config()

Returns:

  • (AWS.Config) —

    The global configuration object singleton instance

See Also:

ECSCredentials ⇒ Object (static, readwrite)

Note:

This feature is not supported in the browser environment of the SDK.

Represents credentials received from relative URI specified in the ECS container.

This class will request refreshable credentials from the relative URI specified by the AWS_CONTAINER_CREDENTIALS_RELATIVE_URI or the AWS_CONTAINER_CREDENTIALS_FULL_URI environment variable. If valid credentials are returned in the response, these will be used with zero configuration.

This credentials class will by default timeout after 1 second of inactivity and retry 3 times. If your requests to the relative URI are timing out, you can increase the value by configuring them directly:

AWS.config.credentials = new AWS.ECSCredentials({
  httpOptions: { timeout: 5000 }, // 5 second timeout
  maxRetries: 10, // retry 10 times
  retryDelayOptions: { base: 200 } // see AWS.Config for information
});

Default Value:

AWS.ECSCredentials = AWS.RemoteCredentials

See Also:

events ⇒ AWS.SequentialExecutor (static, readonly)

Returns a collection of global event listeners that are attached to every sent request.

Default Value:

AWS.events = new AWS.SequentialExecutor()

Examples:

Logging the time taken to send a request

AWS.events.on('send', function startSend(resp) {
  resp.startTime = new Date().getTime();
}).on('complete', function calculateTime(resp) {
  var time = (new Date().getTime() - resp.startTime) / 1000;
  console.log('Request took ' + time + ' seconds');
});

new AWS.S3().listBuckets(); // prints 'Request took 0.285 seconds'

Returns:

  • (AWS.SequentialExecutor) —

    a collection of global event listeners that are attached to every sent request.

See Also: