AWS Elastic Beanstalk (version v1.*.*)

$body#

Type: object

{
  "EnvironmentId" : "This specifies the ID of the environment with the in-progress update that you want to cancel.",
  "EnvironmentName" : "This specifies the name of the environment with the in-progress update that you want to cancel."
}

$body#

Request to execute a scheduled managed action immediately.

Type: object

{
  "EnvironmentId" : "The environment ID of the target environment.",
  "ActionId" : "The action ID of the scheduled managed action to execute.",
  "EnvironmentName" : "The name of the target environment."
}

$body#

Results message indicating whether a CNAME is available.

Type: object

{
  "CNAMEPrefix" : "The prefix used when this CNAME is reserved."
}

$body#

Request to create or update a group of environments.

Type: object

{
  "GroupName" : "The name of the group to which the target environments belong. Specify a group name only if the environment name defined in each target environment's manifest ends with a + (plus) character. See Environment Manifest (env.yaml) for details.",
  "VersionLabels" : [ "string" ],
  "ApplicationName" : "The name of the application to which the specified source bundles belong."
}

$body#

Request to create an application.

Type: object

{
  "ApplicationName" : "The name of the application. \nConstraint: This name must be unique within your account. If the specified name already exists, the action returns an InvalidParameterValue error.",
  "Description" : "Describes the application.",
  "ResourceLifecycleConfig" : {
    "ServiceRole" : "The ARN of an IAM service role that Elastic Beanstalk has permission to assume. \nThe ServiceRole property is required the first time that you provide a VersionLifecycleConfig for the application in one of the supporting calls (CreateApplication or UpdateApplicationResourceLifecycle). After you provide it once, in either one of the calls, Elastic Beanstalk persists the Service Role with the application, and you don't need to specify it again in subsequent UpdateApplicationResourceLifecycle calls. You can, however, specify it in subsequent calls to change the Service Role to another value.",
    "VersionLifecycleConfig" : {
      "MaxCountRule" : {
        "DeleteSourceFromS3" : "Set to true to delete a version's source bundle from Amazon S3 when Elastic Beanstalk deletes the application version.",
        "Enabled" : "Specify true to apply the rule, or false to disable it.",
        "MaxCount" : "Specify the maximum number of application versions to retain."
      },
      "MaxAgeRule" : {
        "DeleteSourceFromS3" : "Set to true to delete a version's source bundle from Amazon S3 when Elastic Beanstalk deletes the application version.",
        "MaxAgeInDays" : "Specify the number of days to retain an application versions.",
        "Enabled" : "Specify true to apply the rule, or false to disable it."
      }
    }
  },
  "Tags" : [ {
    "Tag" : {
      "Value" : "The value of the tag.",
      "Key" : "The key of the tag."
    }
  } ]
}

$body#

Type: object

{
  "SourceBuildInformation" : {
    "SourceLocation" : "The location of the source code, as a formatted string, depending on the value of SourceRepository   \n For CodeCommit, the format is the repository name and commit ID, separated by a forward slash. For example, my-git-repo/265cfa0cf6af46153527f55d6503ec030551f57a.  \n 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. ",
    "SourceType" : "The type of repository.  \n  Git   \n  Zip  ",
    "SourceRepository" : "Location where the repository is stored.  \n  CodeCommit   \n  S3  "
  },
  "BuildConfiguration" : {
    "CodeBuildServiceRole" : "The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.",
    "ArtifactName" : "The name of the artifact of the CodeBuild build. If provided, Elastic Beanstalk stores the build artifact in the S3 location S3-bucket/resources/application-name/codebuild/codebuild-version-label-artifact-name.zip. If not provided, Elastic Beanstalk stores the build artifact in the S3 location S3-bucket/resources/application-name/codebuild/codebuild-version-label.zip. ",
    "Image" : "The ID of the Docker image to use for this build project.",
    "ComputeType" : "Information about the compute resources the build project will use.  \n  BUILD_GENERAL1_SMALL: Use up to 3 GB memory and 2 vCPUs for builds   \n  BUILD_GENERAL1_MEDIUM: Use up to 7 GB memory and 4 vCPUs for builds   \n  BUILD_GENERAL1_LARGE: Use up to 15 GB memory and 8 vCPUs for builds  ",
    "TimeoutInMinutes" : "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."
  },
  "ApplicationName" : " The name of the application. If no application is found with this name, and AutoCreateApplication is false, returns an InvalidParameterValue error. ",
  "Description" : "Describes this version.",
  "VersionLabel" : "A label identifying this version. \nConstraint: 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. ",
  "SourceBundle" : {
    "S3Bucket" : "The Amazon S3 bucket where the data is located.",
    "S3Key" : "The Amazon S3 key where the data is located."
  },
  "Process" : "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. \nYou 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.  \nThe Process option validates Elastic Beanstalk configuration files. It doesn't validate your application's configuration files, like proxy server or Docker configuration.",
  "AutoCreateApplication" : "Set to true to create an application with the specified name if it doesn't already exist.",
  "Tags" : [ {
    "Tag" : {
      "Value" : "The value of the tag.",
      "Key" : "The key of the tag."
    }
  } ]
}

$body#

Request to create a configuration template.

Type: object

{
  "PlatformArn" : "The ARN of the custom platform.",
  "EnvironmentId" : "The ID of the environment used with this configuration template.",
  "ApplicationName" : "The name of the application to associate with this configuration template. If no application is found with this name, AWS Elastic Beanstalk returns an InvalidParameterValue error. ",
  "Description" : "Describes this configuration.",
  "OptionSettings" : [ {
    "ConfigurationOptionSetting" : {
      "ResourceName" : "A unique resource name for a time-based scaling configuration option.",
      "Value" : "The current value for the configuration option.",
      "Namespace" : "A unique namespace identifying the option's associated AWS resource.",
      "OptionName" : "The name of the configuration option."
    }
  } ],
  "SourceConfiguration" : {
    "ApplicationName" : "The name of the application associated with the configuration.",
    "TemplateName" : "The name of the configuration template."
  },
  "TemplateName" : "The name of the configuration template. \nConstraint: This name must be unique per application. \nDefault: If a configuration template already exists with this name, AWS Elastic Beanstalk returns an InvalidParameterValue error. ",
  "SolutionStackName" : "The name of the solution stack used by this configuration. The solution stack specifies the operating system, architecture, and application server for a configuration template. It determines the set of configuration options as well as the possible and default values. \n Use ListAvailableSolutionStacks to obtain a list of available solution stacks.  \n A solution stack name or a source configuration parameter must be specified, otherwise AWS Elastic Beanstalk returns an InvalidParameterValue error.  \nIf a solution stack name is not specified and the source configuration parameter is specified, AWS Elastic Beanstalk uses the same solution stack as the source configuration template.",
  "Tags" : [ {
    "Tag" : {
      "Value" : "The value of the tag.",
      "Key" : "The key of the tag."
    }
  } ]
}

$body#

Type: object

{
  "GroupName" : "The name of the group to which the target environment belongs. Specify a group name only if the environment's name is specified in an environment manifest and not with the environment name parameter. See Environment Manifest (env.yaml) for details.",
  "PlatformArn" : "The ARN of the platform.",
  "ApplicationName" : "The name of the application that contains the version to be deployed. \n If no application is found with this name, CreateEnvironment returns an InvalidParameterValue error. ",
  "Description" : "Describes this environment.",
  "EnvironmentName" : "A unique name for the deployment environment. Used in the application URL. \nConstraint: Must be from 4 to 40 characters in length. The name can contain only letters, numbers, and hyphens. It cannot start or end with a hyphen. This name must be unique within a region in your account. If the specified name already exists in the region, AWS Elastic Beanstalk returns an InvalidParameterValue error.  \nDefault: If the CNAME parameter is not specified, the environment name becomes part of the CNAME, and therefore part of the visible URL for your application.",
  "Tier" : {
    "Type" : "The type of this environment tier. \nValid values:  \n For Web server tier – Standard   \n For Worker tier – SQS/HTTP  ",
    "Version" : "The version of this environment tier. When you don't set a value to it, Elastic Beanstalk uses the latest compatible worker tier version.  \nThis member is deprecated. Any specific version that you set may become out of date. We recommend leaving it unspecified.",
    "Name" : "The name of this environment tier. \nValid values:  \n For Web server tier – WebServer   \n For Worker tier – Worker  "
  },
  "VersionLabel" : "The name of the application version to deploy. \n If the specified application has no associated application versions, AWS Elastic Beanstalk UpdateEnvironment returns an InvalidParameterValue error.  \nDefault: If not specified, AWS Elastic Beanstalk attempts to launch the sample application in the container.",
  "OptionsToRemove" : [ {
    "OptionSpecification" : {
      "ResourceName" : "A unique resource name for a time-based scaling configuration option.",
      "Namespace" : "A unique namespace identifying the option's associated AWS resource.",
      "OptionName" : "The name of the configuration option."
    }
  } ],
  "OptionSettings" : [ {
    "ConfigurationOptionSetting" : {
      "ResourceName" : "A unique resource name for a time-based scaling configuration option.",
      "Value" : "The current value for the configuration option.",
      "Namespace" : "A unique namespace identifying the option's associated AWS resource.",
      "OptionName" : "The name of the configuration option."
    }
  } ],
  "TemplateName" : " The name of the configuration template to use in deployment. If no configuration template is found with this name, AWS Elastic Beanstalk returns an InvalidParameterValue error. ",
  "SolutionStackName" : "This is an alternative to specifying a template name. If specified, AWS Elastic Beanstalk sets the configuration values to the default values associated with the specified solution stack. \nFor a list of current solution stacks, see Elastic Beanstalk Supported Platforms.",
  "CNAMEPrefix" : "If specified, the environment attempts to use this value as the prefix for the CNAME. If not specified, the CNAME is generated automatically by appending a random alphanumeric string to the environment name.",
  "Tags" : [ {
    "Tag" : {
      "Value" : "The value of the tag.",
      "Key" : "The key of the tag."
    }
  } ]
}

$body#

Request to create a new platform version.

Type: object

{
  "PlatformName" : "The name of your custom platform.",
  "PlatformVersion" : "The number, such as 1.0.2, for the new platform version.",
  "EnvironmentName" : "The name of the builder environment.",
  "OptionSettings" : [ {
    "ConfigurationOptionSetting" : {
      "ResourceName" : "A unique resource name for a time-based scaling configuration option.",
      "Value" : "The current value for the configuration option.",
      "Namespace" : "A unique namespace identifying the option's associated AWS resource.",
      "OptionName" : "The name of the configuration option."
    }
  } ],
  "PlatformDefinitionBundle" : {
    "S3Bucket" : "The Amazon S3 bucket where the data is located.",
    "S3Key" : "The Amazon S3 key where the data is located."
  },
  "Tags" : [ {
    "Tag" : {
      "Value" : "The value of the tag.",
      "Key" : "The key of the tag."
    }
  } ]
}

$body#

Request to delete an application.

Type: object

{
  "ApplicationName" : "The name of the application to delete.",
  "TerminateEnvByForce" : "When set to true, running environments will be terminated before deleting the application."
}

$body#

Request to delete an application version.

Type: object

{
  "DeleteSourceBundle" : "Set to true to delete the source bundle from your storage bucket. Otherwise, the application version is deleted only from Elastic Beanstalk and the source bundle remains in Amazon S3.",
  "ApplicationName" : "The name of the application to which the version belongs.",
  "VersionLabel" : "The label of the version to delete."
}

$body#

Request to delete a configuration template.

Type: object

{
  "ApplicationName" : "The name of the application to delete the configuration template from.",
  "TemplateName" : "The name of the configuration template to delete."
}

$body#

Request to delete a draft environment configuration.

Type: object

{
  "ApplicationName" : "The name of the application the environment is associated with.",
  "EnvironmentName" : "The name of the environment to delete the draft configuration from."
}

$body#

Type: object

{
  "PlatformArn" : "The ARN of the version of the custom platform."
}

$body#

Request to describe application versions.

Type: object

{
  "VersionLabels" : [ "string" ],
  "ApplicationName" : "Specify an application name to show only application versions for that application."
}

$body#

Request to describe one or more applications.

Type: object

{
  "ApplicationNames" : [ "string" ]
}

$body#

Result message containing a list of application version descriptions.

Type: object

{
  "Options" : [ {
    "OptionSpecification" : {
      "ResourceName" : "A unique resource name for a time-based scaling configuration option.",
      "Namespace" : "A unique namespace identifying the option's associated AWS resource.",
      "OptionName" : "The name of the configuration option."
    }
  } ],
  "PlatformArn" : "The ARN of the custom platform.",
  "ApplicationName" : "The name of the application associated with the configuration template or environment. Only needed if you want to describe the configuration options associated with either the configuration template or environment.",
  "EnvironmentName" : "The name of the environment whose configuration options you want to describe.",
  "TemplateName" : "The name of the configuration template whose configuration options you want to describe.",
  "SolutionStackName" : "The name of the solution stack whose configuration options you want to describe."
}

$body#

Result message containing all of the configuration settings for a specified solution stack or configuration template.

Type: object

{
  "ApplicationName" : "The application for the environment or configuration template.",
  "EnvironmentName" : "The name of the environment to describe. \n 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. ",
  "TemplateName" : "The name of the configuration template to describe. \n Conditional: You must specify either this parameter or an EnvironmentName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns a MissingRequiredParameter error. "
}

$body#

See the example below to learn how to create a request body.

Type: object

{
  "EnvironmentId" : "Specify the environment by ID. \nYou must specify either this or an EnvironmentName, or both.",
  "EnvironmentName" : "Specify the environment by name. \nYou must specify either this or an EnvironmentName, or both.",
  "AttributeNames" : [ "string. Possible values: Status | Color | Causes | ApplicationMetrics | InstancesHealth | All | HealthStatus | RefreshedAt" ]
}

$body#

Request to list completed and failed managed actions.

Type: object

{
  "EnvironmentId" : "The environment ID of the target environment.",
  "EnvironmentName" : "The name of the target environment."
}

$body#

Request to list an environment's upcoming and in-progress managed actions.

Type: object

{
  "Status" : "To show only actions with a particular status, specify a status.",
  "EnvironmentId" : "The environment ID of the target environment.",
  "EnvironmentName" : "The name of the target environment."
}

$body#

Request to describe the resources in an environment.

Type: object

{
  "EnvironmentId" : "The ID of the environment to retrieve AWS resource usage data. \n Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error. ",
  "EnvironmentName" : "The name of the environment to retrieve AWS resource usage data. \n Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error. "
}

$body#

Request to describe one or more environments.

Type: object

{
  "IncludedDeletedBackTo" : " If specified when IncludeDeleted is set to true, then environments deleted after this date are displayed. ",
  "EnvironmentNames" : [ "string" ],
  "ApplicationName" : "If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.",
  "VersionLabel" : "If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.",
  "IncludeDeleted" : "Indicates whether to include deleted environments: \n true: Environments that have been deleted after IncludedDeletedBackTo are displayed. \n false: Do not include deleted environments.",
  "EnvironmentIds" : [ "string" ]
}

$body#

Request to retrieve a list of events for an environment.

Type: object

{
  "EnvironmentId" : "If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment.",
  "PlatformArn" : "The ARN of the version of the custom platform.",
  "ApplicationName" : "If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those associated with this application.",
  "RequestId" : "If specified, AWS Elastic Beanstalk restricts the described events to include only those associated with this request ID.",
  "EndTime" : " If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur up to, but not including, the EndTime. ",
  "EnvironmentName" : "If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment.",
  "VersionLabel" : "If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this application version.",
  "StartTime" : "If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur on or after this time.",
  "TemplateName" : "If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that are associated with this environment configuration.",
  "Severity" : "If specified, limits the events returned from this call to include only those with the specified severity or higher."
}

$body#

Parameters for a call to DescribeInstancesHealth.

Type: object

{
  "EnvironmentId" : "Specify the AWS Elastic Beanstalk environment by ID.",
  "NextToken" : "Specify the pagination token returned by a previous call.",
  "EnvironmentName" : "Specify the AWS Elastic Beanstalk environment by name.",
  "AttributeNames" : [ "string. Possible values: HealthStatus | Color | Causes | ApplicationMetrics | RefreshedAt | LaunchedAt | System | Deployment | AvailabilityZone | InstanceType | All" ]
}

$body#

Type: object

{
  "PlatformArn" : "The ARN of the version of the platform."
}

$body#

Type: object

{
  "Filters" : [ {
    "PlatformFilter" : {
      "Operator" : "The operator to apply to the Type with each of the Values. \n Valid Values: = (equal to) | != (not equal to) | < (less than) | <= (less than or equal to) | > (greater than) | >= (greater than or equal to) | contains | begins_with | ends_with ",
      "Type" : "The custom platform attribute to which the filter values are applied. \nValid Values: PlatformName | PlatformVersion | PlatformStatus | PlatformOwner ",
      "Values" : [ "string" ]
    }
  } ]
}

$body#

Type: object

{
  "ResourceArn" : "The Amazon Resource Name (ARN) of the resouce for which a tag list is requested. \nMust be the ARN of an Elastic Beanstalk environment."
}

$body#

Type: object

{
  "EnvironmentId" : "The ID of the environment to rebuild. \n Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error. ",
  "EnvironmentName" : "The name of the environment to rebuild. \n Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error. "
}

$body#

Request to retrieve logs from an environment and store them in your Elastic Beanstalk storage bucket.

Type: object

{
  "EnvironmentId" : "The ID of the environment of the requested data. \nIf no such environment is found, RequestEnvironmentInfo returns an InvalidParameterValue error.  \nCondition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error. ",
  "EnvironmentName" : "The name of the environment of the requested data. \nIf no such environment is found, RequestEnvironmentInfo returns an InvalidParameterValue error.  \nCondition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error. ",
  "InfoType" : "The type of information to request."
}

$body#

Type: object

{
  "EnvironmentId" : "The ID of the environment to restart the server for. \n Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error. ",
  "EnvironmentName" : "The name of the environment to restart the server for. \n Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error. "
}

$body#

Request to download logs retrieved with RequestEnvironmentInfo.

Type: object

{
  "EnvironmentId" : "The ID of the data's environment. \nIf no such environment is found, returns an InvalidParameterValue error. \nCondition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.",
  "EnvironmentName" : "The name of the data's environment. \n If no such environment is found, returns an InvalidParameterValue error.  \n Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error. ",
  "InfoType" : "The type of information to retrieve."
}

$body#

Swaps the CNAMEs of two environments.

Type: object

{
  "SourceEnvironmentName" : "The name of the source environment. \n Condition: You must specify at least the SourceEnvironmentID or the SourceEnvironmentName. You may also specify both. If you specify the SourceEnvironmentName, you must specify the DestinationEnvironmentName. ",
  "DestinationEnvironmentId" : "The ID of the destination environment. \n Condition: You must specify at least the DestinationEnvironmentID or the DestinationEnvironmentName. You may also specify both. You must specify the SourceEnvironmentId with the DestinationEnvironmentId. ",
  "DestinationEnvironmentName" : "The name of the destination environment. \n Condition: You must specify at least the DestinationEnvironmentID or the DestinationEnvironmentName. You may also specify both. You must specify the SourceEnvironmentName with the DestinationEnvironmentName. ",
  "SourceEnvironmentId" : "The ID of the source environment. \n 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. "
}

$body#

Request to terminate an environment.

Type: object

{
  "EnvironmentId" : "The ID of the environment to terminate. \n Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error. ",
  "EnvironmentName" : "The name of the environment to terminate. \n Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error. ",
  "TerminateResources" : "Indicates whether the associated AWS resources should shut down when the environment is terminated:  \n  true: The specified environment as well as the associated AWS resources, such as Auto Scaling group and LoadBalancer, are terminated.  \n  false: AWS Elastic Beanstalk resource management is removed from the environment, but the AWS resources continue to operate.   \n For more information, see the  AWS Elastic Beanstalk User Guide.   \n Default: true  \n Valid Values: true | false ",
  "ForceTerminate" : "Terminates the target environment even if another environment in the same group is dependent on it."
}

$body#

Request to update an application.

Type: object

{
  "ApplicationName" : "The name of the application to update. If no such application is found, UpdateApplication returns an InvalidParameterValue error. ",
  "Description" : "A new description for the application. \nDefault: If not specified, AWS Elastic Beanstalk does not update the description."
}

$body#

Type: object

{
  "ApplicationName" : "The name of the application.",
  "ResourceLifecycleConfig" : {
    "ServiceRole" : "The ARN of an IAM service role that Elastic Beanstalk has permission to assume. \nThe ServiceRole property is required the first time that you provide a VersionLifecycleConfig for the application in one of the supporting calls (CreateApplication or UpdateApplicationResourceLifecycle). After you provide it once, in either one of the calls, Elastic Beanstalk persists the Service Role with the application, and you don't need to specify it again in subsequent UpdateApplicationResourceLifecycle calls. You can, however, specify it in subsequent calls to change the Service Role to another value.",
    "VersionLifecycleConfig" : {
      "MaxCountRule" : {
        "DeleteSourceFromS3" : "Set to true to delete a version's source bundle from Amazon S3 when Elastic Beanstalk deletes the application version.",
        "Enabled" : "Specify true to apply the rule, or false to disable it.",
        "MaxCount" : "Specify the maximum number of application versions to retain."
      },
      "MaxAgeRule" : {
        "DeleteSourceFromS3" : "Set to true to delete a version's source bundle from Amazon S3 when Elastic Beanstalk deletes the application version.",
        "MaxAgeInDays" : "Specify the number of days to retain an application versions.",
        "Enabled" : "Specify true to apply the rule, or false to disable it."
      }
    }
  }
}

$body#

Type: object

{
  "ApplicationName" : "The name of the application associated with this version. \n If no application is found with this name, UpdateApplication returns an InvalidParameterValue error.",
  "Description" : "A new description for this version.",
  "VersionLabel" : "The name of the version to update. \nIf no application version is found with this label, UpdateApplication returns an InvalidParameterValue error. "
}

$body#

The result message containing the options for the specified solution stack.

Type: object

{
  "ApplicationName" : "The name of the application associated with the configuration template to update. \n If no application is found with this name, UpdateConfigurationTemplate returns an InvalidParameterValue error. ",
  "Description" : "A new description for the configuration.",
  "OptionSettings" : [ {
    "ConfigurationOptionSetting" : {
      "ResourceName" : "A unique resource name for a time-based scaling configuration option.",
      "Value" : "The current value for the configuration option.",
      "Namespace" : "A unique namespace identifying the option's associated AWS resource.",
      "OptionName" : "The name of the configuration option."
    }
  } ],
  "TemplateName" : "The name of the configuration template to update. \n If no configuration template is found with this name, UpdateConfigurationTemplate returns an InvalidParameterValue error. ",
  "OptionsToRemove" : [ {
    "OptionSpecification" : {
      "ResourceName" : "A unique resource name for a time-based scaling configuration option.",
      "Namespace" : "A unique namespace identifying the option's associated AWS resource.",
      "OptionName" : "The name of the configuration option."
    }
  } ]
}

$body#

Request to update an environment.

Type: object

{
  "GroupName" : "The name of the group to which the target environment belongs. Specify a group name only if the environment's name is specified in an environment manifest and not with the environment name or environment ID parameters. See Environment Manifest (env.yaml) for details.",
  "EnvironmentId" : "The ID of the environment to update. \nIf no environment with this ID exists, AWS Elastic Beanstalk returns an InvalidParameterValue error. \nCondition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error. ",
  "PlatformArn" : "The ARN of the platform, if used.",
  "ApplicationName" : "The name of the application with which the environment is associated.",
  "Description" : "If this parameter is specified, AWS Elastic Beanstalk updates the description of this environment.",
  "EnvironmentName" : "The name of the environment to update. If no environment with this name exists, AWS Elastic Beanstalk returns an InvalidParameterValue error.  \nCondition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error. ",
  "Tier" : {
    "Type" : "The type of this environment tier. \nValid values:  \n For Web server tier – Standard   \n For Worker tier – SQS/HTTP  ",
    "Version" : "The version of this environment tier. When you don't set a value to it, Elastic Beanstalk uses the latest compatible worker tier version.  \nThis member is deprecated. Any specific version that you set may become out of date. We recommend leaving it unspecified.",
    "Name" : "The name of this environment tier. \nValid values:  \n For Web server tier – WebServer   \n For Worker tier – Worker  "
  },
  "OptionSettings" : [ {
    "ConfigurationOptionSetting" : {
      "ResourceName" : "A unique resource name for a time-based scaling configuration option.",
      "Value" : "The current value for the configuration option.",
      "Namespace" : "A unique namespace identifying the option's associated AWS resource.",
      "OptionName" : "The name of the configuration option."
    }
  } ],
  "VersionLabel" : "If this parameter is specified, AWS Elastic Beanstalk deploys the named application version to the environment. If no such application version is found, returns an InvalidParameterValue error. ",
  "TemplateName" : "If this parameter is specified, AWS Elastic Beanstalk deploys this configuration template to the environment. If no such configuration template is found, AWS Elastic Beanstalk returns an InvalidParameterValue error. ",
  "SolutionStackName" : "This specifies the platform version that the environment will run after the environment is updated.",
  "OptionsToRemove" : [ {
    "OptionSpecification" : {
      "ResourceName" : "A unique resource name for a time-based scaling configuration option.",
      "Namespace" : "A unique namespace identifying the option's associated AWS resource.",
      "OptionName" : "The name of the configuration option."
    }
  } ]
}

$body#

Type: object

{
  "ResourceArn" : "The Amazon Resource Name (ARN) of the resouce to be updated. \nMust be the ARN of an Elastic Beanstalk environment.",
  "TagsToAdd" : [ {
    "Tag" : {
      "Value" : "The value of the tag.",
      "Key" : "The key of the tag."
    }
  } ],
  "TagsToRemove" : [ "string" ]
}

$body#

A list of validation messages for a specified configuration template.

Type: object

{
  "ApplicationName" : "The name of the application that the configuration template or environment belongs to.",
  "EnvironmentName" : "The name of the environment to validate the settings against. \nCondition: You cannot specify both this and a configuration template name.",
  "OptionSettings" : [ {
    "ConfigurationOptionSetting" : {
      "ResourceName" : "A unique resource name for a time-based scaling configuration option.",
      "Value" : "The current value for the configuration option.",
      "Namespace" : "A unique namespace identifying the option's associated AWS resource.",
      "OptionName" : "The name of the configuration option."
    }
  } ],
  "TemplateName" : "The name of the configuration template to validate the settings against. \nCondition: You cannot specify both this and an environment name."
}