NAME WebService::Amazon::ElasticBeanstalk - Basic interface to Amazon ElasticBeanstalk VERSION Version 0.0.1 SYNOPSIS This module provides a Perl wrapper around Amazon's ( http://aws.amazon.com ) ElasticBeanstalk API. You will need to be an AWS customer with an ID and Secret with access to Elastic Beanstalk. Note: Some parameter validation is purposely lax. The API will generally fail when invalid params are passed. The errors may not be helpful. INTERFACE new Inherited from WebService::Simple, and takes all the same arguments. You must provide the Amazon required arguments of id, and secret in the param hash: my $ebn = WebService::Amazon::ElasticBeanstalk->new( param => { id => $AWS_ACCESS_KEY_ID, region => 'us-east-1', secret => $AWS_ACCESS_KEY_SECRET } ); Parameters id (required) You can find more information in the AWS docs: http://docs.aws.amazon.com/elasticbeanstalk/latest/APIReference/Comm onParameters.html region *(optional)* - defaults to us-east-1 You can find available regions at: http://docs.aws.amazon.com/general/latest/gr/rande.html#elasticbeans talk_region secret (required) You can find more information in the AWS docs: http://docs.aws.amazon.com/elasticbeanstalk/latest/APIReference/Comm onParameters.html CheckDNSAvailability( CNAMEPrefix => 'the-thing-to-check' ) Returns a list of the available solution stack names. Refer to http://docs.aws.amazon.com/elasticbeanstalk/latest/APIReference/API_Chec kDNSAvailability.html Parameters CNAMEPrefix (required scalar) The prefix used when this CNAME is reserved. Returns: XML result from API DescribeApplicationVersions( ) Returns a list of the available solution stack names. Refer to http://docs.aws.amazon.com/elasticbeanstalk/latest/APIReference/API_Desc ribeApplicationVersions.html Parameters ApplicationName *(optional scalar)* If specified, AWS Elastic Beanstalk restricts the returned descriptions to only include ones that are associated with the specified application. VersionLabels *(optional array)* If specified, AWS Elastic Beanstalk restricts the returned versions to only include those with the specified names. Returns: XML result from API DescribeApplications( ) Returns a list of the available solution stack names. Refer to http://docs.aws.amazon.com/elasticbeanstalk/latest/APIReference/API_Desc ribeApplications.html Parameters ApplicationNames *(optional array)* If specified, AWS Elastic Beanstalk restricts the returned descriptions to only include those with the specified names. Returns: XML result from API DescribeConfigurationOptions( ) Returns a list of the available solution stack names. Refer to http://docs.aws.amazon.com/elasticbeanstalk/latest/APIReference/API_Desc ribeConfigurationOptions.html Parameters ApplicationName *(optional string)* 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 *(optional string)* The name of the environment whose configuration options you want to describe. Options *(optional array)* If specified, restricts the descriptions to only the specified options. SolutionStackName *(optional string)* The name of the solution stack whose configuration options you want to describe. TemplateName *(optional string)* The name of the configuration template whose configuration options you want to describe. Returns: XML result from API DescribeConfigurationSettings( ) Returns a list of the available solution stack names. Refer to http://docs.aws.amazon.com/elasticbeanstalk/latest/APIReference/API_Desc ribeConfigurationSettings.html Parameters ApplicationName (required string) The application for the environment or configuration template. EnvironmentName I(optional string) 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. TemplateName I(optional string) 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. Returns: XML result from API DescribeEnvironmentResources( ) Returns a list of the available solution stack names. Refer to http://docs.aws.amazon.com/elasticbeanstalk/latest/APIReference/API_Desc ribeApplications.html Parameters ApplicationNames *(optional array)* If specified, AWS Elastic Beanstalk restricts the returned descriptions to only include those with the specified names. Returns: XML result from API DescribeEnvironments( ) Returns a list of the available solution stack names. Refer to http://docs.aws.amazon.com/elasticbeanstalk/latest/APIReference/API_Desc ribeEnvironments.html Parameters ApplicationName *(optional string)* If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application. EnvironmentIds *(optional array)* If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs. EnvironmentNames *(optional array)* If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names. IncludeDeleted *(optional boolean)* Indicates whether to include deleted environments: true: Environments that have been deleted after IncludedDeletedBackTo are displayed. false: Do not include deleted environments. IncludedDeletedBackTo *(optional date)* If specified when IncludeDeleted is set to true, then environments deleted after this date are displayed. VersionLabel *(optional string)* If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version. Returns: XML result from API DescribeEvents( ) Returns list of event descriptions matching criteria up to the last 6 weeks. Refer to http://docs.aws.amazon.com/elasticbeanstalk/latest/APIReference/API_Desc ribeEvents.html Parameters ApplicationNames *(optional array)* If specified, AWS Elastic Beanstalk restricts the returned descriptions to only include those with the specified names. Returns: XML result from API ListAvailableSolutionStacks( ) Returns a list of the available solution stack names. Refer to http://docs.aws.amazon.com/elasticbeanstalk/latest/APIReference/API_List AvailableSolutionStacks.html Parameters none Returns: XML result from API RetrieveEnvironmentInfo( ) Retrieves the compiled information from a RequestEnvironmentInfo request. Refer to http://docs.aws.amazon.com/elasticbeanstalk/latest/APIReference/API_Retr ieveEnvironmentInfo.html Parameters EnvironmentId *(optional string)* 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. EnvironmentName *(optional string)* 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. Type: String Length constraints: Minimum length of 4. Maximum length of 23. Required: No InfoType (required string) The type of information to retrieve. Type: String Valid Values: tail Required: Yes Returns: XML result from API 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. Refer to http://docs.aws.amazon.com/elasticbeanstalk/latest/APIReference/API_Vali dateConfigurationSettings.html Parameters ApplicationName (required string) The name of the application that the configuration template or environment belongs to. EnvironmentName *(optional string)* The name of the environment to validate the settings against. Condition: You cannot specify both this and a configuration template name. OptionSettings *(required array)* A list of the options and desired values to evaluate. TemplateName *(optional string)* The name of the configuration template to validate the settings against. Condition: You cannot specify both this and an environment name. Returns: XML result from API AUTHOR Matthew Cox `' BUGS Please report any bugs or feature requests to `bug-webservice-amazon-elasticbeanstalk at rt.cpan.org', or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=WebService-Amazon-Elastic Beanstalk. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes. SUPPORT You can find documentation for this module with the perldoc command. perldoc WebService::Amazon::ElasticBeanstalk You can also look for information at: * RT: CPAN's request tracker (report bugs here) http://rt.cpan.org/NoAuth/Bugs.html?Dist=WebService-Amazon-ElasticBe anstalk * AnnoCPAN: Annotated CPAN documentation http://annocpan.org/dist/WebService-Amazon-ElasticBeanstalk * CPAN Ratings http://cpanratings.perl.org/d/WebService-Amazon-ElasticBeanstalk * Search CPAN http://search.cpan.org/dist/WebService-Amazon-ElasticBeanstalk/ SEE ALSO perl(1), WebService::Simple, XML::Simple, HTTP::Common::Response LICENSE AND COPYRIGHT Copyright 2015 Matthew Cox. This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at: http://www.perlfoundation.org/artistic_license_2_0 Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license. If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license. This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder. This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed. Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.