@aws-sdk/client-elastic-beanstalk
Description
AWS SDK for JavaScript ElasticBeanstalk Client for Node.js, Browser and React Native.
AWS Elastic Beanstalk
AWS Elastic Beanstalk makes it easy for you to create, deploy, and manage scalable,
fault-tolerant applications running on the Amazon Web Services cloud.
For more information about this product, go to the AWS Elastic Beanstalk details page. The location of the
latest AWS Elastic Beanstalk WSDL is https://elasticbeanstalk.s3.amazonaws.com/doc/2010-12-01/AWSElasticBeanstalk.wsdl.
To install the Software Development Kits (SDKs), Integrated Development Environment (IDE)
Toolkits, and command line tools that enable you to access the API, go to Tools for Amazon Web Services.
Endpoints
For a list of region-specific endpoints that AWS Elastic Beanstalk supports, go to
Regions and Endpoints in the Amazon Web Services
Glossary.
Installing
To install this package, simply type add or install @aws-sdk/client-elastic-beanstalk
using your favorite package manager:
npm install @aws-sdk/client-elastic-beanstalk
yarn add @aws-sdk/client-elastic-beanstalk
pnpm add @aws-sdk/client-elastic-beanstalk
Getting Started
Import
The AWS SDK is modulized by clients and commands.
To send a request, you only need to import the ElasticBeanstalkClient
and
the commands you need, for example ListPlatformBranchesCommand
:
const { ElasticBeanstalkClient, ListPlatformBranchesCommand } = require("@aws-sdk/client-elastic-beanstalk");
import { ElasticBeanstalkClient, ListPlatformBranchesCommand } from "@aws-sdk/client-elastic-beanstalk";
Usage
To send a request, you:
- Initiate client with configuration (e.g. credentials, region).
- Initiate command with input parameters.
- Call
send
operation on client with command object as input. - If you are using a custom http handler, you may call
destroy()
to close open connections.
const client = new ElasticBeanstalkClient({ region: "REGION" });
const params = {
};
const command = new ListPlatformBranchesCommand(params);
Async/await
We recommend using await
operator to wait for the promise returned by send operation as follows:
try {
const data = await client.send(command);
} catch (error) {
} finally {
}
Async-await is clean, concise, intuitive, easy to debug and has better error handling
as compared to using Promise chains or callbacks.
Promises
You can also use Promise chaining
to execute send operation.
client.send(command).then(
(data) => {
},
(error) => {
}
);
Promises can also be called using .catch()
and .finally()
as follows:
client
.send(command)
.then((data) => {
})
.catch((error) => {
})
.finally(() => {
});
Callbacks
We do not recommend using callbacks because of callback hell,
but they are supported by the send operation.
client.send(command, (err, data) => {
});
v2 compatible style
The client can also send requests using v2 compatible style.
However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
on modular packages in AWS SDK for JavaScript
import * as AWS from "@aws-sdk/client-elastic-beanstalk";
const client = new AWS.ElasticBeanstalk({ region: "REGION" });
try {
const data = await client.listPlatformBranches(params);
} catch (error) {
}
client
.listPlatformBranches(params)
.then((data) => {
})
.catch((error) => {
});
client.listPlatformBranches(params, (err, data) => {
});
Troubleshooting
When the service returns an exception, the error will include the exception information,
as well as response metadata (e.g. request id).
try {
const data = await client.send(command);
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$metadata;
console.log({ requestId, cfId, extendedRequestId });
}
Getting Help
Please use these community resources for getting help.
We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
To test your universal JavaScript code in Node.js, browser and react-native environments,
visit our code samples repo.
Contributing
This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-elastic-beanstalk
package is updated.
To contribute to client you can check our generate clients scripts.
License
This SDK is distributed under the
Apache License, Version 2.0,
see LICENSE for more information.
Client Commands (Operations List)
AbortEnvironmentUpdate
Command API Reference / Input / Output
ApplyEnvironmentManagedAction
Command API Reference / Input / Output
AssociateEnvironmentOperationsRole
Command API Reference / Input / Output
CheckDNSAvailability
Command API Reference / Input / Output
ComposeEnvironments
Command API Reference / Input / Output
CreateApplication
Command API Reference / Input / Output
CreateApplicationVersion
Command API Reference / Input / Output
CreateConfigurationTemplate
Command API Reference / Input / Output
CreateEnvironment
Command API Reference / Input / Output
CreatePlatformVersion
Command API Reference / Input / Output
CreateStorageLocation
Command API Reference / Input / Output
DeleteApplication
Command API Reference / Input / Output
DeleteApplicationVersion
Command API Reference / Input / Output
DeleteConfigurationTemplate
Command API Reference / Input / Output
DeleteEnvironmentConfiguration
Command API Reference / Input / Output
DeletePlatformVersion
Command API Reference / Input / Output
DescribeAccountAttributes
Command API Reference / Input / Output
DescribeApplications
Command API Reference / Input / Output
DescribeApplicationVersions
Command API Reference / Input / Output
DescribeConfigurationOptions
Command API Reference / Input / Output
DescribeConfigurationSettings
Command API Reference / Input / Output
DescribeEnvironmentHealth
Command API Reference / Input / Output
DescribeEnvironmentManagedActionHistory
Command API Reference / Input / Output
DescribeEnvironmentManagedActions
Command API Reference / Input / Output
DescribeEnvironmentResources
Command API Reference / Input / Output
DescribeEnvironments
Command API Reference / Input / Output
DescribeEvents
Command API Reference / Input / Output
DescribeInstancesHealth
Command API Reference / Input / Output
DescribePlatformVersion
Command API Reference / Input / Output
DisassociateEnvironmentOperationsRole
Command API Reference / Input / Output
ListAvailableSolutionStacks
Command API Reference / Input / Output
ListPlatformBranches
Command API Reference / Input / Output
ListPlatformVersions
Command API Reference / Input / Output
ListTagsForResource
Command API Reference / Input / Output
RebuildEnvironment
Command API Reference / Input / Output
RequestEnvironmentInfo
Command API Reference / Input / Output
RestartAppServer
Command API Reference / Input / Output
RetrieveEnvironmentInfo
Command API Reference / Input / Output
SwapEnvironmentCNAMEs
Command API Reference / Input / Output
TerminateEnvironment
Command API Reference / Input / Output
UpdateApplication
Command API Reference / Input / Output
UpdateApplicationResourceLifecycle
Command API Reference / Input / Output
UpdateApplicationVersion
Command API Reference / Input / Output
UpdateConfigurationTemplate
Command API Reference / Input / Output
UpdateEnvironment
Command API Reference / Input / Output
UpdateTagsForResource
Command API Reference / Input / Output
ValidateConfigurationSettings
Command API Reference / Input / Output