Cancels in-progress environment configuration update or application version deployment.
" }, "ApplyEnvironmentManagedAction": { "name": "ApplyEnvironmentManagedAction", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ApplyEnvironmentManagedActionRequest" }, "output": { "shape": "ApplyEnvironmentManagedActionResult", "resultWrapper": "ApplyEnvironmentManagedActionResult" }, "errors": [ { "shape": "ElasticBeanstalkServiceException" }, { "shape": "ManagedActionInvalidStateException" } ], "documentation": "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.
Add or change the operations role used by an environment. After this call is made, Elastic Beanstalk uses the associated operations role for permissions to downstream services during subsequent calls acting on this environment. For more information, see Operations roles in the AWS Elastic Beanstalk Developer Guide.
" }, "CheckDNSAvailability": { "name": "CheckDNSAvailability", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CheckDNSAvailabilityMessage" }, "output": { "shape": "CheckDNSAvailabilityResultMessage", "resultWrapper": "CheckDNSAvailabilityResult" }, "documentation": "Checks if the specified CNAME is available.
" }, "ComposeEnvironments": { "name": "ComposeEnvironments", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ComposeEnvironmentsMessage" }, "output": { "shape": "EnvironmentDescriptionsMessage", "resultWrapper": "ComposeEnvironmentsResult" }, "errors": [ { "shape": "TooManyEnvironmentsException" }, { "shape": "InsufficientPrivilegesException" } ], "documentation": "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.
After you create an application version with a specified Amazon S3 bucket and key location, you can't change that Amazon S3 location. If you change the Amazon S3 location, you receive an exception when you attempt to launch an environment from the application version.
Creates an AWS Elastic Beanstalk configuration template, associated with a specific Elastic Beanstalk application. You define application configuration settings in a configuration template. You can then use the configuration template to deploy different versions of the application with the same configuration settings.
Templates aren't associated with any environment. The EnvironmentName response element is always null.
Related Topics
" }, "CreateEnvironment": { "name": "CreateEnvironment", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateEnvironmentMessage" }, "output": { "shape": "EnvironmentDescription", "resultWrapper": "CreateEnvironmentResult" }, "errors": [ { "shape": "TooManyEnvironmentsException" }, { "shape": "InsufficientPrivilegesException" } ], "documentation": "Launches an AWS Elastic Beanstalk environment for the specified application using the specified configuration.
" }, "CreatePlatformVersion": { "name": "CreatePlatformVersion", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreatePlatformVersionRequest" }, "output": { "shape": "CreatePlatformVersionResult", "resultWrapper": "CreatePlatformVersionResult" }, "errors": [ { "shape": "InsufficientPrivilegesException" }, { "shape": "ElasticBeanstalkServiceException" }, { "shape": "TooManyPlatformsException" } ], "documentation": "Create a new version of your custom platform.
" }, "CreateStorageLocation": { "name": "CreateStorageLocation", "http": { "method": "POST", "requestUri": "/" }, "output": { "shape": "CreateStorageLocationResultMessage", "resultWrapper": "CreateStorageLocationResult" }, "errors": [ { "shape": "TooManyBucketsException" }, { "shape": "S3SubscriptionRequiredException" }, { "shape": "InsufficientPrivilegesException" } ], "documentation": "Creates a bucket in Amazon S3 to store application versions, logs, and other files used by Elastic Beanstalk environments. The Elastic Beanstalk console and EB CLI call this API the first time you create an environment in a region. If the storage location already exists, CreateStorageLocation still returns the bucket name but does not create a new bucket.
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.
" }, "DescribeAccountAttributes": { "name": "DescribeAccountAttributes", "http": { "method": "POST", "requestUri": "/" }, "output": { "shape": "DescribeAccountAttributesResult", "resultWrapper": "DescribeAccountAttributesResult" }, "errors": [ { "shape": "InsufficientPrivilegesException" } ], "documentation": "Returns attributes related to AWS Elastic Beanstalk that are associated with the calling AWS account.
The result currently has one set of attributes—resource quotas.
" }, "DescribeApplicationVersions": { "name": "DescribeApplicationVersions", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeApplicationVersionsMessage" }, "output": { "shape": "ApplicationVersionDescriptionsMessage", "resultWrapper": "DescribeApplicationVersionsResult" }, "documentation": "Retrieve a list of application versions.
" }, "DescribeApplications": { "name": "DescribeApplications", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeApplicationsMessage" }, "output": { "shape": "ApplicationDescriptionsMessage", "resultWrapper": "DescribeApplicationsResult" }, "documentation": "Returns the descriptions of existing applications.
" }, "DescribeConfigurationOptions": { "name": "DescribeConfigurationOptions", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeConfigurationOptionsMessage" }, "output": { "shape": "ConfigurationOptionsDescription", "resultWrapper": "DescribeConfigurationOptionsResult" }, "errors": [ { "shape": "TooManyBucketsException" } ], "documentation": "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": { "name": "DescribeConfigurationSettings", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeConfigurationSettingsMessage" }, "output": { "shape": "ConfigurationSettingsDescriptions", "resultWrapper": "DescribeConfigurationSettingsResult" }, "errors": [ { "shape": "TooManyBucketsException" } ], "documentation": "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": { "name": "DescribeEnvironmentHealth", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeEnvironmentHealthRequest" }, "output": { "shape": "DescribeEnvironmentHealthResult", "resultWrapper": "DescribeEnvironmentHealthResult" }, "errors": [ { "shape": "InvalidRequestException" }, { "shape": "ElasticBeanstalkServiceException" } ], "documentation": "Returns information about the overall health of the specified environment. The DescribeEnvironmentHealth operation is only available with AWS Elastic Beanstalk Enhanced Health.
" }, "DescribeEnvironmentManagedActionHistory": { "name": "DescribeEnvironmentManagedActionHistory", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeEnvironmentManagedActionHistoryRequest" }, "output": { "shape": "DescribeEnvironmentManagedActionHistoryResult", "resultWrapper": "DescribeEnvironmentManagedActionHistoryResult" }, "errors": [ { "shape": "ElasticBeanstalkServiceException" } ], "documentation": "Lists an environment's completed and failed managed actions.
" }, "DescribeEnvironmentManagedActions": { "name": "DescribeEnvironmentManagedActions", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeEnvironmentManagedActionsRequest" }, "output": { "shape": "DescribeEnvironmentManagedActionsResult", "resultWrapper": "DescribeEnvironmentManagedActionsResult" }, "errors": [ { "shape": "ElasticBeanstalkServiceException" } ], "documentation": "Lists an environment's upcoming and in-progress managed actions.
" }, "DescribeEnvironmentResources": { "name": "DescribeEnvironmentResources", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeEnvironmentResourcesMessage" }, "output": { "shape": "EnvironmentResourceDescriptionsMessage", "resultWrapper": "DescribeEnvironmentResourcesResult" }, "errors": [ { "shape": "InsufficientPrivilegesException" } ], "documentation": "Returns AWS resources for this environment.
" }, "DescribeEnvironments": { "name": "DescribeEnvironments", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeEnvironmentsMessage" }, "output": { "shape": "EnvironmentDescriptionsMessage", "resultWrapper": "DescribeEnvironmentsResult" }, "documentation": "Returns descriptions for existing environments.
" }, "DescribeEvents": { "name": "DescribeEvents", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeEventsMessage" }, "output": { "shape": "EventDescriptionsMessage", "resultWrapper": "DescribeEventsResult" }, "documentation": "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.
Retrieves detailed information about the health of instances in your AWS Elastic Beanstalk. This operation requires enhanced health reporting.
" }, "DescribePlatformVersion": { "name": "DescribePlatformVersion", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribePlatformVersionRequest" }, "output": { "shape": "DescribePlatformVersionResult", "resultWrapper": "DescribePlatformVersionResult" }, "errors": [ { "shape": "InsufficientPrivilegesException" }, { "shape": "ElasticBeanstalkServiceException" } ], "documentation": "Describes a platform version. Provides full details. Compare to ListPlatformVersions, which provides summary information about a list of platform versions.
For definitions of platform version and other platform-related terms, see AWS Elastic Beanstalk Platforms Glossary.
" }, "DisassociateEnvironmentOperationsRole": { "name": "DisassociateEnvironmentOperationsRole", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DisassociateEnvironmentOperationsRoleMessage" }, "errors": [ { "shape": "InsufficientPrivilegesException" } ], "documentation": "Disassociate the operations role from an environment. After this call is made, Elastic Beanstalk uses the caller's permissions for permissions to downstream services during subsequent calls acting on this environment. For more information, see Operations roles in the AWS Elastic Beanstalk Developer Guide.
" }, "ListAvailableSolutionStacks": { "name": "ListAvailableSolutionStacks", "http": { "method": "POST", "requestUri": "/" }, "output": { "shape": "ListAvailableSolutionStacksResultMessage", "resultWrapper": "ListAvailableSolutionStacksResult" }, "documentation": "Returns a list of the available solution stack names, with the public version first and then in reverse chronological order.
" }, "ListPlatformBranches": { "name": "ListPlatformBranches", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ListPlatformBranchesRequest" }, "output": { "shape": "ListPlatformBranchesResult", "resultWrapper": "ListPlatformBranchesResult" }, "documentation": "Lists the platform branches available for your account in an AWS Region. Provides summary information about each platform branch.
For definitions of platform branch and other platform-related terms, see AWS Elastic Beanstalk Platforms Glossary.
" }, "ListPlatformVersions": { "name": "ListPlatformVersions", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ListPlatformVersionsRequest" }, "output": { "shape": "ListPlatformVersionsResult", "resultWrapper": "ListPlatformVersionsResult" }, "errors": [ { "shape": "InsufficientPrivilegesException" }, { "shape": "ElasticBeanstalkServiceException" } ], "documentation": "Lists the platform versions available for your account in an AWS Region. Provides summary information about each platform version. Compare to DescribePlatformVersion, which provides full details about a single platform version.
For definitions of platform version and other platform-related terms, see AWS Elastic Beanstalk Platforms Glossary.
" }, "ListTagsForResource": { "name": "ListTagsForResource", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ListTagsForResourceMessage" }, "output": { "shape": "ResourceTagsDescriptionMessage", "resultWrapper": "ListTagsForResourceResult" }, "errors": [ { "shape": "InsufficientPrivilegesException" }, { "shape": "ResourceNotFoundException" }, { "shape": "ResourceTypeNotSupportedException" } ], "documentation": "Return the tags applied to an AWS Elastic Beanstalk resource. The response contains a list of tag key-value pairs.
Elastic Beanstalk supports tagging of all of its resources. For details about resource tagging, see Tagging Application Resources.
" }, "RebuildEnvironment": { "name": "RebuildEnvironment", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "RebuildEnvironmentMessage" }, "errors": [ { "shape": "InsufficientPrivilegesException" } ], "documentation": "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": { "name": "RequestEnvironmentInfo", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "RequestEnvironmentInfoMessage" }, "documentation": "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": { "name": "RestartAppServer", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "RestartAppServerMessage" }, "documentation": "Causes the environment to restart the application container server running on each Amazon EC2 instance.
" }, "RetrieveEnvironmentInfo": { "name": "RetrieveEnvironmentInfo", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "RetrieveEnvironmentInfoMessage" }, "output": { "shape": "RetrieveEnvironmentInfoResultMessage", "resultWrapper": "RetrieveEnvironmentInfoResult" }, "documentation": "Retrieves the compiled information from a RequestEnvironmentInfo request.
Related Topics
" }, "SwapEnvironmentCNAMEs": { "name": "SwapEnvironmentCNAMEs", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "SwapEnvironmentCNAMEsMessage" }, "documentation": "Swaps the CNAMEs of two environments.
" }, "TerminateEnvironment": { "name": "TerminateEnvironment", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "TerminateEnvironmentMessage" }, "output": { "shape": "EnvironmentDescription", "resultWrapper": "TerminateEnvironmentResult" }, "errors": [ { "shape": "InsufficientPrivilegesException" } ], "documentation": "Terminates the specified environment.
" }, "UpdateApplication": { "name": "UpdateApplication", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "UpdateApplicationMessage" }, "output": { "shape": "ApplicationDescriptionMessage", "resultWrapper": "UpdateApplicationResult" }, "documentation": "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": { "name": "UpdateApplicationVersion", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "UpdateApplicationVersionMessage" }, "output": { "shape": "ApplicationVersionDescriptionMessage", "resultWrapper": "UpdateApplicationVersionResult" }, "documentation": "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": { "name": "UpdateEnvironment", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "UpdateEnvironmentMessage" }, "output": { "shape": "EnvironmentDescription", "resultWrapper": "UpdateEnvironmentResult" }, "errors": [ { "shape": "InsufficientPrivilegesException" }, { "shape": "TooManyBucketsException" } ], "documentation": "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.
Elastic Beanstalk supports tagging of all of its resources. For details about resource tagging, see Tagging Application Resources.
If you create a custom IAM user policy to control permission to this operation, specify one of the following two virtual actions (or both) instead of the API operation name:
Controls permission to call UpdateTagsForResource and pass a list of tags to add in the TagsToAdd parameter.
Controls permission to call UpdateTagsForResource and pass a list of tag keys to remove in the TagsToRemove parameter.
For details about creating a custom user policy, see Creating a Custom User Policy.
" }, "ValidateConfigurationSettings": { "name": "ValidateConfigurationSettings", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ValidateConfigurationSettingsMessage" }, "output": { "shape": "ConfigurationSettingsValidationMessages", "resultWrapper": "ValidateConfigurationSettingsResult" }, "errors": [ { "shape": "InsufficientPrivilegesException" }, { "shape": "TooManyBucketsException" } ], "documentation": "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": { "type": "string" }, "AbortEnvironmentUpdateMessage": { "type": "structure", "members": { "EnvironmentId": { "shape": "EnvironmentId", "documentation": "This specifies the ID of the environment with the in-progress update that you want to cancel.
" }, "EnvironmentName": { "shape": "EnvironmentName", "documentation": "This specifies the name of the environment with the in-progress update that you want to cancel.
" } }, "documentation": "" }, "AbortableOperationInProgress": { "type": "boolean" }, "ActionHistoryStatus": { "type": "string", "enum": [ "Completed", "Failed", "Unknown" ] }, "ActionStatus": { "type": "string", "enum": [ "Scheduled", "Pending", "Running", "Unknown" ] }, "ActionType": { "type": "string", "enum": [ "InstanceRefresh", "PlatformUpdate", "Unknown" ] }, "ApplicationArn": { "type": "string" }, "ApplicationDescription": { "type": "structure", "members": { "ApplicationArn": { "shape": "ApplicationArn", "documentation": "The Amazon Resource Name (ARN) of the application.
" }, "ApplicationName": { "shape": "ApplicationName", "documentation": "The name of the application.
" }, "Description": { "shape": "Description", "documentation": "User-defined description of the application.
" }, "DateCreated": { "shape": "CreationDate", "documentation": "The date when the application was created.
" }, "DateUpdated": { "shape": "UpdateDate", "documentation": "The date when the application was last modified.
" }, "Versions": { "shape": "VersionLabelsList", "documentation": "The names of the versions for this application.
" }, "ConfigurationTemplates": { "shape": "ConfigurationTemplateNamesList", "documentation": "The names of the configuration templates associated with this application.
" }, "ResourceLifecycleConfig": { "shape": "ApplicationResourceLifecycleConfig", "documentation": "The lifecycle settings for the application.
" } }, "documentation": "Describes the properties of an application.
" }, "ApplicationDescriptionList": { "type": "list", "member": { "shape": "ApplicationDescription" } }, "ApplicationDescriptionMessage": { "type": "structure", "members": { "Application": { "shape": "ApplicationDescription", "documentation": "The ApplicationDescription of the application.
" } }, "documentation": "Result message containing a single description of an application.
" }, "ApplicationDescriptionsMessage": { "type": "structure", "members": { "Applications": { "shape": "ApplicationDescriptionList", "documentation": "This parameter contains a list of ApplicationDescription.
" } }, "documentation": "Result message containing a list of application descriptions.
" }, "ApplicationMetrics": { "type": "structure", "members": { "Duration": { "shape": "NullableInteger", "documentation": "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).
Average number of requests handled by the web server per second over the last 10 seconds.
" }, "StatusCodes": { "shape": "StatusCodes", "documentation": "Represents the percentage of requests over the last 10 seconds that resulted in each type of status code response.
" }, "Latency": { "shape": "Latency", "documentation": "Represents the average latency for the slowest X percent of requests over the last 10 seconds. Latencies are in seconds with one millisecond resolution.
" } }, "documentation": "Application request metrics for an AWS Elastic Beanstalk environment.
" }, "ApplicationName": { "type": "string", "max": 100, "min": 1 }, "ApplicationNamesList": { "type": "list", "member": { "shape": "ApplicationName" } }, "ApplicationResourceLifecycleConfig": { "type": "structure", "members": { "ServiceRole": { "shape": "String", "documentation": "The ARN of an IAM service role that Elastic Beanstalk has permission to assume.
The ServiceRole property is required the first time that you provide a VersionLifecycleConfig for the application in one of the supporting calls (CreateApplication or UpdateApplicationResourceLifecycle). After you provide it once, in either one of the calls, Elastic Beanstalk persists the Service Role with the application, and you don't need to specify it again in subsequent UpdateApplicationResourceLifecycle calls. You can, however, specify it in subsequent calls to change the Service Role to another value.
Defines lifecycle settings for application versions.
" } }, "documentation": "The resource lifecycle configuration for an application. Defines lifecycle settings for resources that belong to the application, and the service role that AWS Elastic Beanstalk assumes in order to apply lifecycle settings. The version lifecycle configuration defines lifecycle settings for application versions.
" }, "ApplicationResourceLifecycleDescriptionMessage": { "type": "structure", "members": { "ApplicationName": { "shape": "ApplicationName", "documentation": "The name of the application.
" }, "ResourceLifecycleConfig": { "shape": "ApplicationResourceLifecycleConfig", "documentation": "The lifecycle configuration.
" } } }, "ApplicationVersionArn": { "type": "string" }, "ApplicationVersionDescription": { "type": "structure", "members": { "ApplicationVersionArn": { "shape": "ApplicationVersionArn", "documentation": "The Amazon Resource Name (ARN) of the application version.
" }, "ApplicationName": { "shape": "ApplicationName", "documentation": "The name of the application to which the application version belongs.
" }, "Description": { "shape": "Description", "documentation": "The description of the application version.
" }, "VersionLabel": { "shape": "VersionLabel", "documentation": "A unique identifier for the application version.
" }, "SourceBuildInformation": { "shape": "SourceBuildInformation", "documentation": "If the version's source code was retrieved from AWS CodeCommit, the location of the source code for the application version.
" }, "BuildArn": { "shape": "String", "documentation": "Reference to the artifact from the AWS CodeBuild build.
" }, "SourceBundle": { "shape": "S3Location", "documentation": "The storage location of the application version's source bundle in Amazon S3.
" }, "DateCreated": { "shape": "CreationDate", "documentation": "The creation date of the application version.
" }, "DateUpdated": { "shape": "UpdateDate", "documentation": "The last modified date of the application version.
" }, "Status": { "shape": "ApplicationVersionStatus", "documentation": "The processing status of the application version. Reflects the state of the application version during its creation. Many of the values are only applicable if you specified True for the Process parameter of the CreateApplicationVersion action. The following list describes the possible values.
Unprocessed – Application version wasn't pre-processed or validated. Elastic Beanstalk will validate configuration files during deployment of the application version to an environment.
Processing – Elastic Beanstalk is currently processing the application version.
Building – Application version is currently undergoing an AWS CodeBuild build.
Processed – Elastic Beanstalk was successfully pre-processed and validated.
Failed – Either the AWS CodeBuild build failed or configuration files didn't pass validation. This application version isn't usable.
Describes the properties of an application version.
" }, "ApplicationVersionDescriptionList": { "type": "list", "member": { "shape": "ApplicationVersionDescription" } }, "ApplicationVersionDescriptionMessage": { "type": "structure", "members": { "ApplicationVersion": { "shape": "ApplicationVersionDescription", "documentation": "The ApplicationVersionDescription of the application version.
" } }, "documentation": "Result message wrapping a single description of an application version.
" }, "ApplicationVersionDescriptionsMessage": { "type": "structure", "members": { "ApplicationVersions": { "shape": "ApplicationVersionDescriptionList", "documentation": "List of ApplicationVersionDescription objects sorted in order of creation.
In a paginated request, the token that you can pass in a subsequent request to get the next response page.
" } }, "documentation": "Result message wrapping a list of application version descriptions.
" }, "ApplicationVersionLifecycleConfig": { "type": "structure", "members": { "MaxCountRule": { "shape": "MaxCountRule", "documentation": "Specify a max count rule to restrict the number of application versions that are retained for an application.
" }, "MaxAgeRule": { "shape": "MaxAgeRule", "documentation": "Specify a max age rule to restrict the length of time that application versions are retained for an application.
" } }, "documentation": "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.
" }, "ApplicationVersionProccess": { "type": "boolean" }, "ApplicationVersionStatus": { "type": "string", "enum": [ "Processed", "Unprocessed", "Failed", "Processing", "Building" ] }, "ApplyEnvironmentManagedActionRequest": { "type": "structure", "required": [ "ActionId" ], "members": { "EnvironmentName": { "shape": "String", "documentation": "The name of the target environment.
" }, "EnvironmentId": { "shape": "String", "documentation": "The environment ID of the target environment.
" }, "ActionId": { "shape": "String", "documentation": "The action ID of the scheduled managed action to execute.
" } }, "documentation": "Request to execute a scheduled managed action immediately.
" }, "ApplyEnvironmentManagedActionResult": { "type": "structure", "members": { "ActionId": { "shape": "String", "documentation": "The action ID of the managed action.
" }, "ActionDescription": { "shape": "String", "documentation": "A description of the managed action.
" }, "ActionType": { "shape": "ActionType", "documentation": "The type of managed action.
" }, "Status": { "shape": "String", "documentation": "The status of the managed action.
" } }, "documentation": "The result message containing information about the managed action.
" }, "AssociateEnvironmentOperationsRoleMessage": { "type": "structure", "required": [ "EnvironmentName", "OperationsRole" ], "members": { "EnvironmentName": { "shape": "EnvironmentName", "documentation": "The name of the environment to which to set the operations role.
" }, "OperationsRole": { "shape": "OperationsRole", "documentation": "The Amazon Resource Name (ARN) of an existing IAM role to be used as the environment's operations role.
" } }, "documentation": "Request to add or change the operations role used by an environment.
" }, "AutoCreateApplication": { "type": "boolean" }, "AutoScalingGroup": { "type": "structure", "members": { "Name": { "shape": "ResourceId", "documentation": "The name of the AutoScalingGroup .
Describes an Auto Scaling launch configuration.
" }, "AutoScalingGroupList": { "type": "list", "member": { "shape": "AutoScalingGroup" } }, "AvailableSolutionStackDetailsList": { "type": "list", "member": { "shape": "SolutionStackDescription" } }, "AvailableSolutionStackNamesList": { "type": "list", "member": { "shape": "SolutionStackName" } }, "BoxedBoolean": { "type": "boolean" }, "BoxedInt": { "type": "integer" }, "BranchName": { "type": "string" }, "BranchOrder": { "type": "integer" }, "BuildConfiguration": { "type": "structure", "required": [ "CodeBuildServiceRole", "Image" ], "members": { "ArtifactName": { "shape": "String", "documentation": "The name of the artifact of the CodeBuild build. If provided, Elastic Beanstalk stores the build artifact in the S3 location S3-bucket/resources/application-name/codebuild/codebuild-version-label-artifact-name.zip. If not provided, Elastic Beanstalk stores the build artifact in the S3 location S3-bucket/resources/application-name/codebuild/codebuild-version-label.zip.
" }, "CodeBuildServiceRole": { "shape": "NonEmptyString", "documentation": "The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.
" }, "ComputeType": { "shape": "ComputeType", "documentation": "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
The ID of the Docker image to use for this build project.
" }, "TimeoutInMinutes": { "shape": "BoxedInt", "documentation": "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.
" } }, "documentation": "Settings for an AWS CodeBuild build.
" }, "Builder": { "type": "structure", "members": { "ARN": { "shape": "ARN", "documentation": "The ARN of the builder.
" } }, "documentation": "The builder used to build the custom platform.
" }, "CPUUtilization": { "type": "structure", "members": { "User": { "shape": "NullableDouble", "documentation": "Percentage of time that the CPU has spent in the User state over the last 10 seconds.
Available on Linux environments only.
Percentage of time that the CPU has spent in the Nice state over the last 10 seconds.
Available on Linux environments only.
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.
Available on Linux environments only.
Percentage of time that the CPU has spent in the I/O Wait state over the last 10 seconds.
Available on Linux environments only.
Percentage of time that the CPU has spent in the IRQ state over the last 10 seconds.
Available on Linux environments only.
Percentage of time that the CPU has spent in the SoftIRQ state over the last 10 seconds.
Available on Windows environments only.
Percentage of time that the CPU has spent in the Privileged state over the last 10 seconds.
CPU utilization metrics for an instance.
" }, "Cause": { "type": "string", "max": 255, "min": 1 }, "Causes": { "type": "list", "member": { "shape": "Cause" } }, "CheckDNSAvailabilityMessage": { "type": "structure", "required": [ "CNAMEPrefix" ], "members": { "CNAMEPrefix": { "shape": "DNSCnamePrefix", "documentation": "The prefix used when this CNAME is reserved.
" } }, "documentation": "Results message indicating whether a CNAME is available.
" }, "CheckDNSAvailabilityResultMessage": { "type": "structure", "members": { "Available": { "shape": "CnameAvailability", "documentation": "Indicates if the specified CNAME is available:
true : The CNAME is available.
false : The CNAME is not available.
The fully qualified CNAME to reserve when CreateEnvironment is called with the provided prefix.
" } }, "documentation": "Indicates if the specified CNAME is available.
" }, "CnameAvailability": { "type": "boolean" }, "ComposeEnvironmentsMessage": { "type": "structure", "members": { "ApplicationName": { "shape": "ApplicationName", "documentation": "The name of the application to which the specified source bundles belong.
" }, "GroupName": { "shape": "GroupName", "documentation": "The name of the group to which the target environments belong. Specify a group name only if the environment name defined in each target environment's manifest ends with a + (plus) character. See Environment Manifest (env.yaml) for details.
" }, "VersionLabels": { "shape": "VersionLabels", "documentation": "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.
" } }, "documentation": "Request to create or update a group of environments.
" }, "ComputeType": { "type": "string", "enum": [ "BUILD_GENERAL1_SMALL", "BUILD_GENERAL1_MEDIUM", "BUILD_GENERAL1_LARGE" ] }, "ConfigurationDeploymentStatus": { "type": "string", "enum": [ "deployed", "pending", "failed" ] }, "ConfigurationOptionDefaultValue": { "type": "string" }, "ConfigurationOptionDescription": { "type": "structure", "members": { "Namespace": { "shape": "OptionNamespace", "documentation": "A unique namespace identifying the option's associated AWS resource.
" }, "Name": { "shape": "ConfigurationOptionName", "documentation": "The name of the configuration option.
" }, "DefaultValue": { "shape": "ConfigurationOptionDefaultValue", "documentation": "The default value for this configuration option.
" }, "ChangeSeverity": { "shape": "ConfigurationOptionSeverity", "documentation": "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.
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
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.
If specified, values for the configuration option are selected from this list.
" }, "MinValue": { "shape": "OptionRestrictionMinValue", "documentation": "If specified, the configuration option must be a numeric value greater than this value.
" }, "MaxValue": { "shape": "OptionRestrictionMaxValue", "documentation": "If specified, the configuration option must be a numeric value less than this value.
" }, "MaxLength": { "shape": "OptionRestrictionMaxLength", "documentation": "If specified, the configuration option must be a string value no longer than this value.
" }, "Regex": { "shape": "OptionRestrictionRegex", "documentation": "If specified, the configuration option must be a string value that satisfies this regular expression.
" } }, "documentation": "Describes the possible values for a configuration option.
" }, "ConfigurationOptionDescriptionsList": { "type": "list", "member": { "shape": "ConfigurationOptionDescription" } }, "ConfigurationOptionName": { "type": "string" }, "ConfigurationOptionPossibleValue": { "type": "string" }, "ConfigurationOptionPossibleValues": { "type": "list", "member": { "shape": "ConfigurationOptionPossibleValue" } }, "ConfigurationOptionSetting": { "type": "structure", "members": { "ResourceName": { "shape": "ResourceName", "documentation": "A unique resource name for the option setting. Use it for a time–based scaling configuration option.
" }, "Namespace": { "shape": "OptionNamespace", "documentation": "A unique namespace that identifies the option's associated AWS resource.
" }, "OptionName": { "shape": "ConfigurationOptionName", "documentation": "The name of the configuration option.
" }, "Value": { "shape": "ConfigurationOptionValue", "documentation": "The current value for the configuration option.
" } }, "documentation": "A specification identifying an individual configuration option along with its current value. For a list of possible namespaces and option values, see Option Values in the AWS Elastic Beanstalk Developer Guide.
" }, "ConfigurationOptionSettingsList": { "type": "list", "member": { "shape": "ConfigurationOptionSetting" } }, "ConfigurationOptionSeverity": { "type": "string" }, "ConfigurationOptionValue": { "type": "string" }, "ConfigurationOptionValueType": { "type": "string", "enum": [ "Scalar", "List" ] }, "ConfigurationOptionsDescription": { "type": "structure", "members": { "SolutionStackName": { "shape": "SolutionStackName", "documentation": "The name of the solution stack these configuration options belong to.
" }, "PlatformArn": { "shape": "PlatformArn", "documentation": "The ARN of the platform version.
" }, "Options": { "shape": "ConfigurationOptionDescriptionsList", "documentation": "A list of ConfigurationOptionDescription.
" } }, "documentation": "Describes the settings for a specified configuration set.
" }, "ConfigurationSettingsDescription": { "type": "structure", "members": { "SolutionStackName": { "shape": "SolutionStackName", "documentation": "The name of the solution stack this configuration set uses.
" }, "PlatformArn": { "shape": "PlatformArn", "documentation": "The ARN of the platform version.
" }, "ApplicationName": { "shape": "ApplicationName", "documentation": "The name of the application associated with this configuration set.
" }, "TemplateName": { "shape": "ConfigurationTemplateName", "documentation": " If not null, the name of the configuration template for this configuration set.
Describes this configuration set.
" }, "EnvironmentName": { "shape": "EnvironmentName", "documentation": " If not null, the name of the environment for this configuration set.
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 date (in UTC time) when this configuration set was created.
" }, "DateUpdated": { "shape": "UpdateDate", "documentation": "The date (in UTC time) when this configuration set was last modified.
" }, "OptionSettings": { "shape": "ConfigurationOptionSettingsList", "documentation": "A list of the configuration options and their values in this configuration set.
" } }, "documentation": "Describes the settings for a configuration set.
" }, "ConfigurationSettingsDescriptionList": { "type": "list", "member": { "shape": "ConfigurationSettingsDescription" } }, "ConfigurationSettingsDescriptions": { "type": "structure", "members": { "ConfigurationSettings": { "shape": "ConfigurationSettingsDescriptionList", "documentation": "A list of ConfigurationSettingsDescription.
" } }, "documentation": "The results from a request to change the configuration settings of an environment.
" }, "ConfigurationSettingsValidationMessages": { "type": "structure", "members": { "Messages": { "shape": "ValidationMessagesList", "documentation": "A list of ValidationMessage.
" } }, "documentation": "Provides a list of validation messages.
" }, "ConfigurationTemplateName": { "type": "string", "max": 100, "min": 1 }, "ConfigurationTemplateNamesList": { "type": "list", "member": { "shape": "ConfigurationTemplateName" } }, "CreateApplicationMessage": { "type": "structure", "required": [ "ApplicationName" ], "members": { "ApplicationName": { "shape": "ApplicationName", "documentation": "The name of the application. Must be unique within your account.
" }, "Description": { "shape": "Description", "documentation": "Your description of the application.
" }, "ResourceLifecycleConfig": { "shape": "ApplicationResourceLifecycleConfig", "documentation": "Specifies an application resource lifecycle configuration to prevent your application from accumulating too many versions.
" }, "Tags": { "shape": "Tags", "documentation": "Specifies the tags applied to the application.
Elastic Beanstalk applies these tags only to the application. Environments that you create in the application don't inherit the tags.
" } }, "documentation": "Request to create an application.
" }, "CreateApplicationVersionMessage": { "type": "structure", "required": [ "ApplicationName", "VersionLabel" ], "members": { "ApplicationName": { "shape": "ApplicationName", "documentation": " The name of the application. If no application is found with this name, and AutoCreateApplication is false, returns an InvalidParameterValue error.
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.
A description of this application version.
" }, "SourceBuildInformation": { "shape": "SourceBuildInformation", "documentation": "Specify a commit in an AWS CodeCommit Git repository to use as the source code for the application version.
" }, "SourceBundle": { "shape": "S3Location", "documentation": "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.
Settings for an AWS CodeBuild build.
" }, "AutoCreateApplication": { "shape": "AutoCreateApplication", "documentation": "Set to true to create an application with the specified name if it doesn't already exist.
Pre-processes and validates the environment manifest (env.yaml) and configuration files (*.config files in the .ebextensions folder) in the source bundle. Validating configuration files can identify issues prior to deploying the application version to an environment.
You must turn processing on for application versions that you create using AWS CodeBuild or AWS CodeCommit. For application versions built from a source bundle in Amazon S3, processing is optional.
The Process option validates Elastic Beanstalk configuration files. It doesn't validate your application's configuration files, like proxy server or Docker configuration.
Specifies the tags applied to the application version.
Elastic Beanstalk applies these tags only to the application version. Environments that use the application version don't inherit the tags.
" } }, "documentation": "" }, "CreateConfigurationTemplateMessage": { "type": "structure", "required": [ "ApplicationName", "TemplateName" ], "members": { "ApplicationName": { "shape": "ApplicationName", "documentation": "The name of the Elastic Beanstalk application to associate with this configuration template.
" }, "TemplateName": { "shape": "ConfigurationTemplateName", "documentation": "The name of the configuration template.
Constraint: This name must be unique per application.
" }, "SolutionStackName": { "shape": "SolutionStackName", "documentation": "The name of an Elastic Beanstalk solution stack (platform version) that this configuration uses. For example, 64bit Amazon Linux 2013.09 running Tomcat 7 Java 7. A solution stack specifies the operating system, runtime, and application server for a configuration template. It also determines the set of configuration options as well as the possible and default values. For more information, see Supported Platforms in the AWS Elastic Beanstalk Developer Guide.
You must specify SolutionStackName if you don't specify PlatformArn, EnvironmentId, or SourceConfiguration.
Use the ListAvailableSolutionStacks API to obtain a list of available solution stacks.
The Amazon Resource Name (ARN) of the custom platform. For more information, see Custom Platforms in the AWS Elastic Beanstalk Developer Guide.
If you specify PlatformArn, then don't specify SolutionStackName.
An Elastic Beanstalk configuration template to base this one on. If specified, Elastic Beanstalk uses the configuration values from the specified configuration template to create a new configuration.
Values specified in OptionSettings override any values obtained from the SourceConfiguration.
You must specify SourceConfiguration if you don't specify PlatformArn, EnvironmentId, or SolutionStackName.
Constraint: If both solution stack name and source configuration are specified, the solution stack of the source configuration template must match the specified solution stack name.
" }, "EnvironmentId": { "shape": "EnvironmentId", "documentation": "The ID of an environment whose settings you want to use to create the configuration template. You must specify EnvironmentId if you don't specify PlatformArn, SolutionStackName, or SourceConfiguration.
An optional description for this configuration.
" }, "OptionSettings": { "shape": "ConfigurationOptionSettingsList", "documentation": "Option values for the Elastic Beanstalk configuration, such as the instance type. If specified, these values override the values obtained from the solution stack or the source configuration template. For a complete list of Elastic Beanstalk configuration options, see Option Values in the AWS Elastic Beanstalk Developer Guide.
" }, "Tags": { "shape": "Tags", "documentation": "Specifies the tags applied to the configuration template.
" } }, "documentation": "Request to create a configuration template.
" }, "CreateEnvironmentMessage": { "type": "structure", "required": [ "ApplicationName" ], "members": { "ApplicationName": { "shape": "ApplicationName", "documentation": "The name of the application that is associated with this environment.
" }, "EnvironmentName": { "shape": "EnvironmentName", "documentation": "A unique name for the environment.
Constraint: Must be from 4 to 40 characters in length. The name can contain only letters, numbers, and hyphens. It can't start or end with a hyphen. This name must be unique within a region in your account. If the specified name already exists in the region, Elastic Beanstalk returns an InvalidParameterValue error.
If you don't specify the CNAMEPrefix parameter, the environment name becomes part of the CNAME, and therefore part of the visible URL for your application.
The name of the group to which the target environment belongs. Specify a group name only if the environment's name is specified in an environment manifest and not with the environment name parameter. See Environment Manifest (env.yaml) for details.
" }, "Description": { "shape": "Description", "documentation": "Your description for this environment.
" }, "CNAMEPrefix": { "shape": "DNSCnamePrefix", "documentation": "If specified, the environment attempts to use this value as the prefix for the CNAME in your Elastic Beanstalk environment URL. If not specified, the CNAME is generated automatically by appending a random alphanumeric string to the environment name.
" }, "Tier": { "shape": "EnvironmentTier", "documentation": "Specifies the tier to use in creating this environment. The environment tier that you choose determines whether Elastic Beanstalk provisions resources to support a web application that handles HTTP(S) requests or a web application that handles background-processing tasks.
" }, "Tags": { "shape": "Tags", "documentation": "Specifies the tags applied to resources in the environment.
" }, "VersionLabel": { "shape": "VersionLabel", "documentation": "The name of the application version to deploy.
Default: If not specified, Elastic Beanstalk attempts to deploy the sample application.
" }, "TemplateName": { "shape": "ConfigurationTemplateName", "documentation": "The name of the Elastic Beanstalk configuration template to use with the environment.
If you specify TemplateName, then don't specify SolutionStackName.
The name of an Elastic Beanstalk solution stack (platform version) to use with the environment. If specified, Elastic Beanstalk sets the configuration values to the default values associated with the specified solution stack. For a list of current solution stacks, see Elastic Beanstalk Supported Platforms in the AWS Elastic Beanstalk Platforms guide.
If you specify SolutionStackName, don't specify PlatformArn or TemplateName.
The Amazon Resource Name (ARN) of the custom platform to use with the environment. For more information, see Custom Platforms in the AWS Elastic Beanstalk Developer Guide.
If you specify PlatformArn, don't specify SolutionStackName.
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.
" }, "OptionsToRemove": { "shape": "OptionsSpecifierList", "documentation": "A list of custom user-defined configuration options to remove from the configuration set for this new environment.
" }, "OperationsRole": { "shape": "OperationsRole", "documentation": "The Amazon Resource Name (ARN) of an existing IAM role to be used as the environment's operations role. If specified, Elastic Beanstalk uses the operations role for permissions to downstream services during this call and during subsequent calls acting on this environment. To specify an operations role, you must have the iam:PassRole permission for the role. For more information, see Operations roles in the AWS Elastic Beanstalk Developer Guide.
The name of your custom platform.
" }, "PlatformVersion": { "shape": "PlatformVersion", "documentation": "The number, such as 1.0.2, for the new platform version.
" }, "PlatformDefinitionBundle": { "shape": "S3Location", "documentation": "The location of the platform definition archive in Amazon S3.
" }, "EnvironmentName": { "shape": "EnvironmentName", "documentation": "The name of the builder environment.
" }, "OptionSettings": { "shape": "ConfigurationOptionSettingsList", "documentation": "The configuration option settings to apply to the builder environment.
" }, "Tags": { "shape": "Tags", "documentation": "Specifies the tags applied to the new platform version.
Elastic Beanstalk applies these tags only to the platform version. Environments that you create using the platform version don't inherit the tags.
" } }, "documentation": "Request to create a new platform version.
" }, "CreatePlatformVersionResult": { "type": "structure", "members": { "PlatformSummary": { "shape": "PlatformSummary", "documentation": "Detailed information about the new version of the custom platform.
" }, "Builder": { "shape": "Builder", "documentation": "The builder used to create the custom platform.
" } } }, "CreateStorageLocationResultMessage": { "type": "structure", "members": { "S3Bucket": { "shape": "S3Bucket", "documentation": "The name of the Amazon S3 bucket created.
" } }, "documentation": "Results of a CreateStorageLocationResult call.
" }, "CreationDate": { "type": "timestamp" }, "CustomAmi": { "type": "structure", "members": { "VirtualizationType": { "shape": "VirtualizationType", "documentation": "The type of virtualization used to create the custom AMI.
" }, "ImageId": { "shape": "ImageId", "documentation": "THe ID of the image used to create the custom AMI.
" } }, "documentation": "A custom AMI available to platforms.
" }, "CustomAmiList": { "type": "list", "member": { "shape": "CustomAmi" } }, "DNSCname": { "type": "string", "max": 255, "min": 1 }, "DNSCnamePrefix": { "type": "string", "max": 63, "min": 4 }, "DeleteApplicationMessage": { "type": "structure", "required": [ "ApplicationName" ], "members": { "ApplicationName": { "shape": "ApplicationName", "documentation": "The name of the application to delete.
" }, "TerminateEnvByForce": { "shape": "TerminateEnvForce", "documentation": "When set to true, running environments will be terminated before deleting the application.
" } }, "documentation": "Request to delete an application.
" }, "DeleteApplicationVersionMessage": { "type": "structure", "required": [ "ApplicationName", "VersionLabel" ], "members": { "ApplicationName": { "shape": "ApplicationName", "documentation": "The name of the application to which the version belongs.
" }, "VersionLabel": { "shape": "VersionLabel", "documentation": "The label of the version to delete.
" }, "DeleteSourceBundle": { "shape": "DeleteSourceBundle", "documentation": "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.
Request to delete an application version.
" }, "DeleteConfigurationTemplateMessage": { "type": "structure", "required": [ "ApplicationName", "TemplateName" ], "members": { "ApplicationName": { "shape": "ApplicationName", "documentation": "The name of the application to delete the configuration template from.
" }, "TemplateName": { "shape": "ConfigurationTemplateName", "documentation": "The name of the configuration template to delete.
" } }, "documentation": "Request to delete a configuration template.
" }, "DeleteEnvironmentConfigurationMessage": { "type": "structure", "required": [ "ApplicationName", "EnvironmentName" ], "members": { "ApplicationName": { "shape": "ApplicationName", "documentation": "The name of the application the environment is associated with.
" }, "EnvironmentName": { "shape": "EnvironmentName", "documentation": "The name of the environment to delete the draft configuration from.
" } }, "documentation": "Request to delete a draft environment configuration.
" }, "DeletePlatformVersionRequest": { "type": "structure", "members": { "PlatformArn": { "shape": "PlatformArn", "documentation": "The ARN of the version of the custom platform.
" } } }, "DeletePlatformVersionResult": { "type": "structure", "members": { "PlatformSummary": { "shape": "PlatformSummary", "documentation": "Detailed information about the version of the custom platform.
" } } }, "DeleteSourceBundle": { "type": "boolean" }, "Deployment": { "type": "structure", "members": { "VersionLabel": { "shape": "String", "documentation": "The version label of the application version in the deployment.
" }, "DeploymentId": { "shape": "NullableLong", "documentation": "The ID of the deployment. This number increases by one each time that you deploy source code or change instance configuration settings.
" }, "Status": { "shape": "String", "documentation": "The status of the deployment:
In Progress : The deployment is in progress.
Deployed : The deployment succeeded.
Failed : The deployment failed.
For in-progress deployments, the time that the deployment started.
For completed deployments, the time that the deployment ended.
" } }, "documentation": "Information about an application version deployment.
" }, "DeploymentTimestamp": { "type": "timestamp" }, "DescribeAccountAttributesResult": { "type": "structure", "members": { "ResourceQuotas": { "shape": "ResourceQuotas", "documentation": "The Elastic Beanstalk resource quotas associated with the calling AWS account.
" } } }, "DescribeApplicationVersionsMessage": { "type": "structure", "members": { "ApplicationName": { "shape": "ApplicationName", "documentation": "Specify an application name to show only application versions for that application.
" }, "VersionLabels": { "shape": "VersionLabelsList", "documentation": "Specify a version label to show a specific application version.
" }, "MaxRecords": { "shape": "MaxRecords", "documentation": "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 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.
Request to describe application versions.
" }, "DescribeApplicationsMessage": { "type": "structure", "members": { "ApplicationNames": { "shape": "ApplicationNamesList", "documentation": "If specified, AWS Elastic Beanstalk restricts the returned descriptions to only include those with the specified names.
" } }, "documentation": "Request to describe one or more applications.
" }, "DescribeConfigurationOptionsMessage": { "type": "structure", "members": { "ApplicationName": { "shape": "ApplicationName", "documentation": "The name of the application associated with the configuration template or environment. Only needed if you want to describe the configuration options associated with either the configuration template or environment.
" }, "TemplateName": { "shape": "ConfigurationTemplateName", "documentation": "The name of the configuration template whose configuration options you want to describe.
" }, "EnvironmentName": { "shape": "EnvironmentName", "documentation": "The name of the environment whose configuration options you want to describe.
" }, "SolutionStackName": { "shape": "SolutionStackName", "documentation": "The name of the solution stack whose configuration options you want to describe.
" }, "PlatformArn": { "shape": "PlatformArn", "documentation": "The ARN of the custom platform.
" }, "Options": { "shape": "OptionsSpecifierList", "documentation": "If specified, restricts the descriptions to only the specified options.
" } }, "documentation": "Result message containing a list of application version descriptions.
" }, "DescribeConfigurationSettingsMessage": { "type": "structure", "required": [ "ApplicationName" ], "members": { "ApplicationName": { "shape": "ApplicationName", "documentation": "The application for the environment or configuration template.
" }, "TemplateName": { "shape": "ConfigurationTemplateName", "documentation": "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.
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.
Result message containing all of the configuration settings for a specified solution stack or configuration template.
" }, "DescribeEnvironmentHealthRequest": { "type": "structure", "members": { "EnvironmentName": { "shape": "EnvironmentName", "documentation": "Specify the environment by name.
You must specify either this or an EnvironmentName, or both.
" }, "EnvironmentId": { "shape": "EnvironmentId", "documentation": "Specify the environment by ID.
You must specify either this or an EnvironmentName, or both.
" }, "AttributeNames": { "shape": "EnvironmentHealthAttributes", "documentation": "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.
See the example below to learn how to create a request body.
" }, "DescribeEnvironmentHealthResult": { "type": "structure", "members": { "EnvironmentName": { "shape": "EnvironmentName", "documentation": "The environment's name.
" }, "HealthStatus": { "shape": "String", "documentation": "The health status of the environment. For example, Ok.
The environment's operational status. Ready, Launching, Updating, Terminating, or Terminated.
The health color of the environment.
" }, "Causes": { "shape": "Causes", "documentation": "Descriptions of the data that contributed to the environment's current health status.
" }, "ApplicationMetrics": { "shape": "ApplicationMetrics", "documentation": "Application request metrics for the environment.
" }, "InstancesHealth": { "shape": "InstanceHealthSummary", "documentation": "Summary health information for the instances in the environment.
" }, "RefreshedAt": { "shape": "RefreshedAt", "documentation": "The date and time that the health information was retrieved.
" } }, "documentation": "Health details for an AWS Elastic Beanstalk environment.
" }, "DescribeEnvironmentManagedActionHistoryRequest": { "type": "structure", "members": { "EnvironmentId": { "shape": "EnvironmentId", "documentation": "The environment ID of the target environment.
" }, "EnvironmentName": { "shape": "EnvironmentName", "documentation": "The name of the target environment.
" }, "NextToken": { "shape": "String", "documentation": "The pagination token returned by a previous request.
" }, "MaxItems": { "shape": "ManagedActionHistoryMaxItems", "documentation": "The maximum number of items to return for a single request.
" } }, "documentation": "Request to list completed and failed managed actions.
" }, "DescribeEnvironmentManagedActionHistoryResult": { "type": "structure", "members": { "ManagedActionHistoryItems": { "shape": "ManagedActionHistoryItems", "documentation": "A list of completed and failed managed actions.
" }, "NextToken": { "shape": "String", "documentation": "A pagination token that you pass to DescribeEnvironmentManagedActionHistory to get the next page of results.
" } }, "documentation": "A result message containing a list of completed and failed managed actions.
" }, "DescribeEnvironmentManagedActionsRequest": { "type": "structure", "members": { "EnvironmentName": { "shape": "String", "documentation": "The name of the target environment.
" }, "EnvironmentId": { "shape": "String", "documentation": "The environment ID of the target environment.
" }, "Status": { "shape": "ActionStatus", "documentation": "To show only actions with a particular status, specify a status.
" } }, "documentation": "Request to list an environment's upcoming and in-progress managed actions.
" }, "DescribeEnvironmentManagedActionsResult": { "type": "structure", "members": { "ManagedActions": { "shape": "ManagedActions", "documentation": "A list of upcoming and in-progress managed actions.
" } }, "documentation": "The result message containing a list of managed actions.
" }, "DescribeEnvironmentResourcesMessage": { "type": "structure", "members": { "EnvironmentId": { "shape": "EnvironmentId", "documentation": "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.
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.
Request to describe the resources in an environment.
" }, "DescribeEnvironmentsMessage": { "type": "structure", "members": { "ApplicationName": { "shape": "ApplicationName", "documentation": "If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.
" }, "VersionLabel": { "shape": "VersionLabel", "documentation": "If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.
" }, "EnvironmentIds": { "shape": "EnvironmentIdList", "documentation": "If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.
" }, "EnvironmentNames": { "shape": "EnvironmentNamesList", "documentation": "If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.
" }, "IncludeDeleted": { "shape": "IncludeDeleted", "documentation": "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.
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.
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.
Request to describe one or more environments.
" }, "DescribeEventsMessage": { "type": "structure", "members": { "ApplicationName": { "shape": "ApplicationName", "documentation": "If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those associated with this application.
" }, "VersionLabel": { "shape": "VersionLabel", "documentation": "If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this application version.
" }, "TemplateName": { "shape": "ConfigurationTemplateName", "documentation": "If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that are associated with this environment configuration.
" }, "EnvironmentId": { "shape": "EnvironmentId", "documentation": "If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment.
" }, "EnvironmentName": { "shape": "EnvironmentName", "documentation": "If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment.
" }, "PlatformArn": { "shape": "PlatformArn", "documentation": "The ARN of a custom platform version. If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this custom platform version.
" }, "RequestId": { "shape": "RequestId", "documentation": "If specified, AWS Elastic Beanstalk restricts the described events to include only those associated with this request ID.
" }, "Severity": { "shape": "EventSeverity", "documentation": "If specified, limits the events returned from this call to include only those with the specified severity or higher.
" }, "StartTime": { "shape": "TimeFilterStart", "documentation": "If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur on or after this time.
" }, "EndTime": { "shape": "TimeFilterEnd", "documentation": " If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur up to, but not including, the EndTime.
Specifies the maximum number of events that can be returned, beginning with the most recent event.
" }, "NextToken": { "shape": "Token", "documentation": "Pagination token. If specified, the events return the next batch of results.
" } }, "documentation": "Request to retrieve a list of events for an environment.
" }, "DescribeInstancesHealthRequest": { "type": "structure", "members": { "EnvironmentName": { "shape": "EnvironmentName", "documentation": "Specify the AWS Elastic Beanstalk environment by name.
" }, "EnvironmentId": { "shape": "EnvironmentId", "documentation": "Specify the AWS Elastic Beanstalk environment by ID.
" }, "AttributeNames": { "shape": "InstancesHealthAttributes", "documentation": "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.
Specify the pagination token returned by a previous call.
" } }, "documentation": "Parameters for a call to DescribeInstancesHealth.
Detailed health information about each instance.
The output differs slightly between Linux and Windows environments. There is a difference in the members that are supported under the <CPUUtilization> type.
The date and time that the health information was retrieved.
" }, "NextToken": { "shape": "NextToken", "documentation": "Pagination token for the next page of results, if available.
" } }, "documentation": "Detailed health information about the Amazon EC2 instances in an AWS Elastic Beanstalk environment.
" }, "DescribePlatformVersionRequest": { "type": "structure", "members": { "PlatformArn": { "shape": "PlatformArn", "documentation": "The ARN of the platform version.
" } } }, "DescribePlatformVersionResult": { "type": "structure", "members": { "PlatformDescription": { "shape": "PlatformDescription", "documentation": "Detailed information about the platform version.
" } } }, "Description": { "type": "string", "max": 200 }, "DisassociateEnvironmentOperationsRoleMessage": { "type": "structure", "required": [ "EnvironmentName" ], "members": { "EnvironmentName": { "shape": "EnvironmentName", "documentation": "The name of the environment from which to disassociate the operations role.
" } }, "documentation": "Request to disassociate the operations role from an environment.
" }, "Ec2InstanceId": { "type": "string" }, "EndpointURL": { "type": "string" }, "EnvironmentArn": { "type": "string" }, "EnvironmentDescription": { "type": "structure", "members": { "EnvironmentName": { "shape": "EnvironmentName", "documentation": "The name of this environment.
" }, "EnvironmentId": { "shape": "EnvironmentId", "documentation": "The ID of this environment.
" }, "ApplicationName": { "shape": "ApplicationName", "documentation": "The name of the application associated with this environment.
" }, "VersionLabel": { "shape": "VersionLabel", "documentation": "The application version deployed in this environment.
" }, "SolutionStackName": { "shape": "SolutionStackName", "documentation": " The name of the SolutionStack deployed with this environment.
The ARN of the platform version.
" }, "TemplateName": { "shape": "ConfigurationTemplateName", "documentation": "The name of the configuration template used to originally launch this environment.
" }, "Description": { "shape": "Description", "documentation": "Describes this environment.
" }, "EndpointURL": { "shape": "EndpointURL", "documentation": "For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.
" }, "CNAME": { "shape": "DNSCname", "documentation": "The URL to the CNAME for this environment.
" }, "DateCreated": { "shape": "CreationDate", "documentation": "The creation date for this environment.
" }, "DateUpdated": { "shape": "UpdateDate", "documentation": "The last modified date for this environment.
" }, "Status": { "shape": "EnvironmentStatus", "documentation": "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.
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.
Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment:
Red: Indicates the environment is not responsive. Occurs when three or more consecutive failures occur for an environment.
Yellow: Indicates that something is wrong. Occurs when two consecutive failures occur for an environment.
Green: Indicates the environment is healthy and fully functional.
Grey: Default health for a new environment. The environment is not fully launched and health checks have not started or health checks are suspended during an UpdateEnvironment or RestartEnvironment request.
Default: Grey
Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses.
" }, "Resources": { "shape": "EnvironmentResourcesDescription", "documentation": "The description of the AWS resources used by this environment.
" }, "Tier": { "shape": "EnvironmentTier", "documentation": "Describes the current tier of this environment.
" }, "EnvironmentLinks": { "shape": "EnvironmentLinks", "documentation": "A list of links to other environments in the same group.
" }, "EnvironmentArn": { "shape": "EnvironmentArn", "documentation": "The environment's Amazon Resource Name (ARN), which can be used in other API requests that require an ARN.
" }, "OperationsRole": { "shape": "OperationsRole", "documentation": "The Amazon Resource Name (ARN) of the environment's operations role. For more information, see Operations roles in the AWS Elastic Beanstalk Developer Guide.
" } }, "documentation": "Describes the properties of an environment.
" }, "EnvironmentDescriptionsList": { "type": "list", "member": { "shape": "EnvironmentDescription" } }, "EnvironmentDescriptionsMessage": { "type": "structure", "members": { "Environments": { "shape": "EnvironmentDescriptionsList", "documentation": "Returns an EnvironmentDescription list.
" }, "NextToken": { "shape": "Token", "documentation": "In a paginated request, the token that you can pass in a subsequent request to get the next response page.
" } }, "documentation": "Result message containing a list of environment descriptions.
" }, "EnvironmentHealth": { "type": "string", "enum": [ "Green", "Yellow", "Red", "Grey" ] }, "EnvironmentHealthAttribute": { "type": "string", "enum": [ "Status", "Color", "Causes", "ApplicationMetrics", "InstancesHealth", "All", "HealthStatus", "RefreshedAt" ] }, "EnvironmentHealthAttributes": { "type": "list", "member": { "shape": "EnvironmentHealthAttribute" } }, "EnvironmentHealthStatus": { "type": "string", "enum": [ "NoData", "Unknown", "Pending", "Ok", "Info", "Warning", "Degraded", "Severe", "Suspended" ] }, "EnvironmentId": { "type": "string" }, "EnvironmentIdList": { "type": "list", "member": { "shape": "EnvironmentId" } }, "EnvironmentInfoDescription": { "type": "structure", "members": { "InfoType": { "shape": "EnvironmentInfoType", "documentation": "The type of information retrieved.
" }, "Ec2InstanceId": { "shape": "Ec2InstanceId", "documentation": "The Amazon EC2 Instance ID for this information.
" }, "SampleTimestamp": { "shape": "SampleTimestamp", "documentation": "The time stamp when this information was retrieved.
" }, "Message": { "shape": "Message", "documentation": "The retrieved information. Currently contains a presigned Amazon S3 URL. The files are deleted after 15 minutes.
Anyone in possession of this URL can access the files before they are deleted. Make the URL available only to trusted parties.
" } }, "documentation": "The information retrieved from the Amazon EC2 instances.
" }, "EnvironmentInfoDescriptionList": { "type": "list", "member": { "shape": "EnvironmentInfoDescription" } }, "EnvironmentInfoType": { "type": "string", "enum": [ "tail", "bundle" ] }, "EnvironmentLink": { "type": "structure", "members": { "LinkName": { "shape": "String", "documentation": "The name of the link.
" }, "EnvironmentName": { "shape": "String", "documentation": "The name of the linked environment (the dependency).
" } }, "documentation": "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.
" }, "EnvironmentLinks": { "type": "list", "member": { "shape": "EnvironmentLink" } }, "EnvironmentName": { "type": "string", "max": 40, "min": 4 }, "EnvironmentNamesList": { "type": "list", "member": { "shape": "EnvironmentName" } }, "EnvironmentResourceDescription": { "type": "structure", "members": { "EnvironmentName": { "shape": "EnvironmentName", "documentation": "The name of the environment.
" }, "AutoScalingGroups": { "shape": "AutoScalingGroupList", "documentation": " The AutoScalingGroups used by this environment.
The Amazon EC2 instances used by this environment.
" }, "LaunchConfigurations": { "shape": "LaunchConfigurationList", "documentation": "The Auto Scaling launch configurations in use by this environment.
" }, "LaunchTemplates": { "shape": "LaunchTemplateList", "documentation": "The Amazon EC2 launch templates in use by this environment.
" }, "LoadBalancers": { "shape": "LoadBalancerList", "documentation": "The LoadBalancers in use by this environment.
" }, "Triggers": { "shape": "TriggerList", "documentation": "The AutoScaling triggers in use by this environment.
The queues used by this environment.
" } }, "documentation": "Describes the AWS resources in use by this environment. This data is live.
" }, "EnvironmentResourceDescriptionsMessage": { "type": "structure", "members": { "EnvironmentResources": { "shape": "EnvironmentResourceDescription", "documentation": "A list of EnvironmentResourceDescription.
" } }, "documentation": "Result message containing a list of environment resource descriptions.
" }, "EnvironmentResourcesDescription": { "type": "structure", "members": { "LoadBalancer": { "shape": "LoadBalancerDescription", "documentation": "Describes the LoadBalancer.
" } }, "documentation": "Describes the AWS resources in use by this environment. This data is not live data.
" }, "EnvironmentStatus": { "type": "string", "enum": [ "Aborting", "Launching", "Updating", "LinkingFrom", "LinkingTo", "Ready", "Terminating", "Terminated" ] }, "EnvironmentTier": { "type": "structure", "members": { "Name": { "shape": "String", "documentation": "The name of this environment tier.
Valid values:
For Web server tier – WebServer
For Worker tier – Worker
The type of this environment tier.
Valid values:
For Web server tier – Standard
For Worker tier – SQS/HTTP
The version of this environment tier. When you don't set a value to it, Elastic Beanstalk uses the latest compatible worker tier version.
This member is deprecated. Any specific version that you set may become out of date. We recommend leaving it unspecified.
Describes the properties of an environment tier
" }, "EventDate": { "type": "timestamp" }, "EventDescription": { "type": "structure", "members": { "EventDate": { "shape": "EventDate", "documentation": "The date when the event occurred.
" }, "Message": { "shape": "EventMessage", "documentation": "The event message.
" }, "ApplicationName": { "shape": "ApplicationName", "documentation": "The application associated with the event.
" }, "VersionLabel": { "shape": "VersionLabel", "documentation": "The release label for the application version associated with this event.
" }, "TemplateName": { "shape": "ConfigurationTemplateName", "documentation": "The name of the configuration associated with this event.
" }, "EnvironmentName": { "shape": "EnvironmentName", "documentation": "The name of the environment associated with this event.
" }, "PlatformArn": { "shape": "PlatformArn", "documentation": "The ARN of the platform version.
" }, "RequestId": { "shape": "RequestId", "documentation": "The web service request ID for the activity of this event.
" }, "Severity": { "shape": "EventSeverity", "documentation": "The severity level of this event.
" } }, "documentation": "Describes an event.
" }, "EventDescriptionList": { "type": "list", "member": { "shape": "EventDescription" } }, "EventDescriptionsMessage": { "type": "structure", "members": { "Events": { "shape": "EventDescriptionList", "documentation": "A list of EventDescription.
" }, "NextToken": { "shape": "Token", "documentation": "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.
" } }, "documentation": "Result message wrapping a list of event descriptions.
" }, "EventMessage": { "type": "string" }, "EventSeverity": { "type": "string", "enum": [ "TRACE", "DEBUG", "INFO", "WARN", "ERROR", "FATAL" ] }, "FailureType": { "type": "string", "enum": [ "UpdateCancelled", "CancellationFailed", "RollbackFailed", "RollbackSuccessful", "InternalFailure", "InvalidEnvironmentState", "PermissionsError" ] }, "FileTypeExtension": { "type": "string", "max": 100, "min": 1 }, "ForceTerminate": { "type": "boolean" }, "GroupName": { "type": "string", "max": 19, "min": 1 }, "ImageId": { "type": "string" }, "IncludeDeleted": { "type": "boolean" }, "IncludeDeletedBackTo": { "type": "timestamp" }, "Instance": { "type": "structure", "members": { "Id": { "shape": "ResourceId", "documentation": "The ID of the Amazon EC2 instance.
" } }, "documentation": "The description of an Amazon EC2 instance.
" }, "InstanceHealthList": { "type": "list", "member": { "shape": "SingleInstanceHealth" } }, "InstanceHealthSummary": { "type": "structure", "members": { "NoData": { "shape": "NullableInteger", "documentation": "Grey. AWS Elastic Beanstalk and the health agent are reporting no data on an instance.
" }, "Unknown": { "shape": "NullableInteger", "documentation": "Grey. AWS Elastic Beanstalk and the health agent are reporting an insufficient amount of data on an instance.
" }, "Pending": { "shape": "NullableInteger", "documentation": "Grey. An operation is in progress on an instance within the command timeout.
" }, "Ok": { "shape": "NullableInteger", "documentation": "Green. An instance is passing health checks and the health agent is not reporting any problems.
" }, "Info": { "shape": "NullableInteger", "documentation": "Green. An operation is in progress on an instance.
" }, "Warning": { "shape": "NullableInteger", "documentation": "Yellow. The health agent is reporting a moderate number of request failures or other issues for an instance or environment.
" }, "Degraded": { "shape": "NullableInteger", "documentation": "Red. The health agent is reporting a high number of request failures or other issues for an instance or environment.
" }, "Severe": { "shape": "NullableInteger", "documentation": "Red. The health agent is reporting a very high number of request failures or other issues for an instance or environment.
" } }, "documentation": "Represents summary information about the health of an instance. For more information, see Health Colors and Statuses.
" }, "InstanceId": { "type": "string", "max": 255, "min": 1 }, "InstanceList": { "type": "list", "member": { "shape": "Instance" } }, "InstancesHealthAttribute": { "type": "string", "enum": [ "HealthStatus", "Color", "Causes", "ApplicationMetrics", "RefreshedAt", "LaunchedAt", "System", "Deployment", "AvailabilityZone", "InstanceType", "All" ] }, "InstancesHealthAttributes": { "type": "list", "member": { "shape": "InstancesHealthAttribute" } }, "Integer": { "type": "integer" }, "Latency": { "type": "structure", "members": { "P999": { "shape": "NullableDouble", "documentation": "The average latency for the slowest 0.1 percent of requests over the last 10 seconds.
" }, "P99": { "shape": "NullableDouble", "documentation": "The average latency for the slowest 1 percent of requests over the last 10 seconds.
" }, "P95": { "shape": "NullableDouble", "documentation": "The average latency for the slowest 5 percent of requests over the last 10 seconds.
" }, "P90": { "shape": "NullableDouble", "documentation": "The average latency for the slowest 10 percent of requests over the last 10 seconds.
" }, "P85": { "shape": "NullableDouble", "documentation": "The average latency for the slowest 15 percent of requests over the last 10 seconds.
" }, "P75": { "shape": "NullableDouble", "documentation": "The average latency for the slowest 25 percent of requests over the last 10 seconds.
" }, "P50": { "shape": "NullableDouble", "documentation": "The average latency for the slowest 50 percent of requests over the last 10 seconds.
" }, "P10": { "shape": "NullableDouble", "documentation": "The average latency for the slowest 90 percent of requests over the last 10 seconds.
" } }, "documentation": "Represents the average latency for the slowest X percent of requests over the last 10 seconds.
" }, "LaunchConfiguration": { "type": "structure", "members": { "Name": { "shape": "ResourceId", "documentation": "The name of the launch configuration.
" } }, "documentation": "Describes an Auto Scaling launch configuration.
" }, "LaunchConfigurationList": { "type": "list", "member": { "shape": "LaunchConfiguration" } }, "LaunchTemplate": { "type": "structure", "members": { "Id": { "shape": "ResourceId", "documentation": "The ID of the launch template.
" } }, "documentation": "Describes an Amazon EC2 launch template.
" }, "LaunchTemplateList": { "type": "list", "member": { "shape": "LaunchTemplate" } }, "LaunchedAt": { "type": "timestamp" }, "ListAvailableSolutionStacksResultMessage": { "type": "structure", "members": { "SolutionStacks": { "shape": "AvailableSolutionStackNamesList", "documentation": "A list of available solution stacks.
" }, "SolutionStackDetails": { "shape": "AvailableSolutionStackDetailsList", "documentation": "A list of available solution stacks and their SolutionStackDescription.
" } }, "documentation": "A list of available AWS Elastic Beanstalk solution stacks.
" }, "ListPlatformBranchesRequest": { "type": "structure", "members": { "Filters": { "shape": "SearchFilters", "documentation": "Criteria for restricting the resulting list of platform branches. The filter is evaluated as a logical conjunction (AND) of the separate SearchFilter terms.
The following list shows valid attribute values for each of the SearchFilter terms. Most operators take a single value. The in and not_in operators can take multiple values.
Attribute = BranchName:
Operator: = | != | begins_with | ends_with | contains | in | not_in
Attribute = LifecycleState:
Operator: = | != | in | not_in
Values: beta | supported | deprecated | retired
Attribute = PlatformName:
Operator: = | != | begins_with | ends_with | contains | in | not_in
Attribute = TierType:
Operator: = | !=
Values: WebServer/Standard | Worker/SQS/HTTP
Array size: limited to 10 SearchFilter objects.
Within each SearchFilter item, the Values array is limited to 10 items.
The maximum number of platform branch values returned in one call.
" }, "NextToken": { "shape": "Token", "documentation": "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.
Summary information about the platform branches.
" }, "NextToken": { "shape": "Token", "documentation": "In a paginated request, if this value isn't null, it's the token that you can pass in a subsequent request to get the next response page.
Criteria for restricting the resulting list of platform versions. The filter is interpreted as a logical conjunction (AND) of the separate PlatformFilter terms.
The maximum number of platform version values returned in one call.
" }, "NextToken": { "shape": "Token", "documentation": "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.
Summary information about the platform versions.
" }, "NextToken": { "shape": "Token", "documentation": "In a paginated request, if this value isn't null, it's the token that you can pass in a subsequent request to get the next response page.
The Amazon Resource Name (ARN) of the resouce for which a tag list is requested.
Must be the ARN of an Elastic Beanstalk resource.
" } } }, "Listener": { "type": "structure", "members": { "Protocol": { "shape": "String", "documentation": "The protocol that is used by the Listener.
" }, "Port": { "shape": "Integer", "documentation": "The port that is used by the Listener.
" } }, "documentation": "Describes the properties of a Listener for the LoadBalancer.
" }, "LoadAverage": { "type": "list", "member": { "shape": "LoadAverageValue" } }, "LoadAverageValue": { "type": "double" }, "LoadBalancer": { "type": "structure", "members": { "Name": { "shape": "ResourceId", "documentation": "The name of the LoadBalancer.
" } }, "documentation": "Describes a LoadBalancer.
" }, "LoadBalancerDescription": { "type": "structure", "members": { "LoadBalancerName": { "shape": "String", "documentation": "The name of the LoadBalancer.
" }, "Domain": { "shape": "String", "documentation": "The domain name of the LoadBalancer.
" }, "Listeners": { "shape": "LoadBalancerListenersDescription", "documentation": "A list of Listeners used by the LoadBalancer.
" } }, "documentation": "Describes the details of a LoadBalancer.
" }, "LoadBalancerList": { "type": "list", "member": { "shape": "LoadBalancer" } }, "LoadBalancerListenersDescription": { "type": "list", "member": { "shape": "Listener" } }, "Maintainer": { "type": "string" }, "ManagedAction": { "type": "structure", "members": { "ActionId": { "shape": "String", "documentation": "A unique identifier for the managed action.
" }, "ActionDescription": { "shape": "String", "documentation": "A description of the managed action.
" }, "ActionType": { "shape": "ActionType", "documentation": "The type of managed action.
" }, "Status": { "shape": "ActionStatus", "documentation": "The status of the managed action. If the action is Scheduled, you can apply it immediately with ApplyEnvironmentManagedAction.
The start time of the maintenance window in which the managed action will execute.
" } }, "documentation": "The record of an upcoming or in-progress managed action.
" }, "ManagedActionHistoryItem": { "type": "structure", "members": { "ActionId": { "shape": "String", "documentation": "A unique identifier for the managed action.
" }, "ActionType": { "shape": "ActionType", "documentation": "The type of the managed action.
" }, "ActionDescription": { "shape": "String", "documentation": "A description of the managed action.
" }, "FailureType": { "shape": "FailureType", "documentation": "If the action failed, the type of failure.
" }, "Status": { "shape": "ActionHistoryStatus", "documentation": "The status of the action.
" }, "FailureDescription": { "shape": "String", "documentation": "If the action failed, a description of the failure.
" }, "ExecutedTime": { "shape": "Timestamp", "documentation": "The date and time that the action started executing.
" }, "FinishedTime": { "shape": "Timestamp", "documentation": "The date and time that the action finished executing.
" } }, "documentation": "The record of a completed or failed managed action.
" }, "ManagedActionHistoryItems": { "type": "list", "member": { "shape": "ManagedActionHistoryItem" }, "max": 100, "min": 1 }, "ManagedActionHistoryMaxItems": { "type": "integer", "max": 100, "min": 1 }, "ManagedActions": { "type": "list", "member": { "shape": "ManagedAction" }, "max": 100, "min": 1 }, "MaxAgeRule": { "type": "structure", "required": [ "Enabled" ], "members": { "Enabled": { "shape": "BoxedBoolean", "documentation": "Specify true to apply the rule, or false to disable it.
Specify the number of days to retain an application versions.
" }, "DeleteSourceFromS3": { "shape": "BoxedBoolean", "documentation": "Set to true to delete a version's source bundle from Amazon S3 when Elastic Beanstalk deletes the application version.
A lifecycle rule that deletes application versions after the specified number of days.
" }, "MaxCountRule": { "type": "structure", "required": [ "Enabled" ], "members": { "Enabled": { "shape": "BoxedBoolean", "documentation": "Specify true to apply the rule, or false to disable it.
Specify the maximum number of application versions to retain.
" }, "DeleteSourceFromS3": { "shape": "BoxedBoolean", "documentation": "Set to true to delete a version's source bundle from Amazon S3 when Elastic Beanstalk deletes the application version.
A lifecycle rule that deletes the oldest application version when the maximum count is exceeded.
" }, "MaxRecords": { "type": "integer", "max": 1000, "min": 1 }, "Message": { "type": "string" }, "NextToken": { "type": "string", "max": 100, "min": 1 }, "NonEmptyString": { "type": "string", "pattern": ".*\\S.*" }, "NullableDouble": { "type": "double" }, "NullableInteger": { "type": "integer" }, "NullableLong": { "type": "long" }, "OperatingSystemName": { "type": "string" }, "OperatingSystemVersion": { "type": "string" }, "OperationsRole": { "type": "string", "max": 256, "min": 1 }, "OptionNamespace": { "type": "string" }, "OptionRestrictionMaxLength": { "type": "integer" }, "OptionRestrictionMaxValue": { "type": "integer" }, "OptionRestrictionMinValue": { "type": "integer" }, "OptionRestrictionRegex": { "type": "structure", "members": { "Pattern": { "shape": "RegexPattern", "documentation": "The regular expression pattern that a string configuration option value with this restriction must match.
" }, "Label": { "shape": "RegexLabel", "documentation": "A unique name representing this regular expression.
" } }, "documentation": "A regular expression representing a restriction on a string configuration option value.
" }, "OptionSpecification": { "type": "structure", "members": { "ResourceName": { "shape": "ResourceName", "documentation": "A unique resource name for a time-based scaling configuration option.
" }, "Namespace": { "shape": "OptionNamespace", "documentation": "A unique namespace identifying the option's associated AWS resource.
" }, "OptionName": { "shape": "ConfigurationOptionName", "documentation": "The name of the configuration option.
" } }, "documentation": "A specification identifying an individual configuration option.
" }, "OptionsSpecifierList": { "type": "list", "member": { "shape": "OptionSpecification" } }, "PlatformArn": { "type": "string" }, "PlatformBranchLifecycleState": { "type": "string" }, "PlatformBranchMaxRecords": { "type": "integer", "min": 1 }, "PlatformBranchSummary": { "type": "structure", "members": { "PlatformName": { "shape": "PlatformName", "documentation": "The name of the platform to which this platform branch belongs.
" }, "BranchName": { "shape": "BranchName", "documentation": "The name of the platform branch.
" }, "LifecycleState": { "shape": "PlatformBranchLifecycleState", "documentation": "The support life cycle state of the platform branch.
Possible values: beta | supported | deprecated | retired
An ordinal number that designates the order in which platform branches have been added to a platform. This can be helpful, for example, if your code calls the ListPlatformBranches action and then displays a list of platform branches.
A larger BranchOrder value designates a newer platform branch within the platform.
The environment tiers that platform versions in this branch support.
Possible values: WebServer/Standard | Worker/SQS/HTTP
Summary information about a platform branch.
" }, "PlatformBranchSummaryList": { "type": "list", "member": { "shape": "PlatformBranchSummary" } }, "PlatformCategory": { "type": "string" }, "PlatformDescription": { "type": "structure", "members": { "PlatformArn": { "shape": "PlatformArn", "documentation": "The ARN of the platform version.
" }, "PlatformOwner": { "shape": "PlatformOwner", "documentation": "The AWS account ID of the person who created the platform version.
" }, "PlatformName": { "shape": "PlatformName", "documentation": "The name of the platform version.
" }, "PlatformVersion": { "shape": "PlatformVersion", "documentation": "The version of the platform version.
" }, "SolutionStackName": { "shape": "SolutionStackName", "documentation": "The name of the solution stack used by the platform version.
" }, "PlatformStatus": { "shape": "PlatformStatus", "documentation": "The status of the platform version.
" }, "DateCreated": { "shape": "CreationDate", "documentation": "The date when the platform version was created.
" }, "DateUpdated": { "shape": "UpdateDate", "documentation": "The date when the platform version was last updated.
" }, "PlatformCategory": { "shape": "PlatformCategory", "documentation": "The category of the platform version.
" }, "Description": { "shape": "Description", "documentation": "The description of the platform version.
" }, "Maintainer": { "shape": "Maintainer", "documentation": "Information about the maintainer of the platform version.
" }, "OperatingSystemName": { "shape": "OperatingSystemName", "documentation": "The operating system used by the platform version.
" }, "OperatingSystemVersion": { "shape": "OperatingSystemVersion", "documentation": "The version of the operating system used by the platform version.
" }, "ProgrammingLanguages": { "shape": "PlatformProgrammingLanguages", "documentation": "The programming languages supported by the platform version.
" }, "Frameworks": { "shape": "PlatformFrameworks", "documentation": "The frameworks supported by the platform version.
" }, "CustomAmiList": { "shape": "CustomAmiList", "documentation": "The custom AMIs supported by the platform version.
" }, "SupportedTierList": { "shape": "SupportedTierList", "documentation": "The tiers supported by the platform version.
" }, "SupportedAddonList": { "shape": "SupportedAddonList", "documentation": "The additions supported by the platform version.
" }, "PlatformLifecycleState": { "shape": "PlatformLifecycleState", "documentation": "The state of the platform version in its lifecycle.
Possible values: Recommended | null
If a null value is returned, the platform version isn't the recommended one for its branch. Each platform branch has a single recommended platform version, typically the most recent one.
" }, "PlatformBranchName": { "shape": "BranchName", "documentation": "The platform branch to which the platform version belongs.
" }, "PlatformBranchLifecycleState": { "shape": "PlatformBranchLifecycleState", "documentation": "The state of the platform version's branch in its lifecycle.
Possible values: Beta | Supported | Deprecated | Retired
Detailed information about a platform version.
" }, "PlatformFilter": { "type": "structure", "members": { "Type": { "shape": "PlatformFilterType", "documentation": "The platform version attribute to which the filter values are applied.
Valid values: PlatformName | PlatformVersion | PlatformStatus | PlatformBranchName | PlatformLifecycleState | PlatformOwner | SupportedTier | SupportedAddon | ProgrammingLanguageName | OperatingSystemName
The operator to apply to the Type with each of the Values.
Valid values: = | != | < | <= | > | >= | contains | begins_with | ends_with
The list of values applied to the filtering platform version attribute. Only one value is supported for all current operators.
The following list shows valid filter values for some filter attributes.
PlatformStatus: Creating | Failed | Ready | Deleting | Deleted
PlatformLifecycleState: recommended
SupportedTier: WebServer/Standard | Worker/SQS/HTTP
SupportedAddon: Log/S3 | Monitoring/Healthd | WorkerDaemon/SQSD
Describes criteria to restrict the results when listing platform versions.
The filter is evaluated as follows: Type Operator Values[1]
The name of the framework.
" }, "Version": { "shape": "String", "documentation": "The version of the framework.
" } }, "documentation": "A framework supported by the platform.
" }, "PlatformFrameworks": { "type": "list", "member": { "shape": "PlatformFramework" } }, "PlatformLifecycleState": { "type": "string" }, "PlatformMaxRecords": { "type": "integer", "min": 1 }, "PlatformName": { "type": "string" }, "PlatformOwner": { "type": "string" }, "PlatformProgrammingLanguage": { "type": "structure", "members": { "Name": { "shape": "String", "documentation": "The name of the programming language.
" }, "Version": { "shape": "String", "documentation": "The version of the programming language.
" } }, "documentation": "A programming language supported by the platform.
" }, "PlatformProgrammingLanguages": { "type": "list", "member": { "shape": "PlatformProgrammingLanguage" } }, "PlatformStatus": { "type": "string", "enum": [ "Creating", "Failed", "Ready", "Deleting", "Deleted" ] }, "PlatformSummary": { "type": "structure", "members": { "PlatformArn": { "shape": "PlatformArn", "documentation": "The ARN of the platform version.
" }, "PlatformOwner": { "shape": "PlatformOwner", "documentation": "The AWS account ID of the person who created the platform version.
" }, "PlatformStatus": { "shape": "PlatformStatus", "documentation": "The status of the platform version. You can create an environment from the platform version once it is ready.
" }, "PlatformCategory": { "shape": "PlatformCategory", "documentation": "The category of platform version.
" }, "OperatingSystemName": { "shape": "OperatingSystemName", "documentation": "The operating system used by the platform version.
" }, "OperatingSystemVersion": { "shape": "OperatingSystemVersion", "documentation": "The version of the operating system used by the platform version.
" }, "SupportedTierList": { "shape": "SupportedTierList", "documentation": "The tiers in which the platform version runs.
" }, "SupportedAddonList": { "shape": "SupportedAddonList", "documentation": "The additions associated with the platform version.
" }, "PlatformLifecycleState": { "shape": "PlatformLifecycleState", "documentation": "The state of the platform version in its lifecycle.
Possible values: recommended | empty
If an empty value is returned, the platform version is supported but isn't the recommended one for its branch.
" }, "PlatformVersion": { "shape": "PlatformVersion", "documentation": "The version string of the platform version.
" }, "PlatformBranchName": { "shape": "BranchName", "documentation": "The platform branch to which the platform version belongs.
" }, "PlatformBranchLifecycleState": { "shape": "PlatformBranchLifecycleState", "documentation": "The state of the platform version's branch in its lifecycle.
Possible values: beta | supported | deprecated | retired
Summary information about a platform version.
" }, "PlatformSummaryList": { "type": "list", "member": { "shape": "PlatformSummary" } }, "PlatformVersion": { "type": "string" }, "Queue": { "type": "structure", "members": { "Name": { "shape": "String", "documentation": "The name of the queue.
" }, "URL": { "shape": "String", "documentation": "The URL of the queue.
" } }, "documentation": "Describes a queue.
" }, "QueueList": { "type": "list", "member": { "shape": "Queue" } }, "RebuildEnvironmentMessage": { "type": "structure", "members": { "EnvironmentId": { "shape": "EnvironmentId", "documentation": "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 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 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 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 type of information to request.
" } }, "documentation": "Request to retrieve logs from an environment and store them in your Elastic Beanstalk storage bucket.
" }, "RequestId": { "type": "string" }, "ResourceArn": { "type": "string" }, "ResourceId": { "type": "string" }, "ResourceName": { "type": "string", "max": 256, "min": 1 }, "ResourceQuota": { "type": "structure", "members": { "Maximum": { "shape": "BoxedInt", "documentation": "The maximum number of instances of this Elastic Beanstalk resource type that an AWS account can use.
" } }, "documentation": "The AWS Elastic Beanstalk quota information for a single resource type in an AWS account. It reflects the resource's limits for this account.
" }, "ResourceQuotas": { "type": "structure", "members": { "ApplicationQuota": { "shape": "ResourceQuota", "documentation": "The quota for applications in the AWS account.
" }, "ApplicationVersionQuota": { "shape": "ResourceQuota", "documentation": "The quota for application versions in the AWS account.
" }, "EnvironmentQuota": { "shape": "ResourceQuota", "documentation": "The quota for environments in the AWS account.
" }, "ConfigurationTemplateQuota": { "shape": "ResourceQuota", "documentation": "The quota for configuration templates in the AWS account.
" }, "CustomPlatformQuota": { "shape": "ResourceQuota", "documentation": "The quota for custom platforms in the AWS account.
" } }, "documentation": "A set of per-resource AWS Elastic Beanstalk quotas associated with an AWS account. They reflect Elastic Beanstalk resource limits for this account.
" }, "ResourceTagsDescriptionMessage": { "type": "structure", "members": { "ResourceArn": { "shape": "ResourceArn", "documentation": "The Amazon Resource Name (ARN) of the resource for which a tag list was requested.
" }, "ResourceTags": { "shape": "TagList", "documentation": "A list of tag key-value pairs.
" } } }, "RestartAppServerMessage": { "type": "structure", "members": { "EnvironmentId": { "shape": "EnvironmentId", "documentation": "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 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 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 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 type of information to retrieve.
" } }, "documentation": "Request to download logs retrieved with RequestEnvironmentInfo.
" }, "RetrieveEnvironmentInfoResultMessage": { "type": "structure", "members": { "EnvironmentInfo": { "shape": "EnvironmentInfoDescriptionList", "documentation": "The EnvironmentInfoDescription of the environment.
" } }, "documentation": "Result message containing a description of the requested environment info.
" }, "S3Bucket": { "type": "string", "max": 255 }, "S3Key": { "type": "string", "max": 1024 }, "S3Location": { "type": "structure", "members": { "S3Bucket": { "shape": "S3Bucket", "documentation": "The Amazon S3 bucket where the data is located.
" }, "S3Key": { "shape": "S3Key", "documentation": "The Amazon S3 key where the data is located.
" } }, "documentation": "The bucket and key of an item stored in Amazon S3.
" }, "SampleTimestamp": { "type": "timestamp" }, "SearchFilter": { "type": "structure", "members": { "Attribute": { "shape": "SearchFilterAttribute", "documentation": "The result attribute to which the filter values are applied. Valid values vary by API action.
" }, "Operator": { "shape": "SearchFilterOperator", "documentation": "The operator to apply to the Attribute with each of the Values. Valid values vary by Attribute.
The list of values applied to the Attribute and Operator attributes. Number of values and valid values vary by Attribute.
Describes criteria to restrict a list of results.
For operators that apply a single value to the attribute, the filter is evaluated as follows: Attribute Operator Values[1]
Some operators, e.g. in, can apply multiple values. In this case, the filter is evaluated as a logical union (OR) of applications of the operator to the attribute with each one of the values: (Attribute Operator Values[1]) OR (Attribute Operator Values[2]) OR ...
The valid values for attributes of SearchFilter depend on the API action. For valid values, see the reference page for the API action you're calling that takes a SearchFilter parameter.
The ID of the Amazon EC2 instance.
" }, "HealthStatus": { "shape": "String", "documentation": "Returns the health status of the specified instance. For more information, see Health Colors and Statuses.
" }, "Color": { "shape": "String", "documentation": "Represents the color indicator that gives you information about the health of the EC2 instance. For more information, see Health Colors and Statuses.
" }, "Causes": { "shape": "Causes", "documentation": "Represents the causes, which provide more information about the current health status.
" }, "LaunchedAt": { "shape": "LaunchedAt", "documentation": "The time at which the EC2 instance was launched.
" }, "ApplicationMetrics": { "shape": "ApplicationMetrics", "documentation": "Request metrics from your application.
" }, "System": { "shape": "SystemStatus", "documentation": "Operating system metrics from the instance.
" }, "Deployment": { "shape": "Deployment", "documentation": "Information about the most recent deployment to an instance.
" }, "AvailabilityZone": { "shape": "String", "documentation": "The availability zone in which the instance runs.
" }, "InstanceType": { "shape": "String", "documentation": "The instance's type.
" } }, "documentation": "Detailed health information about an Amazon EC2 instance in your Elastic Beanstalk environment.
" }, "SolutionStackDescription": { "type": "structure", "members": { "SolutionStackName": { "shape": "SolutionStackName", "documentation": "The name of the solution stack.
" }, "PermittedFileTypes": { "shape": "SolutionStackFileTypeList", "documentation": "The permitted file types allowed for a solution stack.
" } }, "documentation": "Describes the solution stack.
" }, "SolutionStackFileTypeList": { "type": "list", "member": { "shape": "FileTypeExtension" } }, "SolutionStackName": { "type": "string" }, "SourceBuildInformation": { "type": "structure", "required": [ "SourceType", "SourceRepository", "SourceLocation" ], "members": { "SourceType": { "shape": "SourceType", "documentation": "The type of repository.
Git
Zip
Location where the repository is stored.
CodeCommit
S3
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 of the source code for an application version.
" }, "SourceConfiguration": { "type": "structure", "members": { "ApplicationName": { "shape": "ApplicationName", "documentation": "The name of the application associated with the configuration.
" }, "TemplateName": { "shape": "ConfigurationTemplateName", "documentation": "The name of the configuration template.
" } }, "documentation": "A specification for an environment configuration.
" }, "SourceLocation": { "type": "string", "max": 255, "min": 3, "pattern": ".+/.+" }, "SourceRepository": { "type": "string", "enum": [ "CodeCommit", "S3" ] }, "SourceType": { "type": "string", "enum": [ "Git", "Zip" ] }, "StatusCodes": { "type": "structure", "members": { "Status2xx": { "shape": "NullableInteger", "documentation": "The percentage of requests over the last 10 seconds that resulted in a 2xx (200, 201, etc.) status code.
" }, "Status3xx": { "shape": "NullableInteger", "documentation": "The percentage of requests over the last 10 seconds that resulted in a 3xx (300, 301, etc.) status code.
" }, "Status4xx": { "shape": "NullableInteger", "documentation": "The percentage of requests over the last 10 seconds that resulted in a 4xx (400, 401, etc.) status code.
" }, "Status5xx": { "shape": "NullableInteger", "documentation": "The percentage of requests over the last 10 seconds that resulted in a 5xx (500, 501, etc.) status code.
" } }, "documentation": "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.
" }, "String": { "type": "string" }, "SupportedAddon": { "type": "string" }, "SupportedAddonList": { "type": "list", "member": { "shape": "SupportedAddon" } }, "SupportedTier": { "type": "string" }, "SupportedTierList": { "type": "list", "member": { "shape": "SupportedTier" } }, "SwapEnvironmentCNAMEsMessage": { "type": "structure", "members": { "SourceEnvironmentId": { "shape": "EnvironmentId", "documentation": "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 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 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 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.
Swaps the CNAMEs of two environments.
" }, "SystemStatus": { "type": "structure", "members": { "CPUUtilization": { "shape": "CPUUtilization", "documentation": "CPU utilization metrics for the instance.
" }, "LoadAverage": { "shape": "LoadAverage", "documentation": "Load average in the last 1-minute, 5-minute, and 15-minute periods. For more information, see Operating System Metrics.
" } }, "documentation": "CPU utilization and load average metrics for an Amazon EC2 instance.
" }, "Tag": { "type": "structure", "members": { "Key": { "shape": "TagKey", "documentation": "The key of the tag.
" }, "Value": { "shape": "TagValue", "documentation": "The value of the tag.
" } }, "documentation": "Describes a tag applied to a resource in an environment.
" }, "TagKey": { "type": "string", "max": 128, "min": 1 }, "TagKeyList": { "type": "list", "member": { "shape": "TagKey" } }, "TagList": { "type": "list", "member": { "shape": "Tag" } }, "TagValue": { "type": "string", "max": 256, "min": 1 }, "Tags": { "type": "list", "member": { "shape": "Tag" } }, "TerminateEnvForce": { "type": "boolean" }, "TerminateEnvironmentMessage": { "type": "structure", "members": { "EnvironmentId": { "shape": "EnvironmentId", "documentation": "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 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.
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
Terminates the target environment even if another environment in the same group is dependent on it.
" } }, "documentation": "Request to terminate an environment.
" }, "TerminateEnvironmentResources": { "type": "boolean" }, "TimeFilterEnd": { "type": "timestamp" }, "TimeFilterStart": { "type": "timestamp" }, "Timestamp": { "type": "timestamp" }, "Token": { "type": "string" }, "Trigger": { "type": "structure", "members": { "Name": { "shape": "ResourceId", "documentation": "The name of the trigger.
" } }, "documentation": "Describes a trigger.
" }, "TriggerList": { "type": "list", "member": { "shape": "Trigger" } }, "UpdateApplicationMessage": { "type": "structure", "required": [ "ApplicationName" ], "members": { "ApplicationName": { "shape": "ApplicationName", "documentation": "The name of the application to update. If no such application is found, UpdateApplication returns an InvalidParameterValue error.
A new description for the application.
Default: If not specified, AWS Elastic Beanstalk does not update the description.
" } }, "documentation": "Request to update an application.
" }, "UpdateApplicationResourceLifecycleMessage": { "type": "structure", "required": [ "ApplicationName", "ResourceLifecycleConfig" ], "members": { "ApplicationName": { "shape": "ApplicationName", "documentation": "The name of the application.
" }, "ResourceLifecycleConfig": { "shape": "ApplicationResourceLifecycleConfig", "documentation": "The lifecycle configuration.
" } } }, "UpdateApplicationVersionMessage": { "type": "structure", "required": [ "ApplicationName", "VersionLabel" ], "members": { "ApplicationName": { "shape": "ApplicationName", "documentation": "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 version to update.
If no application version is found with this label, UpdateApplication returns an InvalidParameterValue error.
A new description for this version.
" } }, "documentation": "" }, "UpdateConfigurationTemplateMessage": { "type": "structure", "required": [ "ApplicationName", "TemplateName" ], "members": { "ApplicationName": { "shape": "ApplicationName", "documentation": "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 configuration template to update.
If no configuration template is found with this name, UpdateConfigurationTemplate returns an InvalidParameterValue error.
A new description for the configuration.
" }, "OptionSettings": { "shape": "ConfigurationOptionSettingsList", "documentation": "A list of configuration option settings to update with the new specified option value.
" }, "OptionsToRemove": { "shape": "OptionsSpecifierList", "documentation": "A list of configuration options to remove from the configuration set.
Constraint: You can remove only UserDefined configuration options.
The result message containing the options for the specified solution stack.
" }, "UpdateDate": { "type": "timestamp" }, "UpdateEnvironmentMessage": { "type": "structure", "members": { "ApplicationName": { "shape": "ApplicationName", "documentation": "The name of the application with which the environment is associated.
" }, "EnvironmentId": { "shape": "EnvironmentId", "documentation": "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.
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 group to which the target environment belongs. Specify a group name only if the environment's name is specified in an environment manifest and not with the environment name or environment ID parameters. See Environment Manifest (env.yaml) for details.
" }, "Description": { "shape": "Description", "documentation": "If this parameter is specified, AWS Elastic Beanstalk updates the description of this environment.
" }, "Tier": { "shape": "EnvironmentTier", "documentation": "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.
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.
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.
This specifies the platform version that the environment will run after the environment is updated.
" }, "PlatformArn": { "shape": "PlatformArn", "documentation": "The ARN of the platform, if used.
" }, "OptionSettings": { "shape": "ConfigurationOptionSettingsList", "documentation": "If specified, AWS Elastic Beanstalk updates the configuration set associated with the running environment and sets the specified configuration options to the requested value.
" }, "OptionsToRemove": { "shape": "OptionsSpecifierList", "documentation": "A list of custom user-defined configuration options to remove from the configuration set for this environment.
" } }, "documentation": "Request to update an environment.
" }, "UpdateTagsForResourceMessage": { "type": "structure", "required": [ "ResourceArn" ], "members": { "ResourceArn": { "shape": "ResourceArn", "documentation": "The Amazon Resource Name (ARN) of the resouce to be updated.
Must be the ARN of an Elastic Beanstalk resource.
" }, "TagsToAdd": { "shape": "TagList", "documentation": "A list of tags to add or update. If a key of an existing tag is added, the tag's value is updated.
Specify at least one of these parameters: TagsToAdd, TagsToRemove.
A list of tag keys to remove. If a tag key doesn't exist, it is silently ignored.
Specify at least one of these parameters: TagsToAdd, TagsToRemove.
The name of the application that the configuration template or environment belongs to.
" }, "TemplateName": { "shape": "ConfigurationTemplateName", "documentation": "The name of the configuration template to validate the settings against.
Condition: You cannot specify both this and an environment name.
" }, "EnvironmentName": { "shape": "EnvironmentName", "documentation": "The name of the environment to validate the settings against.
Condition: You cannot specify both this and a configuration template name.
" }, "OptionSettings": { "shape": "ConfigurationOptionSettingsList", "documentation": "A list of the options and desired values to evaluate.
" } }, "documentation": "A list of validation messages for a specified configuration template.
" }, "ValidationMessage": { "type": "structure", "members": { "Message": { "shape": "ValidationMessageString", "documentation": "A message describing the error or warning.
" }, "Severity": { "shape": "ValidationSeverity", "documentation": "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.
The namespace to which the option belongs.
" }, "OptionName": { "shape": "ConfigurationOptionName", "documentation": "The name of the option.
" } }, "documentation": "An error or warning for a desired configuration option value.
" }, "ValidationMessageString": { "type": "string" }, "ValidationMessagesList": { "type": "list", "member": { "shape": "ValidationMessage" } }, "ValidationSeverity": { "type": "string", "enum": [ "error", "warning" ] }, "VersionLabel": { "type": "string", "max": 100, "min": 1 }, "VersionLabels": { "type": "list", "member": { "shape": "VersionLabel" } }, "VersionLabelsList": { "type": "list", "member": { "shape": "VersionLabel" } }, "VirtualizationType": { "type": "string" } }, "documentation": "AWS Elastic Beanstalk makes it easy for you to create, deploy, and manage scalable, fault-tolerant applications running on the Amazon Web Services cloud.
For more information about this product, go to the AWS Elastic Beanstalk details page. The location of the latest AWS Elastic Beanstalk WSDL is https://elasticbeanstalk.s3.amazonaws.com/doc/2010-12-01/AWSElasticBeanstalk.wsdl. To install the Software Development Kits (SDKs), Integrated Development Environment (IDE) Toolkits, and command line tools that enable you to access the API, go to Tools for Amazon Web Services.
Endpoints
For a list of region-specific endpoints that AWS Elastic Beanstalk supports, go to Regions and Endpoints in the Amazon Web Services Glossary.
" }