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.

Class: AWS.ElasticBeanstalk

Inherits:
AWS.Service show all
Identifier:
elasticbeanstalk
API Version:
2010-12-01
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

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.

Sending a Request Using ElasticBeanstalk

var elasticbeanstalk = new AWS.ElasticBeanstalk();
elasticbeanstalk.abortEnvironmentUpdate(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the ElasticBeanstalk object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var elasticbeanstalk = new AWS.ElasticBeanstalk({apiVersion: '2010-12-01'});

You can also set the API version globally in AWS.config.apiVersions using the elasticbeanstalk service identifier:

AWS.config.apiVersions = {
  elasticbeanstalk: '2010-12-01',
  // other service API versions
};

var elasticbeanstalk = new AWS.ElasticBeanstalk();

Version:

  • 2010-12-01

Waiter Resource States

This service supports a list of resource states that can be polled using the waitFor() method. The resource states are:

environmentExists, environmentUpdated, environmentTerminated

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, setupRequestListeners, defineService

Constructor Details

new AWS.ElasticBeanstalk(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a ElasticBeanstalk object

var elasticbeanstalk = new AWS.ElasticBeanstalk({apiVersion: '2010-12-01'});

Options Hash (options):

  • params (map) —

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint) —

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • 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 AWS.ElasticBeanstalk.region for more information.

  • maxRetries (Integer) —

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

  • maxRedirects (Integer) —

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

  • sslEnabled (Boolean) —

    whether to enable SSL for requests.

  • paramValidation (Boolean|map) —

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

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

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

  • convertResponseTypes (Boolean) —

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

  • correctClockSkew (Boolean) —

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

  • s3ForcePathStyle (Boolean) —

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean) —

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

  • s3DisableBodySigning (Boolean) —

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

  • s3UsEast1RegionalEndpoint ('legacy'|'regional') —

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

  • s3UseArnRegion (Boolean) —

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

  • retryDelayOptions (map) —

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

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

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

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

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

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

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

  • logger (#write, #log) —

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

  • systemClockOffset (Number) —

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

  • signatureVersion (String) —

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

  • signatureCache (Boolean) —

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

  • dynamoDbCrc32 (Boolean) —

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

  • useAccelerateEndpoint (Boolean) —

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

  • clientSideMonitoring (Boolean) —

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

  • endpointDiscoveryEnabled (Boolean|undefined) —

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

  • endpointCacheSize (Number) —

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

  • hostPrefixEnabled (Boolean) —

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

  • stsRegionalEndpoints ('legacy'|'regional') —

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

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint) —

    an Endpoint object representing the endpoint URL for service requests.

Method Details

abortEnvironmentUpdate(params = {}, callback) ⇒ AWS.Request

Cancels in-progress environment configuration update or application version deployment.

Service Reference:

Examples:

To abort a deployment


/* The following code aborts a running application version deployment for an environment named my-env: */

 var params = {
  EnvironmentName: "my-env"
 };
 elasticbeanstalk.abortEnvironmentUpdate(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the abortEnvironmentUpdate operation

var params = {
  EnvironmentId: 'STRING_VALUE',
  EnvironmentName: 'STRING_VALUE'
};
elasticbeanstalk.abortEnvironmentUpdate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • EnvironmentId — (String)

      This specifies the ID of the environment with the in-progress update that you want to cancel.

    • EnvironmentName — (String)

      This specifies the name of the environment with the in-progress update that you want to cancel.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

applyEnvironmentManagedAction(params = {}, callback) ⇒ AWS.Request

Applies a scheduled managed action immediately. A managed action can be applied only if its status is Scheduled. Get the status and action ID of a managed action with DescribeEnvironmentManagedActions.

Service Reference:

Examples:

Calling the applyEnvironmentManagedAction operation

var params = {
  ActionId: 'STRING_VALUE', /* required */
  EnvironmentId: 'STRING_VALUE',
  EnvironmentName: 'STRING_VALUE'
};
elasticbeanstalk.applyEnvironmentManagedAction(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • EnvironmentName — (String)

      The name of the target environment.

    • EnvironmentId — (String)

      The environment ID of the target environment.

    • ActionId — (String)

      The action ID of the scheduled managed action to execute.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ActionId — (String)

        The action ID of the managed action.

      • ActionDescription — (String)

        A description of the managed action.

      • ActionType — (String)

        The type of managed action.

        Possible values include:
        • "InstanceRefresh"
        • "PlatformUpdate"
        • "Unknown"
      • Status — (String)

        The status of the managed action.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

associateEnvironmentOperationsRole(params = {}, callback) ⇒ AWS.Request

Add or change the operations role used by an environment. After this call is made, Elastic Beanstalk uses the associated operations role for permissions to downstream services during subsequent calls acting on this environment. For more information, see Operations roles in the AWS Elastic Beanstalk Developer Guide.

Service Reference:

Examples:

Calling the associateEnvironmentOperationsRole operation

var params = {
  EnvironmentName: 'STRING_VALUE', /* required */
  OperationsRole: 'STRING_VALUE' /* required */
};
elasticbeanstalk.associateEnvironmentOperationsRole(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • EnvironmentName — (String)

      The name of the environment to which to set the operations role.

    • OperationsRole — (String)

      The Amazon Resource Name (ARN) of an existing IAM role to be used as the environment's operations role.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

checkDNSAvailability(params = {}, callback) ⇒ AWS.Request

Checks if the specified CNAME is available.

Service Reference:

Examples:

To check the availability of a CNAME


/* The following operation checks the availability of the subdomain my-cname: */

 var params = {
  CNAMEPrefix: "my-cname"
 };
 elasticbeanstalk.checkDNSAvailability(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Available: true, 
    FullyQualifiedCNAME: "my-cname.us-west-2.elasticbeanstalk.com"
   }
   */
 });

Calling the checkDNSAvailability operation

var params = {
  CNAMEPrefix: 'STRING_VALUE' /* required */
};
elasticbeanstalk.checkDNSAvailability(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • CNAMEPrefix — (String)

      The prefix used when this CNAME is reserved.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Available — (Boolean)

        Indicates if the specified CNAME is available:

        • true : The CNAME is available.

        • false : The CNAME is not available.

      • FullyQualifiedCNAME — (String)

        The fully qualified CNAME to reserve when CreateEnvironment is called with the provided prefix.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

composeEnvironments(params = {}, callback) ⇒ AWS.Request

Create or update a group of environments that each run a separate component of a single application. Takes a list of version labels that specify application source bundles for each of the environments to create or update. The name of each environment and other required information must be included in the source bundles in an environment manifest named env.yaml. See Compose Environments for details.

Service Reference:

Examples:

Calling the composeEnvironments operation

var params = {
  ApplicationName: 'STRING_VALUE',
  GroupName: 'STRING_VALUE',
  VersionLabels: [
    'STRING_VALUE',
    /* more items */
  ]
};
elasticbeanstalk.composeEnvironments(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationName — (String)

      The name of the application to which the specified source bundles belong.

    • GroupName — (String)

      The name of the group to which the target environments belong. Specify a group name only if the environment name defined in each target environment's manifest ends with a + (plus) character. See Environment Manifest (env.yaml) for details.

    • VersionLabels — (Array<String>)

      A list of version labels, specifying one or more application source bundles that belong to the target application. Each source bundle must include an environment manifest that specifies the name of the environment and the name of the solution stack to use, and optionally can specify environment links to create.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Environments — (Array<map>)

        Returns an EnvironmentDescription list.

        • EnvironmentName — (String)

          The name of this environment.

        • EnvironmentId — (String)

          The ID of this environment.

        • ApplicationName — (String)

          The name of the application associated with this environment.

        • VersionLabel — (String)

          The application version deployed in this environment.

        • SolutionStackName — (String)

          The name of the SolutionStack deployed with this environment.

        • PlatformArn — (String)

          The ARN of the platform version.

        • TemplateName — (String)

          The name of the configuration template used to originally launch this environment.

        • Description — (String)

          Describes this environment.

        • EndpointURL — (String)

          For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.

        • CNAME — (String)

          The URL to the CNAME for this environment.

        • DateCreated — (Date)

          The creation date for this environment.

        • DateUpdated — (Date)

          The last modified date for this environment.

        • Status — (String)

          The current operational status of the environment:

          • Launching: Environment is in the process of initial deployment.

          • Updating: Environment is in the process of updating its configuration settings or application version.

          • Ready: Environment is available to have an action performed on it, such as update or terminate.

          • Terminating: Environment is in the shut-down process.

          • Terminated: Environment is not running.

          Possible values include:
          • "Aborting"
          • "Launching"
          • "Updating"
          • "LinkingFrom"
          • "LinkingTo"
          • "Ready"
          • "Terminating"
          • "Terminated"
        • AbortableOperationInProgress — (Boolean)

          Indicates if there is an in-progress environment configuration update or application version deployment that you can cancel.

          true: There is an update in progress.

          false: There are no updates currently in progress.

        • Health — (String)

          Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment:

          • Red: Indicates the environment is not responsive. Occurs when three or more consecutive failures occur for an environment.

          • Yellow: Indicates that something is wrong. Occurs when two consecutive failures occur for an environment.

          • Green: Indicates the environment is healthy and fully functional.

          • Grey: Default health for a new environment. The environment is not fully launched and health checks have not started or health checks are suspended during an UpdateEnvironment or RestartEnvironment request.

          Default: Grey

          Possible values include:
          • "Green"
          • "Yellow"
          • "Red"
          • "Grey"
        • HealthStatus — (String)

          Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses.

          Possible values include:
          • "NoData"
          • "Unknown"
          • "Pending"
          • "Ok"
          • "Info"
          • "Warning"
          • "Degraded"
          • "Severe"
          • "Suspended"
        • Resources — (map)

          The description of the AWS resources used by this environment.

          • LoadBalancer — (map)

            Describes the LoadBalancer.

            • LoadBalancerName — (String)

              The name of the LoadBalancer.

            • Domain — (String)

              The domain name of the LoadBalancer.

            • Listeners — (Array<map>)

              A list of Listeners used by the LoadBalancer.

              • Protocol — (String)

                The protocol that is used by the Listener.

              • Port — (Integer)

                The port that is used by the Listener.

        • Tier — (map)

          Describes the current tier of this environment.

          • Name — (String)

            The name of this environment tier.

            Valid values:

            • For Web server tier – WebServer

            • For Worker tier – Worker

          • Type — (String)

            The type of this environment tier.

            Valid values:

            • For Web server tier – Standard

            • For Worker tier – SQS/HTTP

          • Version — (String)

            The version of this environment tier. When you don't set a value to it, Elastic Beanstalk uses the latest compatible worker tier version.

            Note: This member is deprecated. Any specific version that you set may become out of date. We recommend leaving it unspecified.
        • EnvironmentLinks — (Array<map>)

          A list of links to other environments in the same group.

          • LinkName — (String)

            The name of the link.

          • EnvironmentName — (String)

            The name of the linked environment (the dependency).

        • EnvironmentArn — (String)

          The environment's Amazon Resource Name (ARN), which can be used in other API requests that require an ARN.

        • OperationsRole — (String)

          The Amazon Resource Name (ARN) of the environment's operations role. For more information, see Operations roles in the AWS Elastic Beanstalk Developer Guide.

      • NextToken — (String)

        In a paginated request, the token that you can pass in a subsequent request to get the next response page.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createApplication(params = {}, callback) ⇒ AWS.Request

Creates an application that has one configuration template named default and no application versions.

Service Reference:

Examples:

To create a new application


/* The following operation creates a new application named my-app: */

 var params = {
  ApplicationName: "my-app", 
  Description: "my application"
 };
 elasticbeanstalk.createApplication(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Application: {
     ApplicationName: "my-app", 
     ConfigurationTemplates: [
     ], 
     DateCreated: <Date Representation>, 
     DateUpdated: <Date Representation>, 
     Description: "my application"
    }
   }
   */
 });

Calling the createApplication operation

var params = {
  ApplicationName: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  ResourceLifecycleConfig: {
    ServiceRole: 'STRING_VALUE',
    VersionLifecycleConfig: {
      MaxAgeRule: {
        Enabled: true || false, /* required */
        DeleteSourceFromS3: true || false,
        MaxAgeInDays: 'NUMBER_VALUE'
      },
      MaxCountRule: {
        Enabled: true || false, /* required */
        DeleteSourceFromS3: true || false,
        MaxCount: 'NUMBER_VALUE'
      }
    }
  },
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
elasticbeanstalk.createApplication(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationName — (String)

      The name of the application. Must be unique within your account.

    • Description — (String)

      Your description of the application.

    • ResourceLifecycleConfig — (map)

      Specifies an application resource lifecycle configuration to prevent your application from accumulating too many versions.

      • ServiceRole — (String)

        The ARN of an IAM service role that Elastic Beanstalk has permission to assume.

        The ServiceRole property is required the first time that you provide a VersionLifecycleConfig for the application in one of the supporting calls (CreateApplication or UpdateApplicationResourceLifecycle). After you provide it once, in either one of the calls, Elastic Beanstalk persists the Service Role with the application, and you don't need to specify it again in subsequent UpdateApplicationResourceLifecycle calls. You can, however, specify it in subsequent calls to change the Service Role to another value.

      • VersionLifecycleConfig — (map)

        Defines lifecycle settings for application versions.

        • MaxCountRule — (map)

          Specify a max count rule to restrict the number of application versions that are retained for an application.

          • Enabled — required — (Boolean)

            Specify true to apply the rule, or false to disable it.

          • MaxCount — (Integer)

            Specify the maximum number of application versions to retain.

          • DeleteSourceFromS3 — (Boolean)

            Set to true to delete a version's source bundle from Amazon S3 when Elastic Beanstalk deletes the application version.

        • MaxAgeRule — (map)

          Specify a max age rule to restrict the length of time that application versions are retained for an application.

          • Enabled — required — (Boolean)

            Specify true to apply the rule, or false to disable it.

          • MaxAgeInDays — (Integer)

            Specify the number of days to retain an application versions.

          • DeleteSourceFromS3 — (Boolean)

            Set to true to delete a version's source bundle from Amazon S3 when Elastic Beanstalk deletes the application version.

    • Tags — (Array<map>)

      Specifies the tags applied to the application.

      Elastic Beanstalk applies these tags only to the application. Environments that you create in the application don't inherit the tags.

      • Key — (String)

        The key of the tag.

      • Value — (String)

        The value of the tag.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Application — (map)

        The ApplicationDescription of the application.

        • ApplicationArn — (String)

          The Amazon Resource Name (ARN) of the application.

        • ApplicationName — (String)

          The name of the application.

        • Description — (String)

          User-defined description of the application.

        • DateCreated — (Date)

          The date when the application was created.

        • DateUpdated — (Date)

          The date when the application was last modified.

        • Versions — (Array<String>)

          The names of the versions for this application.

        • ConfigurationTemplates — (Array<String>)

          The names of the configuration templates associated with this application.

        • ResourceLifecycleConfig — (map)

          The lifecycle settings for the application.

          • ServiceRole — (String)

            The ARN of an IAM service role that Elastic Beanstalk has permission to assume.

            The ServiceRole property is required the first time that you provide a VersionLifecycleConfig for the application in one of the supporting calls (CreateApplication or UpdateApplicationResourceLifecycle). After you provide it once, in either one of the calls, Elastic Beanstalk persists the Service Role with the application, and you don't need to specify it again in subsequent UpdateApplicationResourceLifecycle calls. You can, however, specify it in subsequent calls to change the Service Role to another value.

          • VersionLifecycleConfig — (map)

            Defines lifecycle settings for application versions.

            • MaxCountRule — (map)

              Specify a max count rule to restrict the number of application versions that are retained for an application.

              • Enabled — required — (Boolean)

                Specify true to apply the rule, or false to disable it.

              • MaxCount — (Integer)

                Specify the maximum number of application versions to retain.

              • DeleteSourceFromS3 — (Boolean)

                Set to true to delete a version's source bundle from Amazon S3 when Elastic Beanstalk deletes the application version.

            • MaxAgeRule — (map)

              Specify a max age rule to restrict the length of time that application versions are retained for an application.

              • Enabled — required — (Boolean)

                Specify true to apply the rule, or false to disable it.

              • MaxAgeInDays — (Integer)

                Specify the number of days to retain an application versions.

              • DeleteSourceFromS3 — (Boolean)

                Set to true to delete a version's source bundle from Amazon S3 when Elastic Beanstalk deletes the application version.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createApplicationVersion(params = {}, callback) ⇒ AWS.Request

Creates an application version for the specified application. You can create an application version from a source bundle in Amazon S3, a commit in AWS CodeCommit, or the output of an AWS CodeBuild build as follows:

Specify a commit in an AWS CodeCommit repository with SourceBuildInformation.

Specify a build in an AWS CodeBuild with SourceBuildInformation and BuildConfiguration.

Specify a source bundle in S3 with SourceBundle

Omit both SourceBuildInformation and SourceBundle to use the default sample application.

Note: After you create an application version with a specified Amazon S3 bucket and key location, you can't change that Amazon S3 location. If you change the Amazon S3 location, you receive an exception when you attempt to launch an environment from the application version.

Service Reference:

Examples:

To create a new application


/* The following operation creates a new version (v1) of an application named my-app: */

 var params = {
  ApplicationName: "my-app", 
  AutoCreateApplication: true, 
  Description: "my-app-v1", 
  Process: true, 
  SourceBundle: {
   S3Bucket: "my-bucket", 
   S3Key: "sample.war"
  }, 
  VersionLabel: "v1"
 };
 elasticbeanstalk.createApplicationVersion(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ApplicationVersion: {
     ApplicationName: "my-app", 
     DateCreated: <Date Representation>, 
     DateUpdated: <Date Representation>, 
     Description: "my-app-v1", 
     SourceBundle: {
      S3Bucket: "my-bucket", 
      S3Key: "sample.war"
     }, 
     VersionLabel: "v1"
    }
   }
   */
 });

Calling the createApplicationVersion operation

var params = {
  ApplicationName: 'STRING_VALUE', /* required */
  VersionLabel: 'STRING_VALUE', /* required */
  AutoCreateApplication: true || false,
  BuildConfiguration: {
    CodeBuildServiceRole: 'STRING_VALUE', /* required */
    Image: 'STRING_VALUE', /* required */
    ArtifactName: 'STRING_VALUE',
    ComputeType: BUILD_GENERAL1_SMALL | BUILD_GENERAL1_MEDIUM | BUILD_GENERAL1_LARGE,
    TimeoutInMinutes: 'NUMBER_VALUE'
  },
  Description: 'STRING_VALUE',
  Process: true || false,
  SourceBuildInformation: {
    SourceLocation: 'STRING_VALUE', /* required */
    SourceRepository: CodeCommit | S3, /* required */
    SourceType: Git | Zip /* required */
  },
  SourceBundle: {
    S3Bucket: 'STRING_VALUE',
    S3Key: 'STRING_VALUE'
  },
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
elasticbeanstalk.createApplicationVersion(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationName — (String)

      The name of the application. If no application is found with this name, and AutoCreateApplication is false, returns an InvalidParameterValue error.

    • VersionLabel — (String)

      A label identifying this version.

      Constraint: Must be unique per application. If an application version already exists with this label for the specified application, AWS Elastic Beanstalk returns an InvalidParameterValue error.

    • Description — (String)

      A description of this application version.

    • SourceBuildInformation — (map)

      Specify a commit in an AWS CodeCommit Git repository to use as the source code for the application version.

      • SourceType — required — (String)

        The type of repository.

        • Git

        • Zip

        Possible values include:
        • "Git"
        • "Zip"
      • SourceRepository — required — (String)

        Location where the repository is stored.

        • CodeCommit

        • S3

        Possible values include:
        • "CodeCommit"
        • "S3"
      • SourceLocation — required — (String)

        The location of the source code, as a formatted string, depending on the value of SourceRepository

        • For CodeCommit, the format is the repository name and commit ID, separated by a forward slash. For example, my-git-repo/265cfa0cf6af46153527f55d6503ec030551f57a.

        • For S3, the format is the S3 bucket name and object key, separated by a forward slash. For example, my-s3-bucket/Folders/my-source-file.

    • SourceBundle — (map)

      The Amazon S3 bucket and key that identify the location of the source bundle for this version.

      Note: The Amazon S3 bucket must be in the same region as the environment.

      Specify a source bundle in S3 or a commit in an AWS CodeCommit repository (with SourceBuildInformation), but not both. If neither SourceBundle nor SourceBuildInformation are provided, Elastic Beanstalk uses a sample application.

      • S3Bucket — (String)

        The Amazon S3 bucket where the data is located.

      • S3Key — (String)

        The Amazon S3 key where the data is located.

    • BuildConfiguration — (map)

      Settings for an AWS CodeBuild build.

      • ArtifactName — (String)

        The name of the artifact of the CodeBuild build. If provided, Elastic Beanstalk stores the build artifact in the S3 location S3-bucket/resources/application-name/codebuild/codebuild-version-label-artifact-name.zip. If not provided, Elastic Beanstalk stores the build artifact in the S3 location S3-bucket/resources/application-name/codebuild/codebuild-version-label.zip.

      • CodeBuildServiceRole — required — (String)

        The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.

      • ComputeType — (String)

        Information about the compute resources the build project will use.

        • BUILD_GENERAL1_SMALL: Use up to 3 GB memory and 2 vCPUs for builds

        • BUILD_GENERAL1_MEDIUM: Use up to 7 GB memory and 4 vCPUs for builds

        • BUILD_GENERAL1_LARGE: Use up to 15 GB memory and 8 vCPUs for builds

        Possible values include:
        • "BUILD_GENERAL1_SMALL"
        • "BUILD_GENERAL1_MEDIUM"
        • "BUILD_GENERAL1_LARGE"
      • Image — required — (String)

        The ID of the Docker image to use for this build project.

      • TimeoutInMinutes — (Integer)

        How long in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait until timing out any related build that does not get marked as completed. The default is 60 minutes.

    • AutoCreateApplication — (Boolean)

      Set to true to create an application with the specified name if it doesn't already exist.

    • Process — (Boolean)

      Pre-processes and validates the environment manifest (env.yaml) and configuration files (*.config files in the .ebextensions folder) in the source bundle. Validating configuration files can identify issues prior to deploying the application version to an environment.

      You must turn processing on for application versions that you create using AWS CodeBuild or AWS CodeCommit. For application versions built from a source bundle in Amazon S3, processing is optional.

      Note: The Process option validates Elastic Beanstalk configuration files. It doesn't validate your application's configuration files, like proxy server or Docker configuration.
    • Tags — (Array<map>)

      Specifies the tags applied to the application version.

      Elastic Beanstalk applies these tags only to the application version. Environments that use the application version don't inherit the tags.

      • Key — (String)

        The key of the tag.

      • Value — (String)

        The value of the tag.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ApplicationVersion — (map)

        The ApplicationVersionDescription of the application version.

        • ApplicationVersionArn — (String)

          The Amazon Resource Name (ARN) of the application version.

        • ApplicationName — (String)

          The name of the application to which the application version belongs.

        • Description — (String)

          The description of the application version.

        • VersionLabel — (String)

          A unique identifier for the application version.

        • SourceBuildInformation — (map)

          If the version's source code was retrieved from AWS CodeCommit, the location of the source code for the application version.

          • SourceType — required — (String)

            The type of repository.

            • Git

            • Zip

            Possible values include:
            • "Git"
            • "Zip"
          • SourceRepository — required — (String)

            Location where the repository is stored.

            • CodeCommit

            • S3

            Possible values include:
            • "CodeCommit"
            • "S3"
          • SourceLocation — required — (String)

            The location of the source code, as a formatted string, depending on the value of SourceRepository

            • For CodeCommit, the format is the repository name and commit ID, separated by a forward slash. For example, my-git-repo/265cfa0cf6af46153527f55d6503ec030551f57a.

            • For S3, the format is the S3 bucket name and object key, separated by a forward slash. For example, my-s3-bucket/Folders/my-source-file.

        • BuildArn — (String)

          Reference to the artifact from the AWS CodeBuild build.

        • SourceBundle — (map)

          The storage location of the application version's source bundle in Amazon S3.

          • S3Bucket — (String)

            The Amazon S3 bucket where the data is located.

          • S3Key — (String)

            The Amazon S3 key where the data is located.

        • DateCreated — (Date)

          The creation date of the application version.

        • DateUpdated — (Date)

          The last modified date of the application version.

        • Status — (String)

          The processing status of the application version. Reflects the state of the application version during its creation. Many of the values are only applicable if you specified True for the Process parameter of the CreateApplicationVersion action. The following list describes the possible values.

          • Unprocessed – Application version wasn't pre-processed or validated. Elastic Beanstalk will validate configuration files during deployment of the application version to an environment.

          • Processing – Elastic Beanstalk is currently processing the application version.

          • Building – Application version is currently undergoing an AWS CodeBuild build.

          • Processed – Elastic Beanstalk was successfully pre-processed and validated.

          • Failed – Either the AWS CodeBuild build failed or configuration files didn't pass validation. This application version isn't usable.

          Possible values include:
          • "Processed"
          • "Unprocessed"
          • "Failed"
          • "Processing"
          • "Building"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createConfigurationTemplate(params = {}, callback) ⇒ AWS.Request

Creates an AWS Elastic Beanstalk configuration template, associated with a specific Elastic Beanstalk application. You define application configuration settings in a configuration template. You can then use the configuration template to deploy different versions of the application with the same configuration settings.

Templates aren't associated with any environment. The EnvironmentName response element is always null.

Related Topics

Service Reference:

Examples:

To create a configuration template


/* The following operation creates a configuration template named my-app-v1 from the settings applied to an environment with the id e-rpqsewtp2j: */

 var params = {
  ApplicationName: "my-app", 
  EnvironmentId: "e-rpqsewtp2j", 
  TemplateName: "my-app-v1"
 };
 elasticbeanstalk.createConfigurationTemplate(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ApplicationName: "my-app", 
    DateCreated: <Date Representation>, 
    DateUpdated: <Date Representation>, 
    SolutionStackName: "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8", 
    TemplateName: "my-app-v1"
   }
   */
 });

Calling the createConfigurationTemplate operation

var params = {
  ApplicationName: 'STRING_VALUE', /* required */
  TemplateName: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  EnvironmentId: 'STRING_VALUE',
  OptionSettings: [
    {
      Namespace: 'STRING_VALUE',
      OptionName: 'STRING_VALUE',
      ResourceName: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  PlatformArn: 'STRING_VALUE',
  SolutionStackName: 'STRING_VALUE',
  SourceConfiguration: {
    ApplicationName: 'STRING_VALUE',
    TemplateName: 'STRING_VALUE'
  },
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
elasticbeanstalk.createConfigurationTemplate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationName — (String)

      The name of the Elastic Beanstalk application to associate with this configuration template.

    • TemplateName — (String)

      The name of the configuration template.

      Constraint: This name must be unique per application.

    • SolutionStackName — (String)

      The name of an Elastic Beanstalk solution stack (platform version) that this configuration uses. For example, 64bit Amazon Linux 2013.09 running Tomcat 7 Java 7. A solution stack specifies the operating system, runtime, and application server for a configuration template. It also determines the set of configuration options as well as the possible and default values. For more information, see Supported Platforms in the AWS Elastic Beanstalk Developer Guide.

      You must specify SolutionStackName if you don't specify PlatformArn, EnvironmentId, or SourceConfiguration.

      Use the ListAvailableSolutionStacks API to obtain a list of available solution stacks.

    • PlatformArn — (String)

      The Amazon Resource Name (ARN) of the custom platform. For more information, see Custom Platforms in the AWS Elastic Beanstalk Developer Guide.

      Note: If you specify PlatformArn, then don't specify SolutionStackName.
    • SourceConfiguration — (map)

      An Elastic Beanstalk configuration template to base this one on. If specified, Elastic Beanstalk uses the configuration values from the specified configuration template to create a new configuration.

      Values specified in OptionSettings override any values obtained from the SourceConfiguration.

      You must specify SourceConfiguration if you don't specify PlatformArn, EnvironmentId, or SolutionStackName.

      Constraint: If both solution stack name and source configuration are specified, the solution stack of the source configuration template must match the specified solution stack name.

      • ApplicationName — (String)

        The name of the application associated with the configuration.

      • TemplateName — (String)

        The name of the configuration template.

    • EnvironmentId — (String)

      The ID of an environment whose settings you want to use to create the configuration template. You must specify EnvironmentId if you don't specify PlatformArn, SolutionStackName, or SourceConfiguration.

    • Description — (String)

      An optional description for this configuration.

    • OptionSettings — (Array<map>)

      Option values for the Elastic Beanstalk configuration, such as the instance type. If specified, these values override the values obtained from the solution stack or the source configuration template. For a complete list of Elastic Beanstalk configuration options, see Option Values in the AWS Elastic Beanstalk Developer Guide.

      • ResourceName — (String)

        A unique resource name for the option setting. Use it for a time–based scaling configuration option.

      • Namespace — (String)

        A unique namespace that identifies the option's associated AWS resource.

      • OptionName — (String)

        The name of the configuration option.

      • Value — (String)

        The current value for the configuration option.

    • Tags — (Array<map>)

      Specifies the tags applied to the configuration template.

      • Key — (String)

        The key of the tag.

      • Value — (String)

        The value of the tag.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • SolutionStackName — (String)

        The name of the solution stack this configuration set uses.

      • PlatformArn — (String)

        The ARN of the platform version.

      • ApplicationName — (String)

        The name of the application associated with this configuration set.

      • TemplateName — (String)

        If not null, the name of the configuration template for this configuration set.

      • Description — (String)

        Describes this configuration set.

      • EnvironmentName — (String)

        If not null, the name of the environment for this configuration set.

      • DeploymentStatus — (String)

        If this configuration set is associated with an environment, the DeploymentStatus parameter indicates the deployment status of this configuration set:

        • null: This configuration is not associated with a running environment.

        • pending: This is a draft configuration that is not deployed to the associated environment but is in the process of deploying.

        • deployed: This is the configuration that is currently deployed to the associated running environment.

        • failed: This is a draft configuration that failed to successfully deploy.

        Possible values include:
        • "deployed"
        • "pending"
        • "failed"
      • DateCreated — (Date)

        The date (in UTC time) when this configuration set was created.

      • DateUpdated — (Date)

        The date (in UTC time) when this configuration set was last modified.

      • OptionSettings — (Array<map>)

        A list of the configuration options and their values in this configuration set.

        • ResourceName — (String)

          A unique resource name for the option setting. Use it for a time–based scaling configuration option.

        • Namespace — (String)

          A unique namespace that identifies the option's associated AWS resource.

        • OptionName — (String)

          The name of the configuration option.

        • Value — (String)

          The current value for the configuration option.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createEnvironment(params = {}, callback) ⇒ AWS.Request

Launches an AWS Elastic Beanstalk environment for the specified application using the specified configuration.

Service Reference:

Examples:

To create a new environment for an application


/* The following operation creates a new environment for version v1 of a java application named my-app: */

 var params = {
  ApplicationName: "my-app", 
  CNAMEPrefix: "my-app", 
  EnvironmentName: "my-env", 
  SolutionStackName: "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8", 
  VersionLabel: "v1"
 };
 elasticbeanstalk.createEnvironment(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ApplicationName: "my-app", 
    CNAME: "my-app.elasticbeanstalk.com", 
    DateCreated: <Date Representation>, 
    DateUpdated: <Date Representation>, 
    EnvironmentId: "e-izqpassy4h", 
    EnvironmentName: "my-env", 
    Health: "Grey", 
    SolutionStackName: "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8", 
    Status: "Launching", 
    Tier: {
     Name: "WebServer", 
     Type: "Standard", 
     Version: " "
    }, 
    VersionLabel: "v1"
   }
   */
 });

Calling the createEnvironment operation

var params = {
  ApplicationName: 'STRING_VALUE', /* required */
  CNAMEPrefix: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  EnvironmentName: 'STRING_VALUE',
  GroupName: 'STRING_VALUE',
  OperationsRole: 'STRING_VALUE',
  OptionSettings: [
    {
      Namespace: 'STRING_VALUE',
      OptionName: 'STRING_VALUE',
      ResourceName: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  OptionsToRemove: [
    {
      Namespace: 'STRING_VALUE',
      OptionName: 'STRING_VALUE',
      ResourceName: 'STRING_VALUE'
    },
    /* more items */
  ],
  PlatformArn: 'STRING_VALUE',
  SolutionStackName: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  TemplateName: 'STRING_VALUE',
  Tier: {
    Name: 'STRING_VALUE',
    Type: 'STRING_VALUE',
    Version: 'STRING_VALUE'
  },
  VersionLabel: 'STRING_VALUE'
};
elasticbeanstalk.createEnvironment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationName — (String)

      The name of the application that is associated with this environment.

    • EnvironmentName — (String)

      A unique name for the environment.

      Constraint: Must be from 4 to 40 characters in length. The name can contain only letters, numbers, and hyphens. It can't start or end with a hyphen. This name must be unique within a region in your account. If the specified name already exists in the region, Elastic Beanstalk returns an InvalidParameterValue error.

      If you don't specify the CNAMEPrefix parameter, the environment name becomes part of the CNAME, and therefore part of the visible URL for your application.

    • GroupName — (String)

      The name of the group to which the target environment belongs. Specify a group name only if the environment's name is specified in an environment manifest and not with the environment name parameter. See Environment Manifest (env.yaml) for details.

    • Description — (String)

      Your description for this environment.

    • CNAMEPrefix — (String)

      If specified, the environment attempts to use this value as the prefix for the CNAME in your Elastic Beanstalk environment URL. If not specified, the CNAME is generated automatically by appending a random alphanumeric string to the environment name.

    • Tier — (map)

      Specifies the tier to use in creating this environment. The environment tier that you choose determines whether Elastic Beanstalk provisions resources to support a web application that handles HTTP(S) requests or a web application that handles background-processing tasks.

      • Name — (String)

        The name of this environment tier.

        Valid values:

        • For Web server tier – WebServer

        • For Worker tier – Worker

      • Type — (String)

        The type of this environment tier.

        Valid values:

        • For Web server tier – Standard

        • For Worker tier – SQS/HTTP

      • Version — (String)

        The version of this environment tier. When you don't set a value to it, Elastic Beanstalk uses the latest compatible worker tier version.

        Note: This member is deprecated. Any specific version that you set may become out of date. We recommend leaving it unspecified.
    • Tags — (Array<map>)

      Specifies the tags applied to resources in the environment.

      • Key — (String)

        The key of the tag.

      • Value — (String)

        The value of the tag.

    • VersionLabel — (String)

      The name of the application version to deploy.

      Default: If not specified, Elastic Beanstalk attempts to deploy the sample application.

    • TemplateName — (String)

      The name of the Elastic Beanstalk configuration template to use with the environment.

      Note: If you specify TemplateName, then don't specify SolutionStackName.
    • SolutionStackName — (String)

      The name of an Elastic Beanstalk solution stack (platform version) to use with the environment. If specified, Elastic Beanstalk sets the configuration values to the default values associated with the specified solution stack. For a list of current solution stacks, see Elastic Beanstalk Supported Platforms in the AWS Elastic Beanstalk Platforms guide.

      Note: If you specify SolutionStackName, don't specify PlatformArn or TemplateName.
    • PlatformArn — (String)

      The Amazon Resource Name (ARN) of the custom platform to use with the environment. For more information, see Custom Platforms in the AWS Elastic Beanstalk Developer Guide.

      Note: If you specify PlatformArn, don't specify SolutionStackName.
    • OptionSettings — (Array<map>)

      If specified, AWS Elastic Beanstalk sets the specified configuration options to the requested value in the configuration set for the new environment. These override the values obtained from the solution stack or the configuration template.

      • ResourceName — (String)

        A unique resource name for the option setting. Use it for a time–based scaling configuration option.

      • Namespace — (String)

        A unique namespace that identifies the option's associated AWS resource.

      • OptionName — (String)

        The name of the configuration option.

      • Value — (String)

        The current value for the configuration option.

    • OptionsToRemove — (Array<map>)

      A list of custom user-defined configuration options to remove from the configuration set for this new environment.

      • ResourceName — (String)

        A unique resource name for a time-based scaling configuration option.

      • Namespace — (String)

        A unique namespace identifying the option's associated AWS resource.

      • OptionName — (String)

        The name of the configuration option.

    • OperationsRole — (String)

      The Amazon Resource Name (ARN) of an existing IAM role to be used as the environment's operations role. If specified, Elastic Beanstalk uses the operations role for permissions to downstream services during this call and during subsequent calls acting on this environment. To specify an operations role, you must have the iam:PassRole permission for the role. For more information, see Operations roles in the AWS Elastic Beanstalk Developer Guide.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • EnvironmentName — (String)

        The name of this environment.

      • EnvironmentId — (String)

        The ID of this environment.

      • ApplicationName — (String)

        The name of the application associated with this environment.

      • VersionLabel — (String)

        The application version deployed in this environment.

      • SolutionStackName — (String)

        The name of the SolutionStack deployed with this environment.

      • PlatformArn — (String)

        The ARN of the platform version.

      • TemplateName — (String)

        The name of the configuration template used to originally launch this environment.

      • Description — (String)

        Describes this environment.

      • EndpointURL — (String)

        For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.

      • CNAME — (String)

        The URL to the CNAME for this environment.

      • DateCreated — (Date)

        The creation date for this environment.

      • DateUpdated — (Date)

        The last modified date for this environment.

      • Status — (String)

        The current operational status of the environment:

        • Launching: Environment is in the process of initial deployment.

        • Updating: Environment is in the process of updating its configuration settings or application version.

        • Ready: Environment is available to have an action performed on it, such as update or terminate.

        • Terminating: Environment is in the shut-down process.

        • Terminated: Environment is not running.

        Possible values include:
        • "Aborting"
        • "Launching"
        • "Updating"
        • "LinkingFrom"
        • "LinkingTo"
        • "Ready"
        • "Terminating"
        • "Terminated"
      • AbortableOperationInProgress — (Boolean)

        Indicates if there is an in-progress environment configuration update or application version deployment that you can cancel.

        true: There is an update in progress.

        false: There are no updates currently in progress.

      • Health — (String)

        Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment:

        • Red: Indicates the environment is not responsive. Occurs when three or more consecutive failures occur for an environment.

        • Yellow: Indicates that something is wrong. Occurs when two consecutive failures occur for an environment.

        • Green: Indicates the environment is healthy and fully functional.

        • Grey: Default health for a new environment. The environment is not fully launched and health checks have not started or health checks are suspended during an UpdateEnvironment or RestartEnvironment request.

        Default: Grey

        Possible values include:
        • "Green"
        • "Yellow"
        • "Red"
        • "Grey"
      • HealthStatus — (String)

        Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses.

        Possible values include:
        • "NoData"
        • "Unknown"
        • "Pending"
        • "Ok"
        • "Info"
        • "Warning"
        • "Degraded"
        • "Severe"
        • "Suspended"
      • Resources — (map)

        The description of the AWS resources used by this environment.

        • LoadBalancer — (map)

          Describes the LoadBalancer.

          • LoadBalancerName — (String)

            The name of the LoadBalancer.

          • Domain — (String)

            The domain name of the LoadBalancer.

          • Listeners — (Array<map>)

            A list of Listeners used by the LoadBalancer.

            • Protocol — (String)

              The protocol that is used by the Listener.

            • Port — (Integer)

              The port that is used by the Listener.

      • Tier — (map)

        Describes the current tier of this environment.

        • Name — (String)

          The name of this environment tier.

          Valid values:

          • For Web server tier – WebServer

          • For Worker tier – Worker

        • Type — (String)

          The type of this environment tier.

          Valid values:

          • For Web server tier – Standard

          • For Worker tier – SQS/HTTP

        • Version — (String)

          The version of this environment tier. When you don't set a value to it, Elastic Beanstalk uses the latest compatible worker tier version.

          Note: This member is deprecated. Any specific version that you set may become out of date. We recommend leaving it unspecified.
      • EnvironmentLinks — (Array<map>)

        A list of links to other environments in the same group.

        • LinkName — (String)

          The name of the link.

        • EnvironmentName — (String)

          The name of the linked environment (the dependency).

      • EnvironmentArn — (String)

        The environment's Amazon Resource Name (ARN), which can be used in other API requests that require an ARN.

      • OperationsRole — (String)

        The Amazon Resource Name (ARN) of the environment's operations role. For more information, see Operations roles in the AWS Elastic Beanstalk Developer Guide.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createPlatformVersion(params = {}, callback) ⇒ AWS.Request

Create a new version of your custom platform.

Service Reference:

Examples:

Calling the createPlatformVersion operation

var params = {
  PlatformDefinitionBundle: { /* required */
    S3Bucket: 'STRING_VALUE',
    S3Key: 'STRING_VALUE'
  },
  PlatformName: 'STRING_VALUE', /* required */
  PlatformVersion: 'STRING_VALUE', /* required */
  EnvironmentName: 'STRING_VALUE',
  OptionSettings: [
    {
      Namespace: 'STRING_VALUE',
      OptionName: 'STRING_VALUE',
      ResourceName: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
elasticbeanstalk.createPlatformVersion(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • PlatformName — (String)

      The name of your custom platform.

    • PlatformVersion — (String)

      The number, such as 1.0.2, for the new platform version.

    • PlatformDefinitionBundle — (map)

      The location of the platform definition archive in Amazon S3.

      • S3Bucket — (String)

        The Amazon S3 bucket where the data is located.

      • S3Key — (String)

        The Amazon S3 key where the data is located.

    • EnvironmentName — (String)

      The name of the builder environment.

    • OptionSettings — (Array<map>)

      The configuration option settings to apply to the builder environment.

      • ResourceName — (String)

        A unique resource name for the option setting. Use it for a time–based scaling configuration option.

      • Namespace — (String)

        A unique namespace that identifies the option's associated AWS resource.

      • OptionName — (String)

        The name of the configuration option.

      • Value — (String)

        The current value for the configuration option.

    • Tags — (Array<map>)

      Specifies the tags applied to the new platform version.

      Elastic Beanstalk applies these tags only to the platform version. Environments that you create using the platform version don't inherit the tags.

      • Key — (String)

        The key of the tag.

      • Value — (String)

        The value of the tag.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • PlatformSummary — (map)

        Detailed information about the new version of the custom platform.

        • PlatformArn — (String)

          The ARN of the platform version.

        • PlatformOwner — (String)

          The AWS account ID of the person who created the platform version.

        • PlatformStatus — (String)

          The status of the platform version. You can create an environment from the platform version once it is ready.

          Possible values include:
          • "Creating"
          • "Failed"
          • "Ready"
          • "Deleting"
          • "Deleted"
        • PlatformCategory — (String)

          The category of platform version.

        • OperatingSystemName — (String)

          The operating system used by the platform version.

        • OperatingSystemVersion — (String)

          The version of the operating system used by the platform version.

        • SupportedTierList — (Array<String>)

          The tiers in which the platform version runs.

        • SupportedAddonList — (Array<String>)

          The additions associated with the platform version.

        • PlatformLifecycleState — (String)

          The state of the platform version in its lifecycle.

          Possible values: recommended | empty

          If an empty value is returned, the platform version is supported but isn't the recommended one for its branch.

        • PlatformVersion — (String)

          The version string of the platform version.

        • PlatformBranchName — (String)

          The platform branch to which the platform version belongs.

        • PlatformBranchLifecycleState — (String)

          The state of the platform version's branch in its lifecycle.

          Possible values: beta | supported | deprecated | retired

      • Builder — (map)

        The builder used to create the custom platform.

        • ARN — (String)

          The ARN of the builder.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createStorageLocation(params = {}, callback) ⇒ AWS.Request

Creates a bucket in Amazon S3 to store application versions, logs, and other files used by Elastic Beanstalk environments. The Elastic Beanstalk console and EB CLI call this API the first time you create an environment in a region. If the storage location already exists, CreateStorageLocation still returns the bucket name but does not create a new bucket.

Service Reference:

Examples:

To create a new environment for an application


/* The following operation creates a new environment for version v1 of a java application named my-app: */

 var params = {};
 elasticbeanstalk.createStorageLocation(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    S3Bucket: "elasticbeanstalk-us-west-2-0123456789012"
   }
   */
 });

Calling the createStorageLocation operation

elasticbeanstalk.createStorageLocation(function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • S3Bucket — (String)

        The name of the Amazon S3 bucket created.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteApplication(params = {}, callback) ⇒ AWS.Request

Deletes the specified application along with all associated versions and configurations. The application versions will not be deleted from your Amazon S3 bucket.

Note: You cannot delete an application that has a running environment.

Service Reference:

Examples:

To delete an application


/* The following operation deletes an application named my-app: */

 var params = {
  ApplicationName: "my-app"
 };
 elasticbeanstalk.deleteApplication(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the deleteApplication operation

var params = {
  ApplicationName: 'STRING_VALUE', /* required */
  TerminateEnvByForce: true || false
};
elasticbeanstalk.deleteApplication(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationName — (String)

      The name of the application to delete.

    • TerminateEnvByForce — (Boolean)

      When set to true, running environments will be terminated before deleting the application.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteApplicationVersion(params = {}, callback) ⇒ AWS.Request

Deletes the specified version from the specified application.

Note: You cannot delete an application version that is associated with a running environment.

Service Reference:

Examples:

To delete an application version


/* The following operation deletes an application version named 22a0-stage-150819_182129 for an application named my-app: */

 var params = {
  ApplicationName: "my-app", 
  DeleteSourceBundle: true, 
  VersionLabel: "22a0-stage-150819_182129"
 };
 elasticbeanstalk.deleteApplicationVersion(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the deleteApplicationVersion operation

var params = {
  ApplicationName: 'STRING_VALUE', /* required */
  VersionLabel: 'STRING_VALUE', /* required */
  DeleteSourceBundle: true || false
};
elasticbeanstalk.deleteApplicationVersion(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationName — (String)

      The name of the application to which the version belongs.

    • VersionLabel — (String)

      The label of the version to delete.

    • DeleteSourceBundle — (Boolean)

      Set to true to delete the source bundle from your storage bucket. Otherwise, the application version is deleted only from Elastic Beanstalk and the source bundle remains in Amazon S3.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteConfigurationTemplate(params = {}, callback) ⇒ AWS.Request

Deletes the specified configuration template.

Note: When you launch an environment using a configuration template, the environment gets a copy of the template. You can delete or modify the environment's copy of the template without affecting the running environment.

Service Reference:

Examples:

To delete a configuration template


/* The following operation deletes a configuration template named my-template for an application named my-app: */

 var params = {
  ApplicationName: "my-app", 
  TemplateName: "my-template"
 };
 elasticbeanstalk.deleteConfigurationTemplate(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the deleteConfigurationTemplate operation

var params = {
  ApplicationName: 'STRING_VALUE', /* required */
  TemplateName: 'STRING_VALUE' /* required */
};
elasticbeanstalk.deleteConfigurationTemplate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationName — (String)

      The name of the application to delete the configuration template from.

    • TemplateName — (String)

      The name of the configuration template to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteEnvironmentConfiguration(params = {}, callback) ⇒ AWS.Request

Deletes the draft configuration associated with the running environment.

Updating a running environment with any configuration changes creates a draft configuration set. You can get the draft configuration using DescribeConfigurationSettings while the update is in progress or if the update fails. The DeploymentStatus for the draft configuration indicates whether the deployment is in process or has failed. The draft configuration remains in existence until it is deleted with this action.

Service Reference:

Examples:

To delete a draft configuration


/* The following operation deletes a draft configuration for an environment named my-env: */

 var params = {
  ApplicationName: "my-app", 
  EnvironmentName: "my-env"
 };
 elasticbeanstalk.deleteEnvironmentConfiguration(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the deleteEnvironmentConfiguration operation

var params = {
  ApplicationName: 'STRING_VALUE', /* required */
  EnvironmentName: 'STRING_VALUE' /* required */
};
elasticbeanstalk.deleteEnvironmentConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationName — (String)

      The name of the application the environment is associated with.

    • EnvironmentName — (String)

      The name of the environment to delete the draft configuration from.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deletePlatformVersion(params = {}, callback) ⇒ AWS.Request

Deletes the specified version of a custom platform.

Service Reference:

Examples:

Calling the deletePlatformVersion operation

var params = {
  PlatformArn: 'STRING_VALUE'
};
elasticbeanstalk.deletePlatformVersion(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • PlatformArn — (String)

      The ARN of the version of the custom platform.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • PlatformSummary — (map)

        Detailed information about the version of the custom platform.

        • PlatformArn — (String)

          The ARN of the platform version.

        • PlatformOwner — (String)

          The AWS account ID of the person who created the platform version.

        • PlatformStatus — (String)

          The status of the platform version. You can create an environment from the platform version once it is ready.

          Possible values include:
          • "Creating"
          • "Failed"
          • "Ready"
          • "Deleting"
          • "Deleted"
        • PlatformCategory — (String)

          The category of platform version.

        • OperatingSystemName — (String)

          The operating system used by the platform version.

        • OperatingSystemVersion — (String)

          The version of the operating system used by the platform version.

        • SupportedTierList — (Array<String>)

          The tiers in which the platform version runs.

        • SupportedAddonList — (Array<String>)

          The additions associated with the platform version.

        • PlatformLifecycleState — (String)

          The state of the platform version in its lifecycle.

          Possible values: recommended | empty

          If an empty value is returned, the platform version is supported but isn't the recommended one for its branch.

        • PlatformVersion — (String)

          The version string of the platform version.

        • PlatformBranchName — (String)

          The platform branch to which the platform version belongs.

        • PlatformBranchLifecycleState — (String)

          The state of the platform version's branch in its lifecycle.

          Possible values: beta | supported | deprecated | retired

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeAccountAttributes(params = {}, callback) ⇒ AWS.Request

Returns attributes related to AWS Elastic Beanstalk that are associated with the calling AWS account.

The result currently has one set of attributes—resource quotas.

Service Reference:

Examples:

Calling the describeAccountAttributes operation

elasticbeanstalk.describeAccountAttributes(function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ResourceQuotas — (map)

        The Elastic Beanstalk resource quotas associated with the calling AWS account.

        • ApplicationQuota — (map)

          The quota for applications in the AWS account.

          • Maximum — (Integer)

            The maximum number of instances of this Elastic Beanstalk resource type that an AWS account can use.

        • ApplicationVersionQuota — (map)

          The quota for application versions in the AWS account.

          • Maximum — (Integer)

            The maximum number of instances of this Elastic Beanstalk resource type that an AWS account can use.

        • EnvironmentQuota — (map)

          The quota for environments in the AWS account.

          • Maximum — (Integer)

            The maximum number of instances of this Elastic Beanstalk resource type that an AWS account can use.

        • ConfigurationTemplateQuota — (map)

          The quota for configuration templates in the AWS account.

          • Maximum — (Integer)

            The maximum number of instances of this Elastic Beanstalk resource type that an AWS account can use.

        • CustomPlatformQuota — (map)

          The quota for custom platforms in the AWS account.

          • Maximum — (Integer)

            The maximum number of instances of this Elastic Beanstalk resource type that an AWS account can use.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeApplications(params = {}, callback) ⇒ AWS.Request

Returns the descriptions of existing applications.

Service Reference:

Examples:

To view a list of applications


/* The following operation retrieves information about applications in the current region: */

 var params = {
 };
 elasticbeanstalk.describeApplications(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Applications: [
       {
      ApplicationName: "ruby", 
      ConfigurationTemplates: [
      ], 
      DateCreated: <Date Representation>, 
      DateUpdated: <Date Representation>, 
      Versions: [
         "Sample Application"
      ]
     }, 
       {
      ApplicationName: "pythonsample", 
      ConfigurationTemplates: [
      ], 
      DateCreated: <Date Representation>, 
      DateUpdated: <Date Representation>, 
      Description: "Application created from the EB CLI using \"eb init\"", 
      Versions: [
         "Sample Application"
      ]
     }, 
       {
      ApplicationName: "nodejs-example", 
      ConfigurationTemplates: [
      ], 
      DateCreated: <Date Representation>, 
      DateUpdated: <Date Representation>, 
      Versions: [
         "add elasticache", 
         "First Release"
      ]
     }
    ]
   }
   */
 });

Calling the describeApplications operation

var params = {
  ApplicationNames: [
    'STRING_VALUE',
    /* more items */
  ]
};
elasticbeanstalk.describeApplications(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationNames — (Array<String>)

      If specified, AWS Elastic Beanstalk restricts the returned descriptions to only include those with the specified names.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Applications — (Array<map>)

        This parameter contains a list of ApplicationDescription.

        • ApplicationArn — (String)

          The Amazon Resource Name (ARN) of the application.

        • ApplicationName — (String)

          The name of the application.

        • Description — (String)

          User-defined description of the application.

        • DateCreated — (Date)

          The date when the application was created.

        • DateUpdated — (Date)

          The date when the application was last modified.

        • Versions — (Array<String>)

          The names of the versions for this application.

        • ConfigurationTemplates — (Array<String>)

          The names of the configuration templates associated with this application.

        • ResourceLifecycleConfig — (map)

          The lifecycle settings for the application.

          • ServiceRole — (String)

            The ARN of an IAM service role that Elastic Beanstalk has permission to assume.

            The ServiceRole property is required the first time that you provide a VersionLifecycleConfig for the application in one of the supporting calls (CreateApplication or UpdateApplicationResourceLifecycle). After you provide it once, in either one of the calls, Elastic Beanstalk persists the Service Role with the application, and you don't need to specify it again in subsequent UpdateApplicationResourceLifecycle calls. You can, however, specify it in subsequent calls to change the Service Role to another value.

          • VersionLifecycleConfig — (map)

            Defines lifecycle settings for application versions.

            • MaxCountRule — (map)

              Specify a max count rule to restrict the number of application versions that are retained for an application.

              • Enabled — required — (Boolean)

                Specify true to apply the rule, or false to disable it.

              • MaxCount — (Integer)

                Specify the maximum number of application versions to retain.

              • DeleteSourceFromS3 — (Boolean)

                Set to true to delete a version's source bundle from Amazon S3 when Elastic Beanstalk deletes the application version.

            • MaxAgeRule — (map)

              Specify a max age rule to restrict the length of time that application versions are retained for an application.

              • Enabled — required — (Boolean)

                Specify true to apply the rule, or false to disable it.

              • MaxAgeInDays — (Integer)

                Specify the number of days to retain an application versions.

              • DeleteSourceFromS3 — (Boolean)

                Set to true to delete a version's source bundle from Amazon S3 when Elastic Beanstalk deletes the application version.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeApplicationVersions(params = {}, callback) ⇒ AWS.Request

Retrieve a list of application versions.

Service Reference:

Examples:

To view information about an application version


/* The following operation retrieves information about an application version labeled v2: */

 var params = {
  ApplicationName: "my-app", 
  VersionLabels: [
     "v2"
  ]
 };
 elasticbeanstalk.describeApplicationVersions(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ApplicationVersions: [
       {
      ApplicationName: "my-app", 
      DateCreated: <Date Representation>, 
      DateUpdated: <Date Representation>, 
      Description: "update cover page", 
      SourceBundle: {
       S3Bucket: "elasticbeanstalk-us-west-2-015321684451", 
       S3Key: "my-app/5026-stage-150723_224258.war"
      }, 
      VersionLabel: "v2"
     }, 
       {
      ApplicationName: "my-app", 
      DateCreated: <Date Representation>, 
      DateUpdated: <Date Representation>, 
      Description: "initial version", 
      SourceBundle: {
       S3Bucket: "elasticbeanstalk-us-west-2-015321684451", 
       S3Key: "my-app/5026-stage-150723_222618.war"
      }, 
      VersionLabel: "v1"
     }
    ]
   }
   */
 });

Calling the describeApplicationVersions operation

var params = {
  ApplicationName: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  VersionLabels: [
    'STRING_VALUE',
    /* more items */
  ]
};
elasticbeanstalk.describeApplicationVersions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationName — (String)

      Specify an application name to show only application versions for that application.

    • VersionLabels — (Array<String>)

      Specify a version label to show a specific application version.

    • MaxRecords — (Integer)

      For a paginated request. Specify a maximum number of application versions to include in each response.

      If no MaxRecords is specified, all available application versions are retrieved in a single response.

    • NextToken — (String)

      For a paginated request. Specify a token from a previous response page to retrieve the next response page. All other parameter values must be identical to the ones specified in the initial request.

      If no NextToken is specified, the first page is retrieved.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ApplicationVersions — (Array<map>)

        List of ApplicationVersionDescription objects sorted in order of creation.

        • ApplicationVersionArn — (String)

          The Amazon Resource Name (ARN) of the application version.

        • ApplicationName — (String)

          The name of the application to which the application version belongs.

        • Description — (String)

          The description of the application version.

        • VersionLabel — (String)

          A unique identifier for the application version.

        • SourceBuildInformation — (map)

          If the version's source code was retrieved from AWS CodeCommit, the location of the source code for the application version.

          • SourceType — required — (String)

            The type of repository.

            • Git

            • Zip

            Possible values include:
            • "Git"
            • "Zip"
          • SourceRepository — required — (String)

            Location where the repository is stored.

            • CodeCommit

            • S3

            Possible values include:
            • "CodeCommit"
            • "S3"
          • SourceLocation — required — (String)

            The location of the source code, as a formatted string, depending on the value of SourceRepository

            • For CodeCommit, the format is the repository name and commit ID, separated by a forward slash. For example, my-git-repo/265cfa0cf6af46153527f55d6503ec030551f57a.

            • For S3, the format is the S3 bucket name and object key, separated by a forward slash. For example, my-s3-bucket/Folders/my-source-file.

        • BuildArn — (String)

          Reference to the artifact from the AWS CodeBuild build.

        • SourceBundle — (map)

          The storage location of the application version's source bundle in Amazon S3.

          • S3Bucket — (String)

            The Amazon S3 bucket where the data is located.

          • S3Key — (String)

            The Amazon S3 key where the data is located.

        • DateCreated — (Date)

          The creation date of the application version.

        • DateUpdated — (Date)

          The last modified date of the application version.

        • Status — (String)

          The processing status of the application version. Reflects the state of the application version during its creation. Many of the values are only applicable if you specified True for the Process parameter of the CreateApplicationVersion action. The following list describes the possible values.

          • Unprocessed – Application version wasn't pre-processed or validated. Elastic Beanstalk will validate configuration files during deployment of the application version to an environment.

          • Processing – Elastic Beanstalk is currently processing the application version.

          • Building – Application version is currently undergoing an AWS CodeBuild build.

          • Processed – Elastic Beanstalk was successfully pre-processed and validated.

          • Failed – Either the AWS CodeBuild build failed or configuration files didn't pass validation. This application version isn't usable.

          Possible values include:
          • "Processed"
          • "Unprocessed"
          • "Failed"
          • "Processing"
          • "Building"
      • NextToken — (String)

        In a paginated request, the token that you can pass in a subsequent request to get the next response page.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeConfigurationOptions(params = {}, callback) ⇒ AWS.Request

Describes the configuration options that are used in a particular configuration template or environment, or that a specified solution stack defines. The description includes the values the options, their default values, and an indication of the required action on a running environment if an option value is changed.

Service Reference:

Examples:

To view configuration options for an environment


/* The following operation retrieves descriptions of all available configuration options for an environment named my-env: */

 var params = {
  ApplicationName: "my-app", 
  EnvironmentName: "my-env"
 };
 elasticbeanstalk.describeConfigurationOptions(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Options: [
       {
      ChangeSeverity: "NoInterruption", 
      DefaultValue: "30", 
      MaxValue: 300, 
      MinValue: 5, 
      Name: "Interval", 
      Namespace: "aws:elb:healthcheck", 
      UserDefined: false, 
      ValueType: "Scalar"
     }, 
       {
      ChangeSeverity: "NoInterruption", 
      DefaultValue: "2000000", 
      MinValue: 0, 
      Name: "LowerThreshold", 
      Namespace: "aws:autoscaling:trigger", 
      UserDefined: false, 
      ValueType: "Scalar"
     }
    ]
   }
   */
 });

Calling the describeConfigurationOptions operation

var params = {
  ApplicationName: 'STRING_VALUE',
  EnvironmentName: 'STRING_VALUE',
  Options: [
    {
      Namespace: 'STRING_VALUE',
      OptionName: 'STRING_VALUE',
      ResourceName: 'STRING_VALUE'
    },
    /* more items */
  ],
  PlatformArn: 'STRING_VALUE',
  SolutionStackName: 'STRING_VALUE',
  TemplateName: 'STRING_VALUE'
};
elasticbeanstalk.describeConfigurationOptions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationName — (String)

      The name of the application associated with the configuration template or environment. Only needed if you want to describe the configuration options associated with either the configuration template or environment.

    • TemplateName — (String)

      The name of the configuration template whose configuration options you want to describe.

    • EnvironmentName — (String)

      The name of the environment whose configuration options you want to describe.

    • SolutionStackName — (String)

      The name of the solution stack whose configuration options you want to describe.

    • PlatformArn — (String)

      The ARN of the custom platform.

    • Options — (Array<map>)

      If specified, restricts the descriptions to only the specified options.

      • ResourceName — (String)

        A unique resource name for a time-based scaling configuration option.

      • Namespace — (String)

        A unique namespace identifying the option's associated AWS resource.

      • OptionName — (String)

        The name of the configuration option.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • SolutionStackName — (String)

        The name of the solution stack these configuration options belong to.

      • PlatformArn — (String)

        The ARN of the platform version.

      • Options — (Array<map>)

        A list of ConfigurationOptionDescription.

        • Namespace — (String)

          A unique namespace identifying the option's associated AWS resource.

        • Name — (String)

          The name of the configuration option.

        • DefaultValue — (String)

          The default value for this configuration option.

        • ChangeSeverity — (String)

          An indication of which action is required if the value for this configuration option changes:

          • NoInterruption : There is no interruption to the environment or application availability.

          • RestartEnvironment : The environment is entirely restarted, all AWS resources are deleted and recreated, and the environment is unavailable during the process.

          • RestartApplicationServer : The environment is available the entire time. However, a short application outage occurs when the application servers on the running Amazon EC2 instances are restarted.

        • UserDefined — (Boolean)

          An indication of whether the user defined this configuration option:

          • true : This configuration option was defined by the user. It is a valid choice for specifying if this as an Option to Remove when updating configuration settings.

          • false : This configuration was not defined by the user.

          Constraint: You can remove only UserDefined options from a configuration.

          Valid Values: true | false

        • ValueType — (String)

          An indication of which type of values this option has and whether it is allowable to select one or more than one of the possible values:

          • Scalar : Values for this option are a single selection from the possible values, or an unformatted string, or numeric value governed by the MIN/MAX/Regex constraints.

          • List : Values for this option are multiple selections from the possible values.

          • Boolean : Values for this option are either true or false .

          • Json : Values for this option are a JSON representation of a ConfigDocument.

          Possible values include:
          • "Scalar"
          • "List"
        • ValueOptions — (Array<String>)

          If specified, values for the configuration option are selected from this list.

        • MinValue — (Integer)

          If specified, the configuration option must be a numeric value greater than this value.

        • MaxValue — (Integer)

          If specified, the configuration option must be a numeric value less than this value.

        • MaxLength — (Integer)

          If specified, the configuration option must be a string value no longer than this value.

        • Regex — (map)

          If specified, the configuration option must be a string value that satisfies this regular expression.

          • Pattern — (String)

            The regular expression pattern that a string configuration option value with this restriction must match.

          • Label — (String)

            A unique name representing this regular expression.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeConfigurationSettings(params = {}, callback) ⇒ AWS.Request

Returns a description of the settings for the specified configuration set, that is, either a configuration template or the configuration set associated with a running environment.

When describing the settings for the configuration set associated with a running environment, it is possible to receive two sets of setting descriptions. One is the deployed configuration set, and the other is a draft configuration of an environment that is either in the process of deployment or that failed to deploy.

Related Topics

Service Reference:

Examples:

To view configurations settings for an environment


/* The following operation retrieves configuration settings for an environment named my-env: */

 var params = {
  ApplicationName: "my-app", 
  EnvironmentName: "my-env"
 };
 elasticbeanstalk.describeConfigurationSettings(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ConfigurationSettings: [
       {
      ApplicationName: "my-app", 
      DateCreated: <Date Representation>, 
      DateUpdated: <Date Representation>, 
      DeploymentStatus: "deployed", 
      Description: "Environment created from the EB CLI using \"eb create\"", 
      EnvironmentName: "my-env", 
      OptionSettings: [
         {
        Namespace: "aws:autoscaling:asg", 
        OptionName: "Availability Zones", 
        ResourceName: "AWSEBAutoScalingGroup", 
        Value: "Any"
       }, 
         {
        Namespace: "aws:autoscaling:asg", 
        OptionName: "Cooldown", 
        ResourceName: "AWSEBAutoScalingGroup", 
        Value: "360"
       }, 
         {
        Namespace: "aws:elb:policies", 
        OptionName: "ConnectionDrainingTimeout", 
        ResourceName: "AWSEBLoadBalancer", 
        Value: "20"
       }, 
         {
        Namespace: "aws:elb:policies", 
        OptionName: "ConnectionSettingIdleTimeout", 
        ResourceName: "AWSEBLoadBalancer", 
        Value: "60"
       }
      ], 
      SolutionStackName: "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8"
     }
    ]
   }
   */
 });

Calling the describeConfigurationSettings operation

var params = {
  ApplicationName: 'STRING_VALUE', /* required */
  EnvironmentName: 'STRING_VALUE',
  TemplateName: 'STRING_VALUE'
};
elasticbeanstalk.describeConfigurationSettings(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationName — (String)

      The application for the environment or configuration template.

    • TemplateName — (String)

      The name of the configuration template to describe.

      Conditional: You must specify either this parameter or an EnvironmentName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns a MissingRequiredParameter error.

    • EnvironmentName — (String)

      The name of the environment to describe.

      Condition: You must specify either this or a TemplateName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ConfigurationSettings — (Array<map>)

        A list of ConfigurationSettingsDescription.

        • SolutionStackName — (String)

          The name of the solution stack this configuration set uses.

        • PlatformArn — (String)

          The ARN of the platform version.

        • ApplicationName — (String)

          The name of the application associated with this configuration set.

        • TemplateName — (String)

          If not null, the name of the configuration template for this configuration set.

        • Description — (String)

          Describes this configuration set.

        • EnvironmentName — (String)

          If not null, the name of the environment for this configuration set.

        • DeploymentStatus — (String)

          If this configuration set is associated with an environment, the DeploymentStatus parameter indicates the deployment status of this configuration set:

          • null: This configuration is not associated with a running environment.

          • pending: This is a draft configuration that is not deployed to the associated environment but is in the process of deploying.

          • deployed: This is the configuration that is currently deployed to the associated running environment.

          • failed: This is a draft configuration that failed to successfully deploy.

          Possible values include:
          • "deployed"
          • "pending"
          • "failed"
        • DateCreated — (Date)

          The date (in UTC time) when this configuration set was created.

        • DateUpdated — (Date)

          The date (in UTC time) when this configuration set was last modified.

        • OptionSettings — (Array<map>)

          A list of the configuration options and their values in this configuration set.

          • ResourceName — (String)

            A unique resource name for the option setting. Use it for a time–based scaling configuration option.

          • Namespace — (String)

            A unique namespace that identifies the option's associated AWS resource.

          • OptionName — (String)

            The name of the configuration option.

          • Value — (String)

            The current value for the configuration option.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeEnvironmentHealth(params = {}, callback) ⇒ AWS.Request

Returns information about the overall health of the specified environment. The DescribeEnvironmentHealth operation is only available with AWS Elastic Beanstalk Enhanced Health.

Service Reference:

Examples:

To view environment health


/* The following operation retrieves overall health information for an environment named my-env: */

 var params = {
  AttributeNames: [
     "All"
  ], 
  EnvironmentName: "my-env"
 };
 elasticbeanstalk.describeEnvironmentHealth(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ApplicationMetrics: {
     Duration: 10, 
     Latency: {
      P10: 0.001, 
      P50: 0.001, 
      P75: 0.002, 
      P85: 0.003, 
      P90: 0.003, 
      P95: 0.004, 
      P99: 0.004, 
      P999: 0.004
     }, 
     RequestCount: 45, 
     StatusCodes: {
      Status2xx: 45, 
      Status3xx: 0, 
      Status4xx: 0, 
      Status5xx: 0
     }
    }, 
    Causes: [
    ], 
    Color: "Green", 
    EnvironmentName: "my-env", 
    HealthStatus: "Ok", 
    InstancesHealth: {
     Degraded: 0, 
     Info: 0, 
     NoData: 0, 
     Ok: 1, 
     Pending: 0, 
     Severe: 0, 
     Unknown: 0, 
     Warning: 0
    }, 
    RefreshedAt: <Date Representation>
   }
   */
 });

Calling the describeEnvironmentHealth operation

var params = {
  AttributeNames: [
    Status | Color | Causes | ApplicationMetrics | InstancesHealth | All | HealthStatus | RefreshedAt,
    /* more items */
  ],
  EnvironmentId: 'STRING_VALUE',
  EnvironmentName: 'STRING_VALUE'
};
elasticbeanstalk.describeEnvironmentHealth(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • EnvironmentName — (String)

      Specify the environment by name.

      You must specify either this or an EnvironmentName, or both.

    • EnvironmentId — (String)

      Specify the environment by ID.

      You must specify either this or an EnvironmentName, or both.

    • AttributeNames — (Array<String>)

      Specify the response elements to return. To retrieve all attributes, set to All. If no attribute names are specified, returns the name of the environment.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • EnvironmentName — (String)

        The environment's name.

      • HealthStatus — (String)

        The health status of the environment. For example, Ok.

      • Status — (String)

        The environment's operational status. Ready, Launching, Updating, Terminating, or Terminated.

        Possible values include:
        • "Green"
        • "Yellow"
        • "Red"
        • "Grey"
      • Color — (String)

        The health color of the environment.

      • Causes — (Array<String>)

        Descriptions of the data that contributed to the environment's current health status.

      • ApplicationMetrics — (map)

        Application request metrics for the environment.

        • Duration — (Integer)

          The amount of time that the metrics cover (usually 10 seconds). For example, you might have 5 requests (request_count) within the most recent time slice of 10 seconds (duration).

        • RequestCount — (Integer)

          Average number of requests handled by the web server per second over the last 10 seconds.

        • StatusCodes — (map)

          Represents the percentage of requests over the last 10 seconds that resulted in each type of status code response.

          • Status2xx — (Integer)

            The percentage of requests over the last 10 seconds that resulted in a 2xx (200, 201, etc.) status code.

          • Status3xx — (Integer)

            The percentage of requests over the last 10 seconds that resulted in a 3xx (300, 301, etc.) status code.

          • Status4xx — (Integer)

            The percentage of requests over the last 10 seconds that resulted in a 4xx (400, 401, etc.) status code.

          • Status5xx — (Integer)

            The percentage of requests over the last 10 seconds that resulted in a 5xx (500, 501, etc.) status code.

        • Latency — (map)

          Represents the average latency for the slowest X percent of requests over the last 10 seconds. Latencies are in seconds with one millisecond resolution.

          • P999 — (Float)

            The average latency for the slowest 0.1 percent of requests over the last 10 seconds.

          • P99 — (Float)

            The average latency for the slowest 1 percent of requests over the last 10 seconds.

          • P95 — (Float)

            The average latency for the slowest 5 percent of requests over the last 10 seconds.

          • P90 — (Float)

            The average latency for the slowest 10 percent of requests over the last 10 seconds.

          • P85 — (Float)

            The average latency for the slowest 15 percent of requests over the last 10 seconds.

          • P75 — (Float)

            The average latency for the slowest 25 percent of requests over the last 10 seconds.

          • P50 — (Float)

            The average latency for the slowest 50 percent of requests over the last 10 seconds.

          • P10 — (Float)

            The average latency for the slowest 90 percent of requests over the last 10 seconds.

      • InstancesHealth — (map)

        Summary health information for the instances in the environment.

        • NoData — (Integer)

          Grey. AWS Elastic Beanstalk and the health agent are reporting no data on an instance.

        • Unknown — (Integer)

          Grey. AWS Elastic Beanstalk and the health agent are reporting an insufficient amount of data on an instance.

        • Pending — (Integer)

          Grey. An operation is in progress on an instance within the command timeout.

        • Ok — (Integer)

          Green. An instance is passing health checks and the health agent is not reporting any problems.

        • Info — (Integer)

          Green. An operation is in progress on an instance.

        • Warning — (Integer)

          Yellow. The health agent is reporting a moderate number of request failures or other issues for an instance or environment.

        • Degraded — (Integer)

          Red. The health agent is reporting a high number of request failures or other issues for an instance or environment.

        • Severe — (Integer)

          Red. The health agent is reporting a very high number of request failures or other issues for an instance or environment.

      • RefreshedAt — (Date)

        The date and time that the health information was retrieved.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeEnvironmentManagedActionHistory(params = {}, callback) ⇒ AWS.Request

Lists an environment's completed and failed managed actions.

Service Reference:

Examples:

Calling the describeEnvironmentManagedActionHistory operation

var params = {
  EnvironmentId: 'STRING_VALUE',
  EnvironmentName: 'STRING_VALUE',
  MaxItems: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
elasticbeanstalk.describeEnvironmentManagedActionHistory(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • EnvironmentId — (String)

      The environment ID of the target environment.

    • EnvironmentName — (String)

      The name of the target environment.

    • NextToken — (String)

      The pagination token returned by a previous request.

    • MaxItems — (Integer)

      The maximum number of items to return for a single request.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ManagedActionHistoryItems — (Array<map>)

        A list of completed and failed managed actions.

        • ActionId — (String)

          A unique identifier for the managed action.

        • ActionType — (String)

          The type of the managed action.

          Possible values include:
          • "InstanceRefresh"
          • "PlatformUpdate"
          • "Unknown"
        • ActionDescription — (String)

          A description of the managed action.

        • FailureType — (String)

          If the action failed, the type of failure.

          Possible values include:
          • "UpdateCancelled"
          • "CancellationFailed"
          • "RollbackFailed"
          • "RollbackSuccessful"
          • "InternalFailure"
          • "InvalidEnvironmentState"
          • "PermissionsError"
        • Status — (String)

          The status of the action.

          Possible values include:
          • "Completed"
          • "Failed"
          • "Unknown"
        • FailureDescription — (String)

          If the action failed, a description of the failure.

        • ExecutedTime — (Date)

          The date and time that the action started executing.

        • FinishedTime — (Date)

          The date and time that the action finished executing.

      • NextToken — (String)

        A pagination token that you pass to DescribeEnvironmentManagedActionHistory to get the next page of results.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeEnvironmentManagedActions(params = {}, callback) ⇒ AWS.Request

Lists an environment's upcoming and in-progress managed actions.

Service Reference:

Examples:

Calling the describeEnvironmentManagedActions operation

var params = {
  EnvironmentId: 'STRING_VALUE',
  EnvironmentName: 'STRING_VALUE',
  Status: Scheduled | Pending | Running | Unknown
};
elasticbeanstalk.describeEnvironmentManagedActions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • EnvironmentName — (String)

      The name of the target environment.

    • EnvironmentId — (String)

      The environment ID of the target environment.

    • Status — (String)

      To show only actions with a particular status, specify a status.

      Possible values include:
      • "Scheduled"
      • "Pending"
      • "Running"
      • "Unknown"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ManagedActions — (Array<map>)

        A list of upcoming and in-progress managed actions.

        • ActionId — (String)

          A unique identifier for the managed action.

        • ActionDescription — (String)

          A description of the managed action.

        • ActionType — (String)

          The type of managed action.

          Possible values include:
          • "InstanceRefresh"
          • "PlatformUpdate"
          • "Unknown"
        • Status — (String)

          The status of the managed action. If the action is Scheduled, you can apply it immediately with ApplyEnvironmentManagedAction.

          Possible values include:
          • "Scheduled"
          • "Pending"
          • "Running"
          • "Unknown"
        • WindowStartTime — (Date)

          The start time of the maintenance window in which the managed action will execute.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeEnvironmentResources(params = {}, callback) ⇒ AWS.Request

Returns AWS resources for this environment.

Service Reference:

Examples:

To view information about the AWS resources in your environment


/* The following operation retrieves information about resources in an environment named my-env: */

 var params = {
  EnvironmentName: "my-env"
 };
 elasticbeanstalk.describeEnvironmentResources(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    EnvironmentResources: {
     AutoScalingGroups: [
        {
       Name: "awseb-e-qu3fyyjyjs-stack-AWSEBAutoScalingGroup-QSB2ZO88SXZT"
      }
     ], 
     EnvironmentName: "my-env", 
     Instances: [
        {
       Id: "i-0c91c786"
      }
     ], 
     LaunchConfigurations: [
        {
       Name: "awseb-e-qu3fyyjyjs-stack-AWSEBAutoScalingLaunchConfiguration-1UUVQIBC96TQ2"
      }
     ], 
     LoadBalancers: [
        {
       Name: "awseb-e-q-AWSEBLoa-1EEPZ0K98BIF0"
      }
     ], 
     Queues: [
     ], 
     Triggers: [
     ]
    }
   }
   */
 });

Calling the describeEnvironmentResources operation

var params = {
  EnvironmentId: 'STRING_VALUE',
  EnvironmentName: 'STRING_VALUE'
};
elasticbeanstalk.describeEnvironmentResources(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • EnvironmentId — (String)

      The ID of the environment to retrieve AWS resource usage data.

      Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

    • EnvironmentName — (String)

      The name of the environment to retrieve AWS resource usage data.

      Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • EnvironmentResources — (map)

        A list of EnvironmentResourceDescription.

        • EnvironmentName — (String)

          The name of the environment.

        • AutoScalingGroups — (Array<map>)

          The AutoScalingGroups used by this environment.

          • Name — (String)

            The name of the AutoScalingGroup .

        • Instances — (Array<map>)

          The Amazon EC2 instances used by this environment.

          • Id — (String)

            The ID of the Amazon EC2 instance.

        • LaunchConfigurations — (Array<map>)

          The Auto Scaling launch configurations in use by this environment.

          • Name — (String)

            The name of the launch configuration.

        • LaunchTemplates — (Array<map>)

          The Amazon EC2 launch templates in use by this environment.

          • Id — (String)

            The ID of the launch template.

        • LoadBalancers — (Array<map>)

          The LoadBalancers in use by this environment.

          • Name — (String)

            The name of the LoadBalancer.

        • Triggers — (Array<map>)

          The AutoScaling triggers in use by this environment.

          • Name — (String)

            The name of the trigger.

        • Queues — (Array<map>)

          The queues used by this environment.

          • Name — (String)

            The name of the queue.

          • URL — (String)

            The URL of the queue.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeEnvironments(params = {}, callback) ⇒ AWS.Request

Returns descriptions for existing environments.

Service Reference:

Examples:

To view information about an environment


/* The following operation retrieves information about an environment named my-env: */

 var params = {
  EnvironmentNames: [
     "my-env"
  ]
 };
 elasticbeanstalk.describeEnvironments(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Environments: [
       {
      AbortableOperationInProgress: false, 
      ApplicationName: "my-app", 
      CNAME: "my-env.elasticbeanstalk.com", 
      DateCreated: <Date Representation>, 
      DateUpdated: <Date Representation>, 
      EndpointURL: "awseb-e-w-AWSEBLoa-1483140XB0Q4L-109QXY8121.us-west-2.elb.amazonaws.com", 
      EnvironmentId: "e-rpqsewtp2j", 
      EnvironmentName: "my-env", 
      Health: "Green", 
      SolutionStackName: "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8", 
      Status: "Ready", 
      Tier: {
       Name: "WebServer", 
       Type: "Standard", 
       Version: " "
      }, 
      VersionLabel: "7f58-stage-150812_025409"
     }
    ]
   }
   */
 });

Calling the describeEnvironments operation

var params = {
  ApplicationName: 'STRING_VALUE',
  EnvironmentIds: [
    'STRING_VALUE',
    /* more items */
  ],
  EnvironmentNames: [
    'STRING_VALUE',
    /* more items */
  ],
  IncludeDeleted: true || false,
  IncludedDeletedBackTo: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  MaxRecords: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  VersionLabel: 'STRING_VALUE'
};
elasticbeanstalk.describeEnvironments(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationName — (String)

      If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.

    • VersionLabel — (String)

      If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.

    • EnvironmentIds — (Array<String>)

      If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.

    • EnvironmentNames — (Array<String>)

      If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.

    • IncludeDeleted — (Boolean)

      Indicates whether to include deleted environments:

      true: Environments that have been deleted after IncludedDeletedBackTo are displayed.

      false: Do not include deleted environments.

    • IncludedDeletedBackTo — (Date)

      If specified when IncludeDeleted is set to true, then environments deleted after this date are displayed.

    • MaxRecords — (Integer)

      For a paginated request. Specify a maximum number of environments to include in each response.

      If no MaxRecords is specified, all available environments are retrieved in a single response.

    • NextToken — (String)

      For a paginated request. Specify a token from a previous response page to retrieve the next response page. All other parameter values must be identical to the ones specified in the initial request.

      If no NextToken is specified, the first page is retrieved.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Environments — (Array<map>)

        Returns an EnvironmentDescription list.

        • EnvironmentName — (String)

          The name of this environment.

        • EnvironmentId — (String)

          The ID of this environment.

        • ApplicationName — (String)

          The name of the application associated with this environment.

        • VersionLabel — (String)

          The application version deployed in this environment.

        • SolutionStackName — (String)

          The name of the SolutionStack deployed with this environment.

        • PlatformArn — (String)

          The ARN of the platform version.

        • TemplateName — (String)

          The name of the configuration template used to originally launch this environment.

        • Description — (String)

          Describes this environment.

        • EndpointURL — (String)

          For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.

        • CNAME — (String)

          The URL to the CNAME for this environment.

        • DateCreated — (Date)

          The creation date for this environment.

        • DateUpdated — (Date)

          The last modified date for this environment.

        • Status — (String)

          The current operational status of the environment:

          • Launching: Environment is in the process of initial deployment.

          • Updating: Environment is in the process of updating its configuration settings or application version.

          • Ready: Environment is available to have an action performed on it, such as update or terminate.

          • Terminating: Environment is in the shut-down process.

          • Terminated: Environment is not running.

          Possible values include:
          • "Aborting"
          • "Launching"
          • "Updating"
          • "LinkingFrom"
          • "LinkingTo"
          • "Ready"
          • "Terminating"
          • "Terminated"
        • AbortableOperationInProgress — (Boolean)

          Indicates if there is an in-progress environment configuration update or application version deployment that you can cancel.

          true: There is an update in progress.

          false: There are no updates currently in progress.

        • Health — (String)

          Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment:

          • Red: Indicates the environment is not responsive. Occurs when three or more consecutive failures occur for an environment.

          • Yellow: Indicates that something is wrong. Occurs when two consecutive failures occur for an environment.

          • Green: Indicates the environment is healthy and fully functional.

          • Grey: Default health for a new environment. The environment is not fully launched and health checks have not started or health checks are suspended during an UpdateEnvironment or RestartEnvironment request.

          Default: Grey

          Possible values include:
          • "Green"
          • "Yellow"
          • "Red"
          • "Grey"
        • HealthStatus — (String)

          Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses.

          Possible values include:
          • "NoData"
          • "Unknown"
          • "Pending"
          • "Ok"
          • "Info"
          • "Warning"
          • "Degraded"
          • "Severe"
          • "Suspended"
        • Resources — (map)

          The description of the AWS resources used by this environment.

          • LoadBalancer — (map)

            Describes the LoadBalancer.

            • LoadBalancerName — (String)

              The name of the LoadBalancer.

            • Domain — (String)

              The domain name of the LoadBalancer.

            • Listeners — (Array<map>)

              A list of Listeners used by the LoadBalancer.

              • Protocol — (String)

                The protocol that is used by the Listener.

              • Port — (Integer)

                The port that is used by the Listener.

        • Tier — (map)

          Describes the current tier of this environment.

          • Name — (String)

            The name of this environment tier.

            Valid values:

            • For Web server tier – WebServer

            • For Worker tier – Worker

          • Type — (String)

            The type of this environment tier.

            Valid values:

            • For Web server tier – Standard

            • For Worker tier – SQS/HTTP

          • Version — (String)

            The version of this environment tier. When you don't set a value to it, Elastic Beanstalk uses the latest compatible worker tier version.

            Note: This member is deprecated. Any specific version that you set may become out of date. We recommend leaving it unspecified.
        • EnvironmentLinks — (Array<map>)

          A list of links to other environments in the same group.

          • LinkName — (String)

            The name of the link.

          • EnvironmentName — (String)

            The name of the linked environment (the dependency).

        • EnvironmentArn — (String)

          The environment's Amazon Resource Name (ARN), which can be used in other API requests that require an ARN.

        • OperationsRole — (String)

          The Amazon Resource Name (ARN) of the environment's operations role. For more information, see Operations roles in the AWS Elastic Beanstalk Developer Guide.

      • NextToken — (String)

        In a paginated request, the token that you can pass in a subsequent request to get the next response page.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

Waiter Resource States:

describeEvents(params = {}, callback) ⇒ AWS.Request

Returns list of event descriptions matching criteria up to the last 6 weeks.

Note: This action returns the most recent 1,000 events from the specified NextToken.

Service Reference:

Examples:

To view events for an environment


/* The following operation retrieves events for an environment named my-env: */

 var params = {
  EnvironmentName: "my-env"
 };
 elasticbeanstalk.describeEvents(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Events: [
       {
      ApplicationName: "my-app", 
      EnvironmentName: "my-env", 
      EventDate: <Date Representation>, 
      Message: "Environment health has transitioned from Info to Ok.", 
      Severity: "INFO"
     }, 
       {
      ApplicationName: "my-app", 
      EnvironmentName: "my-env", 
      EventDate: <Date Representation>, 
      Message: "Environment update completed successfully.", 
      RequestId: "b7f3960b-4709-11e5-ba1e-07e16200da41", 
      Severity: "INFO"
     }, 
       {
      ApplicationName: "my-app", 
      EnvironmentName: "my-env", 
      EventDate: <Date Representation>, 
      Message: "Using elasticbeanstalk-us-west-2-012445113685 as Amazon S3 storage bucket for environment data.", 
      RequestId: "ca8dfbf6-41ef-11e5-988b-651aa638f46b", 
      Severity: "INFO"
     }, 
       {
      ApplicationName: "my-app", 
      EnvironmentName: "my-env", 
      EventDate: <Date Representation>, 
      Message: "createEnvironment is starting.", 
      RequestId: "cdfba8f6-41ef-11e5-988b-65638f41aa6b", 
      Severity: "INFO"
     }
    ]
   }
   */
 });

Calling the describeEvents operation

var params = {
  ApplicationName: 'STRING_VALUE',
  EndTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  EnvironmentId: 'STRING_VALUE',
  EnvironmentName: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  PlatformArn: 'STRING_VALUE',
  RequestId: 'STRING_VALUE',
  Severity: TRACE | DEBUG | INFO | WARN | ERROR | FATAL,
  StartTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  TemplateName: 'STRING_VALUE',
  VersionLabel: 'STRING_VALUE'
};
elasticbeanstalk.describeEvents(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationName — (String)

      If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those associated with this application.

    • VersionLabel — (String)

      If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this application version.

    • TemplateName — (String)

      If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that are associated with this environment configuration.

    • EnvironmentId — (String)

      If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment.

    • EnvironmentName — (String)

      If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment.

    • PlatformArn — (String)

      The ARN of a custom platform version. If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this custom platform version.

    • RequestId — (String)

      If specified, AWS Elastic Beanstalk restricts the described events to include only those associated with this request ID.

    • Severity — (String)

      If specified, limits the events returned from this call to include only those with the specified severity or higher.

      Possible values include:
      • "TRACE"
      • "DEBUG"
      • "INFO"
      • "WARN"
      • "ERROR"
      • "FATAL"
    • StartTime — (Date)

      If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur on or after this time.

    • EndTime — (Date)

      If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur up to, but not including, the EndTime.

    • MaxRecords — (Integer)

      Specifies the maximum number of events that can be returned, beginning with the most recent event.

    • NextToken — (String)

      Pagination token. If specified, the events return the next batch of results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Events — (Array<map>)

        A list of EventDescription.

        • EventDate — (Date)

          The date when the event occurred.

        • Message — (String)

          The event message.

        • ApplicationName — (String)

          The application associated with the event.

        • VersionLabel — (String)

          The release label for the application version associated with this event.

        • TemplateName — (String)

          The name of the configuration associated with this event.

        • EnvironmentName — (String)

          The name of the environment associated with this event.

        • PlatformArn — (String)

          The ARN of the platform version.

        • RequestId — (String)

          The web service request ID for the activity of this event.

        • Severity — (String)

          The severity level of this event.

          Possible values include:
          • "TRACE"
          • "DEBUG"
          • "INFO"
          • "WARN"
          • "ERROR"
          • "FATAL"
      • NextToken — (String)

        If returned, this indicates that there are more results to obtain. Use this token in the next DescribeEvents call to get the next batch of events.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeInstancesHealth(params = {}, callback) ⇒ AWS.Request

Retrieves detailed information about the health of instances in your AWS Elastic Beanstalk. This operation requires enhanced health reporting.

Service Reference:

Examples:

To view environment health


/* The following operation retrieves health information for instances in an environment named my-env: */

 var params = {
  AttributeNames: [
     "All"
  ], 
  EnvironmentName: "my-env"
 };
 elasticbeanstalk.describeInstancesHealth(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    InstanceHealthList: [
       {
      ApplicationMetrics: {
       Duration: 10, 
       Latency: {
        P10: 0, 
        P50: 0.001, 
        P75: 0.002, 
        P85: 0.003, 
        P90: 0.004, 
        P95: 0.005, 
        P99: 0.006, 
        P999: 0.006
       }, 
       RequestCount: 48, 
       StatusCodes: {
        Status2xx: 47, 
        Status3xx: 0, 
        Status4xx: 1, 
        Status5xx: 0
       }
      }, 
      Causes: [
      ], 
      Color: "Green", 
      HealthStatus: "Ok", 
      InstanceId: "i-08691cc7", 
      LaunchedAt: <Date Representation>, 
      System: {
       CPUUtilization: {
        IOWait: 0.2, 
        IRQ: 0, 
        Idle: 97.8, 
        Nice: 0.1, 
        SoftIRQ: 0.1, 
        System: 0.3, 
        User: 1.5
       }, 
       LoadAverage: [
          0, 
          0.02, 
          0.05
       ]
      }
     }
    ], 
    RefreshedAt: <Date Representation>
   }
   */
 });

Calling the describeInstancesHealth operation

var params = {
  AttributeNames: [
    HealthStatus | Color | Causes | ApplicationMetrics | RefreshedAt | LaunchedAt | System | Deployment | AvailabilityZone | InstanceType | All,
    /* more items */
  ],
  EnvironmentId: 'STRING_VALUE',
  EnvironmentName: 'STRING_VALUE',
  NextToken: 'STRING_VALUE'
};
elasticbeanstalk.describeInstancesHealth(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • EnvironmentName — (String)

      Specify the AWS Elastic Beanstalk environment by name.

    • EnvironmentId — (String)

      Specify the AWS Elastic Beanstalk environment by ID.

    • AttributeNames — (Array<String>)

      Specifies the response elements you wish to receive. To retrieve all attributes, set to All. If no attribute names are specified, returns a list of instances.

    • NextToken — (String)

      Specify the pagination token returned by a previous call.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • InstanceHealthList — (Array<map>)

        Detailed health information about each instance.

        The output differs slightly between Linux and Windows environments. There is a difference in the members that are supported under the <CPUUtilization> type.

        • InstanceId — (String)

          The ID of the Amazon EC2 instance.

        • HealthStatus — (String)

          Returns the health status of the specified instance. For more information, see Health Colors and Statuses.

        • Color — (String)

          Represents the color indicator that gives you information about the health of the EC2 instance. For more information, see Health Colors and Statuses.

        • Causes — (Array<String>)

          Represents the causes, which provide more information about the current health status.

        • LaunchedAt — (Date)

          The time at which the EC2 instance was launched.

        • ApplicationMetrics — (map)

          Request metrics from your application.

          • Duration — (Integer)

            The amount of time that the metrics cover (usually 10 seconds). For example, you might have 5 requests (request_count) within the most recent time slice of 10 seconds (duration).

          • RequestCount — (Integer)

            Average number of requests handled by the web server per second over the last 10 seconds.

          • StatusCodes — (map)

            Represents the percentage of requests over the last 10 seconds that resulted in each type of status code response.

            • Status2xx — (Integer)

              The percentage of requests over the last 10 seconds that resulted in a 2xx (200, 201, etc.) status code.

            • Status3xx — (Integer)

              The percentage of requests over the last 10 seconds that resulted in a 3xx (300, 301, etc.) status code.

            • Status4xx — (Integer)

              The percentage of requests over the last 10 seconds that resulted in a 4xx (400, 401, etc.) status code.

            • Status5xx — (Integer)

              The percentage of requests over the last 10 seconds that resulted in a 5xx (500, 501, etc.) status code.

          • Latency — (map)

            Represents the average latency for the slowest X percent of requests over the last 10 seconds. Latencies are in seconds with one millisecond resolution.

            • P999 — (Float)

              The average latency for the slowest 0.1 percent of requests over the last 10 seconds.

            • P99 — (Float)

              The average latency for the slowest 1 percent of requests over the last 10 seconds.

            • P95 — (Float)

              The average latency for the slowest 5 percent of requests over the last 10 seconds.

            • P90 — (Float)

              The average latency for the slowest 10 percent of requests over the last 10 seconds.

            • P85 — (Float)

              The average latency for the slowest 15 percent of requests over the last 10 seconds.

            • P75 — (Float)

              The average latency for the slowest 25 percent of requests over the last 10 seconds.

            • P50 — (Float)

              The average latency for the slowest 50 percent of requests over the last 10 seconds.

            • P10 — (Float)

              The average latency for the slowest 90 percent of requests over the last 10 seconds.

        • System — (map)

          Operating system metrics from the instance.

          • CPUUtilization — (map)

            CPU utilization metrics for the instance.

            • User — (Float)

              Percentage of time that the CPU has spent in the User state over the last 10 seconds.

            • Nice — (Float)

              Available on Linux environments only.

              Percentage of time that the CPU has spent in the Nice state over the last 10 seconds.

            • System — (Float)

              Available on Linux environments only.

              Percentage of time that the CPU has spent in the System state over the last 10 seconds.

            • Idle — (Float)

              Percentage of time that the CPU has spent in the Idle state over the last 10 seconds.

            • IOWait — (Float)

              Available on Linux environments only.

              Percentage of time that the CPU has spent in the I/O Wait state over the last 10 seconds.

            • IRQ — (Float)

              Available on Linux environments only.

              Percentage of time that the CPU has spent in the IRQ state over the last 10 seconds.

            • SoftIRQ — (Float)

              Available on Linux environments only.

              Percentage of time that the CPU has spent in the SoftIRQ state over the last 10 seconds.

            • Privileged — (Float)

              Available on Windows environments only.

              Percentage of time that the CPU has spent in the Privileged state over the last 10 seconds.

          • LoadAverage — (Array<Float>)

            Load average in the last 1-minute, 5-minute, and 15-minute periods. For more information, see Operating System Metrics.

        • Deployment — (map)

          Information about the most recent deployment to an instance.

          • VersionLabel — (String)

            The version label of the application version in the deployment.

          • DeploymentId — (Integer)

            The ID of the deployment. This number increases by one each time that you deploy source code or change instance configuration settings.

          • Status — (String)

            The status of the deployment:

            • In Progress : The deployment is in progress.

            • Deployed : The deployment succeeded.

            • Failed : The deployment failed.

          • DeploymentTime — (Date)

            For in-progress deployments, the time that the deployment started.

            For completed deployments, the time that the deployment ended.

        • AvailabilityZone — (String)

          The availability zone in which the instance runs.

        • InstanceType — (String)

          The instance's type.

      • RefreshedAt — (Date)

        The date and time that the health information was retrieved.

      • NextToken — (String)

        Pagination token for the next page of results, if available.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describePlatformVersion(params = {}, callback) ⇒ AWS.Request

Describes a platform version. Provides full details. Compare to ListPlatformVersions, which provides summary information about a list of platform versions.

For definitions of platform version and other platform-related terms, see AWS Elastic Beanstalk Platforms Glossary.

Service Reference:

Examples:

Calling the describePlatformVersion operation

var params = {
  PlatformArn: 'STRING_VALUE'
};
elasticbeanstalk.describePlatformVersion(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • PlatformArn — (String)

      The ARN of the platform version.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • PlatformDescription — (map)

        Detailed information about the platform version.

        • PlatformArn — (String)

          The ARN of the platform version.

        • PlatformOwner — (String)

          The AWS account ID of the person who created the platform version.

        • PlatformName — (String)

          The name of the platform version.

        • PlatformVersion — (String)

          The version of the platform version.

        • SolutionStackName — (String)

          The name of the solution stack used by the platform version.

        • PlatformStatus — (String)

          The status of the platform version.

          Possible values include:
          • "Creating"
          • "Failed"
          • "Ready"
          • "Deleting"
          • "Deleted"
        • DateCreated — (Date)

          The date when the platform version was created.

        • DateUpdated — (Date)

          The date when the platform version was last updated.

        • PlatformCategory — (String)

          The category of the platform version.

        • Description — (String)

          The description of the platform version.

        • Maintainer — (String)

          Information about the maintainer of the platform version.

        • OperatingSystemName — (String)

          The operating system used by the platform version.

        • OperatingSystemVersion — (String)

          The version of the operating system used by the platform version.

        • ProgrammingLanguages — (Array<map>)

          The programming languages supported by the platform version.

          • Name — (String)

            The name of the programming language.

          • Version — (String)

            The version of the programming language.

        • Frameworks — (Array<map>)

          The frameworks supported by the platform version.

          • Name — (String)

            The name of the framework.

          • Version — (String)

            The version of the framework.

        • CustomAmiList — (Array<map>)

          The custom AMIs supported by the platform version.

          • VirtualizationType — (String)

            The type of virtualization used to create the custom AMI.

          • ImageId — (String)

            THe ID of the image used to create the custom AMI.

        • SupportedTierList — (Array<String>)

          The tiers supported by the platform version.

        • SupportedAddonList — (Array<String>)

          The additions supported by the platform version.

        • PlatformLifecycleState — (String)

          The state of the platform version in its lifecycle.

          Possible values: Recommended | null

          If a null value is returned, the platform version isn't the recommended one for its branch. Each platform branch has a single recommended platform version, typically the most recent one.

        • PlatformBranchName — (String)

          The platform branch to which the platform version belongs.

        • PlatformBranchLifecycleState — (String)

          The state of the platform version's branch in its lifecycle.

          Possible values: Beta | Supported | Deprecated | Retired

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

disassociateEnvironmentOperationsRole(params = {}, callback) ⇒ AWS.Request

Disassociate the operations role from an environment. After this call is made, Elastic Beanstalk uses the caller's permissions for permissions to downstream services during subsequent calls acting on this environment. For more information, see Operations roles in the AWS Elastic Beanstalk Developer Guide.

Service Reference:

Examples:

Calling the disassociateEnvironmentOperationsRole operation

var params = {
  EnvironmentName: 'STRING_VALUE' /* required */
};
elasticbeanstalk.disassociateEnvironmentOperationsRole(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • EnvironmentName — (String)

      The name of the environment from which to disassociate the operations role.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listAvailableSolutionStacks(params = {}, callback) ⇒ AWS.Request

Returns a list of the available solution stack names, with the public version first and then in reverse chronological order.

Service Reference:

Examples:

To view solution stacks


/* The following operation lists solution stacks for all currently available platform configurations and any that you have used in the past: */

 var params = {};
 elasticbeanstalk.listAvailableSolutionStacks(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    SolutionStackDetails: [
       {
      PermittedFileTypes: [
         "zip"
      ], 
      SolutionStackName: "64bit Amazon Linux 2015.03 v2.0.0 running Node.js"
     }
    ], 
    SolutionStacks: [
       "64bit Amazon Linux 2015.03 v2.0.0 running Node.js", 
       "64bit Amazon Linux 2015.03 v2.0.0 running PHP 5.6", 
       "64bit Amazon Linux 2015.03 v2.0.0 running PHP 5.5", 
       "64bit Amazon Linux 2015.03 v2.0.0 running PHP 5.4", 
       "64bit Amazon Linux 2015.03 v2.0.0 running Python 3.4", 
       "64bit Amazon Linux 2015.03 v2.0.0 running Python 2.7", 
       "64bit Amazon Linux 2015.03 v2.0.0 running Python", 
       "64bit Amazon Linux 2015.03 v2.0.0 running Ruby 2.2 (Puma)", 
       "64bit Amazon Linux 2015.03 v2.0.0 running Ruby 2.2 (Passenger Standalone)", 
       "64bit Amazon Linux 2015.03 v2.0.0 running Ruby 2.1 (Puma)", 
       "64bit Amazon Linux 2015.03 v2.0.0 running Ruby 2.1 (Passenger Standalone)", 
       "64bit Amazon Linux 2015.03 v2.0.0 running Ruby 2.0 (Puma)", 
       "64bit Amazon Linux 2015.03 v2.0.0 running Ruby 2.0 (Passenger Standalone)", 
       "64bit Amazon Linux 2015.03 v2.0.0 running Ruby 1.9.3", 
       "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8", 
       "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 7 Java 7", 
       "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 7 Java 6", 
       "64bit Windows Server Core 2012 R2 running IIS 8.5", 
       "64bit Windows Server 2012 R2 running IIS 8.5", 
       "64bit Windows Server 2012 running IIS 8", 
       "64bit Windows Server 2008 R2 running IIS 7.5", 
       "64bit Amazon Linux 2015.03 v2.0.0 running Docker 1.6.2", 
       "64bit Amazon Linux 2015.03 v2.0.0 running Multi-container Docker 1.6.2 (Generic)", 
       "64bit Debian jessie v2.0.0 running GlassFish 4.1 Java 8 (Preconfigured - Docker)", 
       "64bit Debian jessie v2.0.0 running GlassFish 4.0 Java 7 (Preconfigured - Docker)", 
       "64bit Debian jessie v2.0.0 running Go 1.4 (Preconfigured - Docker)", 
       "64bit Debian jessie v2.0.0 running Go 1.3 (Preconfigured - Docker)", 
       "64bit Debian jessie v2.0.0 running Python 3.4 (Preconfigured - Docker)"
    ]
   }
   */
 });

Calling the listAvailableSolutionStacks operation

elasticbeanstalk.listAvailableSolutionStacks(function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • SolutionStacks — (Array<String>)

        A list of available solution stacks.

      • SolutionStackDetails — (Array<map>)

        A list of available solution stacks and their SolutionStackDescription.

        • SolutionStackName — (String)

          The name of the solution stack.

        • PermittedFileTypes — (Array<String>)

          The permitted file types allowed for a solution stack.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listPlatformBranches(params = {}, callback) ⇒ AWS.Request

Lists the platform branches available for your account in an AWS Region. Provides summary information about each platform branch.

For definitions of platform branch and other platform-related terms, see AWS Elastic Beanstalk Platforms Glossary.

Service Reference:

Examples:

Calling the listPlatformBranches operation

var params = {
  Filters: [
    {
      Attribute: 'STRING_VALUE',
      Operator: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxRecords: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
elasticbeanstalk.listPlatformBranches(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Filters — (Array<map>)

      Criteria for restricting the resulting list of platform branches. The filter is evaluated as a logical conjunction (AND) of the separate SearchFilter terms.

      The following list shows valid attribute values for each of the SearchFilter terms. Most operators take a single value. The in and not_in operators can take multiple values.

      • Attribute = BranchName:

        • Operator: = | != | begins_with | ends_with | contains | in | not_in

      • Attribute = LifecycleState:

        • Operator: = | != | in | not_in

        • Values: beta | supported | deprecated | retired

      • Attribute = PlatformName:

        • Operator: = | != | begins_with | ends_with | contains | in | not_in

      • Attribute = TierType:

        • Operator: = | !=

        • Values: WebServer/Standard | Worker/SQS/HTTP

      Array size: limited to 10 SearchFilter objects.

      Within each SearchFilter item, the Values array is limited to 10 items.

      • Attribute — (String)

        The result attribute to which the filter values are applied. Valid values vary by API action.

      • Operator — (String)

        The operator to apply to the Attribute with each of the Values. Valid values vary by Attribute.

      • Values — (Array<String>)

        The list of values applied to the Attribute and Operator attributes. Number of values and valid values vary by Attribute.

    • MaxRecords — (Integer)

      The maximum number of platform branch values returned in one call.

    • NextToken — (String)

      For a paginated request. Specify a token from a previous response page to retrieve the next response page. All other parameter values must be identical to the ones specified in the initial request.

      If no NextToken is specified, the first page is retrieved.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • PlatformBranchSummaryList — (Array<map>)

        Summary information about the platform branches.

        • PlatformName — (String)

          The name of the platform to which this platform branch belongs.

        • BranchName — (String)

          The name of the platform branch.

        • LifecycleState — (String)

          The support life cycle state of the platform branch.

          Possible values: beta | supported | deprecated | retired

        • BranchOrder — (Integer)

          An ordinal number that designates the order in which platform branches have been added to a platform. This can be helpful, for example, if your code calls the ListPlatformBranches action and then displays a list of platform branches.

          A larger BranchOrder value designates a newer platform branch within the platform.

        • SupportedTierList — (Array<String>)

          The environment tiers that platform versions in this branch support.

          Possible values: WebServer/Standard | Worker/SQS/HTTP

      • NextToken — (String)

        In a paginated request, if this value isn't null, it's the token that you can pass in a subsequent request to get the next response page.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listPlatformVersions(params = {}, callback) ⇒ AWS.Request

Lists the platform versions available for your account in an AWS Region. Provides summary information about each platform version. Compare to DescribePlatformVersion, which provides full details about a single platform version.

For definitions of platform version and other platform-related terms, see AWS Elastic Beanstalk Platforms Glossary.

Service Reference:

Examples:

Calling the listPlatformVersions operation

var params = {
  Filters: [
    {
      Operator: 'STRING_VALUE',
      Type: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxRecords: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
elasticbeanstalk.listPlatformVersions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Filters — (Array<map>)

      Criteria for restricting the resulting list of platform versions. The filter is interpreted as a logical conjunction (AND) of the separate PlatformFilter terms.

      • Type — (String)

        The platform version attribute to which the filter values are applied.

        Valid values: PlatformName | PlatformVersion | PlatformStatus | PlatformBranchName | PlatformLifecycleState | PlatformOwner | SupportedTier | SupportedAddon | ProgrammingLanguageName | OperatingSystemName

      • Operator — (String)

        The operator to apply to the Type with each of the Values.

        Valid values: = | != | < | <= | > | >= | contains | begins_with | ends_with

      • Values — (Array<String>)

        The list of values applied to the filtering platform version attribute. Only one value is supported for all current operators.

        The following list shows valid filter values for some filter attributes.

        • PlatformStatus: Creating | Failed | Ready | Deleting | Deleted

        • PlatformLifecycleState: recommended

        • SupportedTier: WebServer/Standard | Worker/SQS/HTTP

        • SupportedAddon: Log/S3 | Monitoring/Healthd | WorkerDaemon/SQSD

    • MaxRecords — (Integer)

      The maximum number of platform version values returned in one call.

    • NextToken — (String)

      For a paginated request. Specify a token from a previous response page to retrieve the next response page. All other parameter values must be identical to the ones specified in the initial request.

      If no NextToken is specified, the first page is retrieved.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • PlatformSummaryList — (Array<map>)

        Summary information about the platform versions.

        • PlatformArn — (String)

          The ARN of the platform version.

        • PlatformOwner — (String)

          The AWS account ID of the person who created the platform version.

        • PlatformStatus — (String)

          The status of the platform version. You can create an environment from the platform version once it is ready.

          Possible values include:
          • "Creating"
          • "Failed"
          • "Ready"
          • "Deleting"
          • "Deleted"
        • PlatformCategory — (String)

          The category of platform version.

        • OperatingSystemName — (String)

          The operating system used by the platform version.

        • OperatingSystemVersion — (String)

          The version of the operating system used by the platform version.

        • SupportedTierList — (Array<String>)

          The tiers in which the platform version runs.

        • SupportedAddonList — (Array<String>)

          The additions associated with the platform version.

        • PlatformLifecycleState — (String)

          The state of the platform version in its lifecycle.

          Possible values: recommended | empty

          If an empty value is returned, the platform version is supported but isn't the recommended one for its branch.

        • PlatformVersion — (String)

          The version string of the platform version.

        • PlatformBranchName — (String)

          The platform branch to which the platform version belongs.

        • PlatformBranchLifecycleState — (String)

          The state of the platform version's branch in its lifecycle.

          Possible values: beta | supported | deprecated | retired

      • NextToken — (String)

        In a paginated request, if this value isn't null, it's the token that you can pass in a subsequent request to get the next response page.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

Return the tags applied to an AWS Elastic Beanstalk resource. The response contains a list of tag key-value pairs.

Elastic Beanstalk supports tagging of all of its resources. For details about resource tagging, see Tagging Application Resources.

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  ResourceArn: 'STRING_VALUE' /* required */
};
elasticbeanstalk.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ResourceArn — (String)

      The Amazon Resource Name (ARN) of the resouce for which a tag list is requested.

      Must be the ARN of an Elastic Beanstalk resource.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ResourceArn — (String)

        The Amazon Resource Name (ARN) of the resource for which a tag list was requested.

      • ResourceTags — (Array<map>)

        A list of tag key-value pairs.

        • Key — (String)

          The key of the tag.

        • Value — (String)

          The value of the tag.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

rebuildEnvironment(params = {}, callback) ⇒ AWS.Request

Deletes and recreates all of the AWS resources (for example: the Auto Scaling group, load balancer, etc.) for a specified environment and forces a restart.

Service Reference:

Examples:

To rebuild an environment


/* The following operation terminates and recreates the resources in an environment named my-env: */

 var params = {
  EnvironmentName: "my-env"
 };
 elasticbeanstalk.rebuildEnvironment(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the rebuildEnvironment operation

var params = {
  EnvironmentId: 'STRING_VALUE',
  EnvironmentName: 'STRING_VALUE'
};
elasticbeanstalk.rebuildEnvironment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • EnvironmentId — (String)

      The ID of the environment to rebuild.

      Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

    • EnvironmentName — (String)

      The name of the environment to rebuild.

      Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

requestEnvironmentInfo(params = {}, callback) ⇒ AWS.Request

Initiates a request to compile the specified type of information of the deployed environment.

Setting the InfoType to tail compiles the last lines from the application server log files of every Amazon EC2 instance in your environment.

Setting the InfoType to bundle compresses the application server log files for every Amazon EC2 instance into a .zip file. Legacy and .NET containers do not support bundle logs.

Use RetrieveEnvironmentInfo to obtain the set of logs.

Related Topics

Service Reference:

Examples:

To request tailed logs


/* The following operation requests logs from an environment named my-env: */

 var params = {
  EnvironmentName: "my-env", 
  InfoType: "tail"
 };
 elasticbeanstalk.requestEnvironmentInfo(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the requestEnvironmentInfo operation

var params = {
  InfoType: tail | bundle, /* required */
  EnvironmentId: 'STRING_VALUE',
  EnvironmentName: 'STRING_VALUE'
};
elasticbeanstalk.requestEnvironmentInfo(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • EnvironmentId — (String)

      The ID of the environment of the requested data.

      If no such environment is found, RequestEnvironmentInfo returns an InvalidParameterValue error.

      Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

    • EnvironmentName — (String)

      The name of the environment of the requested data.

      If no such environment is found, RequestEnvironmentInfo returns an InvalidParameterValue error.

      Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

    • InfoType — (String)

      The type of information to request.

      Possible values include:
      • "tail"
      • "bundle"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

restartAppServer(params = {}, callback) ⇒ AWS.Request

Causes the environment to restart the application container server running on each Amazon EC2 instance.

Service Reference:

Examples:

To restart application servers


/* The following operation restarts application servers on all instances in an environment named my-env: */

 var params = {
  EnvironmentName: "my-env"
 };
 elasticbeanstalk.restartAppServer(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the restartAppServer operation

var params = {
  EnvironmentId: 'STRING_VALUE',
  EnvironmentName: 'STRING_VALUE'
};
elasticbeanstalk.restartAppServer(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • EnvironmentId — (String)

      The ID of the environment to restart the server for.

      Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

    • EnvironmentName — (String)

      The name of the environment to restart the server for.

      Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

retrieveEnvironmentInfo(params = {}, callback) ⇒ AWS.Request

Retrieves the compiled information from a RequestEnvironmentInfo request.

Related Topics

Service Reference:

Examples:

To retrieve tailed logs


/* The following operation retrieves a link to logs from an environment named my-env: */

 var params = {
  EnvironmentName: "my-env", 
  InfoType: "tail"
 };
 elasticbeanstalk.retrieveEnvironmentInfo(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    EnvironmentInfo: [
       {
      Ec2InstanceId: "i-09c1c867", 
      InfoType: "tail", 
      Message: "https://elasticbeanstalk-us-west-2-0123456789012.s3.amazonaws.com/resources/environments/logs/tail/e-fyqyju3yjs/i-09c1c867/TailLogs-1440109397703.out?AWSAccessKeyId=AKGPT4J56IAJ2EUBL5CQ&Expires=1440195891&Signature=n%2BEalOV6A2HIOx4Rcfb7LT16bBM%3D", 
      SampleTimestamp: <Date Representation>
     }
    ]
   }
   */
 });

Calling the retrieveEnvironmentInfo operation

var params = {
  InfoType: tail | bundle, /* required */
  EnvironmentId: 'STRING_VALUE',
  EnvironmentName: 'STRING_VALUE'
};
elasticbeanstalk.retrieveEnvironmentInfo(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • EnvironmentId — (String)

      The ID of the data's environment.

      If no such environment is found, returns an InvalidParameterValue error.

      Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

    • EnvironmentName — (String)

      The name of the data's environment.

      If no such environment is found, returns an InvalidParameterValue error.

      Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

    • InfoType — (String)

      The type of information to retrieve.

      Possible values include:
      • "tail"
      • "bundle"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • EnvironmentInfo — (Array<map>)

        The EnvironmentInfoDescription of the environment.

        • InfoType — (String)

          The type of information retrieved.

          Possible values include:
          • "tail"
          • "bundle"
        • Ec2InstanceId — (String)

          The Amazon EC2 Instance ID for this information.

        • SampleTimestamp — (Date)

          The time stamp when this information was retrieved.

        • Message — (String)

          The retrieved information. Currently contains a presigned Amazon S3 URL. The files are deleted after 15 minutes.

          Anyone in possession of this URL can access the files before they are deleted. Make the URL available only to trusted parties.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

swapEnvironmentCNAMEs(params = {}, callback) ⇒ AWS.Request

Swaps the CNAMEs of two environments.

Service Reference:

Examples:

To swap environment CNAMES


/* The following operation swaps the assigned subdomains of two environments: */

 var params = {
  DestinationEnvironmentName: "my-env-green", 
  SourceEnvironmentName: "my-env-blue"
 };
 elasticbeanstalk.swapEnvironmentCNAMEs(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the swapEnvironmentCNAMEs operation

var params = {
  DestinationEnvironmentId: 'STRING_VALUE',
  DestinationEnvironmentName: 'STRING_VALUE',
  SourceEnvironmentId: 'STRING_VALUE',
  SourceEnvironmentName: 'STRING_VALUE'
};
elasticbeanstalk.swapEnvironmentCNAMEs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • SourceEnvironmentId — (String)

      The ID of the source environment.

      Condition: You must specify at least the SourceEnvironmentID or the SourceEnvironmentName. You may also specify both. If you specify the SourceEnvironmentId, you must specify the DestinationEnvironmentId.

    • SourceEnvironmentName — (String)

      The name of the source environment.

      Condition: You must specify at least the SourceEnvironmentID or the SourceEnvironmentName. You may also specify both. If you specify the SourceEnvironmentName, you must specify the DestinationEnvironmentName.

    • DestinationEnvironmentId — (String)

      The ID of the destination environment.

      Condition: You must specify at least the DestinationEnvironmentID or the DestinationEnvironmentName. You may also specify both. You must specify the SourceEnvironmentId with the DestinationEnvironmentId.

    • DestinationEnvironmentName — (String)

      The name of the destination environment.

      Condition: You must specify at least the DestinationEnvironmentID or the DestinationEnvironmentName. You may also specify both. You must specify the SourceEnvironmentName with the DestinationEnvironmentName.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

terminateEnvironment(params = {}, callback) ⇒ AWS.Request

Terminates the specified environment.

Service Reference:

Examples:

To terminate an environment


/* The following operation terminates an Elastic Beanstalk environment named my-env: */

 var params = {
  EnvironmentName: "my-env"
 };
 elasticbeanstalk.terminateEnvironment(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    AbortableOperationInProgress: false, 
    ApplicationName: "my-app", 
    CNAME: "my-env.elasticbeanstalk.com", 
    DateCreated: <Date Representation>, 
    DateUpdated: <Date Representation>, 
    EndpointURL: "awseb-e-f-AWSEBLoa-1I9XUMP4-8492WNUP202574.us-west-2.elb.amazonaws.com", 
    EnvironmentId: "e-fh2eravpns", 
    EnvironmentName: "my-env", 
    Health: "Grey", 
    SolutionStackName: "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8", 
    Status: "Terminating", 
    Tier: {
     Name: "WebServer", 
     Type: "Standard", 
     Version: " "
    }
   }
   */
 });

Calling the terminateEnvironment operation

var params = {
  EnvironmentId: 'STRING_VALUE',
  EnvironmentName: 'STRING_VALUE',
  ForceTerminate: true || false,
  TerminateResources: true || false
};
elasticbeanstalk.terminateEnvironment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • EnvironmentId — (String)

      The ID of the environment to terminate.

      Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

    • EnvironmentName — (String)

      The name of the environment to terminate.

      Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

    • TerminateResources — (Boolean)

      Indicates whether the associated AWS resources should shut down when the environment is terminated:

      • true: The specified environment as well as the associated AWS resources, such as Auto Scaling group and LoadBalancer, are terminated.

      • false: AWS Elastic Beanstalk resource management is removed from the environment, but the AWS resources continue to operate.

      For more information, see the AWS Elastic Beanstalk User Guide.

      Default: true

      Valid Values: true | false

    • ForceTerminate — (Boolean)

      Terminates the target environment even if another environment in the same group is dependent on it.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • EnvironmentName — (String)

        The name of this environment.

      • EnvironmentId — (String)

        The ID of this environment.

      • ApplicationName — (String)

        The name of the application associated with this environment.

      • VersionLabel — (String)

        The application version deployed in this environment.

      • SolutionStackName — (String)

        The name of the SolutionStack deployed with this environment.

      • PlatformArn — (String)

        The ARN of the platform version.

      • TemplateName — (String)

        The name of the configuration template used to originally launch this environment.

      • Description — (String)

        Describes this environment.

      • EndpointURL — (String)

        For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.

      • CNAME — (String)

        The URL to the CNAME for this environment.

      • DateCreated — (Date)

        The creation date for this environment.

      • DateUpdated — (Date)

        The last modified date for this environment.

      • Status — (String)

        The current operational status of the environment:

        • Launching: Environment is in the process of initial deployment.

        • Updating: Environment is in the process of updating its configuration settings or application version.

        • Ready: Environment is available to have an action performed on it, such as update or terminate.

        • Terminating: Environment is in the shut-down process.

        • Terminated: Environment is not running.

        Possible values include:
        • "Aborting"
        • "Launching"
        • "Updating"
        • "LinkingFrom"
        • "LinkingTo"
        • "Ready"
        • "Terminating"
        • "Terminated"
      • AbortableOperationInProgress — (Boolean)

        Indicates if there is an in-progress environment configuration update or application version deployment that you can cancel.

        true: There is an update in progress.

        false: There are no updates currently in progress.

      • Health — (String)

        Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment:

        • Red: Indicates the environment is not responsive. Occurs when three or more consecutive failures occur for an environment.

        • Yellow: Indicates that something is wrong. Occurs when two consecutive failures occur for an environment.

        • Green: Indicates the environment is healthy and fully functional.

        • Grey: Default health for a new environment. The environment is not fully launched and health checks have not started or health checks are suspended during an UpdateEnvironment or RestartEnvironment request.

        Default: Grey

        Possible values include:
        • "Green"
        • "Yellow"
        • "Red"
        • "Grey"
      • HealthStatus — (String)

        Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses.

        Possible values include:
        • "NoData"
        • "Unknown"
        • "Pending"
        • "Ok"
        • "Info"
        • "Warning"
        • "Degraded"
        • "Severe"
        • "Suspended"
      • Resources — (map)

        The description of the AWS resources used by this environment.

        • LoadBalancer — (map)

          Describes the LoadBalancer.

          • LoadBalancerName — (String)

            The name of the LoadBalancer.

          • Domain — (String)

            The domain name of the LoadBalancer.

          • Listeners — (Array<map>)

            A list of Listeners used by the LoadBalancer.

            • Protocol — (String)

              The protocol that is used by the Listener.

            • Port — (Integer)

              The port that is used by the Listener.

      • Tier — (map)

        Describes the current tier of this environment.

        • Name — (String)

          The name of this environment tier.

          Valid values:

          • For Web server tier – WebServer

          • For Worker tier – Worker

        • Type — (String)

          The type of this environment tier.

          Valid values:

          • For Web server tier – Standard

          • For Worker tier – SQS/HTTP

        • Version — (String)

          The version of this environment tier. When you don't set a value to it, Elastic Beanstalk uses the latest compatible worker tier version.

          Note: This member is deprecated. Any specific version that you set may become out of date. We recommend leaving it unspecified.
      • EnvironmentLinks — (Array<map>)

        A list of links to other environments in the same group.

        • LinkName — (String)

          The name of the link.

        • EnvironmentName — (String)

          The name of the linked environment (the dependency).

      • EnvironmentArn — (String)

        The environment's Amazon Resource Name (ARN), which can be used in other API requests that require an ARN.

      • OperationsRole — (String)

        The Amazon Resource Name (ARN) of the environment's operations role. For more information, see Operations roles in the AWS Elastic Beanstalk Developer Guide.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateApplication(params = {}, callback) ⇒ AWS.Request

Updates the specified application to have the specified properties.

Note: If a property (for example, description) is not provided, the value remains unchanged. To clear these properties, specify an empty string.

Service Reference:

Examples:

To change an application's description


/* The following operation updates the description of an application named my-app: */

 var params = {
  ApplicationName: "my-app", 
  Description: "my Elastic Beanstalk application"
 };
 elasticbeanstalk.updateApplication(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Application: {
     ApplicationName: "my-app", 
     ConfigurationTemplates: [
     ], 
     DateCreated: <Date Representation>, 
     DateUpdated: <Date Representation>, 
     Description: "my Elastic Beanstalk application", 
     Versions: [
        "2fba-stage-150819_234450", 
        "bf07-stage-150820_214945", 
        "93f8", 
        "fd7c-stage-150820_000431", 
        "22a0-stage-150819_185942"
     ]
    }
   }
   */
 });

Calling the updateApplication operation

var params = {
  ApplicationName: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE'
};
elasticbeanstalk.updateApplication(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationName — (String)

      The name of the application to update. If no such application is found, UpdateApplication returns an InvalidParameterValue error.

    • Description — (String)

      A new description for the application.

      Default: If not specified, AWS Elastic Beanstalk does not update the description.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Application — (map)

        The ApplicationDescription of the application.

        • ApplicationArn — (String)

          The Amazon Resource Name (ARN) of the application.

        • ApplicationName — (String)

          The name of the application.

        • Description — (String)

          User-defined description of the application.

        • DateCreated — (Date)

          The date when the application was created.

        • DateUpdated — (Date)

          The date when the application was last modified.

        • Versions — (Array<String>)

          The names of the versions for this application.

        • ConfigurationTemplates — (Array<String>)

          The names of the configuration templates associated with this application.

        • ResourceLifecycleConfig — (map)

          The lifecycle settings for the application.

          • ServiceRole — (String)

            The ARN of an IAM service role that Elastic Beanstalk has permission to assume.

            The ServiceRole property is required the first time that you provide a VersionLifecycleConfig for the application in one of the supporting calls (CreateApplication or UpdateApplicationResourceLifecycle). After you provide it once, in either one of the calls, Elastic Beanstalk persists the Service Role with the application, and you don't need to specify it again in subsequent UpdateApplicationResourceLifecycle calls. You can, however, specify it in subsequent calls to change the Service Role to another value.

          • VersionLifecycleConfig — (map)

            Defines lifecycle settings for application versions.

            • MaxCountRule — (map)

              Specify a max count rule to restrict the number of application versions that are retained for an application.

              • Enabled — required — (Boolean)

                Specify true to apply the rule, or false to disable it.

              • MaxCount — (Integer)

                Specify the maximum number of application versions to retain.

              • DeleteSourceFromS3 — (Boolean)

                Set to true to delete a version's source bundle from Amazon S3 when Elastic Beanstalk deletes the application version.

            • MaxAgeRule — (map)

              Specify a max age rule to restrict the length of time that application versions are retained for an application.

              • Enabled — required — (Boolean)

                Specify true to apply the rule, or false to disable it.

              • MaxAgeInDays — (Integer)

                Specify the number of days to retain an application versions.

              • DeleteSourceFromS3 — (Boolean)

                Set to true to delete a version's source bundle from Amazon S3 when Elastic Beanstalk deletes the application version.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateApplicationResourceLifecycle(params = {}, callback) ⇒ AWS.Request

Modifies lifecycle settings for an application.

Service Reference:

Examples:

Calling the updateApplicationResourceLifecycle operation

var params = {
  ApplicationName: 'STRING_VALUE', /* required */
  ResourceLifecycleConfig: { /* required */
    ServiceRole: 'STRING_VALUE',
    VersionLifecycleConfig: {
      MaxAgeRule: {
        Enabled: true || false, /* required */
        DeleteSourceFromS3: true || false,
        MaxAgeInDays: 'NUMBER_VALUE'
      },
      MaxCountRule: {
        Enabled: true || false, /* required */
        DeleteSourceFromS3: true || false,
        MaxCount: 'NUMBER_VALUE'
      }
    }
  }
};
elasticbeanstalk.updateApplicationResourceLifecycle(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationName — (String)

      The name of the application.

    • ResourceLifecycleConfig — (map)

      The lifecycle configuration.

      • ServiceRole — (String)

        The ARN of an IAM service role that Elastic Beanstalk has permission to assume.

        The ServiceRole property is required the first time that you provide a VersionLifecycleConfig for the application in one of the supporting calls (CreateApplication or UpdateApplicationResourceLifecycle). After you provide it once, in either one of the calls, Elastic Beanstalk persists the Service Role with the application, and you don't need to specify it again in subsequent UpdateApplicationResourceLifecycle calls. You can, however, specify it in subsequent calls to change the Service Role to another value.

      • VersionLifecycleConfig — (map)

        Defines lifecycle settings for application versions.

        • MaxCountRule — (map)

          Specify a max count rule to restrict the number of application versions that are retained for an application.

          • Enabled — required — (Boolean)

            Specify true to apply the rule, or false to disable it.

          • MaxCount — (Integer)

            Specify the maximum number of application versions to retain.

          • DeleteSourceFromS3 — (Boolean)

            Set to true to delete a version's source bundle from Amazon S3 when Elastic Beanstalk deletes the application version.

        • MaxAgeRule — (map)

          Specify a max age rule to restrict the length of time that application versions are retained for an application.

          • Enabled — required — (Boolean)

            Specify true to apply the rule, or false to disable it.

          • MaxAgeInDays — (Integer)

            Specify the number of days to retain an application versions.

          • DeleteSourceFromS3 — (Boolean)

            Set to true to delete a version's source bundle from Amazon S3 when Elastic Beanstalk deletes the application version.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ApplicationName — (String)

        The name of the application.

      • ResourceLifecycleConfig — (map)

        The lifecycle configuration.

        • ServiceRole — (String)

          The ARN of an IAM service role that Elastic Beanstalk has permission to assume.

          The ServiceRole property is required the first time that you provide a VersionLifecycleConfig for the application in one of the supporting calls (CreateApplication or UpdateApplicationResourceLifecycle). After you provide it once, in either one of the calls, Elastic Beanstalk persists the Service Role with the application, and you don't need to specify it again in subsequent UpdateApplicationResourceLifecycle calls. You can, however, specify it in subsequent calls to change the Service Role to another value.

        • VersionLifecycleConfig — (map)

          Defines lifecycle settings for application versions.

          • MaxCountRule — (map)

            Specify a max count rule to restrict the number of application versions that are retained for an application.

            • Enabled — required — (Boolean)

              Specify true to apply the rule, or false to disable it.

            • MaxCount — (Integer)

              Specify the maximum number of application versions to retain.

            • DeleteSourceFromS3 — (Boolean)

              Set to true to delete a version's source bundle from Amazon S3 when Elastic Beanstalk deletes the application version.

          • MaxAgeRule — (map)

            Specify a max age rule to restrict the length of time that application versions are retained for an application.

            • Enabled — required — (Boolean)

              Specify true to apply the rule, or false to disable it.

            • MaxAgeInDays — (Integer)

              Specify the number of days to retain an application versions.

            • DeleteSourceFromS3 — (Boolean)

              Set to true to delete a version's source bundle from Amazon S3 when Elastic Beanstalk deletes the application version.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateApplicationVersion(params = {}, callback) ⇒ AWS.Request

Updates the specified application version to have the specified properties.

Note: If a property (for example, description) is not provided, the value remains unchanged. To clear properties, specify an empty string.

Service Reference:

Examples:

To change an application version's description


/* The following operation updates the description of an application version named 22a0-stage-150819_185942: */

 var params = {
  ApplicationName: "my-app", 
  Description: "new description", 
  VersionLabel: "22a0-stage-150819_185942"
 };
 elasticbeanstalk.updateApplicationVersion(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ApplicationVersion: {
     ApplicationName: "my-app", 
     DateCreated: <Date Representation>, 
     DateUpdated: <Date Representation>, 
     Description: "new description", 
     SourceBundle: {
      S3Bucket: "elasticbeanstalk-us-west-2-0123456789012", 
      S3Key: "my-app/22a0-stage-150819_185942.war"
     }, 
     VersionLabel: "22a0-stage-150819_185942"
    }
   }
   */
 });

Calling the updateApplicationVersion operation

var params = {
  ApplicationName: 'STRING_VALUE', /* required */
  VersionLabel: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE'
};
elasticbeanstalk.updateApplicationVersion(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationName — (String)

      The name of the application associated with this version.

      If no application is found with this name, UpdateApplication returns an InvalidParameterValue error.

    • VersionLabel — (String)

      The name of the version to update.

      If no application version is found with this label, UpdateApplication returns an InvalidParameterValue error.

    • Description — (String)

      A new description for this version.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ApplicationVersion — (map)

        The ApplicationVersionDescription of the application version.

        • ApplicationVersionArn — (String)

          The Amazon Resource Name (ARN) of the application version.

        • ApplicationName — (String)

          The name of the application to which the application version belongs.

        • Description — (String)

          The description of the application version.

        • VersionLabel — (String)

          A unique identifier for the application version.

        • SourceBuildInformation — (map)

          If the version's source code was retrieved from AWS CodeCommit, the location of the source code for the application version.

          • SourceType — required — (String)

            The type of repository.

            • Git

            • Zip

            Possible values include:
            • "Git"
            • "Zip"
          • SourceRepository — required — (String)

            Location where the repository is stored.

            • CodeCommit

            • S3

            Possible values include:
            • "CodeCommit"
            • "S3"
          • SourceLocation — required — (String)

            The location of the source code, as a formatted string, depending on the value of SourceRepository

            • For CodeCommit, the format is the repository name and commit ID, separated by a forward slash. For example, my-git-repo/265cfa0cf6af46153527f55d6503ec030551f57a.

            • For S3, the format is the S3 bucket name and object key, separated by a forward slash. For example, my-s3-bucket/Folders/my-source-file.

        • BuildArn — (String)

          Reference to the artifact from the AWS CodeBuild build.

        • SourceBundle — (map)

          The storage location of the application version's source bundle in Amazon S3.

          • S3Bucket — (String)

            The Amazon S3 bucket where the data is located.

          • S3Key — (String)

            The Amazon S3 key where the data is located.

        • DateCreated — (Date)

          The creation date of the application version.

        • DateUpdated — (Date)

          The last modified date of the application version.

        • Status — (String)

          The processing status of the application version. Reflects the state of the application version during its creation. Many of the values are only applicable if you specified True for the Process parameter of the CreateApplicationVersion action. The following list describes the possible values.

          • Unprocessed – Application version wasn't pre-processed or validated. Elastic Beanstalk will validate configuration files during deployment of the application version to an environment.

          • Processing – Elastic Beanstalk is currently processing the application version.

          • Building – Application version is currently undergoing an AWS CodeBuild build.

          • Processed – Elastic Beanstalk was successfully pre-processed and validated.

          • Failed – Either the AWS CodeBuild build failed or configuration files didn't pass validation. This application version isn't usable.

          Possible values include:
          • "Processed"
          • "Unprocessed"
          • "Failed"
          • "Processing"
          • "Building"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateConfigurationTemplate(params = {}, callback) ⇒ AWS.Request

Updates the specified configuration template to have the specified properties or configuration option values.

Note: If a property (for example, ApplicationName) is not provided, its value remains unchanged. To clear such properties, specify an empty string.

Related Topics

Service Reference:

Examples:

To update a configuration template


/* The following operation removes the configured CloudWatch custom health metrics configuration ConfigDocument from a saved configuration template named my-template: */

 var params = {
  ApplicationName: "my-app", 
  OptionsToRemove: [
     {
    Namespace: "aws:elasticbeanstalk:healthreporting:system", 
    OptionName: "ConfigDocument"
   }
  ], 
  TemplateName: "my-template"
 };
 elasticbeanstalk.updateConfigurationTemplate(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ApplicationName: "my-app", 
    DateCreated: <Date Representation>, 
    DateUpdated: <Date Representation>, 
    SolutionStackName: "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8", 
    TemplateName: "my-template"
   }
   */
 });

Calling the updateConfigurationTemplate operation

var params = {
  ApplicationName: 'STRING_VALUE', /* required */
  TemplateName: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  OptionSettings: [
    {
      Namespace: 'STRING_VALUE',
      OptionName: 'STRING_VALUE',
      ResourceName: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  OptionsToRemove: [
    {
      Namespace: 'STRING_VALUE',
      OptionName: 'STRING_VALUE',
      ResourceName: 'STRING_VALUE'
    },
    /* more items */
  ]
};
elasticbeanstalk.updateConfigurationTemplate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationName — (String)

      The name of the application associated with the configuration template to update.

      If no application is found with this name, UpdateConfigurationTemplate returns an InvalidParameterValue error.

    • TemplateName — (String)

      The name of the configuration template to update.

      If no configuration template is found with this name, UpdateConfigurationTemplate returns an InvalidParameterValue error.

    • Description — (String)

      A new description for the configuration.

    • OptionSettings — (Array<map>)

      A list of configuration option settings to update with the new specified option value.

      • ResourceName — (String)

        A unique resource name for the option setting. Use it for a time–based scaling configuration option.

      • Namespace — (String)

        A unique namespace that identifies the option's associated AWS resource.

      • OptionName — (String)

        The name of the configuration option.

      • Value — (String)

        The current value for the configuration option.

    • OptionsToRemove — (Array<map>)

      A list of configuration options to remove from the configuration set.

      Constraint: You can remove only UserDefined configuration options.

      • ResourceName — (String)

        A unique resource name for a time-based scaling configuration option.

      • Namespace — (String)

        A unique namespace identifying the option's associated AWS resource.

      • OptionName — (String)

        The name of the configuration option.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • SolutionStackName — (String)

        The name of the solution stack this configuration set uses.

      • PlatformArn — (String)

        The ARN of the platform version.

      • ApplicationName — (String)

        The name of the application associated with this configuration set.

      • TemplateName — (String)

        If not null, the name of the configuration template for this configuration set.

      • Description — (String)

        Describes this configuration set.

      • EnvironmentName — (String)

        If not null, the name of the environment for this configuration set.

      • DeploymentStatus — (String)

        If this configuration set is associated with an environment, the DeploymentStatus parameter indicates the deployment status of this configuration set:

        • null: This configuration is not associated with a running environment.

        • pending: This is a draft configuration that is not deployed to the associated environment but is in the process of deploying.

        • deployed: This is the configuration that is currently deployed to the associated running environment.

        • failed: This is a draft configuration that failed to successfully deploy.

        Possible values include:
        • "deployed"
        • "pending"
        • "failed"
      • DateCreated — (Date)

        The date (in UTC time) when this configuration set was created.

      • DateUpdated — (Date)

        The date (in UTC time) when this configuration set was last modified.

      • OptionSettings — (Array<map>)

        A list of the configuration options and their values in this configuration set.

        • ResourceName — (String)

          A unique resource name for the option setting. Use it for a time–based scaling configuration option.

        • Namespace — (String)

          A unique namespace that identifies the option's associated AWS resource.

        • OptionName — (String)

          The name of the configuration option.

        • Value — (String)

          The current value for the configuration option.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateEnvironment(params = {}, callback) ⇒ AWS.Request

Updates the environment description, deploys a new application version, updates the configuration settings to an entirely new configuration template, or updates select configuration option values in the running environment.

Attempting to update both the release and configuration is not allowed and AWS Elastic Beanstalk returns an InvalidParameterCombination error.

When updating the configuration settings to a new template or individual settings, a draft configuration is created and DescribeConfigurationSettings for this environment returns two setting descriptions with different DeploymentStatus values.

Service Reference:

Examples:

To update an environment to a new version


/* The following operation updates an environment named "my-env" to version "v2" of the application to which it belongs: */

 var params = {
  EnvironmentName: "my-env", 
  VersionLabel: "v2"
 };
 elasticbeanstalk.updateEnvironment(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ApplicationName: "my-app", 
    CNAME: "my-env.elasticbeanstalk.com", 
    DateCreated: <Date Representation>, 
    DateUpdated: <Date Representation>, 
    EndpointURL: "awseb-e-i-AWSEBLoa-1RDLX6TC9VUAO-0123456789.us-west-2.elb.amazonaws.com", 
    EnvironmentId: "e-szqipays4h", 
    EnvironmentName: "my-env", 
    Health: "Grey", 
    SolutionStackName: "64bit Amazon Linux running Tomcat 7", 
    Status: "Updating", 
    Tier: {
     Name: "WebServer", 
     Type: "Standard", 
     Version: " "
    }, 
    VersionLabel: "v2"
   }
   */
 });

To configure option settings


/* The following operation configures several options in the aws:elb:loadbalancer namespace: */

 var params = {
  EnvironmentName: "my-env", 
  OptionSettings: [
     {
    Namespace: "aws:elb:healthcheck", 
    OptionName: "Interval", 
    Value: "15"
   }, 
     {
    Namespace: "aws:elb:healthcheck", 
    OptionName: "Timeout", 
    Value: "8"
   }, 
     {
    Namespace: "aws:elb:healthcheck", 
    OptionName: "HealthyThreshold", 
    Value: "2"
   }, 
     {
    Namespace: "aws:elb:healthcheck", 
    OptionName: "UnhealthyThreshold", 
    Value: "3"
   }
  ]
 };
 elasticbeanstalk.updateEnvironment(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    AbortableOperationInProgress: true, 
    ApplicationName: "my-app", 
    CNAME: "my-env.elasticbeanstalk.com", 
    DateCreated: <Date Representation>, 
    DateUpdated: <Date Representation>, 
    EndpointURL: "awseb-e-w-AWSEBLoa-14XB83101Q4L-104QXY80921.sa-east-1.elb.amazonaws.com", 
    EnvironmentId: "e-wtp2rpqsej", 
    EnvironmentName: "my-env", 
    Health: "Grey", 
    SolutionStackName: "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8", 
    Status: "Updating", 
    Tier: {
     Name: "WebServer", 
     Type: "Standard", 
     Version: " "
    }, 
    VersionLabel: "7f58-stage-150812_025409"
   }
   */
 });

Calling the updateEnvironment operation

var params = {
  ApplicationName: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  EnvironmentId: 'STRING_VALUE',
  EnvironmentName: 'STRING_VALUE',
  GroupName: 'STRING_VALUE',
  OptionSettings: [
    {
      Namespace: 'STRING_VALUE',
      OptionName: 'STRING_VALUE',
      ResourceName: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  OptionsToRemove: [
    {
      Namespace: 'STRING_VALUE',
      OptionName: 'STRING_VALUE',
      ResourceName: 'STRING_VALUE'
    },
    /* more items */
  ],
  PlatformArn: 'STRING_VALUE',
  SolutionStackName: 'STRING_VALUE',
  TemplateName: 'STRING_VALUE',
  Tier: {
    Name: 'STRING_VALUE',
    Type: 'STRING_VALUE',
    Version: 'STRING_VALUE'
  },
  VersionLabel: 'STRING_VALUE'
};
elasticbeanstalk.updateEnvironment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationName — (String)

      The name of the application with which the environment is associated.

    • EnvironmentId — (String)

      The ID of the environment to update.

      If no environment with this ID exists, AWS Elastic Beanstalk returns an InvalidParameterValue error.

      Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

    • EnvironmentName — (String)

      The name of the environment to update. If no environment with this name exists, AWS Elastic Beanstalk returns an InvalidParameterValue error.

      Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

    • GroupName — (String)

      The name of the group to which the target environment belongs. Specify a group name only if the environment's name is specified in an environment manifest and not with the environment name or environment ID parameters. See Environment Manifest (env.yaml) for details.

    • Description — (String)

      If this parameter is specified, AWS Elastic Beanstalk updates the description of this environment.

    • Tier — (map)

      This specifies the tier to use to update the environment.

      Condition: At this time, if you change the tier version, name, or type, AWS Elastic Beanstalk returns InvalidParameterValue error.

      • Name — (String)

        The name of this environment tier.

        Valid values:

        • For Web server tier – WebServer

        • For Worker tier – Worker

      • Type — (String)

        The type of this environment tier.

        Valid values:

        • For Web server tier – Standard

        • For Worker tier – SQS/HTTP

      • Version — (String)

        The version of this environment tier. When you don't set a value to it, Elastic Beanstalk uses the latest compatible worker tier version.

        Note: This member is deprecated. Any specific version that you set may become out of date. We recommend leaving it unspecified.
    • VersionLabel — (String)

      If this parameter is specified, AWS Elastic Beanstalk deploys the named application version to the environment. If no such application version is found, returns an InvalidParameterValue error.

    • TemplateName — (String)

      If this parameter is specified, AWS Elastic Beanstalk deploys this configuration template to the environment. If no such configuration template is found, AWS Elastic Beanstalk returns an InvalidParameterValue error.

    • SolutionStackName — (String)

      This specifies the platform version that the environment will run after the environment is updated.

    • PlatformArn — (String)

      The ARN of the platform, if used.

    • OptionSettings — (Array<map>)

      If specified, AWS Elastic Beanstalk updates the configuration set associated with the running environment and sets the specified configuration options to the requested value.

      • ResourceName — (String)

        A unique resource name for the option setting. Use it for a time–based scaling configuration option.

      • Namespace — (String)

        A unique namespace that identifies the option's associated AWS resource.

      • OptionName — (String)

        The name of the configuration option.

      • Value — (String)

        The current value for the configuration option.

    • OptionsToRemove — (Array<map>)

      A list of custom user-defined configuration options to remove from the configuration set for this environment.

      • ResourceName — (String)

        A unique resource name for a time-based scaling configuration option.

      • Namespace — (String)

        A unique namespace identifying the option's associated AWS resource.

      • OptionName — (String)

        The name of the configuration option.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • EnvironmentName — (String)

        The name of this environment.

      • EnvironmentId — (String)

        The ID of this environment.

      • ApplicationName — (String)

        The name of the application associated with this environment.

      • VersionLabel — (String)

        The application version deployed in this environment.

      • SolutionStackName — (String)

        The name of the SolutionStack deployed with this environment.

      • PlatformArn — (String)

        The ARN of the platform version.

      • TemplateName — (String)

        The name of the configuration template used to originally launch this environment.

      • Description — (String)

        Describes this environment.

      • EndpointURL — (String)

        For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.

      • CNAME — (String)

        The URL to the CNAME for this environment.

      • DateCreated — (Date)

        The creation date for this environment.

      • DateUpdated — (Date)

        The last modified date for this environment.

      • Status — (String)

        The current operational status of the environment:

        • Launching: Environment is in the process of initial deployment.

        • Updating: Environment is in the process of updating its configuration settings or application version.

        • Ready: Environment is available to have an action performed on it, such as update or terminate.

        • Terminating: Environment is in the shut-down process.

        • Terminated: Environment is not running.

        Possible values include:
        • "Aborting"
        • "Launching"
        • "Updating"
        • "LinkingFrom"
        • "LinkingTo"
        • "Ready"
        • "Terminating"
        • "Terminated"
      • AbortableOperationInProgress — (Boolean)

        Indicates if there is an in-progress environment configuration update or application version deployment that you can cancel.

        true: There is an update in progress.

        false: There are no updates currently in progress.

      • Health — (String)

        Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment:

        • Red: Indicates the environment is not responsive. Occurs when three or more consecutive failures occur for an environment.

        • Yellow: Indicates that something is wrong. Occurs when two consecutive failures occur for an environment.

        • Green: Indicates the environment is healthy and fully functional.

        • Grey: Default health for a new environment. The environment is not fully launched and health checks have not started or health checks are suspended during an UpdateEnvironment or RestartEnvironment request.

        Default: Grey

        Possible values include:
        • "Green"
        • "Yellow"
        • "Red"
        • "Grey"
      • HealthStatus — (String)

        Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses.

        Possible values include:
        • "NoData"
        • "Unknown"
        • "Pending"
        • "Ok"
        • "Info"
        • "Warning"
        • "Degraded"
        • "Severe"
        • "Suspended"
      • Resources — (map)

        The description of the AWS resources used by this environment.

        • LoadBalancer — (map)

          Describes the LoadBalancer.

          • LoadBalancerName — (String)

            The name of the LoadBalancer.

          • Domain — (String)

            The domain name of the LoadBalancer.

          • Listeners — (Array<map>)

            A list of Listeners used by the LoadBalancer.

            • Protocol — (String)

              The protocol that is used by the Listener.

            • Port — (Integer)

              The port that is used by the Listener.

      • Tier — (map)

        Describes the current tier of this environment.

        • Name — (String)

          The name of this environment tier.

          Valid values:

          • For Web server tier – WebServer

          • For Worker tier – Worker

        • Type — (String)

          The type of this environment tier.

          Valid values:

          • For Web server tier – Standard

          • For Worker tier – SQS/HTTP

        • Version — (String)

          The version of this environment tier. When you don't set a value to it, Elastic Beanstalk uses the latest compatible worker tier version.

          Note: This member is deprecated. Any specific version that you set may become out of date. We recommend leaving it unspecified.
      • EnvironmentLinks — (Array<map>)

        A list of links to other environments in the same group.

        • LinkName — (String)

          The name of the link.

        • EnvironmentName — (String)

          The name of the linked environment (the dependency).

      • EnvironmentArn — (String)

        The environment's Amazon Resource Name (ARN), which can be used in other API requests that require an ARN.

      • OperationsRole — (String)

        The Amazon Resource Name (ARN) of the environment's operations role. For more information, see Operations roles in the AWS Elastic Beanstalk Developer Guide.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateTagsForResource(params = {}, callback) ⇒ AWS.Request

Update the list of tags applied to an AWS Elastic Beanstalk resource. Two lists can be passed: TagsToAdd for tags to add or update, and TagsToRemove.

Elastic Beanstalk supports tagging of all of its resources. For details about resource tagging, see Tagging Application Resources.

If you create a custom IAM user policy to control permission to this operation, specify one of the following two virtual actions (or both) instead of the API operation name:

elasticbeanstalk:AddTags

Controls permission to call UpdateTagsForResource and pass a list of tags to add in the TagsToAdd parameter.

elasticbeanstalk:RemoveTags

Controls permission to call UpdateTagsForResource and pass a list of tag keys to remove in the TagsToRemove parameter.

For details about creating a custom user policy, see Creating a Custom User Policy.

Service Reference:

Examples:

Calling the updateTagsForResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  TagsToAdd: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  TagsToRemove: [
    'STRING_VALUE',
    /* more items */
  ]
};
elasticbeanstalk.updateTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ResourceArn — (String)

      The Amazon Resource Name (ARN) of the resouce to be updated.

      Must be the ARN of an Elastic Beanstalk resource.

    • TagsToAdd — (Array<map>)

      A list of tags to add or update. If a key of an existing tag is added, the tag's value is updated.

      Specify at least one of these parameters: TagsToAdd, TagsToRemove.

      • Key — (String)

        The key of the tag.

      • Value — (String)

        The value of the tag.

    • TagsToRemove — (Array<String>)

      A list of tag keys to remove. If a tag key doesn't exist, it is silently ignored.

      Specify at least one of these parameters: TagsToAdd, TagsToRemove.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

validateConfigurationSettings(params = {}, callback) ⇒ AWS.Request

Takes a set of configuration settings and either a configuration template or environment, and determines whether those values are valid.

This action returns a list of messages indicating any errors or warnings associated with the selection of option values.

Service Reference:

Examples:

To validate configuration settings


/* The following operation validates a CloudWatch custom metrics config document: */

 var params = {
  ApplicationName: "my-app", 
  EnvironmentName: "my-env", 
  OptionSettings: [
     {
    Namespace: "aws:elasticbeanstalk:healthreporting:system", 
    OptionName: "ConfigDocument", 
    Value: "{\"CloudWatchMetrics\": {\"Environment\": {\"ApplicationLatencyP99.9\": null,\"InstancesSevere\": 60,\"ApplicationLatencyP90\": 60,\"ApplicationLatencyP99\": null,\"ApplicationLatencyP95\": 60,\"InstancesUnknown\": 60,\"ApplicationLatencyP85\": 60,\"InstancesInfo\": null,\"ApplicationRequests2xx\": null,\"InstancesDegraded\": null,\"InstancesWarning\": 60,\"ApplicationLatencyP50\": 60,\"ApplicationRequestsTotal\": null,\"InstancesNoData\": null,\"InstancesPending\": 60,\"ApplicationLatencyP10\": null,\"ApplicationRequests5xx\": null,\"ApplicationLatencyP75\": null,\"InstancesOk\": 60,\"ApplicationRequests3xx\": null,\"ApplicationRequests4xx\": null},\"Instance\": {\"ApplicationLatencyP99.9\": null,\"ApplicationLatencyP90\": 60,\"ApplicationLatencyP99\": null,\"ApplicationLatencyP95\": null,\"ApplicationLatencyP85\": null,\"CPUUser\": 60,\"ApplicationRequests2xx\": null,\"CPUIdle\": null,\"ApplicationLatencyP50\": null,\"ApplicationRequestsTotal\": 60,\"RootFilesystemUtil\": null,\"LoadAverage1min\": null,\"CPUIrq\": null,\"CPUNice\": 60,\"CPUIowait\": 60,\"ApplicationLatencyP10\": null,\"LoadAverage5min\": null,\"ApplicationRequests5xx\": null,\"ApplicationLatencyP75\": 60,\"CPUSystem\": 60,\"ApplicationRequests3xx\": 60,\"ApplicationRequests4xx\": null,\"InstanceHealth\": null,\"CPUSoftirq\": 60}},\"Version\": 1}"
   }
  ]
 };
 elasticbeanstalk.validateConfigurationSettings(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Messages: [
    ]
   }
   */
 });

Calling the validateConfigurationSettings operation

var params = {
  ApplicationName: 'STRING_VALUE', /* required */
  OptionSettings: [ /* required */
    {
      Namespace: 'STRING_VALUE',
      OptionName: 'STRING_VALUE',
      ResourceName: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  EnvironmentName: 'STRING_VALUE',
  TemplateName: 'STRING_VALUE'
};
elasticbeanstalk.validateConfigurationSettings(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationName — (String)

      The name of the application that the configuration template or environment belongs to.

    • TemplateName — (String)

      The name of the configuration template to validate the settings against.

      Condition: You cannot specify both this and an environment name.

    • EnvironmentName — (String)

      The name of the environment to validate the settings against.

      Condition: You cannot specify both this and a configuration template name.

    • OptionSettings — (Array<map>)

      A list of the options and desired values to evaluate.

      • ResourceName — (String)

        A unique resource name for the option setting. Use it for a time–based scaling configuration option.

      • Namespace — (String)

        A unique namespace that identifies the option's associated AWS resource.

      • OptionName — (String)

        The name of the configuration option.

      • Value — (String)

        The current value for the configuration option.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Messages — (Array<map>)

        A list of ValidationMessage.

        • Message — (String)

          A message describing the error or warning.

        • Severity — (String)

          An indication of the severity of this message:

          • error: This message indicates that this is not a valid setting for an option.

          • warning: This message is providing information you should take into account.

          Possible values include:
          • "error"
          • "warning"
        • Namespace — (String)

          The namespace to which the option belongs.

        • OptionName — (String)

          The name of the option.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

waitFor(state, params = {}, callback) ⇒ AWS.Request

Waits for a given ElasticBeanstalk resource. The final callback or 'complete' event will be fired only when the resource is either in its final state or the waiter has timed out and stopped polling for the final state.

Examples:

Waiting for the environmentExists state

var params = {
  // ... input parameters ...
};
elasticbeanstalk.waitFor('environmentExists', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • state (String) —

    the resource state to wait for. Available states for this service are listed in "Waiter Resource States" below.

  • params (map) (defaults to: {}) —

    a list of parameters for the given state. See each waiter resource state for required parameters.

Callback (callback):

  • function(err, data) { ... }

    Callback containing error and data information. See the respective resource state for the expected error or data information.

    If the waiter times out its requests, it will return a ResourceNotReady error.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

Waiter Resource States:

Waiter Resource Details

elasticbeanstalk.waitFor('environmentExists', params = {}, [callback]) ⇒ AWS.Request

Waits for the environmentExists state by periodically calling the underlying ElasticBeanstalk.describeEnvironments() operation every 20 seconds (at most 20 times).

Examples:

Waiting for the environmentExists state

var params = {
  // ... input parameters ...
};
elasticbeanstalk.waitFor('environmentExists', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) —
    • ApplicationName — (String)

      If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.

    • VersionLabel — (String)

      If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.

    • EnvironmentIds — (Array<String>)

      If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.

    • EnvironmentNames — (Array<String>)

      If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.

    • IncludeDeleted — (Boolean)

      Indicates whether to include deleted environments:

      true: Environments that have been deleted after IncludedDeletedBackTo are displayed.

      false: Do not include deleted environments.

    • IncludedDeletedBackTo — (Date)

      If specified when IncludeDeleted is set to true, then environments deleted after this date are displayed.

    • MaxRecords — (Integer)

      For a paginated request. Specify a maximum number of environments to include in each response.

      If no MaxRecords is specified, all available environments are retrieved in a single response.

    • NextToken — (String)

      For a paginated request. Specify a token from a previous response page to retrieve the next response page. All other parameter values must be identical to the ones specified in the initial request.

      If no NextToken is specified, the first page is retrieved.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Environments — (Array<map>)

        Returns an EnvironmentDescription list.

        • EnvironmentName — (String)

          The name of this environment.

        • EnvironmentId — (String)

          The ID of this environment.

        • ApplicationName — (String)

          The name of the application associated with this environment.

        • VersionLabel — (String)

          The application version deployed in this environment.

        • SolutionStackName — (String)

          The name of the SolutionStack deployed with this environment.

        • PlatformArn — (String)

          The ARN of the platform version.

        • TemplateName — (String)

          The name of the configuration template used to originally launch this environment.

        • Description — (String)

          Describes this environment.

        • EndpointURL — (String)

          For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.

        • CNAME — (String)

          The URL to the CNAME for this environment.

        • DateCreated — (Date)

          The creation date for this environment.

        • DateUpdated — (Date)

          The last modified date for this environment.

        • Status — (String)

          The current operational status of the environment:

          • Launching: Environment is in the process of initial deployment.

          • Updating: Environment is in the process of updating its configuration settings or application version.

          • Ready: Environment is available to have an action performed on it, such as update or terminate.

          • Terminating: Environment is in the shut-down process.

          • Terminated: Environment is not running.

          Possible values include:
          • "Aborting"
          • "Launching"
          • "Updating"
          • "LinkingFrom"
          • "LinkingTo"
          • "Ready"
          • "Terminating"
          • "Terminated"
        • AbortableOperationInProgress — (Boolean)

          Indicates if there is an in-progress environment configuration update or application version deployment that you can cancel.

          true: There is an update in progress.

          false: There are no updates currently in progress.

        • Health — (String)

          Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment:

          • Red: Indicates the environment is not responsive. Occurs when three or more consecutive failures occur for an environment.

          • Yellow: Indicates that something is wrong. Occurs when two consecutive failures occur for an environment.

          • Green: Indicates the environment is healthy and fully functional.

          • Grey: Default health for a new environment. The environment is not fully launched and health checks have not started or health checks are suspended during an UpdateEnvironment or RestartEnvironment request.

          Default: Grey

          Possible values include:
          • "Green"
          • "Yellow"
          • "Red"
          • "Grey"
        • HealthStatus — (String)

          Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses.

          Possible values include:
          • "NoData"
          • "Unknown"
          • "Pending"
          • "Ok"
          • "Info"
          • "Warning"
          • "Degraded"
          • "Severe"
          • "Suspended"
        • Resources — (map)

          The description of the AWS resources used by this environment.

          • LoadBalancer — (map)

            Describes the LoadBalancer.

            • LoadBalancerName — (String)

              The name of the LoadBalancer.

            • Domain — (String)

              The domain name of the LoadBalancer.

            • Listeners — (Array<map>)

              A list of Listeners used by the LoadBalancer.

              • Protocol — (String)

                The protocol that is used by the Listener.

              • Port — (Integer)

                The port that is used by the Listener.

        • Tier — (map)

          Describes the current tier of this environment.

          • Name — (String)

            The name of this environment tier.

            Valid values:

            • For Web server tier – WebServer

            • For Worker tier – Worker

          • Type — (String)

            The type of this environment tier.

            Valid values:

            • For Web server tier – Standard

            • For Worker tier – SQS/HTTP

          • Version — (String)

            The version of this environment tier. When you don't set a value to it, Elastic Beanstalk uses the latest compatible worker tier version.

            Note: This member is deprecated. Any specific version that you set may become out of date. We recommend leaving it unspecified.
        • EnvironmentLinks — (Array<map>)

          A list of links to other environments in the same group.

          • LinkName — (String)

            The name of the link.

          • EnvironmentName — (String)

            The name of the linked environment (the dependency).

        • EnvironmentArn — (String)

          The environment's Amazon Resource Name (ARN), which can be used in other API requests that require an ARN.

        • OperationsRole — (String)

          The Amazon Resource Name (ARN) of the environment's operations role. For more information, see Operations roles in the AWS Elastic Beanstalk Developer Guide.

      • NextToken — (String)

        In a paginated request, the token that you can pass in a subsequent request to get the next response page.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

See Also:

elasticbeanstalk.waitFor('environmentUpdated', params = {}, [callback]) ⇒ AWS.Request

Waits for the environmentUpdated state by periodically calling the underlying ElasticBeanstalk.describeEnvironments() operation every 20 seconds (at most 20 times).

Examples:

Waiting for the environmentUpdated state

var params = {
  // ... input parameters ...
};
elasticbeanstalk.waitFor('environmentUpdated', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) —
    • ApplicationName — (String)

      If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.

    • VersionLabel — (String)

      If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.

    • EnvironmentIds — (Array<String>)

      If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.

    • EnvironmentNames — (Array<String>)

      If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.

    • IncludeDeleted — (Boolean)

      Indicates whether to include deleted environments:

      true: Environments that have been deleted after IncludedDeletedBackTo are displayed.

      false: Do not include deleted environments.

    • IncludedDeletedBackTo — (Date)

      If specified when IncludeDeleted is set to true, then environments deleted after this date are displayed.

    • MaxRecords — (Integer)

      For a paginated request. Specify a maximum number of environments to include in each response.

      If no MaxRecords is specified, all available environments are retrieved in a single response.

    • NextToken — (String)

      For a paginated request. Specify a token from a previous response page to retrieve the next response page. All other parameter values must be identical to the ones specified in the initial request.

      If no NextToken is specified, the first page is retrieved.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Environments — (Array<map>)

        Returns an EnvironmentDescription list.

        • EnvironmentName — (String)

          The name of this environment.

        • EnvironmentId — (String)

          The ID of this environment.

        • ApplicationName — (String)

          The name of the application associated with this environment.

        • VersionLabel — (String)

          The application version deployed in this environment.

        • SolutionStackName — (String)

          The name of the SolutionStack deployed with this environment.

        • PlatformArn — (String)

          The ARN of the platform version.

        • TemplateName — (String)

          The name of the configuration template used to originally launch this environment.

        • Description — (String)

          Describes this environment.

        • EndpointURL — (String)

          For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.

        • CNAME — (String)

          The URL to the CNAME for this environment.

        • DateCreated — (Date)

          The creation date for this environment.

        • DateUpdated — (Date)

          The last modified date for this environment.

        • Status — (String)

          The current operational status of the environment:

          • Launching: Environment is in the process of initial deployment.

          • Updating: Environment is in the process of updating its configuration settings or application version.

          • Ready: Environment is available to have an action performed on it, such as update or terminate.

          • Terminating: Environment is in the shut-down process.

          • Terminated: Environment is not running.

          Possible values include:
          • "Aborting"
          • "Launching"
          • "Updating"
          • "LinkingFrom"
          • "LinkingTo"
          • "Ready"
          • "Terminating"
          • "Terminated"
        • AbortableOperationInProgress — (Boolean)

          Indicates if there is an in-progress environment configuration update or application version deployment that you can cancel.

          true: There is an update in progress.

          false: There are no updates currently in progress.

        • Health — (String)

          Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment:

          • Red: Indicates the environment is not responsive. Occurs when three or more consecutive failures occur for an environment.

          • Yellow: Indicates that something is wrong. Occurs when two consecutive failures occur for an environment.

          • Green: Indicates the environment is healthy and fully functional.

          • Grey: Default health for a new environment. The environment is not fully launched and health checks have not started or health checks are suspended during an UpdateEnvironment or RestartEnvironment request.

          Default: Grey

          Possible values include:
          • "Green"
          • "Yellow"
          • "Red"
          • "Grey"
        • HealthStatus — (String)

          Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses.

          Possible values include:
          • "NoData"
          • "Unknown"
          • "Pending"
          • "Ok"
          • "Info"
          • "Warning"
          • "Degraded"
          • "Severe"
          • "Suspended"
        • Resources — (map)

          The description of the AWS resources used by this environment.

          • LoadBalancer — (map)

            Describes the LoadBalancer.

            • LoadBalancerName — (String)

              The name of the LoadBalancer.

            • Domain — (String)

              The domain name of the LoadBalancer.

            • Listeners — (Array<map>)

              A list of Listeners used by the LoadBalancer.

              • Protocol — (String)

                The protocol that is used by the Listener.

              • Port — (Integer)

                The port that is used by the Listener.

        • Tier — (map)

          Describes the current tier of this environment.

          • Name — (String)

            The name of this environment tier.

            Valid values:

            • For Web server tier – WebServer

            • For Worker tier – Worker

          • Type — (String)

            The type of this environment tier.

            Valid values:

            • For Web server tier – Standard

            • For Worker tier – SQS/HTTP

          • Version — (String)

            The version of this environment tier. When you don't set a value to it, Elastic Beanstalk uses the latest compatible worker tier version.

            Note: This member is deprecated. Any specific version that you set may become out of date. We recommend leaving it unspecified.
        • EnvironmentLinks — (Array<map>)

          A list of links to other environments in the same group.

          • LinkName — (String)

            The name of the link.

          • EnvironmentName — (String)

            The name of the linked environment (the dependency).

        • EnvironmentArn — (String)

          The environment's Amazon Resource Name (ARN), which can be used in other API requests that require an ARN.

        • OperationsRole — (String)

          The Amazon Resource Name (ARN) of the environment's operations role. For more information, see Operations roles in the AWS Elastic Beanstalk Developer Guide.

      • NextToken — (String)

        In a paginated request, the token that you can pass in a subsequent request to get the next response page.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

See Also:

elasticbeanstalk.waitFor('environmentTerminated', params = {}, [callback]) ⇒ AWS.Request

Waits for the environmentTerminated state by periodically calling the underlying ElasticBeanstalk.describeEnvironments() operation every 20 seconds (at most 20 times).

Examples:

Waiting for the environmentTerminated state

var params = {
  // ... input parameters ...
};
elasticbeanstalk.waitFor('environmentTerminated', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) —
    • ApplicationName — (String)

      If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.

    • VersionLabel — (String)

      If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.

    • EnvironmentIds — (Array<String>)

      If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.

    • EnvironmentNames — (Array<String>)

      If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.

    • IncludeDeleted — (Boolean)

      Indicates whether to include deleted environments:

      true: Environments that have been deleted after IncludedDeletedBackTo are displayed.

      false: Do not include deleted environments.

    • IncludedDeletedBackTo — (Date)

      If specified when IncludeDeleted is set to true, then environments deleted after this date are displayed.

    • MaxRecords — (Integer)

      For a paginated request. Specify a maximum number of environments to include in each response.

      If no MaxRecords is specified, all available environments are retrieved in a single response.

    • NextToken — (String)

      For a paginated request. Specify a token from a previous response page to retrieve the next response page. All other parameter values must be identical to the ones specified in the initial request.

      If no NextToken is specified, the first page is retrieved.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Environments — (Array<map>)

        Returns an EnvironmentDescription list.

        • EnvironmentName — (String)

          The name of this environment.

        • EnvironmentId — (String)

          The ID of this environment.

        • ApplicationName — (String)

          The name of the application associated with this environment.

        • VersionLabel — (String)

          The application version deployed in this environment.

        • SolutionStackName — (String)

          The name of the SolutionStack deployed with this environment.

        • PlatformArn — (String)

          The ARN of the platform version.

        • TemplateName — (String)

          The name of the configuration template used to originally launch this environment.

        • Description — (String)

          Describes this environment.

        • EndpointURL — (String)

          For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.

        • CNAME — (String)

          The URL to the CNAME for this environment.

        • DateCreated — (Date)

          The creation date for this environment.

        • DateUpdated — (Date)

          The last modified date for this environment.

        • Status — (String)

          The current operational status of the environment:

          • Launching: Environment is in the process of initial deployment.

          • Updating: Environment is in the process of updating its configuration settings or application version.

          • Ready: Environment is available to have an action performed on it, such as update or terminate.

          • Terminating: Environment is in the shut-down process.

          • Terminated: Environment is not running.

          Possible values include:
          • "Aborting"
          • "Launching"
          • "Updating"
          • "LinkingFrom"
          • "LinkingTo"
          • "Ready"
          • "Terminating"
          • "Terminated"
        • AbortableOperationInProgress — (Boolean)

          Indicates if there is an in-progress environment configuration update or application version deployment that you can cancel.

          true: There is an update in progress.

          false: There are no updates currently in progress.

        • Health — (String)

          Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment:

          • Red: Indicates the environment is not responsive. Occurs when three or more consecutive failures occur for an environment.

          • Yellow: Indicates that something is wrong. Occurs when two consecutive failures occur for an environment.

          • Green: Indicates the environment is healthy and fully functional.

          • Grey: Default health for a new environment. The environment is not fully launched and health checks have not started or health checks are suspended during an UpdateEnvironment or RestartEnvironment request.

          Default: Grey

          Possible values include:
          • "Green"
          • "Yellow"
          • "Red"
          • "Grey"
        • HealthStatus — (String)

          Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses.

          Possible values include:
          • "NoData"
          • "Unknown"
          • "Pending"
          • "Ok"
          • "Info"
          • "Warning"
          • "Degraded"
          • "Severe"
          • "Suspended"
        • Resources — (map)

          The description of the AWS resources used by this environment.

          • LoadBalancer — (map)

            Describes the LoadBalancer.

            • LoadBalancerName — (String)

              The name of the LoadBalancer.

            • Domain — (String)

              The domain name of the LoadBalancer.

            • Listeners — (Array<map>)

              A list of Listeners used by the LoadBalancer.

              • Protocol — (String)

                The protocol that is used by the Listener.

              • Port — (Integer)

                The port that is used by the Listener.

        • Tier — (map)

          Describes the current tier of this environment.

          • Name — (String)

            The name of this environment tier.

            Valid values:

            • For Web server tier – WebServer

            • For Worker tier – Worker

          • Type — (String)

            The type of this environment tier.

            Valid values:

            • For Web server tier – Standard

            • For Worker tier – SQS/HTTP

          • Version — (String)

            The version of this environment tier. When you don't set a value to it, Elastic Beanstalk uses the latest compatible worker tier version.

            Note: This member is deprecated. Any specific version that you set may become out of date. We recommend leaving it unspecified.
        • EnvironmentLinks — (Array<map>)

          A list of links to other environments in the same group.

          • LinkName — (String)

            The name of the link.

          • EnvironmentName — (String)

            The name of the linked environment (the dependency).

        • EnvironmentArn — (String)

          The environment's Amazon Resource Name (ARN), which can be used in other API requests that require an ARN.

        • OperationsRole — (String)

          The Amazon Resource Name (ARN) of the environment's operations role. For more information, see Operations roles in the AWS Elastic Beanstalk Developer Guide.

      • NextToken — (String)

        In a paginated request, the token that you can pass in a subsequent request to get the next response page.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

See Also: