ValidateConfigurationSettings - AWS Elastic Beanstalk

ValidateConfigurationSettings

Takes a set of configuration settings and either a configuration template or environment, and determines whether those values are valid.

This action returns a list of messages indicating any errors or warnings associated with the selection of option values.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

ApplicationName

The name of the application that the configuration template or environment belongs to.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: Yes

EnvironmentName

The name of the environment to validate the settings against.

Condition: You cannot specify both this and a configuration template name.

Type: String

Length Constraints: Minimum length of 4. Maximum length of 40.

Required: No

OptionSettings.member.N

A list of the options and desired values to evaluate.

Type: Array of ConfigurationOptionSetting objects

Required: Yes

TemplateName

The name of the configuration template to validate the settings against.

Condition: You cannot specify both this and an environment name.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: No

Response Elements

The following element is returned by the service.

Messages.member.N

A list of ValidationMessage.

Type: Array of ValidationMessage objects

Errors

For information about the errors that are common to all actions, see Common Errors.

InsufficientPrivileges

The specified account does not have sufficient privileges for one or more AWS services.

HTTP Status Code: 403

TooManyBuckets

The specified account has reached its limit of Amazon S3 buckets.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of ValidateConfigurationSettings.

Sample Request

https://elasticbeanstalk.us-west-2.amazonaws.com/?ApplicationName=SampleApp &EnvironmentName=SampleAppVersion &OptionSettings.member.1.Namespace=aws%3Aautoscaling%3Atrigger &OptionSettings.member.1.OptionName=LowerThreshold &OptionSettings.member.1.Value=1000000 &Operation=ValidateConfigurationSettings &AuthParams

Sample Response

<ValidateConfigurationSettingsResponse xmlns="https://elasticbeanstalk.amazonaws.com/docs/2010-12-01/"> <ValidateConfigurationSettingsResult> <Messages/> </ValidateConfigurationSettingsResult> <ResponseMetadata> <RequestId>06f1cfff-f28f-11df-8a78-9f77047e0d0c</RequestId> </ResponseMetadata> </ValidateConfigurationSettingsResponse>

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: