elasticbeanstalk.d.ts (99742B)
1 import {Request} from '../lib/request'; 2 import {Response} from '../lib/response'; 3 import {AWSError} from '../lib/error'; 4 import {Service} from '../lib/service'; 5 import {ServiceConfigurationOptions} from '../lib/service'; 6 import {ConfigBase as Config} from '../lib/config'; 7 interface Blob {} 8 declare class ElasticBeanstalk extends Service { 9 /** 10 * Constructs a service object. This object has one method for each API operation. 11 */ 12 constructor(options?: ElasticBeanstalk.Types.ClientConfiguration) 13 config: Config & ElasticBeanstalk.Types.ClientConfiguration; 14 /** 15 * Cancels in-progress environment configuration update or application version deployment. 16 */ 17 abortEnvironmentUpdate(params: ElasticBeanstalk.Types.AbortEnvironmentUpdateMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 18 /** 19 * Cancels in-progress environment configuration update or application version deployment. 20 */ 21 abortEnvironmentUpdate(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 22 /** 23 * 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. 24 */ 25 applyEnvironmentManagedAction(params: ElasticBeanstalk.Types.ApplyEnvironmentManagedActionRequest, callback?: (err: AWSError, data: ElasticBeanstalk.Types.ApplyEnvironmentManagedActionResult) => void): Request<ElasticBeanstalk.Types.ApplyEnvironmentManagedActionResult, AWSError>; 26 /** 27 * 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. 28 */ 29 applyEnvironmentManagedAction(callback?: (err: AWSError, data: ElasticBeanstalk.Types.ApplyEnvironmentManagedActionResult) => void): Request<ElasticBeanstalk.Types.ApplyEnvironmentManagedActionResult, AWSError>; 30 /** 31 * Checks if the specified CNAME is available. 32 */ 33 checkDNSAvailability(params: ElasticBeanstalk.Types.CheckDNSAvailabilityMessage, callback?: (err: AWSError, data: ElasticBeanstalk.Types.CheckDNSAvailabilityResultMessage) => void): Request<ElasticBeanstalk.Types.CheckDNSAvailabilityResultMessage, AWSError>; 34 /** 35 * Checks if the specified CNAME is available. 36 */ 37 checkDNSAvailability(callback?: (err: AWSError, data: ElasticBeanstalk.Types.CheckDNSAvailabilityResultMessage) => void): Request<ElasticBeanstalk.Types.CheckDNSAvailabilityResultMessage, AWSError>; 38 /** 39 * 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. 40 */ 41 composeEnvironments(params: ElasticBeanstalk.Types.ComposeEnvironmentsMessage, callback?: (err: AWSError, data: ElasticBeanstalk.Types.EnvironmentDescriptionsMessage) => void): Request<ElasticBeanstalk.Types.EnvironmentDescriptionsMessage, AWSError>; 42 /** 43 * 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. 44 */ 45 composeEnvironments(callback?: (err: AWSError, data: ElasticBeanstalk.Types.EnvironmentDescriptionsMessage) => void): Request<ElasticBeanstalk.Types.EnvironmentDescriptionsMessage, AWSError>; 46 /** 47 * Creates an application that has one configuration template named default and no application versions. 48 */ 49 createApplication(params: ElasticBeanstalk.Types.CreateApplicationMessage, callback?: (err: AWSError, data: ElasticBeanstalk.Types.ApplicationDescriptionMessage) => void): Request<ElasticBeanstalk.Types.ApplicationDescriptionMessage, AWSError>; 50 /** 51 * Creates an application that has one configuration template named default and no application versions. 52 */ 53 createApplication(callback?: (err: AWSError, data: ElasticBeanstalk.Types.ApplicationDescriptionMessage) => void): Request<ElasticBeanstalk.Types.ApplicationDescriptionMessage, AWSError>; 54 /** 55 * Creates an application version for the specified application. Once you create an application version with a specified Amazon S3 bucket and key location, you cannot 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. 56 */ 57 createApplicationVersion(params: ElasticBeanstalk.Types.CreateApplicationVersionMessage, callback?: (err: AWSError, data: ElasticBeanstalk.Types.ApplicationVersionDescriptionMessage) => void): Request<ElasticBeanstalk.Types.ApplicationVersionDescriptionMessage, AWSError>; 58 /** 59 * Creates an application version for the specified application. Once you create an application version with a specified Amazon S3 bucket and key location, you cannot 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. 60 */ 61 createApplicationVersion(callback?: (err: AWSError, data: ElasticBeanstalk.Types.ApplicationVersionDescriptionMessage) => void): Request<ElasticBeanstalk.Types.ApplicationVersionDescriptionMessage, AWSError>; 62 /** 63 * Creates a configuration template. Templates are associated with a specific application and are used to deploy different versions of the application with the same configuration settings. Related Topics DescribeConfigurationOptions DescribeConfigurationSettings ListAvailableSolutionStacks 64 */ 65 createConfigurationTemplate(params: ElasticBeanstalk.Types.CreateConfigurationTemplateMessage, callback?: (err: AWSError, data: ElasticBeanstalk.Types.ConfigurationSettingsDescription) => void): Request<ElasticBeanstalk.Types.ConfigurationSettingsDescription, AWSError>; 66 /** 67 * Creates a configuration template. Templates are associated with a specific application and are used to deploy different versions of the application with the same configuration settings. Related Topics DescribeConfigurationOptions DescribeConfigurationSettings ListAvailableSolutionStacks 68 */ 69 createConfigurationTemplate(callback?: (err: AWSError, data: ElasticBeanstalk.Types.ConfigurationSettingsDescription) => void): Request<ElasticBeanstalk.Types.ConfigurationSettingsDescription, AWSError>; 70 /** 71 * Launches an environment for the specified application using the specified configuration. 72 */ 73 createEnvironment(params: ElasticBeanstalk.Types.CreateEnvironmentMessage, callback?: (err: AWSError, data: ElasticBeanstalk.Types.EnvironmentDescription) => void): Request<ElasticBeanstalk.Types.EnvironmentDescription, AWSError>; 74 /** 75 * Launches an environment for the specified application using the specified configuration. 76 */ 77 createEnvironment(callback?: (err: AWSError, data: ElasticBeanstalk.Types.EnvironmentDescription) => void): Request<ElasticBeanstalk.Types.EnvironmentDescription, AWSError>; 78 /** 79 * Creates the Amazon S3 storage location for the account. This location is used to store user log files. 80 */ 81 createStorageLocation(callback?: (err: AWSError, data: ElasticBeanstalk.Types.CreateStorageLocationResultMessage) => void): Request<ElasticBeanstalk.Types.CreateStorageLocationResultMessage, AWSError>; 82 /** 83 * Deletes the specified application along with all associated versions and configurations. The application versions will not be deleted from your Amazon S3 bucket. You cannot delete an application that has a running environment. 84 */ 85 deleteApplication(params: ElasticBeanstalk.Types.DeleteApplicationMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 86 /** 87 * Deletes the specified application along with all associated versions and configurations. The application versions will not be deleted from your Amazon S3 bucket. You cannot delete an application that has a running environment. 88 */ 89 deleteApplication(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 90 /** 91 * Deletes the specified version from the specified application. You cannot delete an application version that is associated with a running environment. 92 */ 93 deleteApplicationVersion(params: ElasticBeanstalk.Types.DeleteApplicationVersionMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 94 /** 95 * Deletes the specified version from the specified application. You cannot delete an application version that is associated with a running environment. 96 */ 97 deleteApplicationVersion(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 98 /** 99 * Deletes the specified configuration template. 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. 100 */ 101 deleteConfigurationTemplate(params: ElasticBeanstalk.Types.DeleteConfigurationTemplateMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 102 /** 103 * Deletes the specified configuration template. 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. 104 */ 105 deleteConfigurationTemplate(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 106 /** 107 * 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. 108 */ 109 deleteEnvironmentConfiguration(params: ElasticBeanstalk.Types.DeleteEnvironmentConfigurationMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 110 /** 111 * 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. 112 */ 113 deleteEnvironmentConfiguration(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 114 /** 115 * Retrieve a list of application versions stored in your AWS Elastic Beanstalk storage bucket. 116 */ 117 describeApplicationVersions(params: ElasticBeanstalk.Types.DescribeApplicationVersionsMessage, callback?: (err: AWSError, data: ElasticBeanstalk.Types.ApplicationVersionDescriptionsMessage) => void): Request<ElasticBeanstalk.Types.ApplicationVersionDescriptionsMessage, AWSError>; 118 /** 119 * Retrieve a list of application versions stored in your AWS Elastic Beanstalk storage bucket. 120 */ 121 describeApplicationVersions(callback?: (err: AWSError, data: ElasticBeanstalk.Types.ApplicationVersionDescriptionsMessage) => void): Request<ElasticBeanstalk.Types.ApplicationVersionDescriptionsMessage, AWSError>; 122 /** 123 * Returns the descriptions of existing applications. 124 */ 125 describeApplications(params: ElasticBeanstalk.Types.DescribeApplicationsMessage, callback?: (err: AWSError, data: ElasticBeanstalk.Types.ApplicationDescriptionsMessage) => void): Request<ElasticBeanstalk.Types.ApplicationDescriptionsMessage, AWSError>; 126 /** 127 * Returns the descriptions of existing applications. 128 */ 129 describeApplications(callback?: (err: AWSError, data: ElasticBeanstalk.Types.ApplicationDescriptionsMessage) => void): Request<ElasticBeanstalk.Types.ApplicationDescriptionsMessage, AWSError>; 130 /** 131 * 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. 132 */ 133 describeConfigurationOptions(params: ElasticBeanstalk.Types.DescribeConfigurationOptionsMessage, callback?: (err: AWSError, data: ElasticBeanstalk.Types.ConfigurationOptionsDescription) => void): Request<ElasticBeanstalk.Types.ConfigurationOptionsDescription, AWSError>; 134 /** 135 * 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. 136 */ 137 describeConfigurationOptions(callback?: (err: AWSError, data: ElasticBeanstalk.Types.ConfigurationOptionsDescription) => void): Request<ElasticBeanstalk.Types.ConfigurationOptionsDescription, AWSError>; 138 /** 139 * 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 DeleteEnvironmentConfiguration 140 */ 141 describeConfigurationSettings(params: ElasticBeanstalk.Types.DescribeConfigurationSettingsMessage, callback?: (err: AWSError, data: ElasticBeanstalk.Types.ConfigurationSettingsDescriptions) => void): Request<ElasticBeanstalk.Types.ConfigurationSettingsDescriptions, AWSError>; 142 /** 143 * 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 DeleteEnvironmentConfiguration 144 */ 145 describeConfigurationSettings(callback?: (err: AWSError, data: ElasticBeanstalk.Types.ConfigurationSettingsDescriptions) => void): Request<ElasticBeanstalk.Types.ConfigurationSettingsDescriptions, AWSError>; 146 /** 147 * Returns information about the overall health of the specified environment. The DescribeEnvironmentHealth operation is only available with AWS Elastic Beanstalk Enhanced Health. 148 */ 149 describeEnvironmentHealth(params: ElasticBeanstalk.Types.DescribeEnvironmentHealthRequest, callback?: (err: AWSError, data: ElasticBeanstalk.Types.DescribeEnvironmentHealthResult) => void): Request<ElasticBeanstalk.Types.DescribeEnvironmentHealthResult, AWSError>; 150 /** 151 * Returns information about the overall health of the specified environment. The DescribeEnvironmentHealth operation is only available with AWS Elastic Beanstalk Enhanced Health. 152 */ 153 describeEnvironmentHealth(callback?: (err: AWSError, data: ElasticBeanstalk.Types.DescribeEnvironmentHealthResult) => void): Request<ElasticBeanstalk.Types.DescribeEnvironmentHealthResult, AWSError>; 154 /** 155 * Lists an environment's completed and failed managed actions. 156 */ 157 describeEnvironmentManagedActionHistory(params: ElasticBeanstalk.Types.DescribeEnvironmentManagedActionHistoryRequest, callback?: (err: AWSError, data: ElasticBeanstalk.Types.DescribeEnvironmentManagedActionHistoryResult) => void): Request<ElasticBeanstalk.Types.DescribeEnvironmentManagedActionHistoryResult, AWSError>; 158 /** 159 * Lists an environment's completed and failed managed actions. 160 */ 161 describeEnvironmentManagedActionHistory(callback?: (err: AWSError, data: ElasticBeanstalk.Types.DescribeEnvironmentManagedActionHistoryResult) => void): Request<ElasticBeanstalk.Types.DescribeEnvironmentManagedActionHistoryResult, AWSError>; 162 /** 163 * Lists an environment's upcoming and in-progress managed actions. 164 */ 165 describeEnvironmentManagedActions(params: ElasticBeanstalk.Types.DescribeEnvironmentManagedActionsRequest, callback?: (err: AWSError, data: ElasticBeanstalk.Types.DescribeEnvironmentManagedActionsResult) => void): Request<ElasticBeanstalk.Types.DescribeEnvironmentManagedActionsResult, AWSError>; 166 /** 167 * Lists an environment's upcoming and in-progress managed actions. 168 */ 169 describeEnvironmentManagedActions(callback?: (err: AWSError, data: ElasticBeanstalk.Types.DescribeEnvironmentManagedActionsResult) => void): Request<ElasticBeanstalk.Types.DescribeEnvironmentManagedActionsResult, AWSError>; 170 /** 171 * Returns AWS resources for this environment. 172 */ 173 describeEnvironmentResources(params: ElasticBeanstalk.Types.DescribeEnvironmentResourcesMessage, callback?: (err: AWSError, data: ElasticBeanstalk.Types.EnvironmentResourceDescriptionsMessage) => void): Request<ElasticBeanstalk.Types.EnvironmentResourceDescriptionsMessage, AWSError>; 174 /** 175 * Returns AWS resources for this environment. 176 */ 177 describeEnvironmentResources(callback?: (err: AWSError, data: ElasticBeanstalk.Types.EnvironmentResourceDescriptionsMessage) => void): Request<ElasticBeanstalk.Types.EnvironmentResourceDescriptionsMessage, AWSError>; 178 /** 179 * Returns descriptions for existing environments. 180 */ 181 describeEnvironments(params: ElasticBeanstalk.Types.DescribeEnvironmentsMessage, callback?: (err: AWSError, data: ElasticBeanstalk.Types.EnvironmentDescriptionsMessage) => void): Request<ElasticBeanstalk.Types.EnvironmentDescriptionsMessage, AWSError>; 182 /** 183 * Returns descriptions for existing environments. 184 */ 185 describeEnvironments(callback?: (err: AWSError, data: ElasticBeanstalk.Types.EnvironmentDescriptionsMessage) => void): Request<ElasticBeanstalk.Types.EnvironmentDescriptionsMessage, AWSError>; 186 /** 187 * Returns list of event descriptions matching criteria up to the last 6 weeks. This action returns the most recent 1,000 events from the specified NextToken. 188 */ 189 describeEvents(params: ElasticBeanstalk.Types.DescribeEventsMessage, callback?: (err: AWSError, data: ElasticBeanstalk.Types.EventDescriptionsMessage) => void): Request<ElasticBeanstalk.Types.EventDescriptionsMessage, AWSError>; 190 /** 191 * Returns list of event descriptions matching criteria up to the last 6 weeks. This action returns the most recent 1,000 events from the specified NextToken. 192 */ 193 describeEvents(callback?: (err: AWSError, data: ElasticBeanstalk.Types.EventDescriptionsMessage) => void): Request<ElasticBeanstalk.Types.EventDescriptionsMessage, AWSError>; 194 /** 195 * Returns more detailed information about the health of the specified instances (for example, CPU utilization, load average, and causes). The DescribeInstancesHealth operation is only available with AWS Elastic Beanstalk Enhanced Health. 196 */ 197 describeInstancesHealth(params: ElasticBeanstalk.Types.DescribeInstancesHealthRequest, callback?: (err: AWSError, data: ElasticBeanstalk.Types.DescribeInstancesHealthResult) => void): Request<ElasticBeanstalk.Types.DescribeInstancesHealthResult, AWSError>; 198 /** 199 * Returns more detailed information about the health of the specified instances (for example, CPU utilization, load average, and causes). The DescribeInstancesHealth operation is only available with AWS Elastic Beanstalk Enhanced Health. 200 */ 201 describeInstancesHealth(callback?: (err: AWSError, data: ElasticBeanstalk.Types.DescribeInstancesHealthResult) => void): Request<ElasticBeanstalk.Types.DescribeInstancesHealthResult, AWSError>; 202 /** 203 * Returns a list of the available solution stack names. 204 */ 205 listAvailableSolutionStacks(callback?: (err: AWSError, data: ElasticBeanstalk.Types.ListAvailableSolutionStacksResultMessage) => void): Request<ElasticBeanstalk.Types.ListAvailableSolutionStacksResultMessage, AWSError>; 206 /** 207 * 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. 208 */ 209 rebuildEnvironment(params: ElasticBeanstalk.Types.RebuildEnvironmentMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 210 /** 211 * 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. 212 */ 213 rebuildEnvironment(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 214 /** 215 * 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 RetrieveEnvironmentInfo 216 */ 217 requestEnvironmentInfo(params: ElasticBeanstalk.Types.RequestEnvironmentInfoMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 218 /** 219 * 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 RetrieveEnvironmentInfo 220 */ 221 requestEnvironmentInfo(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 222 /** 223 * Causes the environment to restart the application container server running on each Amazon EC2 instance. 224 */ 225 restartAppServer(params: ElasticBeanstalk.Types.RestartAppServerMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 226 /** 227 * Causes the environment to restart the application container server running on each Amazon EC2 instance. 228 */ 229 restartAppServer(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 230 /** 231 * Retrieves the compiled information from a RequestEnvironmentInfo request. Related Topics RequestEnvironmentInfo 232 */ 233 retrieveEnvironmentInfo(params: ElasticBeanstalk.Types.RetrieveEnvironmentInfoMessage, callback?: (err: AWSError, data: ElasticBeanstalk.Types.RetrieveEnvironmentInfoResultMessage) => void): Request<ElasticBeanstalk.Types.RetrieveEnvironmentInfoResultMessage, AWSError>; 234 /** 235 * Retrieves the compiled information from a RequestEnvironmentInfo request. Related Topics RequestEnvironmentInfo 236 */ 237 retrieveEnvironmentInfo(callback?: (err: AWSError, data: ElasticBeanstalk.Types.RetrieveEnvironmentInfoResultMessage) => void): Request<ElasticBeanstalk.Types.RetrieveEnvironmentInfoResultMessage, AWSError>; 238 /** 239 * Swaps the CNAMEs of two environments. 240 */ 241 swapEnvironmentCNAMEs(params: ElasticBeanstalk.Types.SwapEnvironmentCNAMEsMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 242 /** 243 * Swaps the CNAMEs of two environments. 244 */ 245 swapEnvironmentCNAMEs(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 246 /** 247 * Terminates the specified environment. 248 */ 249 terminateEnvironment(params: ElasticBeanstalk.Types.TerminateEnvironmentMessage, callback?: (err: AWSError, data: ElasticBeanstalk.Types.EnvironmentDescription) => void): Request<ElasticBeanstalk.Types.EnvironmentDescription, AWSError>; 250 /** 251 * Terminates the specified environment. 252 */ 253 terminateEnvironment(callback?: (err: AWSError, data: ElasticBeanstalk.Types.EnvironmentDescription) => void): Request<ElasticBeanstalk.Types.EnvironmentDescription, AWSError>; 254 /** 255 * Updates the specified application to have the specified properties. If a property (for example, description) is not provided, the value remains unchanged. To clear these properties, specify an empty string. 256 */ 257 updateApplication(params: ElasticBeanstalk.Types.UpdateApplicationMessage, callback?: (err: AWSError, data: ElasticBeanstalk.Types.ApplicationDescriptionMessage) => void): Request<ElasticBeanstalk.Types.ApplicationDescriptionMessage, AWSError>; 258 /** 259 * Updates the specified application to have the specified properties. If a property (for example, description) is not provided, the value remains unchanged. To clear these properties, specify an empty string. 260 */ 261 updateApplication(callback?: (err: AWSError, data: ElasticBeanstalk.Types.ApplicationDescriptionMessage) => void): Request<ElasticBeanstalk.Types.ApplicationDescriptionMessage, AWSError>; 262 /** 263 * Updates the specified application version to have the specified properties. If a property (for example, description) is not provided, the value remains unchanged. To clear properties, specify an empty string. 264 */ 265 updateApplicationVersion(params: ElasticBeanstalk.Types.UpdateApplicationVersionMessage, callback?: (err: AWSError, data: ElasticBeanstalk.Types.ApplicationVersionDescriptionMessage) => void): Request<ElasticBeanstalk.Types.ApplicationVersionDescriptionMessage, AWSError>; 266 /** 267 * Updates the specified application version to have the specified properties. If a property (for example, description) is not provided, the value remains unchanged. To clear properties, specify an empty string. 268 */ 269 updateApplicationVersion(callback?: (err: AWSError, data: ElasticBeanstalk.Types.ApplicationVersionDescriptionMessage) => void): Request<ElasticBeanstalk.Types.ApplicationVersionDescriptionMessage, AWSError>; 270 /** 271 * Updates the specified configuration template to have the specified properties or configuration option values. If a property (for example, ApplicationName) is not provided, its value remains unchanged. To clear such properties, specify an empty string. Related Topics DescribeConfigurationOptions 272 */ 273 updateConfigurationTemplate(params: ElasticBeanstalk.Types.UpdateConfigurationTemplateMessage, callback?: (err: AWSError, data: ElasticBeanstalk.Types.ConfigurationSettingsDescription) => void): Request<ElasticBeanstalk.Types.ConfigurationSettingsDescription, AWSError>; 274 /** 275 * Updates the specified configuration template to have the specified properties or configuration option values. If a property (for example, ApplicationName) is not provided, its value remains unchanged. To clear such properties, specify an empty string. Related Topics DescribeConfigurationOptions 276 */ 277 updateConfigurationTemplate(callback?: (err: AWSError, data: ElasticBeanstalk.Types.ConfigurationSettingsDescription) => void): Request<ElasticBeanstalk.Types.ConfigurationSettingsDescription, AWSError>; 278 /** 279 * 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. 280 */ 281 updateEnvironment(params: ElasticBeanstalk.Types.UpdateEnvironmentMessage, callback?: (err: AWSError, data: ElasticBeanstalk.Types.EnvironmentDescription) => void): Request<ElasticBeanstalk.Types.EnvironmentDescription, AWSError>; 282 /** 283 * 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. 284 */ 285 updateEnvironment(callback?: (err: AWSError, data: ElasticBeanstalk.Types.EnvironmentDescription) => void): Request<ElasticBeanstalk.Types.EnvironmentDescription, AWSError>; 286 /** 287 * 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. 288 */ 289 validateConfigurationSettings(params: ElasticBeanstalk.Types.ValidateConfigurationSettingsMessage, callback?: (err: AWSError, data: ElasticBeanstalk.Types.ConfigurationSettingsValidationMessages) => void): Request<ElasticBeanstalk.Types.ConfigurationSettingsValidationMessages, AWSError>; 290 /** 291 * 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. 292 */ 293 validateConfigurationSettings(callback?: (err: AWSError, data: ElasticBeanstalk.Types.ConfigurationSettingsValidationMessages) => void): Request<ElasticBeanstalk.Types.ConfigurationSettingsValidationMessages, AWSError>; 294 } 295 declare namespace ElasticBeanstalk.Types { 296 export interface AbortEnvironmentUpdateMessage { 297 /** 298 * This specifies the ID of the environment with the in-progress update that you want to cancel. 299 */ 300 EnvironmentId?: EnvironmentId; 301 /** 302 * This specifies the name of the environment with the in-progress update that you want to cancel. 303 */ 304 EnvironmentName?: EnvironmentName; 305 } 306 export type AbortableOperationInProgress = boolean; 307 export type ActionHistoryStatus = "Completed"|"Failed"|"Unknown"|string; 308 export type ActionStatus = "Scheduled"|"Pending"|"Running"|"Unknown"|string; 309 export type ActionType = "InstanceRefresh"|"PlatformUpdate"|"Unknown"|string; 310 export interface ApplicationDescription { 311 /** 312 * The name of the application. 313 */ 314 ApplicationName?: ApplicationName; 315 /** 316 * User-defined description of the application. 317 */ 318 Description?: Description; 319 /** 320 * The date when the application was created. 321 */ 322 DateCreated?: CreationDate; 323 /** 324 * The date when the application was last modified. 325 */ 326 DateUpdated?: UpdateDate; 327 /** 328 * The names of the versions for this application. 329 */ 330 Versions?: VersionLabelsList; 331 /** 332 * The names of the configuration templates associated with this application. 333 */ 334 ConfigurationTemplates?: ConfigurationTemplateNamesList; 335 } 336 export type ApplicationDescriptionList = ApplicationDescription[]; 337 export interface ApplicationDescriptionMessage { 338 /** 339 * The ApplicationDescription of the application. 340 */ 341 Application?: ApplicationDescription; 342 } 343 export interface ApplicationDescriptionsMessage { 344 /** 345 * This parameter contains a list of ApplicationDescription. 346 */ 347 Applications?: ApplicationDescriptionList; 348 } 349 export interface ApplicationMetrics { 350 /** 351 * 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). 352 */ 353 Duration?: NullableInteger; 354 /** 355 * Average number of requests handled by the web server per second over the last 10 seconds. 356 */ 357 RequestCount?: RequestCount; 358 /** 359 * Represents the percentage of requests over the last 10 seconds that resulted in each type of status code response. 360 */ 361 StatusCodes?: StatusCodes; 362 /** 363 * Represents the average latency for the slowest X percent of requests over the last 10 seconds. Latencies are in seconds with one milisecond resolution. 364 */ 365 Latency?: Latency; 366 } 367 export type ApplicationName = string; 368 export type ApplicationNamesList = ApplicationName[]; 369 export interface ApplicationVersionDescription { 370 /** 371 * The name of the application associated with this release. 372 */ 373 ApplicationName?: ApplicationName; 374 /** 375 * The description of this application version. 376 */ 377 Description?: Description; 378 /** 379 * A label uniquely identifying the version for the associated application. 380 */ 381 VersionLabel?: VersionLabel; 382 SourceBuildInformation?: SourceBuildInformation; 383 /** 384 * The location where the source bundle is located for this version. 385 */ 386 SourceBundle?: S3Location; 387 /** 388 * The creation date of the application version. 389 */ 390 DateCreated?: CreationDate; 391 /** 392 * The last modified date of the application version. 393 */ 394 DateUpdated?: UpdateDate; 395 /** 396 * The processing status of the application version. 397 */ 398 Status?: ApplicationVersionStatus; 399 } 400 export type ApplicationVersionDescriptionList = ApplicationVersionDescription[]; 401 export interface ApplicationVersionDescriptionMessage { 402 /** 403 * The ApplicationVersionDescription of the application version. 404 */ 405 ApplicationVersion?: ApplicationVersionDescription; 406 } 407 export interface ApplicationVersionDescriptionsMessage { 408 /** 409 * List of ApplicationVersionDescription objects sorted by order of creation. 410 */ 411 ApplicationVersions?: ApplicationVersionDescriptionList; 412 /** 413 * For a paginated request, the token that you can pass in a subsequent request to get the next page. 414 */ 415 NextToken?: Token; 416 } 417 export type ApplicationVersionProccess = boolean; 418 export type ApplicationVersionStatus = "Processed"|"Unprocessed"|"Failed"|"Processing"|string; 419 export interface ApplyEnvironmentManagedActionRequest { 420 /** 421 * The name of the target environment. 422 */ 423 EnvironmentName?: String; 424 /** 425 * The environment ID of the target environment. 426 */ 427 EnvironmentId?: String; 428 /** 429 * The action ID of the scheduled managed action to execute. 430 */ 431 ActionId: String; 432 } 433 export interface ApplyEnvironmentManagedActionResult { 434 /** 435 * The action ID of the managed action. 436 */ 437 ActionId?: String; 438 /** 439 * A description of the managed action. 440 */ 441 ActionDescription?: String; 442 /** 443 * The type of managed action. 444 */ 445 ActionType?: ActionType; 446 /** 447 * The status of the managed action. 448 */ 449 Status?: String; 450 } 451 export type AutoCreateApplication = boolean; 452 export interface AutoScalingGroup { 453 /** 454 * The name of the AutoScalingGroup . 455 */ 456 Name?: ResourceId; 457 } 458 export type AutoScalingGroupList = AutoScalingGroup[]; 459 export type AvailableSolutionStackDetailsList = SolutionStackDescription[]; 460 export type AvailableSolutionStackNamesList = SolutionStackName[]; 461 export interface CPUUtilization { 462 /** 463 * Percentage of time that the CPU has spent in the User state over the last 10 seconds. 464 */ 465 User?: NullableDouble; 466 /** 467 * Percentage of time that the CPU has spent in the Nice state over the last 10 seconds. 468 */ 469 Nice?: NullableDouble; 470 /** 471 * Percentage of time that the CPU has spent in the System state over the last 10 seconds. 472 */ 473 System?: NullableDouble; 474 /** 475 * Percentage of time that the CPU has spent in the Idle state over the last 10 seconds. 476 */ 477 Idle?: NullableDouble; 478 /** 479 * Percentage of time that the CPU has spent in the I/O Wait state over the last 10 seconds. 480 */ 481 IOWait?: NullableDouble; 482 /** 483 * Percentage of time that the CPU has spent in the IRQ state over the last 10 seconds. 484 */ 485 IRQ?: NullableDouble; 486 /** 487 * Percentage of time that the CPU has spent in the SoftIRQ state over the last 10 seconds. 488 */ 489 SoftIRQ?: NullableDouble; 490 } 491 export type Cause = string; 492 export type Causes = Cause[]; 493 export interface CheckDNSAvailabilityMessage { 494 /** 495 * The prefix used when this CNAME is reserved. 496 */ 497 CNAMEPrefix: DNSCnamePrefix; 498 } 499 export interface CheckDNSAvailabilityResultMessage { 500 /** 501 * Indicates if the specified CNAME is available: true : The CNAME is available. false : The CNAME is not available. 502 */ 503 Available?: CnameAvailability; 504 /** 505 * The fully qualified CNAME to reserve when CreateEnvironment is called with the provided prefix. 506 */ 507 FullyQualifiedCNAME?: DNSCname; 508 } 509 export type CnameAvailability = boolean; 510 export interface ComposeEnvironmentsMessage { 511 /** 512 * The name of the application to which the specified source bundles belong. 513 */ 514 ApplicationName?: ApplicationName; 515 /** 516 * 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. 517 */ 518 GroupName?: GroupName; 519 /** 520 * 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. 521 */ 522 VersionLabels?: VersionLabels; 523 } 524 export type ConfigurationDeploymentStatus = "deployed"|"pending"|"failed"|string; 525 export type ConfigurationOptionDefaultValue = string; 526 export interface ConfigurationOptionDescription { 527 /** 528 * A unique namespace identifying the option's associated AWS resource. 529 */ 530 Namespace?: OptionNamespace; 531 /** 532 * The name of the configuration option. 533 */ 534 Name?: ConfigurationOptionName; 535 /** 536 * The default value for this configuration option. 537 */ 538 DefaultValue?: ConfigurationOptionDefaultValue; 539 /** 540 * 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. 541 */ 542 ChangeSeverity?: ConfigurationOptionSeverity; 543 /** 544 * 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 545 */ 546 UserDefined?: UserDefinedOption; 547 /** 548 * 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. 549 */ 550 ValueType?: ConfigurationOptionValueType; 551 /** 552 * If specified, values for the configuration option are selected from this list. 553 */ 554 ValueOptions?: ConfigurationOptionPossibleValues; 555 /** 556 * If specified, the configuration option must be a numeric value greater than this value. 557 */ 558 MinValue?: OptionRestrictionMinValue; 559 /** 560 * If specified, the configuration option must be a numeric value less than this value. 561 */ 562 MaxValue?: OptionRestrictionMaxValue; 563 /** 564 * If specified, the configuration option must be a string value no longer than this value. 565 */ 566 MaxLength?: OptionRestrictionMaxLength; 567 /** 568 * If specified, the configuration option must be a string value that satisfies this regular expression. 569 */ 570 Regex?: OptionRestrictionRegex; 571 } 572 export type ConfigurationOptionDescriptionsList = ConfigurationOptionDescription[]; 573 export type ConfigurationOptionName = string; 574 export type ConfigurationOptionPossibleValue = string; 575 export type ConfigurationOptionPossibleValues = ConfigurationOptionPossibleValue[]; 576 export interface ConfigurationOptionSetting { 577 /** 578 * A unique resource name for a time-based scaling configuration option. 579 */ 580 ResourceName?: ResourceName; 581 /** 582 * A unique namespace identifying the option's associated AWS resource. 583 */ 584 Namespace?: OptionNamespace; 585 /** 586 * The name of the configuration option. 587 */ 588 OptionName?: ConfigurationOptionName; 589 /** 590 * The current value for the configuration option. 591 */ 592 Value?: ConfigurationOptionValue; 593 } 594 export type ConfigurationOptionSettingsList = ConfigurationOptionSetting[]; 595 export type ConfigurationOptionSeverity = string; 596 export type ConfigurationOptionValue = string; 597 export type ConfigurationOptionValueType = "Scalar"|"List"|string; 598 export interface ConfigurationOptionsDescription { 599 /** 600 * The name of the solution stack these configuration options belong to. 601 */ 602 SolutionStackName?: SolutionStackName; 603 /** 604 * A list of ConfigurationOptionDescription. 605 */ 606 Options?: ConfigurationOptionDescriptionsList; 607 } 608 export interface ConfigurationSettingsDescription { 609 /** 610 * The name of the solution stack this configuration set uses. 611 */ 612 SolutionStackName?: SolutionStackName; 613 /** 614 * The name of the application associated with this configuration set. 615 */ 616 ApplicationName?: ApplicationName; 617 /** 618 * If not null, the name of the configuration template for this configuration set. 619 */ 620 TemplateName?: ConfigurationTemplateName; 621 /** 622 * Describes this configuration set. 623 */ 624 Description?: Description; 625 /** 626 * If not null, the name of the environment for this configuration set. 627 */ 628 EnvironmentName?: EnvironmentName; 629 /** 630 * 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. 631 */ 632 DeploymentStatus?: ConfigurationDeploymentStatus; 633 /** 634 * The date (in UTC time) when this configuration set was created. 635 */ 636 DateCreated?: CreationDate; 637 /** 638 * The date (in UTC time) when this configuration set was last modified. 639 */ 640 DateUpdated?: UpdateDate; 641 /** 642 * A list of the configuration options and their values in this configuration set. 643 */ 644 OptionSettings?: ConfigurationOptionSettingsList; 645 } 646 export type ConfigurationSettingsDescriptionList = ConfigurationSettingsDescription[]; 647 export interface ConfigurationSettingsDescriptions { 648 /** 649 * A list of ConfigurationSettingsDescription. 650 */ 651 ConfigurationSettings?: ConfigurationSettingsDescriptionList; 652 } 653 export interface ConfigurationSettingsValidationMessages { 654 /** 655 * A list of ValidationMessage. 656 */ 657 Messages?: ValidationMessagesList; 658 } 659 export type ConfigurationTemplateName = string; 660 export type ConfigurationTemplateNamesList = ConfigurationTemplateName[]; 661 export interface CreateApplicationMessage { 662 /** 663 * The name of the application. Constraint: This name must be unique within your account. If the specified name already exists, the action returns an InvalidParameterValue error. 664 */ 665 ApplicationName: ApplicationName; 666 /** 667 * Describes the application. 668 */ 669 Description?: Description; 670 } 671 export interface CreateApplicationVersionMessage { 672 /** 673 * The name of the application. If no application is found with this name, and AutoCreateApplication is false, returns an InvalidParameterValue error. 674 */ 675 ApplicationName: ApplicationName; 676 /** 677 * 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. 678 */ 679 VersionLabel: VersionLabel; 680 /** 681 * Describes this version. 682 */ 683 Description?: Description; 684 SourceBuildInformation?: SourceBuildInformation; 685 /** 686 * The Amazon S3 bucket and key that identify the location of the source bundle for this version. If data found at the Amazon S3 location exceeds the maximum allowed source bundle size, AWS Elastic Beanstalk returns an InvalidParameterValue error. The maximum size allowed is 512 MB. Default: If not specified, AWS Elastic Beanstalk uses a sample application. If only partially specified (for example, a bucket is provided but not the key) or if no data is found at the Amazon S3 location, AWS Elastic Beanstalk returns an InvalidParameterCombination error. 687 */ 688 SourceBundle?: S3Location; 689 /** 690 * Determines how the system behaves if the specified application for this version does not already exist: true : Automatically creates the specified application for this release if it does not already exist. false : Throws an InvalidParameterValue if the specified application for this release does not already exist. Default: false Valid Values: true | false 691 */ 692 AutoCreateApplication?: AutoCreateApplication; 693 /** 694 * Preprocesses and validates the environment manifest and configuration files in the source bundle. Validating configuration files can identify issues prior to deploying the application version to an environment. 695 */ 696 Process?: ApplicationVersionProccess; 697 } 698 export interface CreateConfigurationTemplateMessage { 699 /** 700 * The name of the application to associate with this configuration template. If no application is found with this name, AWS Elastic Beanstalk returns an InvalidParameterValue error. 701 */ 702 ApplicationName: ApplicationName; 703 /** 704 * The name of the configuration template. Constraint: This name must be unique per application. Default: If a configuration template already exists with this name, AWS Elastic Beanstalk returns an InvalidParameterValue error. 705 */ 706 TemplateName: ConfigurationTemplateName; 707 /** 708 * The name of the solution stack used by this configuration. The solution stack specifies the operating system, architecture, and application server for a configuration template. It determines the set of configuration options as well as the possible and default values. Use ListAvailableSolutionStacks to obtain a list of available solution stacks. A solution stack name or a source configuration parameter must be specified, otherwise AWS Elastic Beanstalk returns an InvalidParameterValue error. If a solution stack name is not specified and the source configuration parameter is specified, AWS Elastic Beanstalk uses the same solution stack as the source configuration template. 709 */ 710 SolutionStackName?: SolutionStackName; 711 /** 712 * If specified, AWS Elastic Beanstalk uses the configuration values from the specified configuration template to create a new configuration. Values specified in the OptionSettings parameter of this call overrides any values obtained from the SourceConfiguration. If no configuration template is found, returns an InvalidParameterValue error. Constraint: If both the solution stack name parameter and the source configuration parameters are specified, the solution stack of the source configuration template must match the specified solution stack name or else AWS Elastic Beanstalk returns an InvalidParameterCombination error. 713 */ 714 SourceConfiguration?: SourceConfiguration; 715 /** 716 * The ID of the environment used with this configuration template. 717 */ 718 EnvironmentId?: EnvironmentId; 719 /** 720 * Describes this configuration. 721 */ 722 Description?: Description; 723 /** 724 * If specified, AWS Elastic Beanstalk sets the specified configuration option to the requested value. The new value overrides the value obtained from the solution stack or the source configuration template. 725 */ 726 OptionSettings?: ConfigurationOptionSettingsList; 727 } 728 export interface CreateEnvironmentMessage { 729 /** 730 * The name of the application that contains the version to be deployed. If no application is found with this name, CreateEnvironment returns an InvalidParameterValue error. 731 */ 732 ApplicationName: ApplicationName; 733 /** 734 * A unique name for the deployment environment. Used in the application URL. Constraint: Must be from 4 to 40 characters in length. The name can contain only letters, numbers, and hyphens. It cannot start or end with a hyphen. This name must be unique in your account. If the specified name already exists, AWS Elastic Beanstalk returns an InvalidParameterValue error. Default: If the CNAME parameter is not specified, the environment name becomes part of the CNAME, and therefore part of the visible URL for your application. 735 */ 736 EnvironmentName?: EnvironmentName; 737 /** 738 * 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. 739 */ 740 GroupName?: GroupName; 741 /** 742 * Describes this environment. 743 */ 744 Description?: Description; 745 /** 746 * If specified, the environment attempts to use this value as the prefix for the CNAME. If not specified, the CNAME is generated automatically by appending a random alphanumeric string to the environment name. 747 */ 748 CNAMEPrefix?: DNSCnamePrefix; 749 /** 750 * This specifies the tier to use for creating this environment. 751 */ 752 Tier?: EnvironmentTier; 753 /** 754 * This specifies the tags applied to resources in the environment. 755 */ 756 Tags?: Tags; 757 /** 758 * The name of the application version to deploy. If the specified application has no associated application versions, AWS Elastic Beanstalk UpdateEnvironment returns an InvalidParameterValue error. Default: If not specified, AWS Elastic Beanstalk attempts to launch the sample application in the container. 759 */ 760 VersionLabel?: VersionLabel; 761 /** 762 * The name of the configuration template to use in deployment. If no configuration template is found with this name, AWS Elastic Beanstalk returns an InvalidParameterValue error. Condition: You must specify either this parameter or a SolutionStackName, 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. 763 */ 764 TemplateName?: ConfigurationTemplateName; 765 /** 766 * This is an alternative to specifying a template name. If specified, AWS Elastic Beanstalk sets the configuration values to the default values associated with the specified solution stack. 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 a MissingRequiredParameter error. 767 */ 768 SolutionStackName?: SolutionStackName; 769 /** 770 * 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. 771 */ 772 OptionSettings?: ConfigurationOptionSettingsList; 773 /** 774 * A list of custom user-defined configuration options to remove from the configuration set for this new environment. 775 */ 776 OptionsToRemove?: OptionsSpecifierList; 777 } 778 export interface CreateStorageLocationResultMessage { 779 /** 780 * The name of the Amazon S3 bucket created. 781 */ 782 S3Bucket?: S3Bucket; 783 } 784 export type CreationDate = Date; 785 export type DNSCname = string; 786 export type DNSCnamePrefix = string; 787 export interface DeleteApplicationMessage { 788 /** 789 * The name of the application to delete. 790 */ 791 ApplicationName: ApplicationName; 792 /** 793 * When set to true, running environments will be terminated before deleting the application. 794 */ 795 TerminateEnvByForce?: TerminateEnvForce; 796 } 797 export interface DeleteApplicationVersionMessage { 798 /** 799 * The name of the application to delete releases from. 800 */ 801 ApplicationName: ApplicationName; 802 /** 803 * The label of the version to delete. 804 */ 805 VersionLabel: VersionLabel; 806 /** 807 * Indicates whether to delete the associated source bundle from Amazon S3: true: An attempt is made to delete the associated Amazon S3 source bundle specified at time of creation. false: No action is taken on the Amazon S3 source bundle specified at time of creation. Valid Values: true | false 808 */ 809 DeleteSourceBundle?: DeleteSourceBundle; 810 } 811 export interface DeleteConfigurationTemplateMessage { 812 /** 813 * The name of the application to delete the configuration template from. 814 */ 815 ApplicationName: ApplicationName; 816 /** 817 * The name of the configuration template to delete. 818 */ 819 TemplateName: ConfigurationTemplateName; 820 } 821 export interface DeleteEnvironmentConfigurationMessage { 822 /** 823 * The name of the application the environment is associated with. 824 */ 825 ApplicationName: ApplicationName; 826 /** 827 * The name of the environment to delete the draft configuration from. 828 */ 829 EnvironmentName: EnvironmentName; 830 } 831 export type DeleteSourceBundle = boolean; 832 export interface Deployment { 833 /** 834 * The version label of the application version in the deployment. 835 */ 836 VersionLabel?: String; 837 /** 838 * The ID of the deployment. This number increases by one each time that you deploy source code or change instance configuration settings. 839 */ 840 DeploymentId?: NullableLong; 841 /** 842 * The status of the deployment: In Progress : The deployment is in progress. Deployed : The deployment succeeded. Failed : The deployment failed. 843 */ 844 Status?: String; 845 /** 846 * For in-progress deployments, the time that the deloyment started. For completed deployments, the time that the deployment ended. 847 */ 848 DeploymentTime?: DeploymentTimestamp; 849 } 850 export type DeploymentTimestamp = Date; 851 export interface DescribeApplicationVersionsMessage { 852 /** 853 * If specified, AWS Elastic Beanstalk restricts the returned descriptions to only include ones that are associated with the specified application. 854 */ 855 ApplicationName?: ApplicationName; 856 /** 857 * If specified, restricts the returned descriptions to only include ones that have the specified version labels. 858 */ 859 VersionLabels?: VersionLabelsList; 860 /** 861 * Specify a maximum number of application versions to paginate in the request. 862 */ 863 MaxRecords?: MaxRecords; 864 /** 865 * Specify a next token to retrieve the next page in a paginated request. 866 */ 867 NextToken?: Token; 868 } 869 export interface DescribeApplicationsMessage { 870 /** 871 * If specified, AWS Elastic Beanstalk restricts the returned descriptions to only include those with the specified names. 872 */ 873 ApplicationNames?: ApplicationNamesList; 874 } 875 export interface DescribeConfigurationOptionsMessage { 876 /** 877 * 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. 878 */ 879 ApplicationName?: ApplicationName; 880 /** 881 * The name of the configuration template whose configuration options you want to describe. 882 */ 883 TemplateName?: ConfigurationTemplateName; 884 /** 885 * The name of the environment whose configuration options you want to describe. 886 */ 887 EnvironmentName?: EnvironmentName; 888 /** 889 * The name of the solution stack whose configuration options you want to describe. 890 */ 891 SolutionStackName?: SolutionStackName; 892 /** 893 * If specified, restricts the descriptions to only the specified options. 894 */ 895 Options?: OptionsSpecifierList; 896 } 897 export interface DescribeConfigurationSettingsMessage { 898 /** 899 * The application for the environment or configuration template. 900 */ 901 ApplicationName: ApplicationName; 902 /** 903 * 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. 904 */ 905 TemplateName?: ConfigurationTemplateName; 906 /** 907 * 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. 908 */ 909 EnvironmentName?: EnvironmentName; 910 } 911 export interface DescribeEnvironmentHealthRequest { 912 /** 913 * Specifies the AWS Elastic Beanstalk environment name. Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error. 914 */ 915 EnvironmentName?: EnvironmentName; 916 /** 917 * Specifies the AWS Elastic Beanstalk environment ID. Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error. 918 */ 919 EnvironmentId?: EnvironmentId; 920 /** 921 * Specifies the response elements you wish to receive. If no attribute names are specified, AWS Elastic Beanstalk only returns the name of the environment. 922 */ 923 AttributeNames?: EnvironmentHealthAttributes; 924 } 925 export interface DescribeEnvironmentHealthResult { 926 /** 927 * The AWS Elastic Beanstalk environment name. 928 */ 929 EnvironmentName?: EnvironmentName; 930 /** 931 * Contains the response body with information about the health of the environment. 932 */ 933 HealthStatus?: String; 934 /** 935 * Returns the health status value of the environment. For more information, see Health Colors and Statuses. 936 */ 937 Status?: EnvironmentHealth; 938 /** 939 * Returns the color indicator that tells you information about the health of the environment. For more information, see Health Colors and Statuses. 940 */ 941 Color?: String; 942 /** 943 * Returns potential causes for the reported status. 944 */ 945 Causes?: Causes; 946 ApplicationMetrics?: ApplicationMetrics; 947 InstancesHealth?: InstanceHealthSummary; 948 /** 949 * The date and time the information was last refreshed. 950 */ 951 RefreshedAt?: RefreshedAt; 952 } 953 export interface DescribeEnvironmentManagedActionHistoryRequest { 954 /** 955 * The environment ID of the target environment. 956 */ 957 EnvironmentId?: EnvironmentId; 958 /** 959 * The name of the target environment. 960 */ 961 EnvironmentName?: EnvironmentName; 962 /** 963 * The pagination token returned by a previous request. 964 */ 965 NextToken?: String; 966 /** 967 * The maximum number of items to return for a single request. 968 */ 969 MaxItems?: Integer; 970 } 971 export interface DescribeEnvironmentManagedActionHistoryResult { 972 /** 973 * A list of completed and failed managed actions. 974 */ 975 ManagedActionHistoryItems?: ManagedActionHistoryItems; 976 /** 977 * A pagination token that you pass to DescribeEnvironmentManagedActionHistory to get the next page of results. 978 */ 979 NextToken?: String; 980 } 981 export interface DescribeEnvironmentManagedActionsRequest { 982 /** 983 * The name of the target environment. 984 */ 985 EnvironmentName?: String; 986 /** 987 * The environment ID of the target environment. 988 */ 989 EnvironmentId?: String; 990 /** 991 * To show only actions with a particular status, specify a status. 992 */ 993 Status?: ActionStatus; 994 } 995 export interface DescribeEnvironmentManagedActionsResult { 996 /** 997 * A list of upcoming and in-progress managed actions. 998 */ 999 ManagedActions?: ManagedActions; 1000 } 1001 export interface DescribeEnvironmentResourcesMessage { 1002 /** 1003 * 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. 1004 */ 1005 EnvironmentId?: EnvironmentId; 1006 /** 1007 * 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. 1008 */ 1009 EnvironmentName?: EnvironmentName; 1010 } 1011 export interface DescribeEnvironmentsMessage { 1012 /** 1013 * If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application. 1014 */ 1015 ApplicationName?: ApplicationName; 1016 /** 1017 * If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version. 1018 */ 1019 VersionLabel?: VersionLabel; 1020 /** 1021 * If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs. 1022 */ 1023 EnvironmentIds?: EnvironmentIdList; 1024 /** 1025 * If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names. 1026 */ 1027 EnvironmentNames?: EnvironmentNamesList; 1028 /** 1029 * Indicates whether to include deleted environments: true: Environments that have been deleted after IncludedDeletedBackTo are displayed. false: Do not include deleted environments. 1030 */ 1031 IncludeDeleted?: IncludeDeleted; 1032 /** 1033 * If specified when IncludeDeleted is set to true, then environments deleted after this date are displayed. 1034 */ 1035 IncludedDeletedBackTo?: IncludeDeletedBackTo; 1036 } 1037 export interface DescribeEventsMessage { 1038 /** 1039 * If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those associated with this application. 1040 */ 1041 ApplicationName?: ApplicationName; 1042 /** 1043 * If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this application version. 1044 */ 1045 VersionLabel?: VersionLabel; 1046 /** 1047 * If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that are associated with this environment configuration. 1048 */ 1049 TemplateName?: ConfigurationTemplateName; 1050 /** 1051 * If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment. 1052 */ 1053 EnvironmentId?: EnvironmentId; 1054 /** 1055 * If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment. 1056 */ 1057 EnvironmentName?: EnvironmentName; 1058 /** 1059 * If specified, AWS Elastic Beanstalk restricts the described events to include only those associated with this request ID. 1060 */ 1061 RequestId?: RequestId; 1062 /** 1063 * If specified, limits the events returned from this call to include only those with the specified severity or higher. 1064 */ 1065 Severity?: EventSeverity; 1066 /** 1067 * If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur on or after this time. 1068 */ 1069 StartTime?: TimeFilterStart; 1070 /** 1071 * If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur up to, but not including, the EndTime. 1072 */ 1073 EndTime?: TimeFilterEnd; 1074 /** 1075 * Specifies the maximum number of events that can be returned, beginning with the most recent event. 1076 */ 1077 MaxRecords?: MaxRecords; 1078 /** 1079 * Pagination token. If specified, the events return the next batch of results. 1080 */ 1081 NextToken?: Token; 1082 } 1083 export interface DescribeInstancesHealthRequest { 1084 /** 1085 * Specifies the AWS Elastic Beanstalk environment name. 1086 */ 1087 EnvironmentName?: EnvironmentName; 1088 /** 1089 * Specifies the AWS Elastic Beanstalk environment ID. 1090 */ 1091 EnvironmentId?: EnvironmentId; 1092 /** 1093 * Specifies the response elements you wish to receive. If no attribute names are specified, AWS Elastic Beanstalk only returns a list of instances. 1094 */ 1095 AttributeNames?: InstancesHealthAttributes; 1096 /** 1097 * Specifies the next token of the request. 1098 */ 1099 NextToken?: NextToken; 1100 } 1101 export interface DescribeInstancesHealthResult { 1102 /** 1103 * Contains the response body with information about the health of the instance. 1104 */ 1105 InstanceHealthList?: InstanceHealthList; 1106 /** 1107 * The date and time the information was last refreshed. 1108 */ 1109 RefreshedAt?: RefreshedAt; 1110 /** 1111 * The next token. 1112 */ 1113 NextToken?: NextToken; 1114 } 1115 export type Description = string; 1116 export type Ec2InstanceId = string; 1117 export type EndpointURL = string; 1118 export interface EnvironmentDescription { 1119 /** 1120 * The name of this environment. 1121 */ 1122 EnvironmentName?: EnvironmentName; 1123 /** 1124 * The ID of this environment. 1125 */ 1126 EnvironmentId?: EnvironmentId; 1127 /** 1128 * The name of the application associated with this environment. 1129 */ 1130 ApplicationName?: ApplicationName; 1131 /** 1132 * The application version deployed in this environment. 1133 */ 1134 VersionLabel?: VersionLabel; 1135 /** 1136 * The name of the SolutionStack deployed with this environment. 1137 */ 1138 SolutionStackName?: SolutionStackName; 1139 /** 1140 * The name of the configuration template used to originally launch this environment. 1141 */ 1142 TemplateName?: ConfigurationTemplateName; 1143 /** 1144 * Describes this environment. 1145 */ 1146 Description?: Description; 1147 /** 1148 * For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance. 1149 */ 1150 EndpointURL?: EndpointURL; 1151 /** 1152 * The URL to the CNAME for this environment. 1153 */ 1154 CNAME?: DNSCname; 1155 /** 1156 * The creation date for this environment. 1157 */ 1158 DateCreated?: CreationDate; 1159 /** 1160 * The last modified date for this environment. 1161 */ 1162 DateUpdated?: UpdateDate; 1163 /** 1164 * 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. 1165 */ 1166 Status?: EnvironmentStatus; 1167 /** 1168 * 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. 1169 */ 1170 AbortableOperationInProgress?: AbortableOperationInProgress; 1171 /** 1172 * 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 RestartEnvironement request. Default: Grey 1173 */ 1174 Health?: EnvironmentHealth; 1175 /** 1176 * Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses. 1177 */ 1178 HealthStatus?: EnvironmentHealthStatus; 1179 /** 1180 * The description of the AWS resources used by this environment. 1181 */ 1182 Resources?: EnvironmentResourcesDescription; 1183 /** 1184 * Describes the current tier of this environment. 1185 */ 1186 Tier?: EnvironmentTier; 1187 /** 1188 * A list of links to other environments in the same group. 1189 */ 1190 EnvironmentLinks?: EnvironmentLinks; 1191 } 1192 export type EnvironmentDescriptionsList = EnvironmentDescription[]; 1193 export interface EnvironmentDescriptionsMessage { 1194 /** 1195 * Returns an EnvironmentDescription list. 1196 */ 1197 Environments?: EnvironmentDescriptionsList; 1198 } 1199 export type EnvironmentHealth = "Green"|"Yellow"|"Red"|"Grey"|string; 1200 export type EnvironmentHealthAttribute = "Status"|"Color"|"Causes"|"ApplicationMetrics"|"InstancesHealth"|"All"|"HealthStatus"|"RefreshedAt"|string; 1201 export type EnvironmentHealthAttributes = EnvironmentHealthAttribute[]; 1202 export type EnvironmentHealthStatus = "NoData"|"Unknown"|"Pending"|"Ok"|"Info"|"Warning"|"Degraded"|"Severe"|string; 1203 export type EnvironmentId = string; 1204 export type EnvironmentIdList = EnvironmentId[]; 1205 export interface EnvironmentInfoDescription { 1206 /** 1207 * The type of information retrieved. 1208 */ 1209 InfoType?: EnvironmentInfoType; 1210 /** 1211 * The Amazon EC2 Instance ID for this information. 1212 */ 1213 Ec2InstanceId?: Ec2InstanceId; 1214 /** 1215 * The time stamp when this information was retrieved. 1216 */ 1217 SampleTimestamp?: SampleTimestamp; 1218 /** 1219 * The retrieved information. 1220 */ 1221 Message?: Message; 1222 } 1223 export type EnvironmentInfoDescriptionList = EnvironmentInfoDescription[]; 1224 export type EnvironmentInfoType = "tail"|"bundle"|string; 1225 export interface EnvironmentLink { 1226 /** 1227 * The name of the link. 1228 */ 1229 LinkName?: String; 1230 /** 1231 * The name of the linked environment (the dependency). 1232 */ 1233 EnvironmentName?: String; 1234 } 1235 export type EnvironmentLinks = EnvironmentLink[]; 1236 export type EnvironmentName = string; 1237 export type EnvironmentNamesList = EnvironmentName[]; 1238 export interface EnvironmentResourceDescription { 1239 /** 1240 * The name of the environment. 1241 */ 1242 EnvironmentName?: EnvironmentName; 1243 /** 1244 * The AutoScalingGroups used by this environment. 1245 */ 1246 AutoScalingGroups?: AutoScalingGroupList; 1247 /** 1248 * The Amazon EC2 instances used by this environment. 1249 */ 1250 Instances?: InstanceList; 1251 /** 1252 * The Auto Scaling launch configurations in use by this environment. 1253 */ 1254 LaunchConfigurations?: LaunchConfigurationList; 1255 /** 1256 * The LoadBalancers in use by this environment. 1257 */ 1258 LoadBalancers?: LoadBalancerList; 1259 /** 1260 * The AutoScaling triggers in use by this environment. 1261 */ 1262 Triggers?: TriggerList; 1263 /** 1264 * The queues used by this environment. 1265 */ 1266 Queues?: QueueList; 1267 } 1268 export interface EnvironmentResourceDescriptionsMessage { 1269 /** 1270 * A list of EnvironmentResourceDescription. 1271 */ 1272 EnvironmentResources?: EnvironmentResourceDescription; 1273 } 1274 export interface EnvironmentResourcesDescription { 1275 /** 1276 * Describes the LoadBalancer. 1277 */ 1278 LoadBalancer?: LoadBalancerDescription; 1279 } 1280 export type EnvironmentStatus = "Launching"|"Updating"|"Ready"|"Terminating"|"Terminated"|string; 1281 export interface EnvironmentTier { 1282 /** 1283 * The name of this environment tier. 1284 */ 1285 Name?: String; 1286 /** 1287 * The type of this environment tier. 1288 */ 1289 Type?: String; 1290 /** 1291 * The version of this environment tier. 1292 */ 1293 Version?: String; 1294 } 1295 export type EventDate = Date; 1296 export interface EventDescription { 1297 /** 1298 * The date when the event occurred. 1299 */ 1300 EventDate?: EventDate; 1301 /** 1302 * The event message. 1303 */ 1304 Message?: EventMessage; 1305 /** 1306 * The application associated with the event. 1307 */ 1308 ApplicationName?: ApplicationName; 1309 /** 1310 * The release label for the application version associated with this event. 1311 */ 1312 VersionLabel?: VersionLabel; 1313 /** 1314 * The name of the configuration associated with this event. 1315 */ 1316 TemplateName?: ConfigurationTemplateName; 1317 /** 1318 * The name of the environment associated with this event. 1319 */ 1320 EnvironmentName?: EnvironmentName; 1321 /** 1322 * The web service request ID for the activity of this event. 1323 */ 1324 RequestId?: RequestId; 1325 /** 1326 * The severity level of this event. 1327 */ 1328 Severity?: EventSeverity; 1329 } 1330 export type EventDescriptionList = EventDescription[]; 1331 export interface EventDescriptionsMessage { 1332 /** 1333 * A list of EventDescription. 1334 */ 1335 Events?: EventDescriptionList; 1336 /** 1337 * 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. 1338 */ 1339 NextToken?: Token; 1340 } 1341 export type EventMessage = string; 1342 export type EventSeverity = "TRACE"|"DEBUG"|"INFO"|"WARN"|"ERROR"|"FATAL"|string; 1343 export type ExceptionMessage = string; 1344 export type FailureType = "UpdateCancelled"|"CancellationFailed"|"RollbackFailed"|"RollbackSuccessful"|"InternalFailure"|"InvalidEnvironmentState"|"PermissionsError"|string; 1345 export type FileTypeExtension = string; 1346 export type ForceTerminate = boolean; 1347 export type GroupName = string; 1348 export type IncludeDeleted = boolean; 1349 export type IncludeDeletedBackTo = Date; 1350 export interface Instance { 1351 /** 1352 * The ID of the Amazon EC2 instance. 1353 */ 1354 Id?: ResourceId; 1355 } 1356 export type InstanceHealthList = SingleInstanceHealth[]; 1357 export interface InstanceHealthSummary { 1358 /** 1359 * Grey. AWS Elastic Beanstalk and the health agent are reporting no data on an instance. 1360 */ 1361 NoData?: NullableInteger; 1362 /** 1363 * Grey. AWS Elastic Beanstalk and the health agent are reporting an insufficient amount of data on an instance. 1364 */ 1365 Unknown?: NullableInteger; 1366 /** 1367 * Grey. An operation is in progress on an instance within the command timeout. 1368 */ 1369 Pending?: NullableInteger; 1370 /** 1371 * Green. An instance is passing health checks and the health agent is not reporting any problems. 1372 */ 1373 Ok?: NullableInteger; 1374 /** 1375 * Green. An operation is in progress on an instance. 1376 */ 1377 Info?: NullableInteger; 1378 /** 1379 * Yellow. The health agent is reporting a moderate number of request failures or other issues for an instance or environment. 1380 */ 1381 Warning?: NullableInteger; 1382 /** 1383 * Red. The health agent is reporting a high number of request failures or other issues for an instance or environment. 1384 */ 1385 Degraded?: NullableInteger; 1386 /** 1387 * Red. The health agent is reporting a very high number of request failures or other issues for an instance or environment. 1388 */ 1389 Severe?: NullableInteger; 1390 } 1391 export type InstanceId = string; 1392 export type InstanceList = Instance[]; 1393 export type InstancesHealthAttribute = "HealthStatus"|"Color"|"Causes"|"ApplicationMetrics"|"RefreshedAt"|"LaunchedAt"|"System"|"Deployment"|"AvailabilityZone"|"InstanceType"|"All"|string; 1394 export type InstancesHealthAttributes = InstancesHealthAttribute[]; 1395 export type Integer = number; 1396 export interface Latency { 1397 /** 1398 * The average latency for the slowest 0.1 percent of requests over the last 10 seconds. 1399 */ 1400 P999?: NullableDouble; 1401 /** 1402 * The average latency for the slowest 1 percent of requests over the last 10 seconds. 1403 */ 1404 P99?: NullableDouble; 1405 /** 1406 * The average latency for the slowest 5 percent of requests over the last 10 seconds. 1407 */ 1408 P95?: NullableDouble; 1409 /** 1410 * The average latency for the slowest 10 percent of requests over the last 10 seconds. 1411 */ 1412 P90?: NullableDouble; 1413 /** 1414 * The average latency for the slowest 15 percent of requests over the last 10 seconds. 1415 */ 1416 P85?: NullableDouble; 1417 /** 1418 * The average latency for the slowest 25 percent of requests over the last 10 seconds. 1419 */ 1420 P75?: NullableDouble; 1421 /** 1422 * The average latency for the slowest 50 percent of requests over the last 10 seconds. 1423 */ 1424 P50?: NullableDouble; 1425 /** 1426 * The average latency for the slowest 90 percent of requests over the last 10 seconds. 1427 */ 1428 P10?: NullableDouble; 1429 } 1430 export interface LaunchConfiguration { 1431 /** 1432 * The name of the launch configuration. 1433 */ 1434 Name?: ResourceId; 1435 } 1436 export type LaunchConfigurationList = LaunchConfiguration[]; 1437 export type LaunchedAt = Date; 1438 export interface ListAvailableSolutionStacksResultMessage { 1439 /** 1440 * A list of available solution stacks. 1441 */ 1442 SolutionStacks?: AvailableSolutionStackNamesList; 1443 /** 1444 * A list of available solution stacks and their SolutionStackDescription. 1445 */ 1446 SolutionStackDetails?: AvailableSolutionStackDetailsList; 1447 } 1448 export interface Listener { 1449 /** 1450 * The protocol that is used by the Listener. 1451 */ 1452 Protocol?: String; 1453 /** 1454 * The port that is used by the Listener. 1455 */ 1456 Port?: Integer; 1457 } 1458 export type LoadAverage = LoadAverageValue[]; 1459 export type LoadAverageValue = number; 1460 export interface LoadBalancer { 1461 /** 1462 * The name of the LoadBalancer. 1463 */ 1464 Name?: ResourceId; 1465 } 1466 export interface LoadBalancerDescription { 1467 /** 1468 * The name of the LoadBalancer. 1469 */ 1470 LoadBalancerName?: String; 1471 /** 1472 * The domain name of the LoadBalancer. 1473 */ 1474 Domain?: String; 1475 /** 1476 * A list of Listeners used by the LoadBalancer. 1477 */ 1478 Listeners?: LoadBalancerListenersDescription; 1479 } 1480 export type LoadBalancerList = LoadBalancer[]; 1481 export type LoadBalancerListenersDescription = Listener[]; 1482 export interface ManagedAction { 1483 /** 1484 * A unique identifier for the managed action. 1485 */ 1486 ActionId?: String; 1487 /** 1488 * A description of the managed action. 1489 */ 1490 ActionDescription?: String; 1491 /** 1492 * The type of managed action. 1493 */ 1494 ActionType?: ActionType; 1495 /** 1496 * The status of the managed action. If the action is Scheduled, you can apply it immediately with ApplyEnvironmentManagedAction. 1497 */ 1498 Status?: ActionStatus; 1499 /** 1500 * The start time of the maintenance window in which the managed action will execute. 1501 */ 1502 WindowStartTime?: Timestamp; 1503 } 1504 export interface ManagedActionHistoryItem { 1505 /** 1506 * A unique identifier for the managed action. 1507 */ 1508 ActionId?: String; 1509 /** 1510 * The type of the managed action. 1511 */ 1512 ActionType?: ActionType; 1513 /** 1514 * A description of the managed action. 1515 */ 1516 ActionDescription?: String; 1517 /** 1518 * If the action failed, the type of failure. 1519 */ 1520 FailureType?: FailureType; 1521 /** 1522 * The status of the action. 1523 */ 1524 Status?: ActionHistoryStatus; 1525 /** 1526 * If the action failed, a description of the failure. 1527 */ 1528 FailureDescription?: String; 1529 /** 1530 * The date and time that the action started executing. 1531 */ 1532 ExecutedTime?: Timestamp; 1533 /** 1534 * The date and time that the action finished executing. 1535 */ 1536 FinishedTime?: Timestamp; 1537 } 1538 export type ManagedActionHistoryItems = ManagedActionHistoryItem[]; 1539 export type ManagedActions = ManagedAction[]; 1540 export type MaxRecords = number; 1541 export type Message = string; 1542 export type NextToken = string; 1543 export type NullableDouble = number; 1544 export type NullableInteger = number; 1545 export type NullableLong = number; 1546 export type OptionNamespace = string; 1547 export type OptionRestrictionMaxLength = number; 1548 export type OptionRestrictionMaxValue = number; 1549 export type OptionRestrictionMinValue = number; 1550 export interface OptionRestrictionRegex { 1551 /** 1552 * The regular expression pattern that a string configuration option value with this restriction must match. 1553 */ 1554 Pattern?: RegexPattern; 1555 /** 1556 * A unique name representing this regular expression. 1557 */ 1558 Label?: RegexLabel; 1559 } 1560 export interface OptionSpecification { 1561 /** 1562 * A unique resource name for a time-based scaling configuration option. 1563 */ 1564 ResourceName?: ResourceName; 1565 /** 1566 * A unique namespace identifying the option's associated AWS resource. 1567 */ 1568 Namespace?: OptionNamespace; 1569 /** 1570 * The name of the configuration option. 1571 */ 1572 OptionName?: ConfigurationOptionName; 1573 } 1574 export type OptionsSpecifierList = OptionSpecification[]; 1575 export interface Queue { 1576 /** 1577 * The name of the queue. 1578 */ 1579 Name?: String; 1580 /** 1581 * The URL of the queue. 1582 */ 1583 URL?: String; 1584 } 1585 export type QueueList = Queue[]; 1586 export interface RebuildEnvironmentMessage { 1587 /** 1588 * 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. 1589 */ 1590 EnvironmentId?: EnvironmentId; 1591 /** 1592 * 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. 1593 */ 1594 EnvironmentName?: EnvironmentName; 1595 } 1596 export type RefreshedAt = Date; 1597 export type RegexLabel = string; 1598 export type RegexPattern = string; 1599 export type RequestCount = number; 1600 export interface RequestEnvironmentInfoMessage { 1601 /** 1602 * 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. 1603 */ 1604 EnvironmentId?: EnvironmentId; 1605 /** 1606 * 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. 1607 */ 1608 EnvironmentName?: EnvironmentName; 1609 /** 1610 * The type of information to request. 1611 */ 1612 InfoType: EnvironmentInfoType; 1613 } 1614 export type RequestId = string; 1615 export type ResourceId = string; 1616 export type ResourceName = string; 1617 export interface RestartAppServerMessage { 1618 /** 1619 * 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. 1620 */ 1621 EnvironmentId?: EnvironmentId; 1622 /** 1623 * 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. 1624 */ 1625 EnvironmentName?: EnvironmentName; 1626 } 1627 export interface RetrieveEnvironmentInfoMessage { 1628 /** 1629 * 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. 1630 */ 1631 EnvironmentId?: EnvironmentId; 1632 /** 1633 * 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. 1634 */ 1635 EnvironmentName?: EnvironmentName; 1636 /** 1637 * The type of information to retrieve. 1638 */ 1639 InfoType: EnvironmentInfoType; 1640 } 1641 export interface RetrieveEnvironmentInfoResultMessage { 1642 /** 1643 * The EnvironmentInfoDescription of the environment. 1644 */ 1645 EnvironmentInfo?: EnvironmentInfoDescriptionList; 1646 } 1647 export type S3Bucket = string; 1648 export type S3Key = string; 1649 export interface S3Location { 1650 /** 1651 * The Amazon S3 bucket where the data is located. 1652 */ 1653 S3Bucket?: S3Bucket; 1654 /** 1655 * The Amazon S3 key where the data is located. 1656 */ 1657 S3Key?: S3Key; 1658 } 1659 export type SampleTimestamp = Date; 1660 export interface SingleInstanceHealth { 1661 /** 1662 * The ID of the Amazon EC2 instance. 1663 */ 1664 InstanceId?: InstanceId; 1665 /** 1666 * Returns the health status of the specified instance. For more information, see Health Colors and Statuses. 1667 */ 1668 HealthStatus?: String; 1669 /** 1670 * Represents the color indicator that gives you information about the health of the EC2 instance. For more information, see Health Colors and Statuses. 1671 */ 1672 Color?: String; 1673 /** 1674 * Represents the causes, which provide more information about the current health status. 1675 */ 1676 Causes?: Causes; 1677 /** 1678 * The time at which the EC2 instance was launched. 1679 */ 1680 LaunchedAt?: LaunchedAt; 1681 ApplicationMetrics?: ApplicationMetrics; 1682 System?: SystemStatus; 1683 /** 1684 * Information about the most recent deployment to an instance. 1685 */ 1686 Deployment?: Deployment; 1687 /** 1688 * The availability zone in which the instance runs. 1689 */ 1690 AvailabilityZone?: String; 1691 /** 1692 * The instance's type. 1693 */ 1694 InstanceType?: String; 1695 } 1696 export interface SolutionStackDescription { 1697 /** 1698 * The name of the solution stack. 1699 */ 1700 SolutionStackName?: SolutionStackName; 1701 /** 1702 * The permitted file types allowed for a solution stack. 1703 */ 1704 PermittedFileTypes?: SolutionStackFileTypeList; 1705 } 1706 export type SolutionStackFileTypeList = FileTypeExtension[]; 1707 export type SolutionStackName = string; 1708 export interface SourceBuildInformation { 1709 SourceType: SourceType; 1710 SourceRepository: SourceRepository; 1711 SourceLocation: SourceLocation; 1712 } 1713 export interface SourceConfiguration { 1714 /** 1715 * The name of the application associated with the configuration. 1716 */ 1717 ApplicationName?: ApplicationName; 1718 /** 1719 * The name of the configuration template. 1720 */ 1721 TemplateName?: ConfigurationTemplateName; 1722 } 1723 export type SourceLocation = string; 1724 export type SourceRepository = "CodeCommit"|string; 1725 export type SourceType = "Git"|string; 1726 export interface StatusCodes { 1727 /** 1728 * The percentage of requests over the last 10 seconds that resulted in a 2xx (200, 201, etc.) status code. 1729 */ 1730 Status2xx?: NullableInteger; 1731 /** 1732 * The percentage of requests over the last 10 seconds that resulted in a 3xx (300, 301, etc.) status code. 1733 */ 1734 Status3xx?: NullableInteger; 1735 /** 1736 * The percentage of requests over the last 10 seconds that resulted in a 4xx (400, 401, etc.) status code. 1737 */ 1738 Status4xx?: NullableInteger; 1739 /** 1740 * The percentage of requests over the last 10 seconds that resulted in a 5xx (500, 501, etc.) status code. 1741 */ 1742 Status5xx?: NullableInteger; 1743 } 1744 export type String = string; 1745 export interface SwapEnvironmentCNAMEsMessage { 1746 /** 1747 * 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. 1748 */ 1749 SourceEnvironmentId?: EnvironmentId; 1750 /** 1751 * 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. 1752 */ 1753 SourceEnvironmentName?: EnvironmentName; 1754 /** 1755 * 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. 1756 */ 1757 DestinationEnvironmentId?: EnvironmentId; 1758 /** 1759 * 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. 1760 */ 1761 DestinationEnvironmentName?: EnvironmentName; 1762 } 1763 export interface SystemStatus { 1764 CPUUtilization?: CPUUtilization; 1765 /** 1766 * Load average in the last 1-minute and 5-minute periods. For more information, see Operating System Metrics. 1767 */ 1768 LoadAverage?: LoadAverage; 1769 } 1770 export interface Tag { 1771 /** 1772 * The key of the tag. 1773 */ 1774 Key?: TagKey; 1775 /** 1776 * The value of the tag. 1777 */ 1778 Value?: TagValue; 1779 } 1780 export type TagKey = string; 1781 export type TagValue = string; 1782 export type Tags = Tag[]; 1783 export type TerminateEnvForce = boolean; 1784 export interface TerminateEnvironmentMessage { 1785 /** 1786 * 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. 1787 */ 1788 EnvironmentId?: EnvironmentId; 1789 /** 1790 * 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. 1791 */ 1792 EnvironmentName?: EnvironmentName; 1793 /** 1794 * 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 1795 */ 1796 TerminateResources?: TerminateEnvironmentResources; 1797 /** 1798 * Terminates the target environment even if another environment in the same group is dependent on it. 1799 */ 1800 ForceTerminate?: ForceTerminate; 1801 } 1802 export type TerminateEnvironmentResources = boolean; 1803 export type TimeFilterEnd = Date; 1804 export type TimeFilterStart = Date; 1805 export type Timestamp = Date; 1806 export type Token = string; 1807 export interface Trigger { 1808 /** 1809 * The name of the trigger. 1810 */ 1811 Name?: ResourceId; 1812 } 1813 export type TriggerList = Trigger[]; 1814 export interface UpdateApplicationMessage { 1815 /** 1816 * The name of the application to update. If no such application is found, UpdateApplication returns an InvalidParameterValue error. 1817 */ 1818 ApplicationName: ApplicationName; 1819 /** 1820 * A new description for the application. Default: If not specified, AWS Elastic Beanstalk does not update the description. 1821 */ 1822 Description?: Description; 1823 } 1824 export interface UpdateApplicationVersionMessage { 1825 /** 1826 * The name of the application associated with this version. If no application is found with this name, UpdateApplication returns an InvalidParameterValue error. 1827 */ 1828 ApplicationName: ApplicationName; 1829 /** 1830 * The name of the version to update. If no application version is found with this label, UpdateApplication returns an InvalidParameterValue error. 1831 */ 1832 VersionLabel: VersionLabel; 1833 /** 1834 * A new description for this release. 1835 */ 1836 Description?: Description; 1837 } 1838 export interface UpdateConfigurationTemplateMessage { 1839 /** 1840 * 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. 1841 */ 1842 ApplicationName: ApplicationName; 1843 /** 1844 * The name of the configuration template to update. If no configuration template is found with this name, UpdateConfigurationTemplate returns an InvalidParameterValue error. 1845 */ 1846 TemplateName: ConfigurationTemplateName; 1847 /** 1848 * A new description for the configuration. 1849 */ 1850 Description?: Description; 1851 /** 1852 * A list of configuration option settings to update with the new specified option value. 1853 */ 1854 OptionSettings?: ConfigurationOptionSettingsList; 1855 /** 1856 * A list of configuration options to remove from the configuration set. Constraint: You can remove only UserDefined configuration options. 1857 */ 1858 OptionsToRemove?: OptionsSpecifierList; 1859 } 1860 export type UpdateDate = Date; 1861 export interface UpdateEnvironmentMessage { 1862 /** 1863 * The name of the application with which the environment is associated. 1864 */ 1865 ApplicationName?: ApplicationName; 1866 /** 1867 * 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. 1868 */ 1869 EnvironmentId?: EnvironmentId; 1870 /** 1871 * 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. 1872 */ 1873 EnvironmentName?: EnvironmentName; 1874 /** 1875 * 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. 1876 */ 1877 GroupName?: GroupName; 1878 /** 1879 * If this parameter is specified, AWS Elastic Beanstalk updates the description of this environment. 1880 */ 1881 Description?: Description; 1882 /** 1883 * 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. 1884 */ 1885 Tier?: EnvironmentTier; 1886 /** 1887 * 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. 1888 */ 1889 VersionLabel?: VersionLabel; 1890 /** 1891 * 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. 1892 */ 1893 TemplateName?: ConfigurationTemplateName; 1894 /** 1895 * This specifies the platform version that the environment will run after the environment is updated. 1896 */ 1897 SolutionStackName?: SolutionStackName; 1898 /** 1899 * If specified, AWS Elastic Beanstalk updates the configuration set associated with the running environment and sets the specified configuration options to the requested value. 1900 */ 1901 OptionSettings?: ConfigurationOptionSettingsList; 1902 /** 1903 * A list of custom user-defined configuration options to remove from the configuration set for this environment. 1904 */ 1905 OptionsToRemove?: OptionsSpecifierList; 1906 } 1907 export type UserDefinedOption = boolean; 1908 export interface ValidateConfigurationSettingsMessage { 1909 /** 1910 * The name of the application that the configuration template or environment belongs to. 1911 */ 1912 ApplicationName: ApplicationName; 1913 /** 1914 * The name of the configuration template to validate the settings against. Condition: You cannot specify both this and an environment name. 1915 */ 1916 TemplateName?: ConfigurationTemplateName; 1917 /** 1918 * The name of the environment to validate the settings against. Condition: You cannot specify both this and a configuration template name. 1919 */ 1920 EnvironmentName?: EnvironmentName; 1921 /** 1922 * A list of the options and desired values to evaluate. 1923 */ 1924 OptionSettings: ConfigurationOptionSettingsList; 1925 } 1926 export interface ValidationMessage { 1927 /** 1928 * A message describing the error or warning. 1929 */ 1930 Message?: ValidationMessageString; 1931 /** 1932 * 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. 1933 */ 1934 Severity?: ValidationSeverity; 1935 /** 1936 * 1937 */ 1938 Namespace?: OptionNamespace; 1939 /** 1940 * 1941 */ 1942 OptionName?: ConfigurationOptionName; 1943 } 1944 export type ValidationMessageString = string; 1945 export type ValidationMessagesList = ValidationMessage[]; 1946 export type ValidationSeverity = "error"|"warning"|string; 1947 export type VersionLabel = string; 1948 export type VersionLabels = VersionLabel[]; 1949 export type VersionLabelsList = VersionLabel[]; 1950 /** 1951 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. 1952 */ 1953 export type apiVersion = "2010-12-01"|"latest"|string; 1954 export interface ClientApiVersions { 1955 /** 1956 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. 1957 */ 1958 apiVersion?: apiVersion; 1959 } 1960 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; 1961 } 1962 export = ElasticBeanstalk;