\n This is the AWS Elastic Beanstalk API Reference. This guide provides detailed information \n about AWS Elastic Beanstalk actions, data types, parameters, and errors.\n
\n\nAWS Elastic Beanstalk\n is a tool that makes it easy for you to create,\n deploy, and manage scalable, fault-tolerant applications running on\n Amazon Web Services cloud resources.\n
\n\n\n For more information about this product, go to the AWS Elastic Beanstalk details page. \n The location of the latest AWS Elastic Beanstalk WSDL is \n http://elasticbeanstalk.s3.amazonaws.com/doc/2010-12-01/AWSElasticBeanstalk.wsdl.\n
\nEndpoints
\nFor a list of region-specific endpoints that AWS Elastic Beanstalk supports, go to Regions and Endpoints in the \nAmazon Web Services Glossary.
\n ", "operations": { "CheckDNSAvailability": { "name": "CheckDNSAvailability", "input": { "shape_name": "CheckDNSAvailabilityMessage", "type": "structure", "members": { "CNAMEPrefix": { "shape_name": "DNSCnamePrefix", "type": "string", "min_length": 4, "max_length": 63, "documentation": "\n\n The prefix used when this CNAME is reserved.\n\t\t
\n ", "required": true } }, "documentation": "\nResults message indicating whether a CNAME is available.
\n " }, "output": { "shape_name": "CheckDNSAvailabilityResultMessage", "type": "structure", "members": { "Available": { "shape_name": "CnameAvailability", "type": "boolean", "documentation": "\n\n Indicates if the specified CNAME is available:\n\t\t
\n\n true\n : The CNAME is available.\n
\n true\n : The CNAME is not available.\n
\n
true\n : The CNAME is available.\n false\n : The CNAME is not available.\n The fully qualified CNAME to reserve when CreateEnvironment is called\n with the provided prefix.
\n " } }, "documentation": "\nIndicates if the specified CNAME is available.
\n " }, "errors": [], "documentation": "\n\n Checks if the specified CNAME is available.\n\t\t
\n\nThe name of the application.
\n\n Constraint: This name must be unique within your account.\n If the\n specified name already exists, the action returns an\n InvalidParameterValue\n error.\n
Describes the application.
\n " } }, "documentation": "\nThis documentation target is not reported in the API reference.
\n " }, "output": { "shape_name": "ApplicationDescriptionMessage", "type": "structure", "members": { "Application": { "shape_name": "ApplicationDescription", "type": "structure", "members": { "ApplicationName": { "shape_name": "ApplicationName", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\nThe name of the application.
\n " }, "Description": { "shape_name": "Description", "type": "string", "max_length": 200, "documentation": "\nUser-defined description of the application.
\n " }, "DateCreated": { "shape_name": "CreationDate", "type": "timestamp", "documentation": "\nThe date when the application was created.
\n " }, "DateUpdated": { "shape_name": "UpdateDate", "type": "timestamp", "documentation": "\nThe date when the application was last modified.
\n " }, "Versions": { "shape_name": "VersionLabelsList", "type": "list", "members": { "shape_name": "VersionLabel", "type": "string", "min_length": 1, "max_length": 100, "documentation": null }, "documentation": "\nThe names of the versions for this application.
\n " }, "ConfigurationTemplates": { "shape_name": "ConfigurationTemplateNamesList", "type": "list", "members": { "shape_name": "ConfigurationTemplateName", "type": "string", "min_length": 1, "max_length": 100, "documentation": null }, "documentation": "\n\n The names of the configuration templates associated with this\n application.\n\t
\n " } }, "documentation": "\n\n The\n ApplicationDescription\n of the application.\n
\n " } }, "documentation": "\nResult message containing a single description of an application.
\n " }, "errors": [ { "shape_name": "TooManyApplicationsException", "type": "structure", "members": {}, "documentation": "\nThe caller has exceeded the limit on the number of applications associated with their account.
\n " } ], "documentation": "\n\n Creates an application that has one configuration\n template named\n default\n and no application versions.\n
\n The name of the application.\n If no application is found with this name,\n and\n AutoCreateApplication\n is\n false, returns an\n InvalidParameterValue\n error.\n
A label identifying this version.
\nConstraint:\n Must be unique per application. If an application version already\n exists with this label for the specified application, AWS Elastic Beanstalk\n returns an\n InvalidParameterValue\n error.\n
Describes this version.
\n " }, "SourceBundle": { "shape_name": "S3Location", "type": "structure", "members": { "S3Bucket": { "shape_name": "S3Bucket", "type": "string", "max_length": 255, "documentation": "\nThe Amazon S3 bucket where the data is located.
\n " }, "S3Key": { "shape_name": "S3Key", "type": "string", "max_length": 1024, "documentation": "\nThe Amazon S3 key where the data is located.
\n " } }, "documentation": "\nThe Amazon S3 bucket and key that identify the location of the\n source\n bundle for this version.
\n\n\n If data found at the Amazon S3 location exceeds the maximum allowed\n source bundle size, AWS Elastic Beanstalk\n returns an\n InvalidParameterValue\n error. The maximum size allowed is 512 MB.\n
Default:\n If not specified, AWS Elastic Beanstalk\n uses a sample application.\n If only partially specified (for example, a bucket is provided but not\n the key)\n or if no data is found at the Amazon S3 location, AWS Elastic Beanstalk\n returns an\n InvalidParameterCombination\n error.\n
\n Determines how the system behaves if the specified\n application for this\n version does not already exist:\n
\n\n true: Automatically creates the specified application for this\n version if it does not already exist.\n
\n false: Returns an\n InvalidParameterValue\n if the specified application for this version does not already\n exist.\n
true\n : Automatically creates the specified application for this\n release if it does not already exist.\n false\n : Throws an\n InvalidParameterValue\n if the specified application for this release does not already\n exist.\n \n Default:\n false\n
\n Valid Values:\n true\n |\n false\n
The name of the application associated with this release.
\n " }, "Description": { "shape_name": "Description", "type": "string", "max_length": 200, "documentation": "\nThe description of this application version.
\n " }, "VersionLabel": { "shape_name": "VersionLabel", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\n\n A label uniquely identifying the version for the associated\n application.\n
\n " }, "SourceBundle": { "shape_name": "S3Location", "type": "structure", "members": { "S3Bucket": { "shape_name": "S3Bucket", "type": "string", "max_length": 255, "documentation": "\nThe Amazon S3 bucket where the data is located.
\n " }, "S3Key": { "shape_name": "S3Key", "type": "string", "max_length": 1024, "documentation": "\nThe Amazon S3 key where the data is located.
\n " } }, "documentation": "\n\n The location where the source bundle is located for this version.\n\t
\n " }, "DateCreated": { "shape_name": "CreationDate", "type": "timestamp", "documentation": "\nThe creation date of the application version.
\n " }, "DateUpdated": { "shape_name": "UpdateDate", "type": "timestamp", "documentation": "\nThe last modified date of the application version.
\n " } }, "documentation": "\n\n The\n ApplicationVersionDescription\n of the application version.\n
\n " } }, "documentation": "\n\n Result message wrapping a single description of an application\n version.\n
\n " }, "errors": [ { "shape_name": "TooManyApplicationsException", "type": "structure", "members": {}, "documentation": "\nThe caller has exceeded the limit on the number of applications associated with their account.
\n " }, { "shape_name": "TooManyApplicationVersionsException", "type": "structure", "members": {}, "documentation": "\nThe caller has exceeded the limit on the number of application versions associated with their account.
\n " }, { "shape_name": "InsufficientPrivilegesException", "type": "structure", "members": {}, "documentation": "\nUnable to perform the specified operation because the user does not have enough privileges for one of more downstream aws services
\n " }, { "shape_name": "S3LocationNotInServiceRegionException", "type": "structure", "members": {}, "documentation": "\nThe specified S3 bucket does not belong to the S3 region in which the service is running.
\n " } ], "documentation": "\nCreates an application version for the specified\n application.
\n\n The name of the application to associate with this\n configuration\n template. If no application is found with this name, AWS Elastic Beanstalk returns an\n InvalidParameterValue\n error.\n
The name of the configuration template.
\n\nConstraint: This name must be unique per\n application.
\nDefault:\n If a configuration template\n already exists with this name, AWS Elastic Beanstalk\n returns an\n InvalidParameterValue\n error.\n
The name of the solution stack used by this configuration. The solution\n stack specifies the operating system, architecture, and\n application\n server for a configuration template. It determines the set\n of\n configuration options as well as the possible and default values.\n
\n\n\n Use\n ListAvailableSolutionStacks\n to obtain a list of available solution stacks.\n
\n\n\t\t\t\t A solution stack name or a source configuration parameter must be specified, otherwise AWS Elastic Beanstalk returns an InvalidParameterValue error. \n
\n\t\t\t\t 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.\n
\n\n " }, "SourceConfiguration": { "shape_name": "SourceConfiguration", "type": "structure", "members": { "ApplicationName": { "shape_name": "ApplicationName", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\nThe name of the application associated with the configuration.
\n " }, "TemplateName": { "shape_name": "ConfigurationTemplateName", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\nThe name of the configuration template.
\n " } }, "documentation": "\n\n If specified, AWS Elastic Beanstalk\n uses the configuration values from the\n specified configuration template\n to create a new configuration.\n
\n\n Values specified in the\n OptionSettings\n parameter of this call overrides any values obtained\n from the\n SourceConfiguration.\n
\n If no configuration template is found, returns an\n InvalidParameterValue\n error.\n
\n Constraint: If both the solution stack name parameter and the source\n configuration parameters are specified,\n the solution stack of the source\n configuration template must match the\n specified solution stack name or\n else AWS Elastic Beanstalk\n returns an\n InvalidParameterCombination\n error.\n
\n The ID of the environment used with this configuration template.\n
\n " }, "Description": { "shape_name": "Description", "type": "string", "max_length": 200, "documentation": "\nDescribes this configuration.
\n " }, "OptionSettings": { "shape_name": "ConfigurationOptionSettingsList", "type": "list", "members": { "shape_name": "ConfigurationOptionSetting", "type": "structure", "members": { "Namespace": { "shape_name": "OptionNamespace", "type": "string", "documentation": "\n\n A unique namespace identifying the option's associated AWS resource.\n\t\t
\n " }, "OptionName": { "shape_name": "ConfigurationOptionName", "type": "string", "documentation": "\n\n The name of the configuration option. \n\t\t
\n " }, "Value": { "shape_name": "ConfigurationOptionValue", "type": "string", "documentation": "\n\n The current value for the configuration option.\n\t\t
\n " } }, "documentation": "\n\n A specification identifying an individual configuration option along with its\n current value. For a list of possible option values, go to Option Values in the \nAWS Elastic Beanstalk Developer Guide.\n\t\t
\n\n " }, "documentation": "\n\n If specified, AWS Elastic Beanstalk\n sets the specified configuration option to the requested value.\n The new value overrides the value obtained from the solution stack\n or the source configuration template.\n
\n " } }, "documentation": "\nThis documentation target is not reported in the API reference.
\n " }, "output": { "shape_name": "ConfigurationSettingsDescription", "type": "structure", "members": { "SolutionStackName": { "shape_name": "SolutionStackName", "type": "string", "max_length": 100, "documentation": "\n\n The name of the solution stack this configuration set uses.\n\t\t
\n " }, "ApplicationName": { "shape_name": "ApplicationName", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\n\n The name of the application associated with this configuration set.\n\t\t
\n " }, "TemplateName": { "shape_name": "ConfigurationTemplateName", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\n\n If not\n null, the name of the configuration template for this configuration set.\n
\n Describes this configuration set.\n\t\t
\n " }, "EnvironmentName": { "shape_name": "EnvironmentName", "type": "string", "min_length": 4, "max_length": 23, "documentation": "\n\n If not\n null, the name of the environment for this configuration set.\n
\n If this configuration set is associated with an environment, the \n DeploymentStatus parameter indicates\n the deployment status of this configuration set:\n\t\t
\n null: This configuration is not associated with a running\n environment.\n
\n pending: This is a draft configuration that is not deployed\n to the\n associated environment but is in the process of deploying.\n
\n deployed: This is the configuration that is currently deployed\n to the associated running environment.\n
\n failed: This is a draft configuration, that\n failed to successfully deploy.\n
null: This configuration is not associated with a running\n environment.\n pending: This is a draft configuration that is not deployed\n to the associated environment but is in the process of deploying.\n deployed: This is the configuration that is currently deployed\n to the associated running environment.\n failed: This is a draft configuration that failed to\n successfully deploy.\n \n The date (in UTC time) when this configuration set was created.\n\t\t
\n " }, "DateUpdated": { "shape_name": "UpdateDate", "type": "timestamp", "documentation": "\n\n The date (in UTC time) when this configuration set was last modified.\n\t\t
\n " }, "OptionSettings": { "shape_name": "ConfigurationOptionSettingsList", "type": "list", "members": { "shape_name": "ConfigurationOptionSetting", "type": "structure", "members": { "Namespace": { "shape_name": "OptionNamespace", "type": "string", "documentation": "\n\n A unique namespace identifying the option's associated AWS resource.\n\t\t
\n " }, "OptionName": { "shape_name": "ConfigurationOptionName", "type": "string", "documentation": "\n\n The name of the configuration option. \n\t\t
\n " }, "Value": { "shape_name": "ConfigurationOptionValue", "type": "string", "documentation": "\n\n The current value for the configuration option.\n\t\t
\n " } }, "documentation": "\n\n A specification identifying an individual configuration option along with its\n current value. For a list of possible option values, go to Option Values in the \nAWS Elastic Beanstalk Developer Guide.\n\t\t
\n\n " }, "documentation": "\n\n A list of the configuration options and their values in this configuration\n set.\n\t\t
\n " } }, "documentation": "\n\n Describes the settings for a configuration set.\n\t\t
\n\n " }, "errors": [ { "shape_name": "InsufficientPrivilegesException", "type": "structure", "members": {}, "documentation": "\nUnable to perform the specified operation because the user does not have enough privileges for one of more downstream aws services
\n " }, { "shape_name": "TooManyConfigurationTemplatesException", "type": "structure", "members": {}, "documentation": "\nThe caller has exceeded the limit on the number of configuration templates associated with their account.
\n " } ], "documentation": "\nCreates a configuration template. Templates are associated with a\n specific application\n and are used to deploy different versions of the\n application with\n the same configuration settings.
\n\nRelated Topics
\n\n The name of the application that contains the version to be deployed.\n
\n\n If no application is found with this name, CreateEnvironment\n returns an\n InvalidParameterValue\n error.\n
\n A unique name for the deployment environment. Used in\n the application\n URL.\n
\nConstraint: Must be from 4 to 23 characters\n in length. The name can\n contain only letters, numbers, and hyphens. It cannot start\n or end with\n a hyphen. This name must be unique in your account.\n If the specified\n name already exists, AWS Elastic Beanstalk\n returns an\n InvalidParameterValue\n error.\n
Default: If the CNAME parameter is not specified, the environment name\n becomes part of the CNAME, and therefore\n part of the visible URL for your application.
\n\n\n ", "required": true }, "Description": { "shape_name": "Description", "type": "string", "max_length": 200, "documentation": "\nDescribes this environment.
\n " }, "CNAMEPrefix": { "shape_name": "DNSCnamePrefix", "type": "string", "min_length": 4, "max_length": 63, "documentation": "\n\n If specified, the environment attempts to use this value as the prefix for the\n CNAME.\n If not specified, the CNAME is generated automatically by appending a random alphanumeric string to the environment name.\n\t\t
\n " }, "Tier": { "shape_name": "EnvironmentTier", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\nThe name of this environment tier.
\n " }, "Type": { "shape_name": "String", "type": "string", "documentation": "\nThe type of this environment tier.
\n " }, "Version": { "shape_name": "String", "type": "string", "documentation": "\nThe version of this environment tier.
\n " } }, "documentation": "\n\n This specifies the tier to use for creating this environment.\n
\n " }, "Tags": { "shape_name": "Tags", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "TagKey", "type": "string", "min_length": 1, "max_length": 128, "documentation": "\nThe key of the tag.
\n " }, "Value": { "shape_name": "TagValue", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\nThe value of the tag.
\n " } }, "documentation": "\nDescribes a tag applied to a resource in an environment.
\n " }, "documentation": "\n\n This specifies the tags applied to resources in the environment.\n
\n " }, "VersionLabel": { "shape_name": "VersionLabel", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\nThe name of the application version to deploy.
\n\n If the specified application has no associated application versions, AWS Elastic Beanstalk\n UpdateEnvironment returns an\n InvalidParameterValue\n error.\n
\n Default: If not specified, AWS Elastic Beanstalk\n attempts to launch the sample application in the container.\n
\n " }, "TemplateName": { "shape_name": "ConfigurationTemplateName", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\n\n The name of the configuration template to use in\n deployment. If no\n configuration template is found with this\n name, AWS Elastic Beanstalk\n returns an\n InvalidParameterValue\n error.\n
\n Condition: You must specify either this parameter or a\n SolutionStackName,\n but not both.\n If you specify both, AWS Elastic Beanstalk\n returns an\n InvalidParameterCombination\n error. If you do not specify either, AWS Elastic Beanstalk\n returns a\n MissingRequiredParameter\n error.\n
\n This is an alternative to specifying a configuration name.\n If specified, AWS Elastic Beanstalk\n sets the configuration values to the default values\n associated with the specified solution stack.\n
\n\n Condition: You must specify either this or a\n TemplateName,\n but not both.\n If you specify both, AWS Elastic Beanstalk\n returns an\n InvalidParameterCombination\n error. If you do not specify either, AWS Elastic Beanstalk\n returns a\n MissingRequiredParameter\n error.\n
\n A unique namespace identifying the option's associated AWS resource.\n\t\t
\n " }, "OptionName": { "shape_name": "ConfigurationOptionName", "type": "string", "documentation": "\n\n The name of the configuration option. \n\t\t
\n " }, "Value": { "shape_name": "ConfigurationOptionValue", "type": "string", "documentation": "\n\n The current value for the configuration option.\n\t\t
\n " } }, "documentation": "\n\n A specification identifying an individual configuration option along with its\n current value. For a list of possible option values, go to Option Values in the \nAWS Elastic Beanstalk Developer Guide.\n\t\t
\n\n " }, "documentation": "\n\n If specified, AWS Elastic Beanstalk\n sets the specified configuration options to the requested value in\n the configuration set for the new environment. These override the values\n obtained from\n the solution stack or the configuration template.\n
\n " }, "OptionsToRemove": { "shape_name": "OptionsSpecifierList", "type": "list", "members": { "shape_name": "OptionSpecification", "type": "structure", "members": { "Namespace": { "shape_name": "OptionNamespace", "type": "string", "documentation": "\n\n A unique namespace identifying the option's associated AWS resource.\n\t\t
\n " }, "OptionName": { "shape_name": "ConfigurationOptionName", "type": "string", "documentation": "\n\n The name of the configuration option. \n\t\t
\n " } }, "documentation": "\n\n A specification identifying an individual configuration option.\n\t\t
\n " }, "documentation": "\n\n A list of custom user-defined configuration options to remove from the\n configuration set for this new environment.\n\t\t
\n " } }, "documentation": "\n\n \n " }, "output": { "shape_name": "EnvironmentDescription", "type": "structure", "members": { "EnvironmentName": { "shape_name": "EnvironmentName", "type": "string", "min_length": 4, "max_length": 23, "documentation": "\nThe name of this environment.
\n " }, "EnvironmentId": { "shape_name": "EnvironmentId", "type": "string", "documentation": "\n\n The ID of this environment.\n
\n " }, "ApplicationName": { "shape_name": "ApplicationName", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\nThe name of the application associated with this environment.
\n " }, "VersionLabel": { "shape_name": "VersionLabel", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\nThe application version deployed in this environment.
\n " }, "SolutionStackName": { "shape_name": "SolutionStackName", "type": "string", "max_length": 100, "documentation": "\n\n The name of the\n SolutionStack\n deployed with this environment.\n
\n The name of the configuration template used to\n originally launch this\n environment.\n
\n " }, "Description": { "shape_name": "Description", "type": "string", "max_length": 200, "documentation": "\nDescribes this environment.
\n " }, "EndpointURL": { "shape_name": "EndpointURL", "type": "string", "documentation": "\nFor load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.
\n " }, "CNAME": { "shape_name": "DNSCname", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n\n The URL to the CNAME for this environment.\n
\n " }, "DateCreated": { "shape_name": "CreationDate", "type": "timestamp", "documentation": "\nThe creation date for this environment.
\n " }, "DateUpdated": { "shape_name": "UpdateDate", "type": "timestamp", "documentation": "\nThe last modified date for this environment.
\n " }, "Status": { "shape_name": "EnvironmentStatus", "type": "string", "enum": [ "Launching", "Updating", "Ready", "Terminating", "Terminated" ], "documentation": "\n\n The current operational status of the environment:\n\t\t
\n\nLaunching: Environment is in the process of\n initial deployment.\n Updating: Environment is in the process of\n updating its configuration settings or\n application version.\n Ready: Environment is available to have an action\n performed on it, such as update or terminate.\n Terminating: Environment is in the shut-down process.\n Terminated: Environment is not running.\n \n Describes the health status of the environment. \n\t\t\tAWS Elastic Beanstalk\n indicates the failure levels for a running environment:\n
\n\n Red\n : Indicates the environment is not working.\n
\n Yellow: Indicates that something is wrong, the application\n might not be available, but the instances appear running.\n
\n Green: Indicates the environment is\n healthy and fully functional.\n
Red: Indicates the environment is not responsive. Occurs when three or\n more\n consecutive failures occur for an environment.\n Yellow: Indicates that something is wrong. Occurs when two\n consecutive failures occur for an environment.\n Green: Indicates the environment is\n healthy and fully functional.\n Grey: Default health for a new environment. The environment\n is not fully launched and health checks have not started or health checks\n are suspended during an\n UpdateEnvironment\n or\n RestartEnvironement\n request.\n \n Default: Grey\n
The name of the LoadBalancer.
\n " }, "Domain": { "shape_name": "String", "type": "string", "documentation": "\nThe domain name of the LoadBalancer.
\n " }, "Listeners": { "shape_name": "LoadBalancerListenersDescription", "type": "list", "members": { "shape_name": "Listener", "type": "structure", "members": { "Protocol": { "shape_name": "String", "type": "string", "documentation": "\nThe protocol that is used by the Listener.
\n " }, "Port": { "shape_name": "Integer", "type": "integer", "documentation": "\nThe port that is used by the Listener.
\n " } }, "documentation": "\nDescribes the properties of a Listener for the LoadBalancer.
\n " }, "documentation": "\nA list of Listeners used by the LoadBalancer.
\n " } }, "documentation": "\nDescribes the LoadBalancer.
\n " } }, "documentation": "\nThe description of the AWS resources used by this environment.
\n " }, "Tier": { "shape_name": "EnvironmentTier", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\nThe name of this environment tier.
\n " }, "Type": { "shape_name": "String", "type": "string", "documentation": "\nThe type of this environment tier.
\n " }, "Version": { "shape_name": "String", "type": "string", "documentation": "\nThe version of this environment tier.
\n " } }, "documentation": "\nDescribes the current tier of this environment.
\n " } }, "documentation": "\nDescribes the properties of an environment.
\n\n\n " }, "errors": [ { "shape_name": "TooManyEnvironmentsException", "type": "structure", "members": {}, "documentation": "\nThe caller has exceeded the limit of allowed environments associated with the account.
\n " }, { "shape_name": "InsufficientPrivilegesException", "type": "structure", "members": {}, "documentation": "\nUnable to perform the specified operation because the user does not have enough privileges for one of more downstream aws services
\n " } ], "documentation": "\n\n Launches an environment for the specified application using\n the specified configuration.\n\t\t
\n\n\n The name of the Amazon S3 bucket created.\n\t\t
\n " } }, "documentation": "\nResults of a CreateStorageLocationResult call.
\n " }, "errors": [ { "shape_name": "TooManyBucketsException", "type": "structure", "members": {}, "documentation": "\nThe web service attempted to create a bucket in an Amazon S3 account that already has 100 buckets.
\n " }, { "shape_name": "S3SubscriptionRequiredException", "type": "structure", "members": {}, "documentation": "\nThe caller does not have a subscription to Amazon S3.
\n " }, { "shape_name": "InsufficientPrivilegesException", "type": "structure", "members": {}, "documentation": "\nUnable to perform the specified operation because the user does not have enough privileges for one of more downstream aws services
\n " } ], "documentation": "\n\n Creates the Amazon S3 storage location for the account.\n\t\t
\n\n This location is used to store user log files.\n\t\t
\n\nThe name of the application to delete.
\n ", "required": true }, "TerminateEnvByForce": { "shape_name": "TerminateEnvForce", "type": "boolean", "documentation": "\nWhen set to true, running environments will be terminated before deleting the application.
\n " } }, "documentation": "\nThis documentation target is not reported in the API reference.
\n " }, "output": null, "errors": [ { "shape_name": "OperationInProgressException", "type": "structure", "members": {}, "documentation": "\nUnable to perform the specified operation because another operation is already in progress affecting an an element in this activity.
\n " } ], "documentation": "\n\n Deletes the specified application along with all\n associated versions and\n configurations. The application versions will not be deleted from your Amazon S3 bucket.\n
\nThe name of the application to delete releases from.
\n ", "required": true }, "VersionLabel": { "shape_name": "VersionLabel", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\n\n The label of the version to delete.\n
\n ", "required": true }, "DeleteSourceBundle": { "shape_name": "DeleteSourceBundle", "type": "boolean", "documentation": "\nIndicates whether to delete the associated source bundle from Amazon S3:\n
\ntrue: An attempt is made to delete the\n associated Amazon S3 source bundle specified at time of creation.\n false: No action is taken on the Amazon S3 source bundle specified at\n time of creation.\n \n Valid Values: true | false\n
This documentation target is not reported in the API reference.
\n " }, "output": null, "errors": [ { "shape_name": "SourceBundleDeletionException", "type": "structure", "members": {}, "documentation": "\nUnable to delete the Amazon S3 source bundle associated with the application version, although the application version deleted successfully.
\n " }, { "shape_name": "InsufficientPrivilegesException", "type": "structure", "members": {}, "documentation": "\nUnable to perform the specified operation because the user does not have enough privileges for one of more downstream aws services
\n " }, { "shape_name": "OperationInProgressException", "type": "structure", "members": {}, "documentation": "\nUnable to perform the specified operation because another operation is already in progress affecting an an element in this activity.
\n " }, { "shape_name": "S3LocationNotInServiceRegionException", "type": "structure", "members": {}, "documentation": "\nThe specified S3 bucket does not belong to the S3 region in which the service is running.
\n " } ], "documentation": "\n\n Deletes the specified version from the specified\n application.\n
\n\n The name of the application to delete the configuration\n template from.\n
\n ", "required": true }, "TemplateName": { "shape_name": "ConfigurationTemplateName", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\nThe name of the configuration template to delete.
\n ", "required": true } }, "documentation": "\n\nThis documentation target is not reported in the API reference.
\n " }, "output": null, "errors": [ { "shape_name": "OperationInProgressException", "type": "structure", "members": {}, "documentation": "\nUnable to perform the specified operation because another operation is already in progress affecting an an element in this activity.
\n " } ], "documentation": "\nDeletes the specified configuration template.
\n\n The name of the application the environment is associated with.\n\t\t
\n ", "required": true }, "EnvironmentName": { "shape_name": "EnvironmentName", "type": "string", "min_length": 4, "max_length": 23, "documentation": "\n\n The name of the environment to delete the draft configuration from.\n\t\t
\n ", "required": true } }, "documentation": "\nThis documentation target is not reported in the API reference.
\n " }, "output": null, "errors": [], "documentation": "\n\n Deletes the draft configuration associated with the running environment.\n\t\t
\n\n Updating a running environment with any configuration changes creates a\n draft configuration set. You can get the draft configuration using\n DescribeConfigurationSettings while the update is in progress \n or if the update fails. The DeploymentStatus for the draft \n configuration indicates whether the deployment is in process or has failed.\n The draft configuration remains in existence until it is deleted with this action.\n
\n If specified, AWS Elastic Beanstalk\n restricts the returned descriptions to\n only include ones that are\n associated with the specified application.\n
\n " }, "VersionLabels": { "shape_name": "VersionLabelsList", "type": "list", "members": { "shape_name": "VersionLabel", "type": "string", "min_length": 1, "max_length": 100, "documentation": null }, "documentation": "\n\n If specified, restricts the returned descriptions to only include ones\n that have the specified version labels.\n\t
\n " } }, "documentation": "\n\nResult message containing a list of configuration descriptions.
\n " }, "output": { "shape_name": "ApplicationVersionDescriptionsMessage", "type": "structure", "members": { "ApplicationVersions": { "shape_name": "ApplicationVersionDescriptionList", "type": "list", "members": { "shape_name": "ApplicationVersionDescription", "type": "structure", "members": { "ApplicationName": { "shape_name": "ApplicationName", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\nThe name of the application associated with this release.
\n " }, "Description": { "shape_name": "Description", "type": "string", "max_length": 200, "documentation": "\nThe description of this application version.
\n " }, "VersionLabel": { "shape_name": "VersionLabel", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\n\n A label uniquely identifying the version for the associated\n application.\n
\n " }, "SourceBundle": { "shape_name": "S3Location", "type": "structure", "members": { "S3Bucket": { "shape_name": "S3Bucket", "type": "string", "max_length": 255, "documentation": "\nThe Amazon S3 bucket where the data is located.
\n " }, "S3Key": { "shape_name": "S3Key", "type": "string", "max_length": 1024, "documentation": "\nThe Amazon S3 key where the data is located.
\n " } }, "documentation": "\n\n The location where the source bundle is located for this version.\n\t
\n " }, "DateCreated": { "shape_name": "CreationDate", "type": "timestamp", "documentation": "\nThe creation date of the application version.
\n " }, "DateUpdated": { "shape_name": "UpdateDate", "type": "timestamp", "documentation": "\nThe last modified date of the application version.
\n " } }, "documentation": "\n\n Describes the properties of an application version.\n
\n\n\n " }, "documentation": "\n\n A list of\n ApplicationVersionDescription\n .\n
\n " } }, "documentation": "\nResult message wrapping a list of application version descriptions.
\n " }, "errors": [], "documentation": "\nReturns descriptions for existing application versions.
\n\n If specified, AWS Elastic Beanstalk\n restricts the returned descriptions to\n only include those with the\n specified names.\n
\n " } }, "documentation": "\nThis documentation target is not reported in the API reference.
\n " }, "output": { "shape_name": "ApplicationDescriptionsMessage", "type": "structure", "members": { "Applications": { "shape_name": "ApplicationDescriptionList", "type": "list", "members": { "shape_name": "ApplicationDescription", "type": "structure", "members": { "ApplicationName": { "shape_name": "ApplicationName", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\nThe name of the application.
\n " }, "Description": { "shape_name": "Description", "type": "string", "max_length": 200, "documentation": "\nUser-defined description of the application.
\n " }, "DateCreated": { "shape_name": "CreationDate", "type": "timestamp", "documentation": "\nThe date when the application was created.
\n " }, "DateUpdated": { "shape_name": "UpdateDate", "type": "timestamp", "documentation": "\nThe date when the application was last modified.
\n " }, "Versions": { "shape_name": "VersionLabelsList", "type": "list", "members": { "shape_name": "VersionLabel", "type": "string", "min_length": 1, "max_length": 100, "documentation": null }, "documentation": "\nThe names of the versions for this application.
\n " }, "ConfigurationTemplates": { "shape_name": "ConfigurationTemplateNamesList", "type": "list", "members": { "shape_name": "ConfigurationTemplateName", "type": "string", "min_length": 1, "max_length": 100, "documentation": null }, "documentation": "\n\n The names of the configuration templates associated with this\n application.\n\t
\n " } }, "documentation": "\nDescribes the properties of an application.
\n\n " }, "documentation": "\n\n This parameter contains a list of\n ApplicationDescription.\n
\n " } }, "documentation": "\nResult message containing a list of application descriptions.
\n " }, "errors": [], "documentation": "\nReturns the descriptions of existing applications.
\n\n The name of the application associated with the configuration template or\n environment. Only needed if you want to describe the\n configuration options associated with either the configuration template or\n environment.\n\t\t
\n " }, "TemplateName": { "shape_name": "ConfigurationTemplateName", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\n\n The name of the configuration template whose configuration options\n you want to describe.\n\t\t
\n " }, "EnvironmentName": { "shape_name": "EnvironmentName", "type": "string", "min_length": 4, "max_length": 23, "documentation": "\n\n The name of the environment whose configuration options you want to describe.\n
\n " }, "SolutionStackName": { "shape_name": "SolutionStackName", "type": "string", "max_length": 100, "documentation": "\n\n The name of the solution stack whose configuration options\n you want to describe.\n\t\t
\n " }, "Options": { "shape_name": "OptionsSpecifierList", "type": "list", "members": { "shape_name": "OptionSpecification", "type": "structure", "members": { "Namespace": { "shape_name": "OptionNamespace", "type": "string", "documentation": "\n\n A unique namespace identifying the option's associated AWS resource.\n\t\t
\n " }, "OptionName": { "shape_name": "ConfigurationOptionName", "type": "string", "documentation": "\n\n The name of the configuration option. \n\t\t
\n " } }, "documentation": "\n\n A specification identifying an individual configuration option.\n\t\t
\n " }, "documentation": "\n\n If specified, restricts the descriptions to only the specified options.\n\t\t
\n " } }, "documentation": "\nResult message containig a list of application version descriptions.\n
\n " }, "output": { "shape_name": "ConfigurationOptionsDescription", "type": "structure", "members": { "SolutionStackName": { "shape_name": "SolutionStackName", "type": "string", "max_length": 100, "documentation": "\n\n The name of the solution stack these configuration options belong to.\n\t\t
\n " }, "Options": { "shape_name": "ConfigurationOptionDescriptionsList", "type": "list", "members": { "shape_name": "ConfigurationOptionDescription", "type": "structure", "members": { "Namespace": { "shape_name": "OptionNamespace", "type": "string", "documentation": "\n\n A unique namespace identifying the option's associated AWS resource.\n\t\t
\n " }, "Name": { "shape_name": "ConfigurationOptionName", "type": "string", "documentation": "\n\n The name of the configuration option.\n\t\t
\n " }, "DefaultValue": { "shape_name": "ConfigurationOptionDefaultValue", "type": "string", "documentation": "\n\n The default value for this configuration option.\n\t\t
\n " }, "ChangeSeverity": { "shape_name": "ConfigurationOptionSeverity", "type": "string", "documentation": "\n\n An indication of which action is required if the value for this\n configuration option changes:\n\t\t
\n\n NoInterruption - There is no interruption to the\n environment or application availability.\n\t\t\t\t
\n\n RestartEnvironment - The environment is\n restarted, all AWS resources are deleted and recreated, and\n the environment is unavailable during the process.\n\t\t\t\t
\n\n RestartApplicationServer - The environment is available\n the entire time. However, a short application\n outage occurs when the application servers on the running Amazon EC2 instances\n are restarted.\n\t\t\t\t
\nNoInterruption\n : There is no interruption to the\n environment or application availability.\n RestartEnvironment\n : The environment is entirely\n restarted, all AWS resources are deleted and recreated, and\n the environment is unavailable during the process.\n RestartApplicationServer\n : The environment is available\n the entire time. However, a short application outage occurs when \n the application servers on the running Amazon EC2 instances\n are restarted.\n \n An indication of whether the user defined this configuration option:\n\t\t
\n\n true\n : This configuration option was defined by the user. It is a\n valid choice for specifying this as an Option to Remove when\n updating configuration settings.\n\n
\n false\n : This configuration was not defined by the user.\n
\n true\n : This configuration option was defined by the user. It is a\n valid choice for specifying if this as an\n Option to Remove\n when\n updating configuration settings.\n
false\n : This configuration was not defined by the user.\n \n Constraint: You can remove only UserDefined\n options from a configuration.\n
\n Valid Values: true | false
\n An indication of which type of values this option has and whether\n it is allowable to select one or more than one of the possible values:\n\t\t
\n\n Scalar\n : Values for this option are a single selection from the\n possible values, or a unformatted string or numeric value governed\n by the MIN/MAX/Regex constraints:\n
\n List\n : Values for this option are multiple selections of the\n possible values.\n
\n Boolean\n : Values for this option are either\n true\n or\n false\n .\n
\n
Scalar\n : Values for this option are a single selection from the\n possible values, or an unformatted string, or numeric value governed\n by the MIN/MAX/Regex constraints.\n List\n : Values for this option are multiple selections from the\n possible values.\n Boolean\n : Values for this option are either\n true\n or\n false\n .\n \n If specified, values for the configuration option are selected\n from this list.\n\t\t
\n " }, "MinValue": { "shape_name": "OptionRestrictionMinValue", "type": "integer", "documentation": "\n\n If specified, the configuration option must be a numeric value\n greater than this value.\n\t\t
\n " }, "MaxValue": { "shape_name": "OptionRestrictionMaxValue", "type": "integer", "documentation": "\n\n If specified, the configuration option must be a numeric value less than this\n value.\n\t\t
\n " }, "MaxLength": { "shape_name": "OptionRestrictionMaxLength", "type": "integer", "documentation": "\n\n If specified, the configuration option must be a string value no longer than\n this value.\n\t\t
\n " }, "Regex": { "shape_name": "OptionRestrictionRegex", "type": "structure", "members": { "Pattern": { "shape_name": "RegexPattern", "type": "string", "documentation": "\n\n The regular expression pattern that a string configuration option value with\n this restriction must match.\n\t\t
\n " }, "Label": { "shape_name": "RegexLabel", "type": "string", "documentation": "\n\n A unique name representing this regular expression.\n\t\t
\n " } }, "documentation": "\n\n If specified, the configuration option must be a string value that satisfies\n this regular expression.\n\t\t
\n " } }, "documentation": "\n\n Describes the possible values for a configuration option.\n\t\t
\n " }, "documentation": "\n\n A list of\n ConfigurationOptionDescription.\n
\n " } }, "documentation": "\nDescribes the settings for a specified configuration set.
\n " }, "errors": [], "documentation": "\n\n Describes the configuration options that are used in a\n particular configuration template or environment, or that \n a specified solution stack defines. The description includes the values the\n options, their default values, and an indication of\n the required action on a running environment if an option value is changed.\n\t\t
\n\n The application for the environment or configuration template.\n\t\t
\n ", "required": true }, "TemplateName": { "shape_name": "ConfigurationTemplateName", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\n\n The name of the configuration template to describe. \n
\n\n Conditional: You must specify either this parameter or an EnvironmentName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. \n If you do not specify either, AWS Elastic Beanstalk returns a MissingRequiredParameter error.\n\t\t
\n The name of the environment to describe.\n
\n\n Condition: You must specify either this or a TemplateName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. \n If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.\n\t\t
Result message containing all of the configuration settings for a\n specified solution stack or configuration template.
\n " }, "output": { "shape_name": "ConfigurationSettingsDescriptions", "type": "structure", "members": { "ConfigurationSettings": { "shape_name": "ConfigurationSettingsDescriptionList", "type": "list", "members": { "shape_name": "ConfigurationSettingsDescription", "type": "structure", "members": { "SolutionStackName": { "shape_name": "SolutionStackName", "type": "string", "max_length": 100, "documentation": "\n\n The name of the solution stack this configuration set uses.\n\t\t
\n " }, "ApplicationName": { "shape_name": "ApplicationName", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\n\n The name of the application associated with this configuration set.\n\t\t
\n " }, "TemplateName": { "shape_name": "ConfigurationTemplateName", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\n\n If not\n null, the name of the configuration template for this configuration set.\n
\n Describes this configuration set.\n\t\t
\n " }, "EnvironmentName": { "shape_name": "EnvironmentName", "type": "string", "min_length": 4, "max_length": 23, "documentation": "\n\n If not\n null, the name of the environment for this configuration set.\n
\n If this configuration set is associated with an environment, the \n DeploymentStatus parameter indicates\n the deployment status of this configuration set:\n\t\t
\n null: This configuration is not associated with a running\n environment.\n
\n pending: This is a draft configuration that is not deployed\n to the\n associated environment but is in the process of deploying.\n
\n deployed: This is the configuration that is currently deployed\n to the associated running environment.\n
\n failed: This is a draft configuration, that\n failed to successfully deploy.\n
null: This configuration is not associated with a running\n environment.\n pending: This is a draft configuration that is not deployed\n to the associated environment but is in the process of deploying.\n deployed: This is the configuration that is currently deployed\n to the associated running environment.\n failed: This is a draft configuration that failed to\n successfully deploy.\n \n The date (in UTC time) when this configuration set was created.\n\t\t
\n " }, "DateUpdated": { "shape_name": "UpdateDate", "type": "timestamp", "documentation": "\n\n The date (in UTC time) when this configuration set was last modified.\n\t\t
\n " }, "OptionSettings": { "shape_name": "ConfigurationOptionSettingsList", "type": "list", "members": { "shape_name": "ConfigurationOptionSetting", "type": "structure", "members": { "Namespace": { "shape_name": "OptionNamespace", "type": "string", "documentation": "\n\n A unique namespace identifying the option's associated AWS resource.\n\t\t
\n " }, "OptionName": { "shape_name": "ConfigurationOptionName", "type": "string", "documentation": "\n\n The name of the configuration option. \n\t\t
\n " }, "Value": { "shape_name": "ConfigurationOptionValue", "type": "string", "documentation": "\n\n The current value for the configuration option.\n\t\t
\n " } }, "documentation": "\n\n A specification identifying an individual configuration option along with its\n current value. For a list of possible option values, go to Option Values in the \nAWS Elastic Beanstalk Developer Guide.\n\t\t
\n\n " }, "documentation": "\n\n A list of the configuration options and their values in this configuration\n set.\n\t\t
\n " } }, "documentation": "\n\n Describes the settings for a configuration set.\n\t\t
\n\n " }, "documentation": "\n\n A list of\n ConfigurationSettingsDescription.\n
\n " } }, "documentation": "\nThe results from a request to change the configuration settings of an\n environment.
\n " }, "errors": [], "documentation": "\n\n Returns a description of the settings for the specified\n configuration set, that is, either a configuration template or the\n configuration set associated with a running environment.\n\t\t
\n\n When describing the settings for the configuration set associated with a\n running environment, it is possible to receive two sets of setting descriptions.\n One is the deployed configuration set, and the other is a draft configuration\n of an environment that is either in the process of deployment or that failed to\n deploy. \n\t\t
\nRelated Topics
\n\n The ID of the environment to retrieve AWS resource usage data.\n
\n\n Condition: You must specify either this or an EnvironmentName, or both. \n If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.\n\t\t
\n The name of the environment to retrieve AWS resource usage data.\n
\n\n Condition: You must specify either this or an EnvironmentId, or both. \n If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.\n\t\t
This documentation target is not reported in the API reference.
\n " }, "output": { "shape_name": "EnvironmentResourceDescriptionsMessage", "type": "structure", "members": { "EnvironmentResources": { "shape_name": "EnvironmentResourceDescription", "type": "structure", "members": { "EnvironmentName": { "shape_name": "EnvironmentName", "type": "string", "min_length": 4, "max_length": 23, "documentation": "\nThe name of the environment.
\n " }, "AutoScalingGroups": { "shape_name": "AutoScalingGroupList", "type": "list", "members": { "shape_name": "AutoScalingGroup", "type": "structure", "members": { "Name": { "shape_name": "ResourceId", "type": "string", "documentation": "\n\n The name of the\n AutoScalingGroup\n .\n
\n Describes an Auto Scaling launch configuration.\n
\n " }, "documentation": "\n\n The\n AutoScalingGroups\n used by this environment.\n
The ID of the Amazon EC2 instance.
\n " } }, "documentation": "\nThe description of an Amazon EC2 instance.
\n " }, "documentation": "\nThe Amazon EC2 instances used by this environment.
\n " }, "LaunchConfigurations": { "shape_name": "LaunchConfigurationList", "type": "list", "members": { "shape_name": "LaunchConfiguration", "type": "structure", "members": { "Name": { "shape_name": "ResourceId", "type": "string", "documentation": "\nThe name of the launch configuration.
\n " } }, "documentation": "\nDescribes an Auto Scaling launch configuration.
\n " }, "documentation": "\nThe Auto Scaling launch configurations in use by this environment.
\n " }, "LoadBalancers": { "shape_name": "LoadBalancerList", "type": "list", "members": { "shape_name": "LoadBalancer", "type": "structure", "members": { "Name": { "shape_name": "ResourceId", "type": "string", "documentation": "\nThe name of the LoadBalancer.
\n " } }, "documentation": "\nDescribes a LoadBalancer.
\n " }, "documentation": "\nThe LoadBalancers in use by this environment.
\n " }, "Triggers": { "shape_name": "TriggerList", "type": "list", "members": { "shape_name": "Trigger", "type": "structure", "members": { "Name": { "shape_name": "ResourceId", "type": "string", "documentation": "\nThe name of the trigger.
\n " } }, "documentation": "\nDescribes a trigger.
\n " }, "documentation": "\n\n The\n AutoScaling\n triggers in use by this environment.\n
The name of the queue.
\n " }, "URL": { "shape_name": "String", "type": "string", "documentation": "\nThe URL of the queue.
\n " } }, "documentation": "\nDescribes a queue.
\n " }, "documentation": "\n\n The queues used by this environment.\n
\n " } }, "documentation": "\n\n A list of\n EnvironmentResourceDescription.\n
\n " } }, "documentation": "\nResult message containing a list of environment resource\n descriptions.\n
\n " }, "errors": [ { "shape_name": "InsufficientPrivilegesException", "type": "structure", "members": {}, "documentation": "\nUnable to perform the specified operation because the user does not have enough privileges for one of more downstream aws services
\n " } ], "documentation": "\nReturns AWS resources for this environment.
\n\n\n If specified, AWS Elastic Beanstalk\n restricts the returned descriptions to\n include only those that are\n associated with this application.\n
\n " }, "VersionLabel": { "shape_name": "VersionLabel", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\n\n If specified, AWS Elastic Beanstalk\n restricts the returned descriptions to\n include only those that are\n associated with this application version.\n
\n " }, "EnvironmentIds": { "shape_name": "EnvironmentIdList", "type": "list", "members": { "shape_name": "EnvironmentId", "type": "string", "documentation": null }, "documentation": "\n\n If specified, AWS Elastic Beanstalk\n restricts the returned descriptions to\n include only those that have the\n specified IDs.\n
\n " }, "EnvironmentNames": { "shape_name": "EnvironmentNamesList", "type": "list", "members": { "shape_name": "EnvironmentName", "type": "string", "min_length": 4, "max_length": 23, "documentation": null }, "documentation": "\n\n If specified, AWS Elastic Beanstalk\n restricts the returned descriptions to\n include only those that have the\n specified names.\n
\n " }, "IncludeDeleted": { "shape_name": "IncludeDeleted", "type": "boolean", "documentation": "\nIndicates whether to include deleted environments:\n
\n\n true: Environments that have been deleted after\n IncludedDeletedBackTo\n are displayed.\n
\n false: Do not include deleted environments.\n
\n If specified when\n IncludeDeleted\n is set to\n true,\n then environments deleted after this date are displayed.\n
This documentation target is not reported in the API reference.
\n " }, "output": { "shape_name": "EnvironmentDescriptionsMessage", "type": "structure", "members": { "Environments": { "shape_name": "EnvironmentDescriptionsList", "type": "list", "members": { "shape_name": "EnvironmentDescription", "type": "structure", "members": { "EnvironmentName": { "shape_name": "EnvironmentName", "type": "string", "min_length": 4, "max_length": 23, "documentation": "\nThe name of this environment.
\n " }, "EnvironmentId": { "shape_name": "EnvironmentId", "type": "string", "documentation": "\n\n The ID of this environment.\n
\n " }, "ApplicationName": { "shape_name": "ApplicationName", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\nThe name of the application associated with this environment.
\n " }, "VersionLabel": { "shape_name": "VersionLabel", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\nThe application version deployed in this environment.
\n " }, "SolutionStackName": { "shape_name": "SolutionStackName", "type": "string", "max_length": 100, "documentation": "\n\n The name of the\n SolutionStack\n deployed with this environment.\n
\n The name of the configuration template used to\n originally launch this\n environment.\n
\n " }, "Description": { "shape_name": "Description", "type": "string", "max_length": 200, "documentation": "\nDescribes this environment.
\n " }, "EndpointURL": { "shape_name": "EndpointURL", "type": "string", "documentation": "\nFor load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.
\n " }, "CNAME": { "shape_name": "DNSCname", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n\n The URL to the CNAME for this environment.\n
\n " }, "DateCreated": { "shape_name": "CreationDate", "type": "timestamp", "documentation": "\nThe creation date for this environment.
\n " }, "DateUpdated": { "shape_name": "UpdateDate", "type": "timestamp", "documentation": "\nThe last modified date for this environment.
\n " }, "Status": { "shape_name": "EnvironmentStatus", "type": "string", "enum": [ "Launching", "Updating", "Ready", "Terminating", "Terminated" ], "documentation": "\n\n The current operational status of the environment:\n\t\t
\n\nLaunching: Environment is in the process of\n initial deployment.\n Updating: Environment is in the process of\n updating its configuration settings or\n application version.\n Ready: Environment is available to have an action\n performed on it, such as update or terminate.\n Terminating: Environment is in the shut-down process.\n Terminated: Environment is not running.\n \n Describes the health status of the environment. \n\t\t\tAWS Elastic Beanstalk\n indicates the failure levels for a running environment:\n
\n\n Red\n : Indicates the environment is not working.\n
\n Yellow: Indicates that something is wrong, the application\n might not be available, but the instances appear running.\n
\n Green: Indicates the environment is\n healthy and fully functional.\n
Red: Indicates the environment is not responsive. Occurs when three or\n more\n consecutive failures occur for an environment.\n Yellow: Indicates that something is wrong. Occurs when two\n consecutive failures occur for an environment.\n Green: Indicates the environment is\n healthy and fully functional.\n Grey: Default health for a new environment. The environment\n is not fully launched and health checks have not started or health checks\n are suspended during an\n UpdateEnvironment\n or\n RestartEnvironement\n request.\n \n Default: Grey\n
The name of the LoadBalancer.
\n " }, "Domain": { "shape_name": "String", "type": "string", "documentation": "\nThe domain name of the LoadBalancer.
\n " }, "Listeners": { "shape_name": "LoadBalancerListenersDescription", "type": "list", "members": { "shape_name": "Listener", "type": "structure", "members": { "Protocol": { "shape_name": "String", "type": "string", "documentation": "\nThe protocol that is used by the Listener.
\n " }, "Port": { "shape_name": "Integer", "type": "integer", "documentation": "\nThe port that is used by the Listener.
\n " } }, "documentation": "\nDescribes the properties of a Listener for the LoadBalancer.
\n " }, "documentation": "\nA list of Listeners used by the LoadBalancer.
\n " } }, "documentation": "\nDescribes the LoadBalancer.
\n " } }, "documentation": "\nThe description of the AWS resources used by this environment.
\n " }, "Tier": { "shape_name": "EnvironmentTier", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\nThe name of this environment tier.
\n " }, "Type": { "shape_name": "String", "type": "string", "documentation": "\nThe type of this environment tier.
\n " }, "Version": { "shape_name": "String", "type": "string", "documentation": "\nThe version of this environment tier.
\n " } }, "documentation": "\nDescribes the current tier of this environment.
\n " } }, "documentation": "\nDescribes the properties of an environment.
\n\n\n " }, "documentation": "\n\n Returns an EnvironmentDescription list.\n
\n " } }, "documentation": "\nResult message containing a list of environment descriptions.
\n " }, "errors": [], "documentation": "\nReturns descriptions for existing environments.
\n\n\n If specified, AWS Elastic Beanstalk\n restricts the returned descriptions to\n include only those associated\n with this application.\n
\n " }, "VersionLabel": { "shape_name": "VersionLabel", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\n\n If specified, AWS Elastic Beanstalk\n restricts the returned descriptions to\n those associated with this\n application version.\n
\n " }, "TemplateName": { "shape_name": "ConfigurationTemplateName", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\n\n If specified, AWS Elastic Beanstalk\n restricts the returned descriptions to\n those that are associated with\n this environment\n configuration.\n
\n " }, "EnvironmentId": { "shape_name": "EnvironmentId", "type": "string", "documentation": "\n\n If specified, AWS Elastic Beanstalk\n restricts the returned descriptions to\n those associated with this\n environment.\n
\n " }, "EnvironmentName": { "shape_name": "EnvironmentName", "type": "string", "min_length": 4, "max_length": 23, "documentation": "\n\n If specified, AWS Elastic Beanstalk\n restricts the returned descriptions to\n those associated with this\n environment.\n
\n " }, "RequestId": { "shape_name": "RequestId", "type": "string", "documentation": "\n\n If specified, AWS Elastic Beanstalk\n restricts the described events to include only those\n associated with this request ID.\n
\n " }, "Severity": { "shape_name": "EventSeverity", "type": "string", "enum": [ "TRACE", "DEBUG", "INFO", "WARN", "ERROR", "FATAL" ], "documentation": "\n\n If specified, limits the events returned from this call to include only those\n with the\n specified severity or higher.\n\t\t
\n " }, "StartTime": { "shape_name": "TimeFilterStart", "type": "timestamp", "documentation": "\n\n If specified, AWS Elastic Beanstalk\n restricts the returned descriptions to\n those that occur on or after this\n time.\n
\n " }, "EndTime": { "shape_name": "TimeFilterEnd", "type": "timestamp", "documentation": "\n\n If specified, AWS Elastic Beanstalk\n restricts the returned descriptions to\n those that occur up to, but not including, the\n EndTime.\n
\n Specifies the maximum number of events that can be returned, beginning with the most recent event.\n\t\t
\n " }, "NextToken": { "shape_name": "Token", "type": "string", "documentation": "\n\n Pagination token. If specified, the events return the next batch of results.\n\t\t
\n " } }, "documentation": "\nThis documentation target is not reported in the API reference.
\n " }, "output": { "shape_name": "EventDescriptionsMessage", "type": "structure", "members": { "Events": { "shape_name": "EventDescriptionList", "type": "list", "members": { "shape_name": "EventDescription", "type": "structure", "members": { "EventDate": { "shape_name": "EventDate", "type": "timestamp", "documentation": "\nThe date when the event occurred.
\n " }, "Message": { "shape_name": "EventMessage", "type": "string", "documentation": "\nThe event message.
\n " }, "ApplicationName": { "shape_name": "ApplicationName", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\nThe application associated with the event.
\n " }, "VersionLabel": { "shape_name": "VersionLabel", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\nThe release label for the application version associated with this\n event.
\n " }, "TemplateName": { "shape_name": "ConfigurationTemplateName", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\nThe name of the configuration associated with this event.
\n " }, "EnvironmentName": { "shape_name": "EnvironmentName", "type": "string", "min_length": 4, "max_length": 23, "documentation": "\nThe name of the environment associated with this event.
\n " }, "RequestId": { "shape_name": "RequestId", "type": "string", "documentation": "\nThe web service request ID for the activity of this event.
\n " }, "Severity": { "shape_name": "EventSeverity", "type": "string", "enum": [ "TRACE", "DEBUG", "INFO", "WARN", "ERROR", "FATAL" ], "documentation": "\nThe severity level of this event.
\n " } }, "documentation": "\nDescribes an event.
\n " }, "documentation": "\n\n A list of\n EventDescription.\n
\n " }, "NextToken": { "shape_name": "Token", "type": "string", "documentation": "\n\n If returned, this indicates that there are more results to obtain.\n Use this token in the next\n DescribeEvents\n call to\n get the next batch of events.\n
\n " } }, "documentation": "\nResult message wrapping a list of event descriptions.
\n " }, "errors": [], "documentation": "\nReturns list of event descriptions matching criteria up to the last 6 weeks.
\nNextToken.\n \n A list of available solution stacks.\n\t\t
\n " }, "SolutionStackDetails": { "shape_name": "AvailableSolutionStackDetailsList", "type": "list", "members": { "shape_name": "SolutionStackDescription", "type": "structure", "members": { "SolutionStackName": { "shape_name": "SolutionStackName", "type": "string", "max_length": 100, "documentation": "\n\n The name of the solution stack.\n
\n " }, "PermittedFileTypes": { "shape_name": "SolutionStackFileTypeList", "type": "list", "members": { "shape_name": "FileTypeExtension", "type": "string", "min_length": 1, "max_length": 100, "documentation": null }, "documentation": "\n\n The permitted file types allowed for a solution stack.\n
\n " } }, "documentation": "\nDescribes the solution stack.\n
\n " }, "documentation": "\n\n A list of available solution stacks and their SolutionStackDescription.\n
\n " } }, "documentation": "\nA\n list of available AWS Elastic Beanstalk\n solution stacks.\n
\n " }, "errors": [], "documentation": "\n\n Returns a list of the available solution stack names.\n\t\t
\n\n\n The ID of the environment to rebuild.\n
\n\n Condition: You must specify either this or an EnvironmentName, or both. \n If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.\n\t\t
\n The name of the environment to rebuild.\n\t\t
\n\t\t\n Condition: You must specify either this or an EnvironmentId, or both. \n If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.\n\t\t
Unable to perform the specified operation because the user does not have enough privileges for one of more downstream aws services
\n " } ], "documentation": "\n\n Deletes and recreates all of the AWS resources (for example: the Auto Scaling group, load\n balancer, etc.)\n for a specified environment and forces a restart. \n\t\t
\n\nThe ID of the environment of the requested data.
\n\n If no such environment is found, RequestEnvironmentInfo returns an\n InvalidParameterValue\n error.\n
\n Condition: You must specify either this or an EnvironmentName, or both. \n If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.\n\t\t
The name of the environment of the requested data.
\n\n If no such environment is found, RequestEnvironmentInfo returns an\n InvalidParameterValue\n error.\n
\n Condition: You must specify either this or an EnvironmentId, or both. \n If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.\n\t\t
\n The type of information to request. \n
\n ", "required": true } }, "documentation": "\nThis documentation target is not reported in the API reference.
\n " }, "output": null, "errors": [], "documentation": "\n\n Initiates a request to compile the specified type of\n information of the deployed environment.\n
\n\n\n Setting the InfoType to tail\n compiles the last lines from the application server log files of every\n Amazon EC2 instance in your environment. Use RetrieveEnvironmentInfo\n to access the compiled information.\n
Related Topics
\n\n The ID of the environment to restart the server for.\n\t\t
\n\t\t\n Condition: You must specify either this or an EnvironmentName, or both. \n If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.\n\t\t
\n The name of the environment to restart the server for.\n\t\t
\n\t\t\n Condition: You must specify either this or an EnvironmentId, or both. \n If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.\n\t\t
\n Causes the environment to restart the application\n container server running on each Amazon EC2 instance. \n\t\t
\n\nThe ID of the data's environment.
\n\n If no such environment is found, returns an\n InvalidParameterValue\n error.\n
\n Condition: You must specify either this or an EnvironmentName, or both. \n If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.\n\t\t
The name of the data's environment.
\n\n If no such environment is found, returns an\n InvalidParameterValue\n error.\n
\n Condition: You must specify either this or an EnvironmentId, or both. \n If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.\n\t\t
\n The type of information to retrieve. \n
\n ", "required": true } }, "documentation": "\nThis documentation target is not reported in the API reference.
\n " }, "output": { "shape_name": "RetrieveEnvironmentInfoResultMessage", "type": "structure", "members": { "EnvironmentInfo": { "shape_name": "EnvironmentInfoDescriptionList", "type": "list", "members": { "shape_name": "EnvironmentInfoDescription", "type": "structure", "members": { "InfoType": { "shape_name": "EnvironmentInfoType", "type": "string", "enum": [ "tail" ], "documentation": "\nThe type of information retrieved.
\n " }, "Ec2InstanceId": { "shape_name": "Ec2InstanceId", "type": "string", "documentation": "\nThe Amazon EC2 Instance ID for this information.
\n " }, "SampleTimestamp": { "shape_name": "SampleTimestamp", "type": "timestamp", "documentation": "\nThe time stamp when this information was retrieved.
\n " }, "Message": { "shape_name": "Message", "type": "string", "documentation": "\nThe retrieved information.
\n " } }, "documentation": "\nThe information retrieved from the Amazon EC2 instances.
\n " }, "documentation": "\n\n The\n EnvironmentInfoDescription\n of the environment.\n
\n " } }, "documentation": "\nResult message containing a description of the requested environment\n info.
\n " }, "errors": [], "documentation": "\n\n Retrieves the compiled information from a\n RequestEnvironmentInfo\n request.\n
\nRelated Topics
\n\n The ID of the source environment.\n
\n\n Condition: You must specify at least the SourceEnvironmentID or the SourceEnvironmentName. \n You may also specify both.\n If you specify the SourceEnvironmentId, you must specify the DestinationEnvironmentId.\n
\n The name of the source environment.\n
\n\n Condition: You must specify at least the SourceEnvironmentID or the SourceEnvironmentName. \n You may also specify both.\n If you specify the SourceEnvironmentName, you must specify the DestinationEnvironmentName.\n
\n The ID of the destination environment.\n
\n\n Condition: You must specify at least the DestinationEnvironmentID or the DestinationEnvironmentName. \n You may also specify both.\n You must specify the SourceEnvironmentId with the DestinationEnvironmentId.\n
\n The name of the destination environment.\n
\n\n Condition: You must specify at least the DestinationEnvironmentID or the DestinationEnvironmentName. \n You may also specify both. You must specify the SourceEnvironmentName with the DestinationEnvironmentName.\n
\n Swaps the CNAMEs of two environments. \n
\n \nThe ID of the environment to terminate.
\n\n Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.\n\t\t
The name of the environment to terminate.
\n\n Condition: You must specify either this or an EnvironmentId, or both. \n If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.\n\t\t
\n Indicates whether the associated AWS resources should shut down\n when the environment is terminated:\n\t\t
\n\n true: (default) The user AWS resources\n (for example, the Auto Scaling group, LoadBalancer, etc.) are terminated\n along with the environment.\n
\n false:\n The environment is removed from the\n\t\t\t\t\tAWS Elastic Beanstalk\n but the AWS resources continue to operate.\n\n
true: The specified environment as well as the associated\n AWS resources, such as Auto Scaling group and LoadBalancer, are terminated.\n\n false: AWS Elastic Beanstalk\n resource management is removed from the\n environment, but the AWS resources continue to operate.\n \n For more information, see the\n \n AWS Elastic Beanstalk\n User Guide.\n \n
\n\n\n Default:\n true\n
\n Valid Values:\n true\n |\n false\n
This documentation target is not reported in the API reference.
\n " }, "output": { "shape_name": "EnvironmentDescription", "type": "structure", "members": { "EnvironmentName": { "shape_name": "EnvironmentName", "type": "string", "min_length": 4, "max_length": 23, "documentation": "\nThe name of this environment.
\n " }, "EnvironmentId": { "shape_name": "EnvironmentId", "type": "string", "documentation": "\n\n The ID of this environment.\n
\n " }, "ApplicationName": { "shape_name": "ApplicationName", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\nThe name of the application associated with this environment.
\n " }, "VersionLabel": { "shape_name": "VersionLabel", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\nThe application version deployed in this environment.
\n " }, "SolutionStackName": { "shape_name": "SolutionStackName", "type": "string", "max_length": 100, "documentation": "\n\n The name of the\n SolutionStack\n deployed with this environment.\n
\n The name of the configuration template used to\n originally launch this\n environment.\n
\n " }, "Description": { "shape_name": "Description", "type": "string", "max_length": 200, "documentation": "\nDescribes this environment.
\n " }, "EndpointURL": { "shape_name": "EndpointURL", "type": "string", "documentation": "\nFor load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.
\n " }, "CNAME": { "shape_name": "DNSCname", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n\n The URL to the CNAME for this environment.\n
\n " }, "DateCreated": { "shape_name": "CreationDate", "type": "timestamp", "documentation": "\nThe creation date for this environment.
\n " }, "DateUpdated": { "shape_name": "UpdateDate", "type": "timestamp", "documentation": "\nThe last modified date for this environment.
\n " }, "Status": { "shape_name": "EnvironmentStatus", "type": "string", "enum": [ "Launching", "Updating", "Ready", "Terminating", "Terminated" ], "documentation": "\n\n The current operational status of the environment:\n\t\t
\n\nLaunching: Environment is in the process of\n initial deployment.\n Updating: Environment is in the process of\n updating its configuration settings or\n application version.\n Ready: Environment is available to have an action\n performed on it, such as update or terminate.\n Terminating: Environment is in the shut-down process.\n Terminated: Environment is not running.\n \n Describes the health status of the environment. \n\t\t\tAWS Elastic Beanstalk\n indicates the failure levels for a running environment:\n
\n\n Red\n : Indicates the environment is not working.\n
\n Yellow: Indicates that something is wrong, the application\n might not be available, but the instances appear running.\n
\n Green: Indicates the environment is\n healthy and fully functional.\n
Red: Indicates the environment is not responsive. Occurs when three or\n more\n consecutive failures occur for an environment.\n Yellow: Indicates that something is wrong. Occurs when two\n consecutive failures occur for an environment.\n Green: Indicates the environment is\n healthy and fully functional.\n Grey: Default health for a new environment. The environment\n is not fully launched and health checks have not started or health checks\n are suspended during an\n UpdateEnvironment\n or\n RestartEnvironement\n request.\n \n Default: Grey\n
The name of the LoadBalancer.
\n " }, "Domain": { "shape_name": "String", "type": "string", "documentation": "\nThe domain name of the LoadBalancer.
\n " }, "Listeners": { "shape_name": "LoadBalancerListenersDescription", "type": "list", "members": { "shape_name": "Listener", "type": "structure", "members": { "Protocol": { "shape_name": "String", "type": "string", "documentation": "\nThe protocol that is used by the Listener.
\n " }, "Port": { "shape_name": "Integer", "type": "integer", "documentation": "\nThe port that is used by the Listener.
\n " } }, "documentation": "\nDescribes the properties of a Listener for the LoadBalancer.
\n " }, "documentation": "\nA list of Listeners used by the LoadBalancer.
\n " } }, "documentation": "\nDescribes the LoadBalancer.
\n " } }, "documentation": "\nThe description of the AWS resources used by this environment.
\n " }, "Tier": { "shape_name": "EnvironmentTier", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\nThe name of this environment tier.
\n " }, "Type": { "shape_name": "String", "type": "string", "documentation": "\nThe type of this environment tier.
\n " }, "Version": { "shape_name": "String", "type": "string", "documentation": "\nThe version of this environment tier.
\n " } }, "documentation": "\nDescribes the current tier of this environment.
\n " } }, "documentation": "\nDescribes the properties of an environment.
\n\n\n " }, "errors": [ { "shape_name": "InsufficientPrivilegesException", "type": "structure", "members": {}, "documentation": "\nUnable to perform the specified operation because the user does not have enough privileges for one of more downstream aws services
\n " } ], "documentation": "\n\n Terminates the specified environment.\n\t\t
\n\n\n The name of the application to update. If no such application\n is found, UpdateApplication returns an\n InvalidParameterValue\n error.\n
\n A new description for the application. \n
\nDefault:\n If not specified, AWS Elastic Beanstalk\n does not update the description.\n
\n " } }, "documentation": "\nThis documentation target is not reported in the API reference.
\n " }, "output": { "shape_name": "ApplicationDescriptionMessage", "type": "structure", "members": { "Application": { "shape_name": "ApplicationDescription", "type": "structure", "members": { "ApplicationName": { "shape_name": "ApplicationName", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\nThe name of the application.
\n " }, "Description": { "shape_name": "Description", "type": "string", "max_length": 200, "documentation": "\nUser-defined description of the application.
\n " }, "DateCreated": { "shape_name": "CreationDate", "type": "timestamp", "documentation": "\nThe date when the application was created.
\n " }, "DateUpdated": { "shape_name": "UpdateDate", "type": "timestamp", "documentation": "\nThe date when the application was last modified.
\n " }, "Versions": { "shape_name": "VersionLabelsList", "type": "list", "members": { "shape_name": "VersionLabel", "type": "string", "min_length": 1, "max_length": 100, "documentation": null }, "documentation": "\nThe names of the versions for this application.
\n " }, "ConfigurationTemplates": { "shape_name": "ConfigurationTemplateNamesList", "type": "list", "members": { "shape_name": "ConfigurationTemplateName", "type": "string", "min_length": 1, "max_length": 100, "documentation": null }, "documentation": "\n\n The names of the configuration templates associated with this\n application.\n\t
\n " } }, "documentation": "\n\n The\n ApplicationDescription\n of the application.\n
\n " } }, "documentation": "\nResult message containing a single description of an application.
\n " }, "errors": [], "documentation": "\nUpdates the specified application to have the specified\n properties.\t
\ndescription) is not provided, the\n value\n remains unchanged. To clear these properties, specify an empty string.\n \n The name of the application associated with this version.\n
\n\n If no application is found with this name, UpdateApplication returns an\n InvalidParameterValue\n error.\n
The name of the version to update.
\n\n If no application version is found with this label, UpdateApplication returns\n an\n InvalidParameterValue\n error.\n
A new description for this release.
\n " } }, "documentation": "\n \n " }, "output": { "shape_name": "ApplicationVersionDescriptionMessage", "type": "structure", "members": { "ApplicationVersion": { "shape_name": "ApplicationVersionDescription", "type": "structure", "members": { "ApplicationName": { "shape_name": "ApplicationName", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\nThe name of the application associated with this release.
\n " }, "Description": { "shape_name": "Description", "type": "string", "max_length": 200, "documentation": "\nThe description of this application version.
\n " }, "VersionLabel": { "shape_name": "VersionLabel", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\n\n A label uniquely identifying the version for the associated\n application.\n
\n " }, "SourceBundle": { "shape_name": "S3Location", "type": "structure", "members": { "S3Bucket": { "shape_name": "S3Bucket", "type": "string", "max_length": 255, "documentation": "\nThe Amazon S3 bucket where the data is located.
\n " }, "S3Key": { "shape_name": "S3Key", "type": "string", "max_length": 1024, "documentation": "\nThe Amazon S3 key where the data is located.
\n " } }, "documentation": "\n\n The location where the source bundle is located for this version.\n\t
\n " }, "DateCreated": { "shape_name": "CreationDate", "type": "timestamp", "documentation": "\nThe creation date of the application version.
\n " }, "DateUpdated": { "shape_name": "UpdateDate", "type": "timestamp", "documentation": "\nThe last modified date of the application version.
\n " } }, "documentation": "\n\n The\n ApplicationVersionDescription\n of the application version.\n
\n " } }, "documentation": "\n\n Result message wrapping a single description of an application\n version.\n
\n " }, "errors": [], "documentation": "\n\n Updates the specified application version to have the specified\n properties.\n \n
\n\ndescription) is not provided, the\n value remains unchanged. To clear properties,\n specify an empty string.\n The name of the application associated with the configuration template\n to update.
\n\n If no application is found with this name, UpdateConfigurationTemplate returns an\n InvalidParameterValue\n error.\n
The name of the configuration template to update.
\n\n If no configuration template is found with this name, UpdateConfigurationTemplate returns an\n InvalidParameterValue\n error.\n
A new description for the configuration.
\n " }, "OptionSettings": { "shape_name": "ConfigurationOptionSettingsList", "type": "list", "members": { "shape_name": "ConfigurationOptionSetting", "type": "structure", "members": { "Namespace": { "shape_name": "OptionNamespace", "type": "string", "documentation": "\n\n A unique namespace identifying the option's associated AWS resource.\n\t\t
\n " }, "OptionName": { "shape_name": "ConfigurationOptionName", "type": "string", "documentation": "\n\n The name of the configuration option. \n\t\t
\n " }, "Value": { "shape_name": "ConfigurationOptionValue", "type": "string", "documentation": "\n\n The current value for the configuration option.\n\t\t
\n " } }, "documentation": "\n\n A specification identifying an individual configuration option along with its\n current value. For a list of possible option values, go to Option Values in the \nAWS Elastic Beanstalk Developer Guide.\n\t\t
\n\n " }, "documentation": "\n\n A list of configuration option settings to update with the new specified\n option value.\n\t\t
\n " }, "OptionsToRemove": { "shape_name": "OptionsSpecifierList", "type": "list", "members": { "shape_name": "OptionSpecification", "type": "structure", "members": { "Namespace": { "shape_name": "OptionNamespace", "type": "string", "documentation": "\n\n A unique namespace identifying the option's associated AWS resource.\n\t\t
\n " }, "OptionName": { "shape_name": "ConfigurationOptionName", "type": "string", "documentation": "\n\n The name of the configuration option. \n\t\t
\n " } }, "documentation": "\n\n A specification identifying an individual configuration option.\n\t\t
\n " }, "documentation": "\n\n A list of configuration options to remove from the configuration set.\n\t\t
\n\n Constraint: You can remove only UserDefined\n configuration options.\n
The result message containing the options for the specified solution\n stack.
\n " }, "output": { "shape_name": "ConfigurationSettingsDescription", "type": "structure", "members": { "SolutionStackName": { "shape_name": "SolutionStackName", "type": "string", "max_length": 100, "documentation": "\n\n The name of the solution stack this configuration set uses.\n\t\t
\n " }, "ApplicationName": { "shape_name": "ApplicationName", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\n\n The name of the application associated with this configuration set.\n\t\t
\n " }, "TemplateName": { "shape_name": "ConfigurationTemplateName", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\n\n If not\n null, the name of the configuration template for this configuration set.\n
\n Describes this configuration set.\n\t\t
\n " }, "EnvironmentName": { "shape_name": "EnvironmentName", "type": "string", "min_length": 4, "max_length": 23, "documentation": "\n\n If not\n null, the name of the environment for this configuration set.\n
\n If this configuration set is associated with an environment, the \n DeploymentStatus parameter indicates\n the deployment status of this configuration set:\n\t\t
\n null: This configuration is not associated with a running\n environment.\n
\n pending: This is a draft configuration that is not deployed\n to the\n associated environment but is in the process of deploying.\n
\n deployed: This is the configuration that is currently deployed\n to the associated running environment.\n
\n failed: This is a draft configuration, that\n failed to successfully deploy.\n
null: This configuration is not associated with a running\n environment.\n pending: This is a draft configuration that is not deployed\n to the associated environment but is in the process of deploying.\n deployed: This is the configuration that is currently deployed\n to the associated running environment.\n failed: This is a draft configuration that failed to\n successfully deploy.\n \n The date (in UTC time) when this configuration set was created.\n\t\t
\n " }, "DateUpdated": { "shape_name": "UpdateDate", "type": "timestamp", "documentation": "\n\n The date (in UTC time) when this configuration set was last modified.\n\t\t
\n " }, "OptionSettings": { "shape_name": "ConfigurationOptionSettingsList", "type": "list", "members": { "shape_name": "ConfigurationOptionSetting", "type": "structure", "members": { "Namespace": { "shape_name": "OptionNamespace", "type": "string", "documentation": "\n\n A unique namespace identifying the option's associated AWS resource.\n\t\t
\n " }, "OptionName": { "shape_name": "ConfigurationOptionName", "type": "string", "documentation": "\n\n The name of the configuration option. \n\t\t
\n " }, "Value": { "shape_name": "ConfigurationOptionValue", "type": "string", "documentation": "\n\n The current value for the configuration option.\n\t\t
\n " } }, "documentation": "\n\n A specification identifying an individual configuration option along with its\n current value. For a list of possible option values, go to Option Values in the \nAWS Elastic Beanstalk Developer Guide.\n\t\t
\n\n " }, "documentation": "\n\n A list of the configuration options and their values in this configuration\n set.\n\t\t
\n " } }, "documentation": "\n\n Describes the settings for a configuration set.\n\t\t
\n\n " }, "errors": [ { "shape_name": "InsufficientPrivilegesException", "type": "structure", "members": {}, "documentation": "\nUnable to perform the specified operation because the user does not have enough privileges for one of more downstream aws services
\n " } ], "documentation": "\n\n Updates the specified configuration template to have the specified\n properties or configuration option values.\n\t
\nApplicationName) is not provided, its\n value remains unchanged. To clear such\n properties, specify an empty string.\n Related Topics
\nThe ID of the environment to update.
\n\n If no environment with this ID exists, AWS Elastic Beanstalk\n returns an\n InvalidParameterValue\n error.\n
\n Condition: You must specify either this or an EnvironmentName, or both. \n If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.\n\t\t
The\n name of the environment to update. If no environment with this name\n exists, \n AWS Elastic Beanstalk\n returns an\n InvalidParameterValue\n error.\n
\n Condition: You must specify either this or an EnvironmentId, or both. \n If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.\n\t\t
\n If this parameter is specified, AWS Elastic Beanstalk\n updates the description\n of this environment.\n
\n " }, "Tier": { "shape_name": "EnvironmentTier", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\nThe name of this environment tier.
\n " }, "Type": { "shape_name": "String", "type": "string", "documentation": "\nThe type of this environment tier.
\n " }, "Version": { "shape_name": "String", "type": "string", "documentation": "\nThe version of this environment tier.
\n " } }, "documentation": "\n\n This specifies the tier to use to update the environment.\n
\n\n Condition: You can only update the tier version for an environment. If you change the name of the type, \n AWS Elastic Beanstalk returns InvalidParameterValue error.\n
\n If this parameter is specified, AWS Elastic Beanstalk\n deploys the named\n application version to the environment. If no such\n application version is\n found, returns an\n InvalidParameterValue\n error.\n
\n If this parameter is specified, AWS Elastic Beanstalk\n deploys this\n configuration template to the environment. If no such\n configuration\n template is found, AWS Elastic Beanstalk\n returns an\n InvalidParameterValue\n error.\n
\n A unique namespace identifying the option's associated AWS resource.\n\t\t
\n " }, "OptionName": { "shape_name": "ConfigurationOptionName", "type": "string", "documentation": "\n\n The name of the configuration option. \n\t\t
\n " }, "Value": { "shape_name": "ConfigurationOptionValue", "type": "string", "documentation": "\n\n The current value for the configuration option.\n\t\t
\n " } }, "documentation": "\n\n A specification identifying an individual configuration option along with its\n current value. For a list of possible option values, go to Option Values in the \nAWS Elastic Beanstalk Developer Guide.\n\t\t
\n\n " }, "documentation": "\n\n If specified, AWS Elastic Beanstalk\n updates the configuration set associated with\n the running environment and sets the specified configuration options to\n the requested value.\n
\n " }, "OptionsToRemove": { "shape_name": "OptionsSpecifierList", "type": "list", "members": { "shape_name": "OptionSpecification", "type": "structure", "members": { "Namespace": { "shape_name": "OptionNamespace", "type": "string", "documentation": "\n\n A unique namespace identifying the option's associated AWS resource.\n\t\t
\n " }, "OptionName": { "shape_name": "ConfigurationOptionName", "type": "string", "documentation": "\n\n The name of the configuration option. \n\t\t
\n " } }, "documentation": "\n\n A specification identifying an individual configuration option.\n\t\t
\n " }, "documentation": "\n\n A list of custom user-defined configuration options to remove from the\n configuration set for this environment.\n\t\t
\n " } }, "documentation": "\n\nThis documentation target is not reported in the API reference.
\n " }, "output": { "shape_name": "EnvironmentDescription", "type": "structure", "members": { "EnvironmentName": { "shape_name": "EnvironmentName", "type": "string", "min_length": 4, "max_length": 23, "documentation": "\nThe name of this environment.
\n " }, "EnvironmentId": { "shape_name": "EnvironmentId", "type": "string", "documentation": "\n\n The ID of this environment.\n
\n " }, "ApplicationName": { "shape_name": "ApplicationName", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\nThe name of the application associated with this environment.
\n " }, "VersionLabel": { "shape_name": "VersionLabel", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\nThe application version deployed in this environment.
\n " }, "SolutionStackName": { "shape_name": "SolutionStackName", "type": "string", "max_length": 100, "documentation": "\n\n The name of the\n SolutionStack\n deployed with this environment.\n
\n The name of the configuration template used to\n originally launch this\n environment.\n
\n " }, "Description": { "shape_name": "Description", "type": "string", "max_length": 200, "documentation": "\nDescribes this environment.
\n " }, "EndpointURL": { "shape_name": "EndpointURL", "type": "string", "documentation": "\nFor load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.
\n " }, "CNAME": { "shape_name": "DNSCname", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n\n The URL to the CNAME for this environment.\n
\n " }, "DateCreated": { "shape_name": "CreationDate", "type": "timestamp", "documentation": "\nThe creation date for this environment.
\n " }, "DateUpdated": { "shape_name": "UpdateDate", "type": "timestamp", "documentation": "\nThe last modified date for this environment.
\n " }, "Status": { "shape_name": "EnvironmentStatus", "type": "string", "enum": [ "Launching", "Updating", "Ready", "Terminating", "Terminated" ], "documentation": "\n\n The current operational status of the environment:\n\t\t
\n\nLaunching: Environment is in the process of\n initial deployment.\n Updating: Environment is in the process of\n updating its configuration settings or\n application version.\n Ready: Environment is available to have an action\n performed on it, such as update or terminate.\n Terminating: Environment is in the shut-down process.\n Terminated: Environment is not running.\n \n Describes the health status of the environment. \n\t\t\tAWS Elastic Beanstalk\n indicates the failure levels for a running environment:\n
\n\n Red\n : Indicates the environment is not working.\n
\n Yellow: Indicates that something is wrong, the application\n might not be available, but the instances appear running.\n
\n Green: Indicates the environment is\n healthy and fully functional.\n
Red: Indicates the environment is not responsive. Occurs when three or\n more\n consecutive failures occur for an environment.\n Yellow: Indicates that something is wrong. Occurs when two\n consecutive failures occur for an environment.\n Green: Indicates the environment is\n healthy and fully functional.\n Grey: Default health for a new environment. The environment\n is not fully launched and health checks have not started or health checks\n are suspended during an\n UpdateEnvironment\n or\n RestartEnvironement\n request.\n \n Default: Grey\n
The name of the LoadBalancer.
\n " }, "Domain": { "shape_name": "String", "type": "string", "documentation": "\nThe domain name of the LoadBalancer.
\n " }, "Listeners": { "shape_name": "LoadBalancerListenersDescription", "type": "list", "members": { "shape_name": "Listener", "type": "structure", "members": { "Protocol": { "shape_name": "String", "type": "string", "documentation": "\nThe protocol that is used by the Listener.
\n " }, "Port": { "shape_name": "Integer", "type": "integer", "documentation": "\nThe port that is used by the Listener.
\n " } }, "documentation": "\nDescribes the properties of a Listener for the LoadBalancer.
\n " }, "documentation": "\nA list of Listeners used by the LoadBalancer.
\n " } }, "documentation": "\nDescribes the LoadBalancer.
\n " } }, "documentation": "\nThe description of the AWS resources used by this environment.
\n " }, "Tier": { "shape_name": "EnvironmentTier", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\nThe name of this environment tier.
\n " }, "Type": { "shape_name": "String", "type": "string", "documentation": "\nThe type of this environment tier.
\n " }, "Version": { "shape_name": "String", "type": "string", "documentation": "\nThe version of this environment tier.
\n " } }, "documentation": "\nDescribes the current tier of this environment.
\n " } }, "documentation": "\nDescribes the properties of an environment.
\n\n\n " }, "errors": [ { "shape_name": "InsufficientPrivilegesException", "type": "structure", "members": {}, "documentation": "\nUnable to perform the specified operation because the user does not have enough privileges for one of more downstream aws services
\n " } ], "documentation": "\n\n Updates the environment description, deploys a new application\n version, updates the configuration settings to an entirely new configuration\n template, or updates select configuration option values in the running\n environment.\n\t\t
\n\n Attempting to update both the release and configuration is\n not allowed and AWS Elastic Beanstalk\n returns an\n InvalidParameterCombination\n error.\n
\n When updating the configuration settings to a new template or\n individual settings,\n a draft configuration is created and\n DescribeConfigurationSettings\n for this\n environment returns two setting descriptions with different\n DeploymentStatus\n values.\n
\n The name of the application that the configuration template or environment\n belongs to.\n\t\t
\n ", "required": true }, "TemplateName": { "shape_name": "ConfigurationTemplateName", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\n\n The name of the configuration template to validate the settings against.\n\t\t
\n\n Condition: You cannot specify both this and an environment name.\n\t\t
\n " }, "EnvironmentName": { "shape_name": "EnvironmentName", "type": "string", "min_length": 4, "max_length": 23, "documentation": "\n\n The name of the environment to validate the settings against.\n\t\t
\n\n Condition: You cannot specify both this and a configuration template name.\n\t\t
\n " }, "OptionSettings": { "shape_name": "ConfigurationOptionSettingsList", "type": "list", "members": { "shape_name": "ConfigurationOptionSetting", "type": "structure", "members": { "Namespace": { "shape_name": "OptionNamespace", "type": "string", "documentation": "\n\n A unique namespace identifying the option's associated AWS resource.\n\t\t
\n " }, "OptionName": { "shape_name": "ConfigurationOptionName", "type": "string", "documentation": "\n\n The name of the configuration option. \n\t\t
\n " }, "Value": { "shape_name": "ConfigurationOptionValue", "type": "string", "documentation": "\n\n The current value for the configuration option.\n\t\t
\n " } }, "documentation": "\n\n A specification identifying an individual configuration option along with its\n current value. For a list of possible option values, go to Option Values in the \nAWS Elastic Beanstalk Developer Guide.\n\t\t
\n\n " }, "documentation": "\n\n A list of the options and desired values to evaluate.\n\t\t
\n ", "required": true } }, "documentation": "\nA list of validation messages for a specified configuration template.\n
\n " }, "output": { "shape_name": "ConfigurationSettingsValidationMessages", "type": "structure", "members": { "Messages": { "shape_name": "ValidationMessagesList", "type": "list", "members": { "shape_name": "ValidationMessage", "type": "structure", "members": { "Message": { "shape_name": "ValidationMessageString", "type": "string", "documentation": "\n\n A message describing the error or warning.\n\t\t
\n " }, "Severity": { "shape_name": "ValidationSeverity", "type": "string", "enum": [ "error", "warning" ], "documentation": "\n\n An indication of the severity of this message:\n\t\t
\n\n error: This message indicates that this is not a valid setting for an option.\n
\n\n warning: This message is providing information you should take into\n account.\n\t\t\t\t
\n\n An error or warning for a desired configuration option value.\n\t\t
\n " }, "documentation": "\n\n A list of\n ValidationMessage.\n
\n " } }, "documentation": "\nProvides a list of validation messages.
\n " }, "errors": [ { "shape_name": "InsufficientPrivilegesException", "type": "structure", "members": {}, "documentation": "\nUnable to perform the specified operation because the user does not have enough privileges for one of more downstream aws services
\n " } ], "documentation": "\n\n Takes a set of configuration settings and either a configuration\n template or environment, and determines whether those values are valid.\n\t\t
\n\n This action returns a list of messages indicating any errors or warnings\n associated\n with the selection of option values.\n\t\t
\n