AWS — AWS SDK for JavaScript (original) (raw)

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.

Module: AWS

Overview

Defined Under Namespace

Modules: EventListeners Classes: ACM, ACMPCA, APIGateway, ARCZonalShift, AccessAnalyzer, Account, Amp, Amplify, AmplifyBackend, AmplifyUIBuilder, ApiGatewayManagementApi, ApiGatewayV2, AppConfig, AppConfigData, AppFabric, AppIntegrations, AppMesh, AppMesh, AppRunner, AppStream, AppSync, AppTest, Appflow, ApplicationAutoScaling, ApplicationCostProfiler, ApplicationInsights, ApplicationSignals, Artifact, Athena, AuditManager, AugmentedAIRuntime, AutoScaling, AutoScalingPlans, B2bi, BCMDataExports, Backup, BackupGateway, Batch, Bedrock, BedrockAgent, BedrockAgentRuntime, BedrockRuntime, Billingconductor, Braket, Budgets, CUR, ChainableTemporaryCredentials, Chatbot, Chime, ChimeSDKIdentity, ChimeSDKMediaPipelines, ChimeSDKMeetings, ChimeSDKMessaging, ChimeSDKVoice, CleanRooms, CleanRoomsML, Cloud9, CloudControl, CloudDirectory, CloudDirectory, CloudFormation, CloudFront, CloudFront, CloudFront, CloudFront, CloudFront, CloudFront, CloudFront, CloudHSM, CloudHSMV2, CloudSearch, CloudSearchDomain, CloudSearch, CloudTrail, CloudTrailData, CloudWatch, CloudWatchEvents, CloudWatchLogs, CodeArtifact, CodeBuild, CodeCatalyst, CodeCommit, CodeConnections, CodeDeploy, CodeGuruProfiler, CodeGuruReviewer, CodeGuruSecurity, CodePipeline, CodeStarNotifications, CodeStarconnections, CognitoIdentity, CognitoIdentityCredentials, CognitoIdentityServiceProvider, CognitoSync, Comprehend, ComprehendMedical, ComputeOptimizer, Config, ConfigService, Connect, ConnectCampaigns, ConnectCases, ConnectContactLens, ConnectParticipant, ControlCatalog, ControlTower, CostExplorer, CostOptimizationHub, CredentialProviderChain, Credentials, CustomerProfiles, DAX, DLM, DMS, DataBrew, DataExchange, DataPipeline, DataSync, DataZone, Deadline, Detective, DevOpsGuru, DeviceFarm, DirectConnect, DirectoryService, Discovery, DocDB, DocDBElastic, Drs, DynamoDB, DynamoDBStreams, DynamoDB, EBS, EC2, EC2InstanceConnect, EC2MetadataCredentials, ECR, ECRPUBLIC, ECS, EFS, EKS, EKSAuth, ELB, ELBv2, EMR, EMRServerless, EMRcontainers, ES, ElastiCache, ElasticBeanstalk, ElasticInference, ElasticTranscoder, Endpoint, EntityResolution, EnvironmentCredentials, EventBridge, Evidently, FMS, FSx, FileSystemCredentials, Finspace, Finspacedata, Firehose, Fis, ForecastQueryService, ForecastService, FraudDetector, FreeTier, GameLift, Glacier, GlobalAccelerator, Glue, Grafana, Greengrass, GreengrassV2, GroundStation, GuardDuty, Health, HealthLake, HttpClient, HttpRequest, HttpResponse, IAM, IVS, IVSRealTime, IdentityStore, Imagebuilder, ImportExport, IniLoader, Inspector, Inspector2, InspectorScan, InternetMonitor, IoT1ClickDevicesService, IoT1ClickProjects, IoTAnalytics, IoTEvents, IoTEventsData, IoTFleetHub, IoTFleetWise, IoTJobsDataPlane, IoTSecureTunneling, IoTSiteWise, IoTThingsGraph, IoTTwinMaker, IoTWireless, Iot, IotData, IotDeviceAdvisor, Ivschat, KMS, Kafka, KafkaConnect, Kendra, KendraRanking, Keyspaces, Kinesis, KinesisAnalytics, KinesisAnalyticsV2, KinesisVideo, KinesisVideoArchivedMedia, KinesisVideoMedia, KinesisVideoSignalingChannels, KinesisVideoWebRTCStorage, LakeFormation, Lambda, Lambda, LaunchWizard, LexModelBuildingService, LexModelsV2, LexRuntime, LexRuntimeV2, LicenseManager, LicenseManagerLinuxSubscriptions, LicenseManagerUserSubscriptions, Lightsail, Location, LookoutEquipment, LookoutMetrics, LookoutVision, M2, MQ, MTurk, MWAA, MachineLearning, Macie2, MailManager, ManagedBlockchain, ManagedBlockchainQuery, MarketplaceAgreement, MarketplaceCatalog, MarketplaceCommerceAnalytics, MarketplaceDeployment, MarketplaceEntitlementService, MarketplaceMetering, MediaConnect, MediaConvert, MediaLive, MediaPackage, MediaPackageV2, MediaPackageVod, MediaStore, MediaStoreData, MediaTailor, MedicalImaging, MemoryDB, MetadataService, Mgn, MigrationHub, MigrationHubConfig, MigrationHubOrchestrator, MigrationHubRefactorSpaces, MigrationHubStrategy, MobileAnalytics, Neptune, Neptunedata, NetworkFirewall, NetworkManager, NetworkMonitor, Nimble, OAM, OSIS, Omics, OpenSearch, OpenSearchServerless, OpsWorks, OpsWorksCM, Organizations, Outposts, PCS, PI, Panorama, PaymentCryptography, PaymentCryptographyData, PcaConnectorAd, PcaConnectorScep, Personalize, PersonalizeEvents, PersonalizeRuntime, Pinpoint, PinpointEmail, PinpointSMSVoice, PinpointSMSVoiceV2, Pipes, Polly, Pricing, PrivateNetworks, ProcessCredentials, Proton, QApps, QBusiness, QConnect, QLDB, QLDBSession, QuickSight, RAM, RDS, RDSDataService, RDS, RDS, RDS, RDS, RUM, Rbin, Redshift, RedshiftData, RedshiftServerless, Rekognition, RemoteCredentials, Repostspace, Request, Resiliencehub, ResourceExplorer2, ResourceGroups, ResourceGroupsTaggingAPI, Response, RoboMaker, RolesAnywhere, Route53, Route53Domains, Route53Profiles, Route53RecoveryCluster, Route53RecoveryControlConfig, Route53RecoveryReadiness, Route53Resolver, S3, S3Control, S3Outposts, SAMLCredentials, SES, SESV2, SMS, SNS, SQS, SSM, SSMContacts, SSMIncidents, SSMQuickSetup, SSO, SSOAdmin, SSOOIDC, SSOTokenProvider, STS, SWF, SageMaker, SageMakerFeatureStoreRuntime, SageMakerGeospatial, SageMakerMetrics, SageMakerRuntime, SagemakerEdge, SavingsPlans, Scheduler, Schemas, SecretsManager, SecurityHub, SecurityLake, ServerlessApplicationRepository, Service, ServiceCatalog, ServiceCatalogAppRegistry, ServiceDiscovery, ServiceQuotas, SharedIniFileCredentials, Shield, Signer, SimSpaceWeaver, SimpleDB, SnowDeviceManagement, Snowball, SsmSap, SsoCredentials, StaticTokenProvider, StepFunctions, StorageGateway, SupplyChain, Support, SupportApp, Synthetics, TaxSettings, TemporaryCredentials, Textract, TimestreamInfluxDB, TimestreamQuery, TimestreamWrite, Tnb, Token, TokenFileWebIdentityCredentials, TokenProviderChain, TranscribeService, Transfer, Translate, TrustedAdvisor, VPCLattice, VerifiedPermissions, VoiceID, WAF, WAFRegional, WAFV2, WebIdentityCredentials, WellArchitected, Wisdom, WorkDocs, WorkLink, WorkMail, WorkMailMessageFlow, WorkSpaces, WorkSpacesThinClient, WorkSpacesWeb, XRay

Constant Summarycollapse

SimpleWorkflow =

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

AWS.SWF

VERSION =

'2.1692.0'

Loading and Setting Configuration Optionscollapse

Property Summarycollapse

Property Details

config ⇒ AWS.Config

Returns The global configuration object singleton instance.

ECSCredentials ⇒ Object

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
});

events ⇒ AWS.SequentialExecutor

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