ElasticBeanstalkClient Class

Member Function Documentation

ElasticBeanstalkClient::ElasticBeanstalkClient(const QtAws::Core::AwsRegion::Region region = QtAws::Core::AwsRegion::InvalidRegion, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

Constructs a ElasticBeanstalkClient object.

The new client object will region, credentials, and manager for network operations.

The new object will be owned by parent, if set.

ElasticBeanstalkClient::ElasticBeanstalkClient(const QUrl &endpoint, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

This function overloads ElasticBeanstalkClient().

This overload allows the caller to specify the specific endpoint to send requests to. Typically, it is easier to use the alternative constructor, which allows the caller to specify an AWS region instead, in which case this client will determine the correct endpoint for the given region automatically (via AwsEndpoint::getEndpoint).

See also QtAws::Core::AwsEndpoint::getEndpoint.

[slot] AbortEnvironmentUpdateResponse *ElasticBeanstalkClient::abortEnvironmentUpdate(const AbortEnvironmentUpdateRequest &request)

Sends request to the ElasticBeanstalkClient service, and returns a pointer to an AbortEnvironmentUpdateResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Cancels in-progress environment configuration update or application version

[slot] ApplyEnvironmentManagedActionResponse *ElasticBeanstalkClient::applyEnvironmentManagedAction(const ApplyEnvironmentManagedActionRequest &request)

Sends request to the ElasticBeanstalkClient service, and returns a pointer to an ApplyEnvironmentManagedActionResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Applies a scheduled managed action immediately. A managed action can be applied only if its status is <code>Scheduled</code>. Get the status and action ID of a managed action with

[slot] CheckDNSAvailabilityResponse *ElasticBeanstalkClient::checkDNSAvailability(const CheckDNSAvailabilityRequest &request)

Sends request to the ElasticBeanstalkClient service, and returns a pointer to an CheckDNSAvailabilityResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Checks if the specified CNAME is

[slot] ComposeEnvironmentsResponse *ElasticBeanstalkClient::composeEnvironments(const ComposeEnvironmentsRequest &request)

Sends request to the ElasticBeanstalkClient service, and returns a pointer to an ComposeEnvironmentsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 <code>env.yaml</code>. See <a href="http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/environment-mgmt-compose.html">Compose Environments</a> for

[slot] CreateApplicationResponse *ElasticBeanstalkClient::createApplication(const CreateApplicationRequest &request)

Sends request to the ElasticBeanstalkClient service, and returns a pointer to an CreateApplicationResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates an application that has one configuration template named <code>default</code> and no application versions.

[slot] CreateApplicationVersionResponse *ElasticBeanstalkClient::createApplicationVersion(const CreateApplicationVersionRequest &request)

Sends request to the ElasticBeanstalkClient service, and returns a pointer to an CreateApplicationVersionResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

<code>SourceBuildInformation</code>>

Specify a build in an AWS CodeBuild with <code>SourceBuildInformation</code> and

<code>BuildConfiguration</code>>

Specify a source bundle in S3 with <code>SourceBundle</code>

</p

Omit both <code>SourceBuildInformation</code> and <code>SourceBundle</code> to use the default sample

application> <note>

Once you create an application version with a specified Amazon S3 bucket and key location, you cannot change that Amazon S3 location. If you change the Amazon S3 location, you receive an exception when you attempt to launch an environment from the application

[slot] CreateConfigurationTemplateResponse *ElasticBeanstalkClient::createConfigurationTemplate(const CreateConfigurationTemplateRequest &request)

Sends request to the ElasticBeanstalkClient service, and returns a pointer to an CreateConfigurationTemplateResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates a configuration template. Templates are associated with a specific application and are used to deploy different versions of the application with the same configuration

settings>

Related

Topic> <ul> <li>

<a>DescribeConfigurationOptions</a>

</p </li> <li>

<a>DescribeConfigurationSettings</a>

</p </li> <li>

<a>ListAvailableSolutionStacks</a>

[slot] CreateEnvironmentResponse *ElasticBeanstalkClient::createEnvironment(const CreateEnvironmentRequest &request)

Sends request to the ElasticBeanstalkClient service, and returns a pointer to an CreateEnvironmentResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Launches an environment for the specified application using the specified

[slot] CreatePlatformVersionResponse *ElasticBeanstalkClient::createPlatformVersion(const CreatePlatformVersionRequest &request)

Sends request to the ElasticBeanstalkClient service, and returns a pointer to an CreatePlatformVersionResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Create a new version of your custom

[slot] CreateStorageLocationResponse *ElasticBeanstalkClient::createStorageLocation()

Sends a CreateStorageLocation request to the ElasticBeanstalkClient service, and returns a pointer to an CreateStorageLocationResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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, <code>CreateStorageLocation</code> still returns the bucket name but does not create a new

[slot] DeleteApplicationResponse *ElasticBeanstalkClient::deleteApplication(const DeleteApplicationRequest &request)

Sends request to the ElasticBeanstalkClient service, and returns a pointer to an DeleteApplicationResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes the specified application along with all associated versions and configurations. The application versions will not be deleted from your Amazon S3

bucket> <note>

You cannot delete an application that has a running

[slot] DeleteApplicationVersionResponse *ElasticBeanstalkClient::deleteApplicationVersion(const DeleteApplicationVersionRequest &request)

Sends request to the ElasticBeanstalkClient service, and returns a pointer to an DeleteApplicationVersionResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes the specified version from the specified

application> <note>

You cannot delete an application version that is associated with a running

[slot] DeleteConfigurationTemplateResponse *ElasticBeanstalkClient::deleteConfigurationTemplate(const DeleteConfigurationTemplateRequest &request)

Sends request to the ElasticBeanstalkClient service, and returns a pointer to an DeleteConfigurationTemplateResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes the specified configuration

template> <note>

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

[slot] DeleteEnvironmentConfigurationResponse *ElasticBeanstalkClient::deleteEnvironmentConfiguration(const DeleteEnvironmentConfigurationRequest &request)

Sends request to the ElasticBeanstalkClient service, and returns a pointer to an DeleteEnvironmentConfigurationResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 <a>DescribeConfigurationSettings</a> while the update is in progress or if the update fails. The <code>DeploymentStatus</code> 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

[slot] DeletePlatformVersionResponse *ElasticBeanstalkClient::deletePlatformVersion(const DeletePlatformVersionRequest &request)

Sends request to the ElasticBeanstalkClient service, and returns a pointer to an DeletePlatformVersionResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes the specified version of a custom

[slot] DescribeAccountAttributesResponse *ElasticBeanstalkClient::describeAccountAttributes()

Sends a DescribeAccountAttributes request to the ElasticBeanstalkClient service, and returns a pointer to an DescribeAccountAttributesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns attributes related to AWS Elastic Beanstalk that are associated with the calling AWS

account>

The result currently has one set of attributes—resource

[slot] DescribeApplicationVersionsResponse *ElasticBeanstalkClient::describeApplicationVersions(const DescribeApplicationVersionsRequest &request)

Sends request to the ElasticBeanstalkClient service, and returns a pointer to an DescribeApplicationVersionsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Retrieve a list of application

[slot] DescribeApplicationsResponse *ElasticBeanstalkClient::describeApplications(const DescribeApplicationsRequest &request)

Sends request to the ElasticBeanstalkClient service, and returns a pointer to an DescribeApplicationsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns the descriptions of existing

[slot] DescribeConfigurationOptionsResponse *ElasticBeanstalkClient::describeConfigurationOptions(const DescribeConfigurationOptionsRequest &request)

Sends request to the ElasticBeanstalkClient service, and returns a pointer to an DescribeConfigurationOptionsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] DescribeConfigurationSettingsResponse *ElasticBeanstalkClient::describeConfigurationSettings(const DescribeConfigurationSettingsRequest &request)

Sends request to the ElasticBeanstalkClient service, and returns a pointer to an DescribeConfigurationSettingsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

Topic> <ul> <li>

<a>DeleteEnvironmentConfiguration</a>

[slot] DescribeEnvironmentHealthResponse *ElasticBeanstalkClient::describeEnvironmentHealth(const DescribeEnvironmentHealthRequest &request)

Sends request to the ElasticBeanstalkClient service, and returns a pointer to an DescribeEnvironmentHealthResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns information about the overall health of the specified environment. The <b>DescribeEnvironmentHealth</b> operation is only available with AWS Elastic Beanstalk Enhanced

[slot] DescribeEnvironmentManagedActionHistoryResponse *ElasticBeanstalkClient::describeEnvironmentManagedActionHistory(const DescribeEnvironmentManagedActionHistoryRequest &request)

Sends request to the ElasticBeanstalkClient service, and returns a pointer to an DescribeEnvironmentManagedActionHistoryResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Lists an environment's completed and failed managed

[slot] DescribeEnvironmentManagedActionsResponse *ElasticBeanstalkClient::describeEnvironmentManagedActions(const DescribeEnvironmentManagedActionsRequest &request)

Sends request to the ElasticBeanstalkClient service, and returns a pointer to an DescribeEnvironmentManagedActionsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Lists an environment's upcoming and in-progress managed

[slot] DescribeEnvironmentResourcesResponse *ElasticBeanstalkClient::describeEnvironmentResources(const DescribeEnvironmentResourcesRequest &request)

Sends request to the ElasticBeanstalkClient service, and returns a pointer to an DescribeEnvironmentResourcesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns AWS resources for this

[slot] DescribeEnvironmentsResponse *ElasticBeanstalkClient::describeEnvironments(const DescribeEnvironmentsRequest &request)

Sends request to the ElasticBeanstalkClient service, and returns a pointer to an DescribeEnvironmentsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns descriptions for existing

[slot] DescribeEventsResponse *ElasticBeanstalkClient::describeEvents(const DescribeEventsRequest &request)

Sends request to the ElasticBeanstalkClient service, and returns a pointer to an DescribeEventsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns list of event descriptions matching criteria up to the last 6

weeks> <note>

This action returns the most recent 1,000 events from the specified

[slot] DescribeInstancesHealthResponse *ElasticBeanstalkClient::describeInstancesHealth(const DescribeInstancesHealthRequest &request)

Sends request to the ElasticBeanstalkClient service, and returns a pointer to an DescribeInstancesHealthResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Retrives detailed information about the health of instances in your AWS Elastic Beanstalk. This operation requires <a href="http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced.html">enhanced health

[slot] DescribePlatformVersionResponse *ElasticBeanstalkClient::describePlatformVersion(const DescribePlatformVersionRequest &request)

Sends request to the ElasticBeanstalkClient service, and returns a pointer to an DescribePlatformVersionResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Describes the version of the

[slot] ListAvailableSolutionStacksResponse *ElasticBeanstalkClient::listAvailableSolutionStacks()

Sends a ListAvailableSolutionStacks request to the ElasticBeanstalkClient service, and returns a pointer to an ListAvailableSolutionStacksResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns a list of the available solution stack names, with the public version first and then in reverse chronological

[slot] ListPlatformVersionsResponse *ElasticBeanstalkClient::listPlatformVersions(const ListPlatformVersionsRequest &request)

Sends request to the ElasticBeanstalkClient service, and returns a pointer to an ListPlatformVersionsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Lists the available

[slot] ListTagsForResourceResponse *ElasticBeanstalkClient::listTagsForResource(const ListTagsForResourceRequest &request)

Sends request to the ElasticBeanstalkClient service, and returns a pointer to an ListTagsForResourceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns the tags applied to an AWS Elastic Beanstalk resource. The response contains a list of tag key-value

pairs>

Currently, Elastic Beanstalk only supports tagging of Elastic Beanstalk environments. For details about environment tagging, see <a href="http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/using-features.tagging.html">Tagging Resources in Your Elastic Beanstalk

[slot] RebuildEnvironmentResponse *ElasticBeanstalkClient::rebuildEnvironment(const RebuildEnvironmentRequest &request)

Sends request to the ElasticBeanstalkClient service, and returns a pointer to an RebuildEnvironmentResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes and recreates all of the AWS resources (for example: the Auto Scaling group, load balancer, etc.) for a specified environment and forces a

[slot] RequestEnvironmentInfoResponse *ElasticBeanstalkClient::requestEnvironmentInfo(const RequestEnvironmentInfoRequest &request)

Sends request to the ElasticBeanstalkClient service, and returns a pointer to an RequestEnvironmentInfoResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Initiates a request to compile the specified type of information of the deployed

environment>

Setting the <code>InfoType</code> to <code>tail</code> compiles the last lines from the application server log files of every Amazon EC2 instance in your environment.

</p

Setting the <code>InfoType</code> to <code>bundle</code> compresses the application server log files for every Amazon EC2 instance into a <code>.zip</code> file. Legacy and .NET containers do not support bundle logs.

</p

Use <a>RetrieveEnvironmentInfo</a> to obtain the set of logs.

</p

Related

Topic> <ul> <li>

<a>RetrieveEnvironmentInfo</a>

[slot] RestartAppServerResponse *ElasticBeanstalkClient::restartAppServer(const RestartAppServerRequest &request)

Sends request to the ElasticBeanstalkClient service, and returns a pointer to an RestartAppServerResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Causes the environment to restart the application container server running on each Amazon EC2

[slot] RetrieveEnvironmentInfoResponse *ElasticBeanstalkClient::retrieveEnvironmentInfo(const RetrieveEnvironmentInfoRequest &request)

Sends request to the ElasticBeanstalkClient service, and returns a pointer to an RetrieveEnvironmentInfoResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Retrieves the compiled information from a <a>RequestEnvironmentInfo</a>

request>

Related

Topic> <ul> <li>

<a>RequestEnvironmentInfo</a>

[slot] SwapEnvironmentCNAMEsResponse *ElasticBeanstalkClient::swapEnvironmentCNAMEs(const SwapEnvironmentCNAMEsRequest &request)

Sends request to the ElasticBeanstalkClient service, and returns a pointer to an SwapEnvironmentCNAMEsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Swaps the CNAMEs of two

[slot] TerminateEnvironmentResponse *ElasticBeanstalkClient::terminateEnvironment(const TerminateEnvironmentRequest &request)

Sends request to the ElasticBeanstalkClient service, and returns a pointer to an TerminateEnvironmentResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Terminates the specified

[slot] UpdateApplicationResponse *ElasticBeanstalkClient::updateApplication(const UpdateApplicationRequest &request)

Sends request to the ElasticBeanstalkClient service, and returns a pointer to an UpdateApplicationResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Updates the specified application to have the specified

properties> <note>

If a property (for example, <code>description</code>) is not provided, the value remains unchanged. To clear these properties, specify an empty

[slot] UpdateApplicationResourceLifecycleResponse *ElasticBeanstalkClient::updateApplicationResourceLifecycle(const UpdateApplicationResourceLifecycleRequest &request)

Sends request to the ElasticBeanstalkClient service, and returns a pointer to an UpdateApplicationResourceLifecycleResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Modifies lifecycle settings for an

[slot] UpdateApplicationVersionResponse *ElasticBeanstalkClient::updateApplicationVersion(const UpdateApplicationVersionRequest &request)

Sends request to the ElasticBeanstalkClient service, and returns a pointer to an UpdateApplicationVersionResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Updates the specified application version to have the specified

properties> <note>

If a property (for example, <code>description</code>) is not provided, the value remains unchanged. To clear properties, specify an empty

[slot] UpdateConfigurationTemplateResponse *ElasticBeanstalkClient::updateConfigurationTemplate(const UpdateConfigurationTemplateRequest &request)

Sends request to the ElasticBeanstalkClient service, and returns a pointer to an UpdateConfigurationTemplateResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Updates the specified configuration template to have the specified properties or configuration option

values> <note>

If a property (for example, <code>ApplicationName</code>) is not provided, its value remains unchanged. To clear such properties, specify an empty

string> </note>

Related

Topic> <ul> <li>

<a>DescribeConfigurationOptions</a>

[slot] UpdateEnvironmentResponse *ElasticBeanstalkClient::updateEnvironment(const UpdateEnvironmentRequest &request)

Sends request to the ElasticBeanstalkClient service, and returns a pointer to an UpdateEnvironmentResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 <code>InvalidParameterCombination</code> error.

</p

When updating the configuration settings to a new template or individual settings, a draft configuration is created and <a>DescribeConfigurationSettings</a> for this environment returns two setting descriptions with different <code>DeploymentStatus</code> values.

[slot] UpdateTagsForResourceResponse *ElasticBeanstalkClient::updateTagsForResource(const UpdateTagsForResourceRequest &request)

Sends request to the ElasticBeanstalkClient service, and returns a pointer to an UpdateTagsForResourceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Update the list of tags applied to an AWS Elastic Beanstalk resource. Two lists can be passed: <code>TagsToAdd</code> for tags to add or update, and

<code>TagsToRemove</code>>

Currently, Elastic Beanstalk only supports tagging of Elastic Beanstalk environments. For details about environment tagging, see <a href="http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/using-features.tagging.html">Tagging Resources in Your Elastic Beanstalk

Environment</a>>

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> <dl> <dt>elasticbeanstalk:AddTags</dt> <dd>

Controls permission to call <code>UpdateTagsForResource</code> and pass a list of tags to add in the <code>TagsToAdd</code>

parameter> </dd> <dt>elasticbeanstalk:RemoveTags</dt> <dd>

Controls permission to call <code>UpdateTagsForResource</code> and pass a list of tag keys to remove in the <code>TagsToRemove</code>

parameter> </dd> </dl>

For details about creating a custom user policy, see <a href="http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/AWSHowTo.iam.managed-policies.html#AWSHowTo.iam.policies">Creating a Custom User

[slot] ValidateConfigurationSettingsResponse *ElasticBeanstalkClient::validateConfigurationSettings(const ValidateConfigurationSettingsRequest &request)

Sends request to the ElasticBeanstalkClient service, and returns a pointer to an ValidateConfigurationSettingsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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