{
"version": "2.0",
"service": "
AWS Elastic Beanstalk makes it easy for you to create, deploy, and manage scalable, fault-tolerant applications running on the Amazon Web Services cloud.
For more information about this product, go to the AWS Elastic Beanstalk details page. The location of the latest AWS Elastic Beanstalk WSDL is http://elasticbeanstalk.s3.amazonaws.com/doc/2010-12-01/AWSElasticBeanstalk.wsdl. To install the Software Development Kits (SDKs), Integrated Development Environment (IDE) Toolkits, and command line tools that enable you to access the API, go to Tools for Amazon Web Services.
Endpoints
For a list of region-specific endpoints that AWS Elastic Beanstalk supports, go to Regions and Endpoints in the Amazon Web Services Glossary.
", "operations": { "AbortEnvironmentUpdate": "Cancels in-progress environment configuration update or application version deployment.
", "ApplyEnvironmentManagedAction": "Applies a scheduled managed action immediately. A managed action can be applied only if its status is Scheduled
. Get the status and action ID of a managed action with DescribeEnvironmentManagedActions.
Checks if the specified CNAME is available.
", "ComposeEnvironments": "Create or update a group of environments that each run a separate component of a single application. Takes a list of version labels that specify application source bundles for each of the environments to create or update. The name of each environment and other required information must be included in the source bundles in an environment manifest named env.yaml
. See Compose Environments for details.
Creates an application that has one configuration template named default
and no application versions.
Creates an application version for the specified application. You can create an application version from a source bundle in Amazon S3, a commit in AWS CodeCommit, or the output of an AWS CodeBuild build as follows:
Specify a commit in an AWS CodeCommit repository with SourceBuildInformation
.
Specify a build in an AWS CodeBuild with SourceBuildInformation
and BuildConfiguration
.
Specify a source bundle in S3 with SourceBundle
Omit both SourceBuildInformation
and SourceBundle
to use the default sample application.
Once you create an application version with a specified Amazon S3 bucket and key location, you cannot change that Amazon S3 location. If you change the Amazon S3 location, you receive an exception when you attempt to launch an environment from the application version.
Creates a configuration template. Templates are associated with a specific application and are used to deploy different versions of the application with the same configuration settings.
Related Topics
", "CreateEnvironment": "Launches an environment for the specified application using the specified configuration.
", "CreatePlatformVersion": "Create a new version of your custom platform.
", "CreateStorageLocation": "Creates the Amazon S3 storage location for the account.
This location is used to store user log files.
", "DeleteApplication": "Deletes the specified application along with all associated versions and configurations. The application versions will not be deleted from your Amazon S3 bucket.
You cannot delete an application that has a running environment.
Deletes the specified version from the specified application.
You cannot delete an application version that is associated with a running environment.
Deletes the specified configuration template.
When you launch an environment using a configuration template, the environment gets a copy of the template. You can delete or modify the environment's copy of the template without affecting the running environment.
Deletes the draft configuration associated with the running environment.
Updating a running environment with any configuration changes creates a draft configuration set. You can get the draft configuration using DescribeConfigurationSettings while the update is in progress or if the update fails. The DeploymentStatus
for the draft configuration indicates whether the deployment is in process or has failed. The draft configuration remains in existence until it is deleted with this action.
Deletes the specified version of a custom platform.
", "DescribeApplicationVersions": "Retrieve a list of application versions.
", "DescribeApplications": "Returns the descriptions of existing applications.
", "DescribeConfigurationOptions": "Describes the configuration options that are used in a particular configuration template or environment, or that a specified solution stack defines. The description includes the values the options, their default values, and an indication of the required action on a running environment if an option value is changed.
", "DescribeConfigurationSettings": "Returns a description of the settings for the specified configuration set, that is, either a configuration template or the configuration set associated with a running environment.
When describing the settings for the configuration set associated with a running environment, it is possible to receive two sets of setting descriptions. One is the deployed configuration set, and the other is a draft configuration of an environment that is either in the process of deployment or that failed to deploy.
Related Topics
", "DescribeEnvironmentHealth": "Returns information about the overall health of the specified environment. The DescribeEnvironmentHealth operation is only available with AWS Elastic Beanstalk Enhanced Health.
", "DescribeEnvironmentManagedActionHistory": "Lists an environment's completed and failed managed actions.
", "DescribeEnvironmentManagedActions": "Lists an environment's upcoming and in-progress managed actions.
", "DescribeEnvironmentResources": "Returns AWS resources for this environment.
", "DescribeEnvironments": "Returns descriptions for existing environments.
", "DescribeEvents": "Returns list of event descriptions matching criteria up to the last 6 weeks.
This action returns the most recent 1,000 events from the specified NextToken
.
Retrives detailed information about the health of instances in your AWS Elastic Beanstalk. This operation requires enhanced health reporting.
", "DescribePlatformVersion": "Describes the version of the platform.
", "ListAvailableSolutionStacks": "Returns a list of the available solution stack names, with the public version first and then in reverse chronological order.
", "ListPlatformVersions": "Lists the available platforms.
", "ListTagsForResource": "Returns the tags applied to an AWS Elastic Beanstalk resource. The response contains a list of tag key-value pairs.
Currently, Elastic Beanstalk only supports tagging Elastic Beanstalk environments.
", "RebuildEnvironment": "Deletes and recreates all of the AWS resources (for example: the Auto Scaling group, load balancer, etc.) for a specified environment and forces a restart.
", "RequestEnvironmentInfo": "Initiates a request to compile the specified type of information of the deployed environment.
Setting the InfoType
to tail
compiles the last lines from the application server log files of every Amazon EC2 instance in your environment.
Setting the InfoType
to bundle
compresses the application server log files for every Amazon EC2 instance into a .zip
file. Legacy and .NET containers do not support bundle logs.
Use RetrieveEnvironmentInfo to obtain the set of logs.
Related Topics
", "RestartAppServer": "Causes the environment to restart the application container server running on each Amazon EC2 instance.
", "RetrieveEnvironmentInfo": "Retrieves the compiled information from a RequestEnvironmentInfo request.
Related Topics
", "SwapEnvironmentCNAMEs": "Swaps the CNAMEs of two environments.
", "TerminateEnvironment": "Terminates the specified environment.
", "UpdateApplication": "Updates the specified application to have the specified properties.
If a property (for example, description
) is not provided, the value remains unchanged. To clear these properties, specify an empty string.
Modifies lifecycle settings for an application.
", "UpdateApplicationVersion": "Updates the specified application version to have the specified properties.
If a property (for example, description
) is not provided, the value remains unchanged. To clear properties, specify an empty string.
Updates the specified configuration template to have the specified properties or configuration option values.
If a property (for example, ApplicationName
) is not provided, its value remains unchanged. To clear such properties, specify an empty string.
Related Topics
", "UpdateEnvironment": "Updates the environment description, deploys a new application version, updates the configuration settings to an entirely new configuration template, or updates select configuration option values in the running environment.
Attempting to update both the release and configuration is not allowed and AWS Elastic Beanstalk returns an InvalidParameterCombination
error.
When updating the configuration settings to a new template or individual settings, a draft configuration is created and DescribeConfigurationSettings for this environment returns two setting descriptions with different DeploymentStatus
values.
Update the list of tags applied to an AWS Elastic Beanstalk resource. Two lists can be passed: TagsToAdd
for tags to add or update, and TagsToRemove
.
Currently, Elastic Beanstalk only supports tagging of Elastic Beanstalk environments.
", "ValidateConfigurationSettings": "Takes a set of configuration settings and either a configuration template or environment, and determines whether those values are valid.
This action returns a list of messages indicating any errors or warnings associated with the selection of option values.
" }, "shapes": { "ARN": { "base": null, "refs": { "Builder$ARN": "The ARN of the builder.
" } }, "AbortEnvironmentUpdateMessage": { "base": "", "refs": { } }, "AbortableOperationInProgress": { "base": null, "refs": { "EnvironmentDescription$AbortableOperationInProgress": "Indicates if there is an in-progress environment configuration update or application version deployment that you can cancel.
true:
There is an update in progress.
false:
There are no updates currently in progress.
The status of the action.
" } }, "ActionStatus": { "base": null, "refs": { "DescribeEnvironmentManagedActionsRequest$Status": "To show only actions with a particular status, specify a status.
", "ManagedAction$Status": "The status of the managed action. If the action is Scheduled
, you can apply it immediately with ApplyEnvironmentManagedAction.
The type of managed action.
", "ManagedAction$ActionType": "The type of managed action.
", "ManagedActionHistoryItem$ActionType": "The type of the managed action.
" } }, "ApplicationDescription": { "base": "Describes the properties of an application.
", "refs": { "ApplicationDescriptionList$member": null, "ApplicationDescriptionMessage$Application": "The ApplicationDescription of the application.
" } }, "ApplicationDescriptionList": { "base": null, "refs": { "ApplicationDescriptionsMessage$Applications": "This parameter contains a list of ApplicationDescription.
" } }, "ApplicationDescriptionMessage": { "base": "Result message containing a single description of an application.
", "refs": { } }, "ApplicationDescriptionsMessage": { "base": "Result message containing a list of application descriptions.
", "refs": { } }, "ApplicationMetrics": { "base": "Application request metrics for an AWS Elastic Beanstalk environment.
", "refs": { "DescribeEnvironmentHealthResult$ApplicationMetrics": "Application request metrics for the environment.
", "SingleInstanceHealth$ApplicationMetrics": "Request metrics from your application.
" } }, "ApplicationName": { "base": null, "refs": { "ApplicationDescription$ApplicationName": "The name of the application.
", "ApplicationNamesList$member": null, "ApplicationResourceLifecycleDescriptionMessage$ApplicationName": "The name of the application.
", "ApplicationVersionDescription$ApplicationName": "The name of the application to which the application version belongs.
", "ComposeEnvironmentsMessage$ApplicationName": "The name of the application to which the specified source bundles belong.
", "ConfigurationSettingsDescription$ApplicationName": "The name of the application associated with this configuration set.
", "CreateApplicationMessage$ApplicationName": "The name of the application.
Constraint: This name must be unique within your account. If the specified name already exists, the action returns an InvalidParameterValue
error.
The name of the application. If no application is found with this name, and AutoCreateApplication
is false
, returns an InvalidParameterValue
error.
The name of the application to associate with this configuration template. If no application is found with this name, AWS Elastic Beanstalk returns an InvalidParameterValue
error.
The name of the application that contains the version to be deployed.
If no application is found with this name, CreateEnvironment
returns an InvalidParameterValue
error.
The name of the application to delete.
", "DeleteApplicationVersionMessage$ApplicationName": "The name of the application to which the version belongs.
", "DeleteConfigurationTemplateMessage$ApplicationName": "The name of the application to delete the configuration template from.
", "DeleteEnvironmentConfigurationMessage$ApplicationName": "The name of the application the environment is associated with.
", "DescribeApplicationVersionsMessage$ApplicationName": "Specify an application name to show only application versions for that application.
", "DescribeConfigurationOptionsMessage$ApplicationName": "The name of the application associated with the configuration template or environment. Only needed if you want to describe the configuration options associated with either the configuration template or environment.
", "DescribeConfigurationSettingsMessage$ApplicationName": "The application for the environment or configuration template.
", "DescribeEnvironmentsMessage$ApplicationName": "If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.
", "DescribeEventsMessage$ApplicationName": "If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those associated with this application.
", "EnvironmentDescription$ApplicationName": "The name of the application associated with this environment.
", "EventDescription$ApplicationName": "The application associated with the event.
", "SourceConfiguration$ApplicationName": "The name of the application associated with the configuration.
", "UpdateApplicationMessage$ApplicationName": "The name of the application to update. If no such application is found, UpdateApplication
returns an InvalidParameterValue
error.
The name of the application.
", "UpdateApplicationVersionMessage$ApplicationName": "The name of the application associated with this version.
If no application is found with this name, UpdateApplication
returns an InvalidParameterValue
error.
The name of the application associated with the configuration template to update.
If no application is found with this name, UpdateConfigurationTemplate
returns an InvalidParameterValue
error.
The name of the application with which the environment is associated.
", "ValidateConfigurationSettingsMessage$ApplicationName": "The name of the application that the configuration template or environment belongs to.
" } }, "ApplicationNamesList": { "base": null, "refs": { "DescribeApplicationsMessage$ApplicationNames": "If specified, AWS Elastic Beanstalk restricts the returned descriptions to only include those with the specified names.
" } }, "ApplicationResourceLifecycleConfig": { "base": "The resource lifecycle configuration for an application. Defines lifecycle settings for resources that belong to the application, and the service role that Elastic Beanstalk assumes in order to apply lifecycle settings. The version lifecycle configuration defines lifecycle settings for application versions.
", "refs": { "ApplicationDescription$ResourceLifecycleConfig": "The lifecycle settings for the application.
", "ApplicationResourceLifecycleDescriptionMessage$ResourceLifecycleConfig": "The lifecycle configuration.
", "CreateApplicationMessage$ResourceLifecycleConfig": "Specify an application resource lifecycle configuration to prevent your application from accumulating too many versions.
", "UpdateApplicationResourceLifecycleMessage$ResourceLifecycleConfig": "The lifecycle configuration.
" } }, "ApplicationResourceLifecycleDescriptionMessage": { "base": null, "refs": { } }, "ApplicationVersionDescription": { "base": "Describes the properties of an application version.
", "refs": { "ApplicationVersionDescriptionList$member": null, "ApplicationVersionDescriptionMessage$ApplicationVersion": "The ApplicationVersionDescription of the application version.
" } }, "ApplicationVersionDescriptionList": { "base": null, "refs": { "ApplicationVersionDescriptionsMessage$ApplicationVersions": "List of ApplicationVersionDescription
objects sorted in order of creation.
Result message wrapping a single description of an application version.
", "refs": { } }, "ApplicationVersionDescriptionsMessage": { "base": "Result message wrapping a list of application version descriptions.
", "refs": { } }, "ApplicationVersionLifecycleConfig": { "base": "The application version lifecycle settings for an application. Defines the rules that Elastic Beanstalk applies to an application's versions in order to avoid hitting the per-region limit for application versions.
When Elastic Beanstalk deletes an application version from its database, you can no longer deploy that version to an environment. The source bundle remains in S3 unless you configure the rule to delete it.
", "refs": { "ApplicationResourceLifecycleConfig$VersionLifecycleConfig": "The application version lifecycle configuration.
" } }, "ApplicationVersionProccess": { "base": null, "refs": { "CreateApplicationVersionMessage$Process": "Preprocesses and validates the environment manifest and configuration files in the source bundle. Validating configuration files can identify issues prior to deploying the application version to an environment.
" } }, "ApplicationVersionStatus": { "base": null, "refs": { "ApplicationVersionDescription$Status": "The processing status of the application version.
" } }, "ApplyEnvironmentManagedActionRequest": { "base": "Request to execute a scheduled managed action immediately.
", "refs": { } }, "ApplyEnvironmentManagedActionResult": { "base": "The result message containing information about the managed action.
", "refs": { } }, "AutoCreateApplication": { "base": null, "refs": { "CreateApplicationVersionMessage$AutoCreateApplication": "Set to true
to create an application with the specified name if it doesn't already exist.
Describes an Auto Scaling launch configuration.
", "refs": { "AutoScalingGroupList$member": null } }, "AutoScalingGroupList": { "base": null, "refs": { "EnvironmentResourceDescription$AutoScalingGroups": " The AutoScalingGroups
used by this environment.
A list of available solution stacks and their SolutionStackDescription.
" } }, "AvailableSolutionStackNamesList": { "base": null, "refs": { "ListAvailableSolutionStacksResultMessage$SolutionStacks": "A list of available solution stacks.
" } }, "BoxedBoolean": { "base": null, "refs": { "MaxAgeRule$Enabled": "Specify true
to apply the rule, or false
to disable it.
Set to true
to delete a version's source bundle from Amazon S3 when Elastic Beanstalk deletes the application version.
Specify true
to apply the rule, or false
to disable it.
Set to true
to delete a version's source bundle from Amazon S3 when Elastic Beanstalk deletes the application version.
How long in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait until timing out any related build that does not get marked as completed. The default is 60 minutes.
", "MaxAgeRule$MaxAgeInDays": "Specify the number of days to retain an application versions.
", "MaxCountRule$MaxCount": "Specify the maximum number of application versions to retain.
" } }, "BuildConfiguration": { "base": "Settings for an AWS CodeBuild build.
", "refs": { "CreateApplicationVersionMessage$BuildConfiguration": "Settings for an AWS CodeBuild build.
" } }, "Builder": { "base": "The builder used to build the custom platform.
", "refs": { "CreatePlatformVersionResult$Builder": "The builder used to create the custom platform.
" } }, "CPUUtilization": { "base": "CPU utilization metrics for an instance.
", "refs": { "SystemStatus$CPUUtilization": "CPU utilization metrics for the instance.
" } }, "Cause": { "base": null, "refs": { "Causes$member": null } }, "Causes": { "base": null, "refs": { "DescribeEnvironmentHealthResult$Causes": "Descriptions of the data that contributed to the environment's current health status.
", "SingleInstanceHealth$Causes": "Represents the causes, which provide more information about the current health status.
" } }, "CheckDNSAvailabilityMessage": { "base": "Results message indicating whether a CNAME is available.
", "refs": { } }, "CheckDNSAvailabilityResultMessage": { "base": "Indicates if the specified CNAME is available.
", "refs": { } }, "CnameAvailability": { "base": null, "refs": { "CheckDNSAvailabilityResultMessage$Available": "Indicates if the specified CNAME is available:
true
: The CNAME is available.
false
: The CNAME is not available.
AWS CodeBuild is not available in the specified region.
", "refs": { } }, "ComposeEnvironmentsMessage": { "base": "Request to create or update a group of environments.
", "refs": { } }, "ComputeType": { "base": null, "refs": { "BuildConfiguration$ComputeType": "Information about the compute resources the build project will use.
BUILD_GENERAL1_SMALL: Use up to 3 GB memory and 2 vCPUs for builds
BUILD_GENERAL1_MEDIUM: Use up to 7 GB memory and 4 vCPUs for builds
BUILD_GENERAL1_LARGE: Use up to 15 GB memory and 8 vCPUs for builds
If this configuration set is associated with an environment, the DeploymentStatus
parameter indicates the deployment status of this configuration set:
null
: This configuration is not associated with a running environment.
pending
: This is a draft configuration that is not deployed to the associated environment but is in the process of deploying.
deployed
: This is the configuration that is currently deployed to the associated running environment.
failed
: This is a draft configuration that failed to successfully deploy.
The default value for this configuration option.
" } }, "ConfigurationOptionDescription": { "base": "Describes the possible values for a configuration option.
", "refs": { "ConfigurationOptionDescriptionsList$member": null } }, "ConfigurationOptionDescriptionsList": { "base": null, "refs": { "ConfigurationOptionsDescription$Options": "A list of ConfigurationOptionDescription.
" } }, "ConfigurationOptionName": { "base": null, "refs": { "ConfigurationOptionDescription$Name": "The name of the configuration option.
", "ConfigurationOptionSetting$OptionName": "The name of the configuration option.
", "OptionSpecification$OptionName": "The name of the configuration option.
", "ValidationMessage$OptionName": "The name of the option.
" } }, "ConfigurationOptionPossibleValue": { "base": null, "refs": { "ConfigurationOptionPossibleValues$member": null } }, "ConfigurationOptionPossibleValues": { "base": null, "refs": { "ConfigurationOptionDescription$ValueOptions": "If specified, values for the configuration option are selected from this list.
" } }, "ConfigurationOptionSetting": { "base": "A specification identifying an individual configuration option along with its current value. For a list of possible option values, go to Option Values in the AWS Elastic Beanstalk Developer Guide.
", "refs": { "ConfigurationOptionSettingsList$member": null } }, "ConfigurationOptionSettingsList": { "base": null, "refs": { "ConfigurationSettingsDescription$OptionSettings": "A list of the configuration options and their values in this configuration set.
", "CreateConfigurationTemplateMessage$OptionSettings": "If specified, AWS Elastic Beanstalk sets the specified configuration option to the requested value. The new value overrides the value obtained from the solution stack or the source configuration template.
", "CreateEnvironmentMessage$OptionSettings": "If specified, AWS Elastic Beanstalk sets the specified configuration options to the requested value in the configuration set for the new environment. These override the values obtained from the solution stack or the configuration template.
", "CreatePlatformVersionRequest$OptionSettings": "The configuration option settings to apply to the builder environment.
", "UpdateConfigurationTemplateMessage$OptionSettings": "A list of configuration option settings to update with the new specified option value.
", "UpdateEnvironmentMessage$OptionSettings": "If specified, AWS Elastic Beanstalk updates the configuration set associated with the running environment and sets the specified configuration options to the requested value.
", "ValidateConfigurationSettingsMessage$OptionSettings": "A list of the options and desired values to evaluate.
" } }, "ConfigurationOptionSeverity": { "base": null, "refs": { "ConfigurationOptionDescription$ChangeSeverity": "An indication of which action is required if the value for this configuration option changes:
NoInterruption
: There is no interruption to the environment or application availability.
RestartEnvironment
: The environment is entirely restarted, all AWS resources are deleted and recreated, and the environment is unavailable during the process.
RestartApplicationServer
: The environment is available the entire time. However, a short application outage occurs when the application servers on the running Amazon EC2 instances are restarted.
The current value for the configuration option.
" } }, "ConfigurationOptionValueType": { "base": null, "refs": { "ConfigurationOptionDescription$ValueType": "An indication of which type of values this option has and whether it is allowable to select one or more than one of the possible values:
Scalar
: Values for this option are a single selection from the possible values, or an unformatted string, or numeric value governed by the MIN/MAX/Regex
constraints.
List
: Values for this option are multiple selections from the possible values.
Boolean
: Values for this option are either true
or false
.
Json
: Values for this option are a JSON representation of a ConfigDocument
.
Describes the settings for a specified configuration set.
", "refs": { } }, "ConfigurationSettingsDescription": { "base": "Describes the settings for a configuration set.
", "refs": { "ConfigurationSettingsDescriptionList$member": null } }, "ConfigurationSettingsDescriptionList": { "base": null, "refs": { "ConfigurationSettingsDescriptions$ConfigurationSettings": "A list of ConfigurationSettingsDescription.
" } }, "ConfigurationSettingsDescriptions": { "base": "The results from a request to change the configuration settings of an environment.
", "refs": { } }, "ConfigurationSettingsValidationMessages": { "base": "Provides a list of validation messages.
", "refs": { } }, "ConfigurationTemplateName": { "base": null, "refs": { "ConfigurationSettingsDescription$TemplateName": " If not null
, the name of the configuration template for this configuration set.
The name of the configuration template.
Constraint: This name must be unique per application.
Default: If a configuration template already exists with this name, AWS Elastic Beanstalk returns an InvalidParameterValue
error.
The name of the configuration template to use in deployment. If no configuration template is found with this name, AWS Elastic Beanstalk returns an InvalidParameterValue
error.
The name of the configuration template to delete.
", "DescribeConfigurationOptionsMessage$TemplateName": "The name of the configuration template whose configuration options you want to describe.
", "DescribeConfigurationSettingsMessage$TemplateName": "The name of the configuration template to describe.
Conditional: You must specify either this parameter or an EnvironmentName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination
error. If you do not specify either, AWS Elastic Beanstalk returns a MissingRequiredParameter
error.
If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that are associated with this environment configuration.
", "EnvironmentDescription$TemplateName": "The name of the configuration template used to originally launch this environment.
", "EventDescription$TemplateName": "The name of the configuration associated with this event.
", "SourceConfiguration$TemplateName": "The name of the configuration template.
", "UpdateConfigurationTemplateMessage$TemplateName": "The name of the configuration template to update.
If no configuration template is found with this name, UpdateConfigurationTemplate
returns an InvalidParameterValue
error.
If this parameter is specified, AWS Elastic Beanstalk deploys this configuration template to the environment. If no such configuration template is found, AWS Elastic Beanstalk returns an InvalidParameterValue
error.
The name of the configuration template to validate the settings against.
Condition: You cannot specify both this and an environment name.
" } }, "ConfigurationTemplateNamesList": { "base": null, "refs": { "ApplicationDescription$ConfigurationTemplates": "The names of the configuration templates associated with this application.
" } }, "CreateApplicationMessage": { "base": "Request to create an application.
", "refs": { } }, "CreateApplicationVersionMessage": { "base": "", "refs": { } }, "CreateConfigurationTemplateMessage": { "base": "Request to create a configuration template.
", "refs": { } }, "CreateEnvironmentMessage": { "base": "", "refs": { } }, "CreatePlatformVersionRequest": { "base": "Request to create a new platform version.
", "refs": { } }, "CreatePlatformVersionResult": { "base": null, "refs": { } }, "CreateStorageLocationResultMessage": { "base": "Results of a CreateStorageLocationResult call.
", "refs": { } }, "CreationDate": { "base": null, "refs": { "ApplicationDescription$DateCreated": "The date when the application was created.
", "ApplicationVersionDescription$DateCreated": "The creation date of the application version.
", "ConfigurationSettingsDescription$DateCreated": "The date (in UTC time) when this configuration set was created.
", "EnvironmentDescription$DateCreated": "The creation date for this environment.
", "PlatformDescription$DateCreated": "The date when the platform was created.
" } }, "CustomAmi": { "base": "A custom AMI available to platforms.
", "refs": { "CustomAmiList$member": null } }, "CustomAmiList": { "base": null, "refs": { "PlatformDescription$CustomAmiList": "The custom AMIs supported by the platform.
" } }, "DNSCname": { "base": null, "refs": { "CheckDNSAvailabilityResultMessage$FullyQualifiedCNAME": "The fully qualified CNAME to reserve when CreateEnvironment is called with the provided prefix.
", "EnvironmentDescription$CNAME": "The URL to the CNAME for this environment.
" } }, "DNSCnamePrefix": { "base": null, "refs": { "CheckDNSAvailabilityMessage$CNAMEPrefix": "The prefix used when this CNAME is reserved.
", "CreateEnvironmentMessage$CNAMEPrefix": "If specified, the environment attempts to use this value as the prefix for the CNAME. If not specified, the CNAME is generated automatically by appending a random alphanumeric string to the environment name.
" } }, "DeleteApplicationMessage": { "base": "Request to delete an application.
", "refs": { } }, "DeleteApplicationVersionMessage": { "base": "Request to delete an application version.
", "refs": { } }, "DeleteConfigurationTemplateMessage": { "base": "Request to delete a configuration template.
", "refs": { } }, "DeleteEnvironmentConfigurationMessage": { "base": "Request to delete a draft environment configuration.
", "refs": { } }, "DeletePlatformVersionRequest": { "base": null, "refs": { } }, "DeletePlatformVersionResult": { "base": null, "refs": { } }, "DeleteSourceBundle": { "base": null, "refs": { "DeleteApplicationVersionMessage$DeleteSourceBundle": "Set to true
to delete the source bundle from your storage bucket. Otherwise, the application version is deleted only from Elastic Beanstalk and the source bundle remains in Amazon S3.
Information about an application version deployment.
", "refs": { "SingleInstanceHealth$Deployment": "Information about the most recent deployment to an instance.
" } }, "DeploymentTimestamp": { "base": null, "refs": { "Deployment$DeploymentTime": "For in-progress deployments, the time that the deployment started.
For completed deployments, the time that the deployment ended.
" } }, "DescribeApplicationVersionsMessage": { "base": "Request to describe application versions.
", "refs": { } }, "DescribeApplicationsMessage": { "base": "Request to describe one or more applications.
", "refs": { } }, "DescribeConfigurationOptionsMessage": { "base": "Result message containing a list of application version descriptions.
", "refs": { } }, "DescribeConfigurationSettingsMessage": { "base": "Result message containing all of the configuration settings for a specified solution stack or configuration template.
", "refs": { } }, "DescribeEnvironmentHealthRequest": { "base": "See the example below to learn how to create a request body.
", "refs": { } }, "DescribeEnvironmentHealthResult": { "base": "Health details for an AWS Elastic Beanstalk environment.
", "refs": { } }, "DescribeEnvironmentManagedActionHistoryRequest": { "base": "Request to list completed and failed managed actions.
", "refs": { } }, "DescribeEnvironmentManagedActionHistoryResult": { "base": "A result message containing a list of completed and failed managed actions.
", "refs": { } }, "DescribeEnvironmentManagedActionsRequest": { "base": "Request to list an environment's upcoming and in-progress managed actions.
", "refs": { } }, "DescribeEnvironmentManagedActionsResult": { "base": "The result message containing a list of managed actions.
", "refs": { } }, "DescribeEnvironmentResourcesMessage": { "base": "Request to describe the resources in an environment.
", "refs": { } }, "DescribeEnvironmentsMessage": { "base": "Request to describe one or more environments.
", "refs": { } }, "DescribeEventsMessage": { "base": "Request to retrieve a list of events for an environment.
", "refs": { } }, "DescribeInstancesHealthRequest": { "base": "Parameters for a call to DescribeInstancesHealth
.
Detailed health information about the Amazon EC2 instances in an AWS Elastic Beanstalk environment.
", "refs": { } }, "DescribePlatformVersionRequest": { "base": null, "refs": { } }, "DescribePlatformVersionResult": { "base": null, "refs": { } }, "Description": { "base": null, "refs": { "ApplicationDescription$Description": "User-defined description of the application.
", "ApplicationVersionDescription$Description": "The description of the application version.
", "ConfigurationSettingsDescription$Description": "Describes this configuration set.
", "CreateApplicationMessage$Description": "Describes the application.
", "CreateApplicationVersionMessage$Description": "Describes this version.
", "CreateConfigurationTemplateMessage$Description": "Describes this configuration.
", "CreateEnvironmentMessage$Description": "Describes this environment.
", "EnvironmentDescription$Description": "Describes this environment.
", "PlatformDescription$Description": "The description of the platform.
", "UpdateApplicationMessage$Description": "A new description for the application.
Default: If not specified, AWS Elastic Beanstalk does not update the description.
", "UpdateApplicationVersionMessage$Description": "A new description for this version.
", "UpdateConfigurationTemplateMessage$Description": "A new description for the configuration.
", "UpdateEnvironmentMessage$Description": "If this parameter is specified, AWS Elastic Beanstalk updates the description of this environment.
" } }, "Ec2InstanceId": { "base": null, "refs": { "EnvironmentInfoDescription$Ec2InstanceId": "The Amazon EC2 Instance ID for this information.
" } }, "ElasticBeanstalkServiceException": { "base": "A generic service exception has occurred.
", "refs": { } }, "EndpointURL": { "base": null, "refs": { "EnvironmentDescription$EndpointURL": "For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.
" } }, "EnvironmentArn": { "base": null, "refs": { "EnvironmentDescription$EnvironmentArn": "The environment's Amazon Resource Name (ARN), which can be used in other API reuqests that require an ARN.
" } }, "EnvironmentDescription": { "base": "Describes the properties of an environment.
", "refs": { "EnvironmentDescriptionsList$member": null } }, "EnvironmentDescriptionsList": { "base": null, "refs": { "EnvironmentDescriptionsMessage$Environments": "Returns an EnvironmentDescription list.
" } }, "EnvironmentDescriptionsMessage": { "base": "Result message containing a list of environment descriptions.
", "refs": { } }, "EnvironmentHealth": { "base": null, "refs": { "DescribeEnvironmentHealthResult$Status": "The environment's operational status. Ready
, Launching
, Updating
, Terminating
, or Terminated
.
Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment:
Red
: Indicates the environment is not responsive. Occurs when three or more consecutive failures occur for an environment.
Yellow
: Indicates that something is wrong. Occurs when two consecutive failures occur for an environment.
Green
: Indicates the environment is healthy and fully functional.
Grey
: Default health for a new environment. The environment is not fully launched and health checks have not started or health checks are suspended during an UpdateEnvironment
or RestartEnvironement
request.
Default: Grey
Specify the response elements to return. To retrieve all attributes, set to All
. If no attribute names are specified, returns the name of the environment.
Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses.
" } }, "EnvironmentId": { "base": null, "refs": { "AbortEnvironmentUpdateMessage$EnvironmentId": "This specifies the ID of the environment with the in-progress update that you want to cancel.
", "CreateConfigurationTemplateMessage$EnvironmentId": "The ID of the environment used with this configuration template.
", "DescribeEnvironmentHealthRequest$EnvironmentId": "Specify the environment by ID.
You must specify either this or an EnvironmentName, or both.
", "DescribeEnvironmentManagedActionHistoryRequest$EnvironmentId": "The environment ID of the target environment.
", "DescribeEnvironmentResourcesMessage$EnvironmentId": "The ID of the environment to retrieve AWS resource usage data.
Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter
error.
If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment.
", "DescribeInstancesHealthRequest$EnvironmentId": "Specify the AWS Elastic Beanstalk environment by ID.
", "EnvironmentDescription$EnvironmentId": "The ID of this environment.
", "EnvironmentIdList$member": null, "RebuildEnvironmentMessage$EnvironmentId": "The ID of the environment to rebuild.
Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter
error.
The ID of the environment of the requested data.
If no such environment is found, RequestEnvironmentInfo
returns an InvalidParameterValue
error.
Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter
error.
The ID of the environment to restart the server for.
Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter
error.
The ID of the data's environment.
If no such environment is found, returns an InvalidParameterValue
error.
Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter
error.
The ID of the source environment.
Condition: You must specify at least the SourceEnvironmentID
or the SourceEnvironmentName
. You may also specify both. If you specify the SourceEnvironmentId
, you must specify the DestinationEnvironmentId
.
The ID of the destination environment.
Condition: You must specify at least the DestinationEnvironmentID
or the DestinationEnvironmentName
. You may also specify both. You must specify the SourceEnvironmentId
with the DestinationEnvironmentId
.
The ID of the environment to terminate.
Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter
error.
The ID of the environment to update.
If no environment with this ID exists, AWS Elastic Beanstalk returns an InvalidParameterValue
error.
Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter
error.
If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.
" } }, "EnvironmentInfoDescription": { "base": "The information retrieved from the Amazon EC2 instances.
", "refs": { "EnvironmentInfoDescriptionList$member": null } }, "EnvironmentInfoDescriptionList": { "base": null, "refs": { "RetrieveEnvironmentInfoResultMessage$EnvironmentInfo": "The EnvironmentInfoDescription of the environment.
" } }, "EnvironmentInfoType": { "base": null, "refs": { "EnvironmentInfoDescription$InfoType": "The type of information retrieved.
", "RequestEnvironmentInfoMessage$InfoType": "The type of information to request.
", "RetrieveEnvironmentInfoMessage$InfoType": "The type of information to retrieve.
" } }, "EnvironmentLink": { "base": "A link to another environment, defined in the environment's manifest. Links provide connection information in system properties that can be used to connect to another environment in the same group. See Environment Manifest (env.yaml) for details.
", "refs": { "EnvironmentLinks$member": null } }, "EnvironmentLinks": { "base": null, "refs": { "EnvironmentDescription$EnvironmentLinks": "A list of links to other environments in the same group.
" } }, "EnvironmentName": { "base": null, "refs": { "AbortEnvironmentUpdateMessage$EnvironmentName": "This specifies the name of the environment with the in-progress update that you want to cancel.
", "ConfigurationSettingsDescription$EnvironmentName": " If not null
, the name of the environment for this configuration set.
A unique name for the deployment environment. Used in the application URL.
Constraint: Must be from 4 to 40 characters in length. The name can contain only letters, numbers, and hyphens. It cannot start or end with a hyphen. This name must be unique within a region in your account. If the specified name already exists in the region, AWS Elastic Beanstalk returns an InvalidParameterValue
error.
Default: If the CNAME parameter is not specified, the environment name becomes part of the CNAME, and therefore part of the visible URL for your application.
", "CreatePlatformVersionRequest$EnvironmentName": "The name of the builder environment.
", "DeleteEnvironmentConfigurationMessage$EnvironmentName": "The name of the environment to delete the draft configuration from.
", "DescribeConfigurationOptionsMessage$EnvironmentName": "The name of the environment whose configuration options you want to describe.
", "DescribeConfigurationSettingsMessage$EnvironmentName": "The name of the environment to describe.
Condition: You must specify either this or a TemplateName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination
error. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter
error.
Specify the environment by name.
You must specify either this or an EnvironmentName, or both.
", "DescribeEnvironmentHealthResult$EnvironmentName": "The environment's name.
", "DescribeEnvironmentManagedActionHistoryRequest$EnvironmentName": "The name of the target environment.
", "DescribeEnvironmentResourcesMessage$EnvironmentName": "The name of the environment to retrieve AWS resource usage data.
Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter
error.
If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment.
", "DescribeInstancesHealthRequest$EnvironmentName": "Specify the AWS Elastic Beanstalk environment by name.
", "EnvironmentDescription$EnvironmentName": "The name of this environment.
", "EnvironmentNamesList$member": null, "EnvironmentResourceDescription$EnvironmentName": "The name of the environment.
", "EventDescription$EnvironmentName": "The name of the environment associated with this event.
", "RebuildEnvironmentMessage$EnvironmentName": "The name of the environment to rebuild.
Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter
error.
The name of the environment of the requested data.
If no such environment is found, RequestEnvironmentInfo
returns an InvalidParameterValue
error.
Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter
error.
The name of the environment to restart the server for.
Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter
error.
The name of the data's environment.
If no such environment is found, returns an InvalidParameterValue
error.
Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter
error.
The name of the source environment.
Condition: You must specify at least the SourceEnvironmentID
or the SourceEnvironmentName
. You may also specify both. If you specify the SourceEnvironmentName
, you must specify the DestinationEnvironmentName
.
The name of the destination environment.
Condition: You must specify at least the DestinationEnvironmentID
or the DestinationEnvironmentName
. You may also specify both. You must specify the SourceEnvironmentName
with the DestinationEnvironmentName
.
The name of the environment to terminate.
Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter
error.
The name of the environment to update. If no environment with this name exists, AWS Elastic Beanstalk returns an InvalidParameterValue
error.
Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter
error.
The name of the environment to validate the settings against.
Condition: You cannot specify both this and a configuration template name.
" } }, "EnvironmentNamesList": { "base": null, "refs": { "DescribeEnvironmentsMessage$EnvironmentNames": "If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.
" } }, "EnvironmentResourceDescription": { "base": "Describes the AWS resources in use by this environment. This data is live.
", "refs": { "EnvironmentResourceDescriptionsMessage$EnvironmentResources": "A list of EnvironmentResourceDescription.
" } }, "EnvironmentResourceDescriptionsMessage": { "base": "Result message containing a list of environment resource descriptions.
", "refs": { } }, "EnvironmentResourcesDescription": { "base": "Describes the AWS resources in use by this environment. This data is not live data.
", "refs": { "EnvironmentDescription$Resources": "The description of the AWS resources used by this environment.
" } }, "EnvironmentStatus": { "base": null, "refs": { "EnvironmentDescription$Status": "The current operational status of the environment:
Launching
: Environment is in the process of initial deployment.
Updating
: Environment is in the process of updating its configuration settings or application version.
Ready
: Environment is available to have an action performed on it, such as update or terminate.
Terminating
: Environment is in the shut-down process.
Terminated
: Environment is not running.
Describes the properties of an environment tier
", "refs": { "CreateEnvironmentMessage$Tier": "This specifies the tier to use for creating this environment.
", "EnvironmentDescription$Tier": "Describes the current tier of this environment.
", "UpdateEnvironmentMessage$Tier": "This specifies the tier to use to update the environment.
Condition: At this time, if you change the tier version, name, or type, AWS Elastic Beanstalk returns InvalidParameterValue
error.
The date when the event occurred.
" } }, "EventDescription": { "base": "Describes an event.
", "refs": { "EventDescriptionList$member": null } }, "EventDescriptionList": { "base": null, "refs": { "EventDescriptionsMessage$Events": "A list of EventDescription.
" } }, "EventDescriptionsMessage": { "base": "Result message wrapping a list of event descriptions.
", "refs": { } }, "EventMessage": { "base": null, "refs": { "EventDescription$Message": "The event message.
" } }, "EventSeverity": { "base": null, "refs": { "DescribeEventsMessage$Severity": "If specified, limits the events returned from this call to include only those with the specified severity or higher.
", "EventDescription$Severity": "The severity level of this event.
" } }, "ExceptionMessage": { "base": null, "refs": { "ElasticBeanstalkServiceException$message": "The exception error message.
" } }, "FailureType": { "base": null, "refs": { "ManagedActionHistoryItem$FailureType": "If the action failed, the type of failure.
" } }, "FileTypeExtension": { "base": null, "refs": { "SolutionStackFileTypeList$member": null } }, "ForceTerminate": { "base": null, "refs": { "TerminateEnvironmentMessage$ForceTerminate": "Terminates the target environment even if another environment in the same group is dependent on it.
" } }, "GroupName": { "base": null, "refs": { "ComposeEnvironmentsMessage$GroupName": "The name of the group to which the target environments belong. Specify a group name only if the environment name defined in each target environment's manifest ends with a + (plus) character. See Environment Manifest (env.yaml) for details.
", "CreateEnvironmentMessage$GroupName": "The name of the group to which the target environment belongs. Specify a group name only if the environment's name is specified in an environment manifest and not with the environment name parameter. See Environment Manifest (env.yaml) for details.
", "UpdateEnvironmentMessage$GroupName": "The name of the group to which the target environment belongs. Specify a group name only if the environment's name is specified in an environment manifest and not with the environment name or environment ID parameters. See Environment Manifest (env.yaml) for details.
" } }, "ImageId": { "base": null, "refs": { "CustomAmi$ImageId": "THe ID of the image used to create the custom AMI.
" } }, "IncludeDeleted": { "base": null, "refs": { "DescribeEnvironmentsMessage$IncludeDeleted": "Indicates whether to include deleted environments:
true
: Environments that have been deleted after IncludedDeletedBackTo
are displayed.
false
: Do not include deleted environments.
If specified when IncludeDeleted
is set to true
, then environments deleted after this date are displayed.
The description of an Amazon EC2 instance.
", "refs": { "InstanceList$member": null } }, "InstanceHealthList": { "base": null, "refs": { "DescribeInstancesHealthResult$InstanceHealthList": "Detailed health information about each instance.
" } }, "InstanceHealthSummary": { "base": "Represents summary information about the health of an instance. For more information, see Health Colors and Statuses.
", "refs": { "DescribeEnvironmentHealthResult$InstancesHealth": "Summary health information for the instances in the environment.
" } }, "InstanceId": { "base": null, "refs": { "SingleInstanceHealth$InstanceId": "The ID of the Amazon EC2 instance.
" } }, "InstanceList": { "base": null, "refs": { "EnvironmentResourceDescription$Instances": "The Amazon EC2 instances used by this environment.
" } }, "InstancesHealthAttribute": { "base": null, "refs": { "InstancesHealthAttributes$member": null } }, "InstancesHealthAttributes": { "base": null, "refs": { "DescribeInstancesHealthRequest$AttributeNames": "Specifies the response elements you wish to receive. To retrieve all attributes, set to All
. If no attribute names are specified, returns a list of instances.
The specified account does not have sufficient privileges for one of more AWS services.
", "refs": { } }, "Integer": { "base": null, "refs": { "DescribeEnvironmentManagedActionHistoryRequest$MaxItems": "The maximum number of items to return for a single request.
", "Listener$Port": "The port that is used by the Listener.
" } }, "InvalidRequestException": { "base": "One or more input parameters is not valid. Please correct the input parameters and try the operation again.
", "refs": { } }, "Latency": { "base": "Represents the average latency for the slowest X percent of requests over the last 10 seconds.
", "refs": { "ApplicationMetrics$Latency": "Represents the average latency for the slowest X percent of requests over the last 10 seconds. Latencies are in seconds with one millisecond resolution.
" } }, "LaunchConfiguration": { "base": "Describes an Auto Scaling launch configuration.
", "refs": { "LaunchConfigurationList$member": null } }, "LaunchConfigurationList": { "base": null, "refs": { "EnvironmentResourceDescription$LaunchConfigurations": "The Auto Scaling launch configurations in use by this environment.
" } }, "LaunchedAt": { "base": null, "refs": { "SingleInstanceHealth$LaunchedAt": "The time at which the EC2 instance was launched.
" } }, "ListAvailableSolutionStacksResultMessage": { "base": "A list of available AWS Elastic Beanstalk solution stacks.
", "refs": { } }, "ListPlatformVersionsRequest": { "base": null, "refs": { } }, "ListPlatformVersionsResult": { "base": null, "refs": { } }, "ListTagsForResourceMessage": { "base": null, "refs": { } }, "Listener": { "base": "Describes the properties of a Listener for the LoadBalancer.
", "refs": { "LoadBalancerListenersDescription$member": null } }, "LoadAverage": { "base": null, "refs": { "SystemStatus$LoadAverage": "Load average in the last 1-minute, 5-minute, and 15-minute periods. For more information, see Operating System Metrics.
" } }, "LoadAverageValue": { "base": null, "refs": { "LoadAverage$member": null } }, "LoadBalancer": { "base": "Describes a LoadBalancer.
", "refs": { "LoadBalancerList$member": null } }, "LoadBalancerDescription": { "base": "Describes the details of a LoadBalancer.
", "refs": { "EnvironmentResourcesDescription$LoadBalancer": "Describes the LoadBalancer.
" } }, "LoadBalancerList": { "base": null, "refs": { "EnvironmentResourceDescription$LoadBalancers": "The LoadBalancers in use by this environment.
" } }, "LoadBalancerListenersDescription": { "base": null, "refs": { "LoadBalancerDescription$Listeners": "A list of Listeners used by the LoadBalancer.
" } }, "Maintainer": { "base": null, "refs": { "PlatformDescription$Maintainer": "Information about the maintainer of the platform.
" } }, "ManagedAction": { "base": "The record of an upcoming or in-progress managed action.
", "refs": { "ManagedActions$member": null } }, "ManagedActionHistoryItem": { "base": "The record of a completed or failed managed action.
", "refs": { "ManagedActionHistoryItems$member": null } }, "ManagedActionHistoryItems": { "base": null, "refs": { "DescribeEnvironmentManagedActionHistoryResult$ManagedActionHistoryItems": "A list of completed and failed managed actions.
" } }, "ManagedActionInvalidStateException": { "base": "Cannot modify the managed action in its current state.
", "refs": { } }, "ManagedActions": { "base": null, "refs": { "DescribeEnvironmentManagedActionsResult$ManagedActions": "A list of upcoming and in-progress managed actions.
" } }, "MaxAgeRule": { "base": "A lifecycle rule that deletes application versions after the specified number of days.
", "refs": { "ApplicationVersionLifecycleConfig$MaxAgeRule": "Specify a max age rule to restrict the length of time that application versions are retained for an application.
" } }, "MaxCountRule": { "base": "A lifecycle rule that deletes the oldest application version when the maximum count is exceeded.
", "refs": { "ApplicationVersionLifecycleConfig$MaxCountRule": "Specify a max count rule to restrict the number of application versions that are retained for an application.
" } }, "MaxRecords": { "base": null, "refs": { "DescribeApplicationVersionsMessage$MaxRecords": "For a paginated request. Specify a maximum number of application versions to include in each response.
If no MaxRecords
is specified, all available application versions are retrieved in a single response.
For a paginated request. Specify a maximum number of environments to include in each response.
If no MaxRecords
is specified, all available environments are retrieved in a single response.
Specifies the maximum number of events that can be returned, beginning with the most recent event.
" } }, "Message": { "base": null, "refs": { "EnvironmentInfoDescription$Message": "The retrieved information.
" } }, "NextToken": { "base": null, "refs": { "DescribeInstancesHealthRequest$NextToken": "Specify the pagination token returned by a previous call.
", "DescribeInstancesHealthResult$NextToken": "Pagination token for the next page of results, if available.
" } }, "NonEmptyString": { "base": null, "refs": { "BuildConfiguration$CodeBuildServiceRole": "The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.
", "BuildConfiguration$Image": "The ID of the Docker image to use for this build project.
" } }, "NullableDouble": { "base": null, "refs": { "CPUUtilization$User": "Percentage of time that the CPU has spent in the User
state over the last 10 seconds.
Percentage of time that the CPU has spent in the Nice
state over the last 10 seconds.
Percentage of time that the CPU has spent in the System
state over the last 10 seconds.
Percentage of time that the CPU has spent in the Idle
state over the last 10 seconds.
Percentage of time that the CPU has spent in the I/O Wait
state over the last 10 seconds.
Percentage of time that the CPU has spent in the IRQ
state over the last 10 seconds.
Percentage of time that the CPU has spent in the SoftIRQ
state over the last 10 seconds.
The average latency for the slowest 0.1 percent of requests over the last 10 seconds.
", "Latency$P99": "The average latency for the slowest 1 percent of requests over the last 10 seconds.
", "Latency$P95": "The average latency for the slowest 5 percent of requests over the last 10 seconds.
", "Latency$P90": "The average latency for the slowest 10 percent of requests over the last 10 seconds.
", "Latency$P85": "The average latency for the slowest 15 percent of requests over the last 10 seconds.
", "Latency$P75": "The average latency for the slowest 25 percent of requests over the last 10 seconds.
", "Latency$P50": "The average latency for the slowest 50 percent of requests over the last 10 seconds.
", "Latency$P10": "The average latency for the slowest 90 percent of requests over the last 10 seconds.
" } }, "NullableInteger": { "base": null, "refs": { "ApplicationMetrics$Duration": "The amount of time that the metrics cover (usually 10 seconds). For example, you might have 5 requests (request_count
) within the most recent time slice of 10 seconds (duration
).
Grey. AWS Elastic Beanstalk and the health agent are reporting no data on an instance.
", "InstanceHealthSummary$Unknown": "Grey. AWS Elastic Beanstalk and the health agent are reporting an insufficient amount of data on an instance.
", "InstanceHealthSummary$Pending": "Grey. An operation is in progress on an instance within the command timeout.
", "InstanceHealthSummary$Ok": "Green. An instance is passing health checks and the health agent is not reporting any problems.
", "InstanceHealthSummary$Info": "Green. An operation is in progress on an instance.
", "InstanceHealthSummary$Warning": "Yellow. The health agent is reporting a moderate number of request failures or other issues for an instance or environment.
", "InstanceHealthSummary$Degraded": "Red. The health agent is reporting a high number of request failures or other issues for an instance or environment.
", "InstanceHealthSummary$Severe": "Red. The health agent is reporting a very high number of request failures or other issues for an instance or environment.
", "StatusCodes$Status2xx": "The percentage of requests over the last 10 seconds that resulted in a 2xx (200, 201, etc.) status code.
", "StatusCodes$Status3xx": "The percentage of requests over the last 10 seconds that resulted in a 3xx (300, 301, etc.) status code.
", "StatusCodes$Status4xx": "The percentage of requests over the last 10 seconds that resulted in a 4xx (400, 401, etc.) status code.
", "StatusCodes$Status5xx": "The percentage of requests over the last 10 seconds that resulted in a 5xx (500, 501, etc.) status code.
" } }, "NullableLong": { "base": null, "refs": { "Deployment$DeploymentId": "The ID of the deployment. This number increases by one each time that you deploy source code or change instance configuration settings.
" } }, "OperatingSystemName": { "base": null, "refs": { "PlatformDescription$OperatingSystemName": "The operating system used by the platform.
", "PlatformSummary$OperatingSystemName": "The operating system used by the platform.
" } }, "OperatingSystemVersion": { "base": null, "refs": { "PlatformDescription$OperatingSystemVersion": "The version of the operating system used by the platform.
", "PlatformSummary$OperatingSystemVersion": "The version of the operating system used by the platform.
" } }, "OperationInProgressException": { "base": "Unable to perform the specified operation because another operation that effects an element in this activity is already in progress.
", "refs": { } }, "OptionNamespace": { "base": null, "refs": { "ConfigurationOptionDescription$Namespace": "A unique namespace identifying the option's associated AWS resource.
", "ConfigurationOptionSetting$Namespace": "A unique namespace identifying the option's associated AWS resource.
", "OptionSpecification$Namespace": "A unique namespace identifying the option's associated AWS resource.
", "ValidationMessage$Namespace": "The namespace to which the option belongs.
" } }, "OptionRestrictionMaxLength": { "base": null, "refs": { "ConfigurationOptionDescription$MaxLength": "If specified, the configuration option must be a string value no longer than this value.
" } }, "OptionRestrictionMaxValue": { "base": null, "refs": { "ConfigurationOptionDescription$MaxValue": "If specified, the configuration option must be a numeric value less than this value.
" } }, "OptionRestrictionMinValue": { "base": null, "refs": { "ConfigurationOptionDescription$MinValue": "If specified, the configuration option must be a numeric value greater than this value.
" } }, "OptionRestrictionRegex": { "base": "A regular expression representing a restriction on a string configuration option value.
", "refs": { "ConfigurationOptionDescription$Regex": "If specified, the configuration option must be a string value that satisfies this regular expression.
" } }, "OptionSpecification": { "base": "A specification identifying an individual configuration option.
", "refs": { "OptionsSpecifierList$member": null } }, "OptionsSpecifierList": { "base": null, "refs": { "CreateEnvironmentMessage$OptionsToRemove": "A list of custom user-defined configuration options to remove from the configuration set for this new environment.
", "DescribeConfigurationOptionsMessage$Options": "If specified, restricts the descriptions to only the specified options.
", "UpdateConfigurationTemplateMessage$OptionsToRemove": "A list of configuration options to remove from the configuration set.
Constraint: You can remove only UserDefined
configuration options.
A list of custom user-defined configuration options to remove from the configuration set for this environment.
" } }, "PlatformArn": { "base": null, "refs": { "ConfigurationOptionsDescription$PlatformArn": "The ARN of the platform.
", "ConfigurationSettingsDescription$PlatformArn": "The ARN of the platform.
", "CreateConfigurationTemplateMessage$PlatformArn": "The ARN of the custome platform.
", "CreateEnvironmentMessage$PlatformArn": "The ARN of the platform.
", "DeletePlatformVersionRequest$PlatformArn": "The ARN of the version of the custom platform.
", "DescribeConfigurationOptionsMessage$PlatformArn": "The ARN of the custom platform.
", "DescribeEventsMessage$PlatformArn": "The ARN of the version of the custom platform.
", "DescribePlatformVersionRequest$PlatformArn": "The ARN of the version of the platform.
", "EnvironmentDescription$PlatformArn": "The ARN of the platform.
", "EventDescription$PlatformArn": "The ARN of the platform.
", "PlatformDescription$PlatformArn": "The ARN of the platform.
", "PlatformSummary$PlatformArn": "The ARN of the platform.
", "UpdateEnvironmentMessage$PlatformArn": "The ARN of the platform, if used.
" } }, "PlatformCategory": { "base": null, "refs": { "PlatformDescription$PlatformCategory": "The category of the platform.
", "PlatformSummary$PlatformCategory": "The category of platform.
" } }, "PlatformDescription": { "base": "Detailed information about a platform.
", "refs": { "DescribePlatformVersionResult$PlatformDescription": "Detailed information about the version of the platform.
" } }, "PlatformFilter": { "base": "Specify criteria to restrict the results when listing custom platforms.
The filter is evaluated as the expression:
Type
Operator
Values[i]
The operator to apply to the Type
with each of the Values
.
Valid Values: =
(equal to) | !=
(not equal to) | <
(less than) | <=
(less than or equal to) | >
(greater than) | >=
(greater than or equal to) | contains
| begins_with
| ends_with
The custom platform attribute to which the filter values are applied.
Valid Values: PlatformName
| PlatformVersion
| PlatformStatus
| PlatformOwner
The list of values applied to the custom platform attribute.
" } }, "PlatformFilters": { "base": null, "refs": { "ListPlatformVersionsRequest$Filters": "List only the platforms where the platform member value relates to one of the supplied values.
" } }, "PlatformFramework": { "base": "A framework supported by the custom platform.
", "refs": { "PlatformFrameworks$member": null } }, "PlatformFrameworks": { "base": null, "refs": { "PlatformDescription$Frameworks": "The frameworks supported by the platform.
" } }, "PlatformMaxRecords": { "base": null, "refs": { "ListPlatformVersionsRequest$MaxRecords": "The maximum number of platform values returned in one call.
" } }, "PlatformName": { "base": null, "refs": { "CreatePlatformVersionRequest$PlatformName": "The name of your custom platform.
", "PlatformDescription$PlatformName": "The name of the platform.
" } }, "PlatformOwner": { "base": null, "refs": { "PlatformDescription$PlatformOwner": "The AWS account ID of the person who created the platform.
", "PlatformSummary$PlatformOwner": "The AWS account ID of the person who created the platform.
" } }, "PlatformProgrammingLanguage": { "base": "A programming language supported by the platform.
", "refs": { "PlatformProgrammingLanguages$member": null } }, "PlatformProgrammingLanguages": { "base": null, "refs": { "PlatformDescription$ProgrammingLanguages": "The programming languages supported by the platform.
" } }, "PlatformStatus": { "base": null, "refs": { "PlatformDescription$PlatformStatus": "The status of the platform.
", "PlatformSummary$PlatformStatus": "The status of the platform. You can create an environment from the platform once it is ready.
" } }, "PlatformSummary": { "base": "Detailed information about a platform.
", "refs": { "CreatePlatformVersionResult$PlatformSummary": "Detailed information about the new version of the custom platform.
", "DeletePlatformVersionResult$PlatformSummary": "Detailed information about the version of the custom platform.
", "PlatformSummaryList$member": null } }, "PlatformSummaryList": { "base": null, "refs": { "ListPlatformVersionsResult$PlatformSummaryList": "Detailed information about the platforms.
" } }, "PlatformVersion": { "base": null, "refs": { "CreatePlatformVersionRequest$PlatformVersion": "The number, such as 1.0.2, for the new platform version.
", "PlatformDescription$PlatformVersion": "The version of the platform.
" } }, "PlatformVersionStillReferencedException": { "base": "You cannot delete the platform version because there are still environments running on it.
", "refs": { } }, "Queue": { "base": "Describes a queue.
", "refs": { "QueueList$member": null } }, "QueueList": { "base": null, "refs": { "EnvironmentResourceDescription$Queues": "The queues used by this environment.
" } }, "RebuildEnvironmentMessage": { "base": "", "refs": { } }, "RefreshedAt": { "base": null, "refs": { "DescribeEnvironmentHealthResult$RefreshedAt": "The date and time that the health information was retrieved.
", "DescribeInstancesHealthResult$RefreshedAt": "The date and time that the health information was retrieved.
" } }, "RegexLabel": { "base": null, "refs": { "OptionRestrictionRegex$Label": "A unique name representing this regular expression.
" } }, "RegexPattern": { "base": null, "refs": { "OptionRestrictionRegex$Pattern": "The regular expression pattern that a string configuration option value with this restriction must match.
" } }, "RequestCount": { "base": null, "refs": { "ApplicationMetrics$RequestCount": "Average number of requests handled by the web server per second over the last 10 seconds.
" } }, "RequestEnvironmentInfoMessage": { "base": "Request to retrieve logs from an environment and store them in your Elastic Beanstalk storage bucket.
", "refs": { } }, "RequestId": { "base": null, "refs": { "DescribeEventsMessage$RequestId": "If specified, AWS Elastic Beanstalk restricts the described events to include only those associated with this request ID.
", "EventDescription$RequestId": "The web service request ID for the activity of this event.
" } }, "ResourceArn": { "base": null, "refs": { "ListTagsForResourceMessage$ResourceArn": "The Amazon Resource Name (ARN) of the resouce for which a tag list is requested.
Must be the ARN of an Elastic Beanstalk environment.
", "ResourceTagsDescriptionMessage$ResourceArn": "The Amazon Resource Name (ARN) of the resouce for which a tag list was requested.
", "UpdateTagsForResourceMessage$ResourceArn": "The Amazon Resource Name (ARN) of the resouce to be updated.
Must be the ARN of an Elastic Beanstalk environment.
" } }, "ResourceId": { "base": null, "refs": { "AutoScalingGroup$Name": "The name of the AutoScalingGroup
.
The ID of the Amazon EC2 instance.
", "LaunchConfiguration$Name": "The name of the launch configuration.
", "LoadBalancer$Name": "The name of the LoadBalancer.
", "Trigger$Name": "The name of the trigger.
" } }, "ResourceName": { "base": null, "refs": { "ConfigurationOptionSetting$ResourceName": "A unique resource name for a time-based scaling configuration option.
", "OptionSpecification$ResourceName": "A unique resource name for a time-based scaling configuration option.
" } }, "ResourceNotFoundException": { "base": "A resource doesn't exist for the specified Amazon Resource Name (ARN).
", "refs": { } }, "ResourceTagsDescriptionMessage": { "base": null, "refs": { } }, "ResourceTypeNotSupportedException": { "base": "The type of the specified Amazon Resource Name (ARN) isn't supported for this operation.
", "refs": { } }, "RestartAppServerMessage": { "base": "", "refs": { } }, "RetrieveEnvironmentInfoMessage": { "base": "Request to download logs retrieved with RequestEnvironmentInfo.
", "refs": { } }, "RetrieveEnvironmentInfoResultMessage": { "base": "Result message containing a description of the requested environment info.
", "refs": { } }, "S3Bucket": { "base": null, "refs": { "CreateStorageLocationResultMessage$S3Bucket": "The name of the Amazon S3 bucket created.
", "S3Location$S3Bucket": "The Amazon S3 bucket where the data is located.
" } }, "S3Key": { "base": null, "refs": { "S3Location$S3Key": "The Amazon S3 key where the data is located.
" } }, "S3Location": { "base": "The bucket and key of an item stored in Amazon S3.
", "refs": { "ApplicationVersionDescription$SourceBundle": "The storage location of the application version's source bundle in Amazon S3.
", "CreateApplicationVersionMessage$SourceBundle": "The Amazon S3 bucket and key that identify the location of the source bundle for this version.
The Amazon S3 bucket must be in the same region as the environment.
Specify a source bundle in S3 or a commit in an AWS CodeCommit repository (with SourceBuildInformation
), but not both. If neither SourceBundle
nor SourceBuildInformation
are provided, Elastic Beanstalk uses a sample application.
The location of the platform definition archive in Amazon S3.
" } }, "S3LocationNotInServiceRegionException": { "base": "The specified S3 bucket does not belong to the S3 region in which the service is running. The following regions are supported:
IAD/us-east-1
PDX/us-west-2
DUB/eu-west-1
The specified account does not have a subscription to Amazon S3.
", "refs": { } }, "SampleTimestamp": { "base": null, "refs": { "EnvironmentInfoDescription$SampleTimestamp": "The time stamp when this information was retrieved.
" } }, "SingleInstanceHealth": { "base": "Detailed health information about an Amazon EC2 instance in your Elastic Beanstalk environment.
", "refs": { "InstanceHealthList$member": null } }, "SolutionStackDescription": { "base": "Describes the solution stack.
", "refs": { "AvailableSolutionStackDetailsList$member": null } }, "SolutionStackFileTypeList": { "base": null, "refs": { "SolutionStackDescription$PermittedFileTypes": "The permitted file types allowed for a solution stack.
" } }, "SolutionStackName": { "base": null, "refs": { "AvailableSolutionStackNamesList$member": null, "ConfigurationOptionsDescription$SolutionStackName": "The name of the solution stack these configuration options belong to.
", "ConfigurationSettingsDescription$SolutionStackName": "The name of the solution stack this configuration set uses.
", "CreateConfigurationTemplateMessage$SolutionStackName": "The name of the solution stack used by this configuration. The solution stack specifies the operating system, architecture, and application server for a configuration template. It determines the set of configuration options as well as the possible and default values.
Use ListAvailableSolutionStacks to obtain a list of available solution stacks.
A solution stack name or a source configuration parameter must be specified, otherwise AWS Elastic Beanstalk returns an InvalidParameterValue
error.
If a solution stack name is not specified and the source configuration parameter is specified, AWS Elastic Beanstalk uses the same solution stack as the source configuration template.
", "CreateEnvironmentMessage$SolutionStackName": "This is an alternative to specifying a template name. If specified, AWS Elastic Beanstalk sets the configuration values to the default values associated with the specified solution stack.
", "DescribeConfigurationOptionsMessage$SolutionStackName": "The name of the solution stack whose configuration options you want to describe.
", "EnvironmentDescription$SolutionStackName": " The name of the SolutionStack
deployed with this environment.
The name of the solution stack used by the platform.
", "SolutionStackDescription$SolutionStackName": "The name of the solution stack.
", "UpdateEnvironmentMessage$SolutionStackName": "This specifies the platform version that the environment will run after the environment is updated.
" } }, "SourceBuildInformation": { "base": "Location of the source code for an application version.
", "refs": { "ApplicationVersionDescription$SourceBuildInformation": "If the version's source code was retrieved from AWS CodeCommit, the location of the source code for the application version.
", "CreateApplicationVersionMessage$SourceBuildInformation": "Specify a commit in an AWS CodeCommit Git repository to use as the source code for the application version.
" } }, "SourceBundleDeletionException": { "base": "Unable to delete the Amazon S3 source bundle associated with the application version. The application version was deleted successfully.
", "refs": { } }, "SourceConfiguration": { "base": "A specification for an environment configuration
", "refs": { "CreateConfigurationTemplateMessage$SourceConfiguration": "If specified, AWS Elastic Beanstalk uses the configuration values from the specified configuration template to create a new configuration.
Values specified in the OptionSettings
parameter of this call overrides any values obtained from the SourceConfiguration
.
If no configuration template is found, returns an InvalidParameterValue
error.
Constraint: If both the solution stack name parameter and the source configuration parameters are specified, the solution stack of the source configuration template must match the specified solution stack name or else AWS Elastic Beanstalk returns an InvalidParameterCombination
error.
The location of the source code, as a formatted string, depending on the value of SourceRepository
For CodeCommit
, the format is the repository name and commit ID, separated by a forward slash. For example, my-git-repo/265cfa0cf6af46153527f55d6503ec030551f57a
.
For S3
, the format is the S3 bucket name and object key, separated by a forward slash. For example, my-s3-bucket/Folders/my-source-file
.
Location where the repository is stored.
CodeCommit
S3
The type of repository.
Git
Zip
Represents the percentage of requests over the last 10 seconds that resulted in each type of status code response. For more information, see Status Code Definitions.
", "refs": { "ApplicationMetrics$StatusCodes": "Represents the percentage of requests over the last 10 seconds that resulted in each type of status code response.
" } }, "String": { "base": null, "refs": { "ApplicationResourceLifecycleConfig$ServiceRole": "The ARN of an IAM service role that Elastic Beanstalk has permission to assume.
", "ApplicationVersionDescription$BuildArn": "Reference to the artifact from the AWS CodeBuild build.
", "ApplyEnvironmentManagedActionRequest$EnvironmentName": "The name of the target environment.
", "ApplyEnvironmentManagedActionRequest$EnvironmentId": "The environment ID of the target environment.
", "ApplyEnvironmentManagedActionRequest$ActionId": "The action ID of the scheduled managed action to execute.
", "ApplyEnvironmentManagedActionResult$ActionId": "The action ID of the managed action.
", "ApplyEnvironmentManagedActionResult$ActionDescription": "A description of the managed action.
", "ApplyEnvironmentManagedActionResult$Status": "The status of the managed action.
", "BuildConfiguration$ArtifactName": "The name of the artifact of the CodeBuild build. If provided, Elastic Beanstalk stores the build artifact in the S3 location S3-bucket/resources/application-name/codebuild/codebuild-version-label-artifact-name.zip. If not provided, Elastic Beanstalk stores the build artifact in the S3 location S3-bucket/resources/application-name/codebuild/codebuild-version-label.zip.
", "Deployment$VersionLabel": "The version label of the application version in the deployment.
", "Deployment$Status": "The status of the deployment:
In Progress
: The deployment is in progress.
Deployed
: The deployment succeeded.
Failed
: The deployment failed.
The health status of the environment. For example, Ok
.
The health color of the environment.
", "DescribeEnvironmentManagedActionHistoryRequest$NextToken": "The pagination token returned by a previous request.
", "DescribeEnvironmentManagedActionHistoryResult$NextToken": "A pagination token that you pass to DescribeEnvironmentManagedActionHistory to get the next page of results.
", "DescribeEnvironmentManagedActionsRequest$EnvironmentName": "The name of the target environment.
", "DescribeEnvironmentManagedActionsRequest$EnvironmentId": "The environment ID of the target environment.
", "EnvironmentLink$LinkName": "The name of the link.
", "EnvironmentLink$EnvironmentName": "The name of the linked environment (the dependency).
", "EnvironmentTier$Name": "The name of this environment tier.
", "EnvironmentTier$Type": "The type of this environment tier.
", "EnvironmentTier$Version": "The version of this environment tier.
", "Listener$Protocol": "The protocol that is used by the Listener.
", "LoadBalancerDescription$LoadBalancerName": "The name of the LoadBalancer.
", "LoadBalancerDescription$Domain": "The domain name of the LoadBalancer.
", "ManagedAction$ActionId": "A unique identifier for the managed action.
", "ManagedAction$ActionDescription": "A description of the managed action.
", "ManagedActionHistoryItem$ActionId": "A unique identifier for the managed action.
", "ManagedActionHistoryItem$ActionDescription": "A description of the managed action.
", "ManagedActionHistoryItem$FailureDescription": "If the action failed, a description of the failure.
", "PlatformFramework$Name": "The name of the framework.
", "PlatformFramework$Version": "The version of the framework.
", "PlatformProgrammingLanguage$Name": "The name of the programming language.
", "PlatformProgrammingLanguage$Version": "The version of the programming language.
", "Queue$Name": "The name of the queue.
", "Queue$URL": "The URL of the queue.
", "SingleInstanceHealth$HealthStatus": "Returns the health status of the specified instance. For more information, see Health Colors and Statuses.
", "SingleInstanceHealth$Color": "Represents the color indicator that gives you information about the health of the EC2 instance. For more information, see Health Colors and Statuses.
", "SingleInstanceHealth$AvailabilityZone": "The availability zone in which the instance runs.
", "SingleInstanceHealth$InstanceType": "The instance's type.
" } }, "SupportedAddon": { "base": null, "refs": { "SupportedAddonList$member": null } }, "SupportedAddonList": { "base": null, "refs": { "PlatformDescription$SupportedAddonList": "The additions supported by the platform.
", "PlatformSummary$SupportedAddonList": "The additions associated with the platform.
" } }, "SupportedTier": { "base": null, "refs": { "SupportedTierList$member": null } }, "SupportedTierList": { "base": null, "refs": { "PlatformDescription$SupportedTierList": "The tiers supported by the platform.
", "PlatformSummary$SupportedTierList": "The tiers in which the platform runs.
" } }, "SwapEnvironmentCNAMEsMessage": { "base": "Swaps the CNAMEs of two environments.
", "refs": { } }, "SystemStatus": { "base": "CPU utilization and load average metrics for an Amazon EC2 instance.
", "refs": { "SingleInstanceHealth$System": "Operating system metrics from the instance.
" } }, "Tag": { "base": "Describes a tag applied to a resource in an environment.
", "refs": { "TagList$member": null, "Tags$member": null } }, "TagKey": { "base": null, "refs": { "Tag$Key": "The key of the tag.
", "TagKeyList$member": null } }, "TagKeyList": { "base": null, "refs": { "UpdateTagsForResourceMessage$TagsToRemove": "A list of tag keys to remove.
If a tag key doesn't exist, it is silently ignored.
" } }, "TagList": { "base": null, "refs": { "ResourceTagsDescriptionMessage$ResourceTags": "A list of tag key-value pairs.
", "UpdateTagsForResourceMessage$TagsToAdd": "A list of tags to add or update.
If a key of an existing tag is added, the tag's value is updated.
" } }, "TagValue": { "base": null, "refs": { "Tag$Value": "The value of the tag.
" } }, "Tags": { "base": null, "refs": { "CreateEnvironmentMessage$Tags": "This specifies the tags applied to resources in the environment.
" } }, "TerminateEnvForce": { "base": null, "refs": { "DeleteApplicationMessage$TerminateEnvByForce": "When set to true, running environments will be terminated before deleting the application.
" } }, "TerminateEnvironmentMessage": { "base": "Request to terminate an environment.
", "refs": { } }, "TerminateEnvironmentResources": { "base": null, "refs": { "TerminateEnvironmentMessage$TerminateResources": "Indicates whether the associated AWS resources should shut down when the environment is terminated:
true
: The specified environment as well as the associated AWS resources, such as Auto Scaling group and LoadBalancer, are terminated.
false
: AWS Elastic Beanstalk resource management is removed from the environment, but the AWS resources continue to operate.
For more information, see the AWS Elastic Beanstalk User Guide.
Default: true
Valid Values: true
| false
If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur up to, but not including, the EndTime
.
If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur on or after this time.
" } }, "Timestamp": { "base": null, "refs": { "ManagedAction$WindowStartTime": "The start time of the maintenance window in which the managed action will execute.
", "ManagedActionHistoryItem$ExecutedTime": "The date and time that the action started executing.
", "ManagedActionHistoryItem$FinishedTime": "The date and time that the action finished executing.
" } }, "Token": { "base": null, "refs": { "ApplicationVersionDescriptionsMessage$NextToken": "In a paginated request, the token that you can pass in a subsequent request to get the next response page.
", "DescribeApplicationVersionsMessage$NextToken": "For a paginated request. Specify a token from a previous response page to retrieve the next response page. All other parameter values must be identical to the ones specified in the initial request.
If no NextToken
is specified, the first page is retrieved.
For a paginated request. Specify a token from a previous response page to retrieve the next response page. All other parameter values must be identical to the ones specified in the initial request.
If no NextToken
is specified, the first page is retrieved.
Pagination token. If specified, the events return the next batch of results.
", "EnvironmentDescriptionsMessage$NextToken": "In a paginated request, the token that you can pass in a subsequent request to get the next response page.
", "EventDescriptionsMessage$NextToken": "If returned, this indicates that there are more results to obtain. Use this token in the next DescribeEvents call to get the next batch of events.
", "ListPlatformVersionsRequest$NextToken": "The starting index into the remaining list of platforms. Use the NextToken
value from a previous ListPlatformVersion
call.
The starting index into the remaining list of platforms. if this value is not null
, you can use it in a subsequent ListPlatformVersion
call.
The specified account has reached its limit of application versions.
", "refs": { } }, "TooManyApplicationsException": { "base": "The specified account has reached its limit of applications.
", "refs": { } }, "TooManyBucketsException": { "base": "The specified account has reached its limit of Amazon S3 buckets.
", "refs": { } }, "TooManyConfigurationTemplatesException": { "base": "The specified account has reached its limit of configuration templates.
", "refs": { } }, "TooManyEnvironmentsException": { "base": "The specified account has reached its limit of environments.
", "refs": { } }, "TooManyPlatformsException": { "base": "You have exceeded the maximum number of allowed platforms associated with the account.
", "refs": { } }, "TooManyTagsException": { "base": "The number of tags in the resource would exceed the number of tags that each resource can have.
To calculate this, the operation considers both the number of tags the resource already has and the tags this operation would add if it succeeded.
", "refs": { } }, "Trigger": { "base": "Describes a trigger.
", "refs": { "TriggerList$member": null } }, "TriggerList": { "base": null, "refs": { "EnvironmentResourceDescription$Triggers": "The AutoScaling
triggers in use by this environment.
Request to update an application.
", "refs": { } }, "UpdateApplicationResourceLifecycleMessage": { "base": null, "refs": { } }, "UpdateApplicationVersionMessage": { "base": "", "refs": { } }, "UpdateConfigurationTemplateMessage": { "base": "The result message containing the options for the specified solution stack.
", "refs": { } }, "UpdateDate": { "base": null, "refs": { "ApplicationDescription$DateUpdated": "The date when the application was last modified.
", "ApplicationVersionDescription$DateUpdated": "The last modified date of the application version.
", "ConfigurationSettingsDescription$DateUpdated": "The date (in UTC time) when this configuration set was last modified.
", "EnvironmentDescription$DateUpdated": "The last modified date for this environment.
", "PlatformDescription$DateUpdated": "The date when the platform was last updated.
" } }, "UpdateEnvironmentMessage": { "base": "Request to update an environment.
", "refs": { } }, "UpdateTagsForResourceMessage": { "base": null, "refs": { } }, "UserDefinedOption": { "base": null, "refs": { "ConfigurationOptionDescription$UserDefined": "An indication of whether the user defined this configuration option:
true
: This configuration option was defined by the user. It is a valid choice for specifying if this as an Option to Remove
when updating configuration settings.
false
: This configuration was not defined by the user.
Constraint: You can remove only UserDefined
options from a configuration.
Valid Values: true
| false
A list of validation messages for a specified configuration template.
", "refs": { } }, "ValidationMessage": { "base": "An error or warning for a desired configuration option value.
", "refs": { "ValidationMessagesList$member": null } }, "ValidationMessageString": { "base": null, "refs": { "ValidationMessage$Message": "A message describing the error or warning.
" } }, "ValidationMessagesList": { "base": null, "refs": { "ConfigurationSettingsValidationMessages$Messages": "A list of ValidationMessage.
" } }, "ValidationSeverity": { "base": null, "refs": { "ValidationMessage$Severity": "An indication of the severity of this message:
error
: This message indicates that this is not a valid setting for an option.
warning
: This message is providing information you should take into account.
A unique identifier for the application version.
", "CreateApplicationVersionMessage$VersionLabel": "A label identifying this version.
Constraint: Must be unique per application. If an application version already exists with this label for the specified application, AWS Elastic Beanstalk returns an InvalidParameterValue
error.
The name of the application version to deploy.
If the specified application has no associated application versions, AWS Elastic Beanstalk UpdateEnvironment
returns an InvalidParameterValue
error.
Default: If not specified, AWS Elastic Beanstalk attempts to launch the sample application in the container.
", "DeleteApplicationVersionMessage$VersionLabel": "The label of the version to delete.
", "DescribeEnvironmentsMessage$VersionLabel": "If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.
", "DescribeEventsMessage$VersionLabel": "If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this application version.
", "EnvironmentDescription$VersionLabel": "The application version deployed in this environment.
", "EventDescription$VersionLabel": "The release label for the application version associated with this event.
", "UpdateApplicationVersionMessage$VersionLabel": "The name of the version to update.
If no application version is found with this label, UpdateApplication
returns an InvalidParameterValue
error.
If this parameter is specified, AWS Elastic Beanstalk deploys the named application version to the environment. If no such application version is found, returns an InvalidParameterValue
error.
A list of version labels, specifying one or more application source bundles that belong to the target application. Each source bundle must include an environment manifest that specifies the name of the environment and the name of the solution stack to use, and optionally can specify environment links to create.
" } }, "VersionLabelsList": { "base": null, "refs": { "ApplicationDescription$Versions": "The names of the versions for this application.
", "DescribeApplicationVersionsMessage$VersionLabels": "Specify a version label to show a specific application version.
" } }, "VirtualizationType": { "base": null, "refs": { "CustomAmi$VirtualizationType": "The type of virtualization used to create the custom AMI.
" } } } }