AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Classes

NameDescription
Class AbortEnvironmentUpdateRequest

Container for the parameters to the AbortEnvironmentUpdate operation. Cancels in-progress environment configuration update or application version deployment.

Class AbortEnvironmentUpdateResponse

This is the response object from the AbortEnvironmentUpdate operation.

Class ApplicationDescription

Describes the properties of an application.

Class ApplicationMetrics

Application request metrics for an AWS Elastic Beanstalk environment.

Class ApplicationResourceLifecycleConfig

The resource lifecycle configuration for an application. Defines lifecycle settings for resources that belong to the application, and the service role that Elastic Beanstalk assumes in order to apply lifecycle settings. The version lifecycle configuration defines lifecycle settings for application versions.

Class ApplicationVersionDescription

Describes the properties of an application version.

Class ApplicationVersionLifecycleConfig

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.

Class ApplyEnvironmentManagedActionRequest

Container for the parameters to the ApplyEnvironmentManagedAction operation. 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.

Class ApplyEnvironmentManagedActionResponse

The result message containing information about the managed action.

Class AutoScalingGroup

Describes an Auto Scaling launch configuration.

Class BuildConfiguration

Settings for an AWS CodeBuild build.

Class Builder

The builder used to build the custom platform.

Class CheckDNSAvailabilityRequest

Container for the parameters to the CheckDNSAvailability operation. Checks if the specified CNAME is available.

Class CheckDNSAvailabilityResponse

Indicates if the specified CNAME is available.

Class CodeBuildNotInServiceRegionException

ElasticBeanstalk exception

Class ComposeEnvironmentsRequest

Container for the parameters to the ComposeEnvironments operation. 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.

Class ComposeEnvironmentsResponse

Result message containing a list of environment descriptions.

Class ConfigurationOptionDescription

Describes the possible values for a configuration option.

Class ConfigurationOptionSetting

A specification identifying an individual configuration option along with its current value. For a list of possible option values, go to Option Values in the AWS Elastic Beanstalk Developer Guide.

Class ConfigurationSettingsDescription

Describes the settings for a configuration set.

Class CPUUtilization

CPU utilization metrics for an instance.

Class CreateApplicationRequest

Container for the parameters to the CreateApplication operation. Creates an application that has one configuration template named default and no application versions.

Class CreateApplicationResponse

Result message containing a single description of an application.

Class CreateApplicationVersionRequest

Container for the parameters to the CreateApplicationVersion operation. 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.

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 version.

Class CreateApplicationVersionResponse

Result message wrapping a single description of an application version.

Class CreateConfigurationTemplateRequest

Container for the parameters to the CreateConfigurationTemplate operation. 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 Topics

Class CreateConfigurationTemplateResponse

Describes the settings for a configuration set.

Class CreateEnvironmentRequest

Container for the parameters to the CreateEnvironment operation. Launches an environment for the specified application using the specified configuration.

Class CreateEnvironmentResponse

Describes the properties of an environment.

Class CreatePlatformVersionRequest

Container for the parameters to the CreatePlatformVersion operation. Create a new version of your custom platform.

Class CreatePlatformVersionResponse

This is the response object from the CreatePlatformVersion operation.

Class CreateStorageLocationRequest

Container for the parameters to the CreateStorageLocation operation. Creates the Amazon S3 storage location for the account.

This location is used to store user log files.

Class CreateStorageLocationResponse

Results of a CreateStorageLocationResult call.

Class CustomAmi

A custom AMI available to platforms.

Class DeleteApplicationRequest

Container for the parameters to the DeleteApplication operation. 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.

Class DeleteApplicationResponse

This is the response object from the DeleteApplication operation.

Class DeleteApplicationVersionRequest

Container for the parameters to the DeleteApplicationVersion operation. Deletes the specified version from the specified application.

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

Class DeleteApplicationVersionResponse

This is the response object from the DeleteApplicationVersion operation.

Class DeleteConfigurationTemplateRequest

Container for the parameters to the DeleteConfigurationTemplate operation. 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.

Class DeleteConfigurationTemplateResponse

This is the response object from the DeleteConfigurationTemplate operation.

Class DeleteEnvironmentConfigurationRequest

Container for the parameters to the DeleteEnvironmentConfiguration operation. 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.

Class DeleteEnvironmentConfigurationResponse

This is the response object from the DeleteEnvironmentConfiguration operation.

Class DeletePlatformVersionRequest

Container for the parameters to the DeletePlatformVersion operation. Deletes the specified version of a custom platform.

Class DeletePlatformVersionResponse

This is the response object from the DeletePlatformVersion operation.

Class Deployment

Information about an application version deployment.

Class DescribeApplicationsRequest

Container for the parameters to the DescribeApplications operation. Returns the descriptions of existing applications.

Class DescribeApplicationsResponse

Result message containing a list of application descriptions.

Class DescribeApplicationVersionsRequest

Container for the parameters to the DescribeApplicationVersions operation. Retrieve a list of application versions.

Class DescribeApplicationVersionsResponse

Result message wrapping a list of application version descriptions.

Class DescribeConfigurationOptionsRequest

Container for the parameters to the DescribeConfigurationOptions operation. 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.

Class DescribeConfigurationOptionsResponse

Describes the settings for a specified configuration set.

Class DescribeConfigurationSettingsRequest

Container for the parameters to the DescribeConfigurationSettings operation. 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

Class DescribeConfigurationSettingsResponse

The results from a request to change the configuration settings of an environment.

Class DescribeEnvironmentHealthRequest

Container for the parameters to the DescribeEnvironmentHealth operation. Returns information about the overall health of the specified environment. The DescribeEnvironmentHealth operation is only available with AWS Elastic Beanstalk Enhanced Health.

Class DescribeEnvironmentHealthResponse

Health details for an AWS Elastic Beanstalk environment.

Class DescribeEnvironmentManagedActionHistoryRequest

Container for the parameters to the DescribeEnvironmentManagedActionHistory operation. Lists an environment's completed and failed managed actions.

Class DescribeEnvironmentManagedActionHistoryResponse

A result message containing a list of completed and failed managed actions.

Class DescribeEnvironmentManagedActionsRequest

Container for the parameters to the DescribeEnvironmentManagedActions operation. Lists an environment's upcoming and in-progress managed actions.

Class DescribeEnvironmentManagedActionsResponse

The result message containing a list of managed actions.

Class DescribeEnvironmentResourcesRequest

Container for the parameters to the DescribeEnvironmentResources operation. Returns AWS resources for this environment.

Class DescribeEnvironmentResourcesResponse

Result message containing a list of environment resource descriptions.

Class DescribeEnvironmentsRequest

Container for the parameters to the DescribeEnvironments operation. Returns descriptions for existing environments.

Class DescribeEnvironmentsResponse

Result message containing a list of environment descriptions.

Class DescribeEventsRequest

Container for the parameters to the DescribeEvents operation. 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.

Class DescribeEventsResponse

Result message wrapping a list of event descriptions.

Class DescribeInstancesHealthRequest

Container for the parameters to the DescribeInstancesHealth operation. Retrives detailed information about the health of instances in your AWS Elastic Beanstalk. This operation requires enhanced health reporting.

Class DescribeInstancesHealthResponse

Detailed health information about the Amazon EC2 instances in an AWS Elastic Beanstalk environment.

Class DescribePlatformVersionRequest

Container for the parameters to the DescribePlatformVersion operation. Describes the version of the platform.

Class DescribePlatformVersionResponse

This is the response object from the DescribePlatformVersion operation.

Class ElasticBeanstalkServiceException

ElasticBeanstalk exception

Class EnvironmentDescription

Describes the properties of an environment.

Class EnvironmentInfoDescription

The information retrieved from the Amazon EC2 instances.

Class EnvironmentLink

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.

Class EnvironmentResourceDescription

Describes the AWS resources in use by this environment. This data is live.

Class EnvironmentResourcesDescription

Describes the AWS resources in use by this environment. This data is not live data.

Class EnvironmentTier

Describes the properties of an environment tier

Class EventDescription

Describes an event.

Class Instance

The description of an Amazon EC2 instance.

Class InstanceHealthSummary

Represents summary information about the health of an instance. For more information, see Health Colors and Statuses.

Class InsufficientPrivilegesException

ElasticBeanstalk exception

Class InvalidRequestException

ElasticBeanstalk exception

Class Latency

Represents the average latency for the slowest X percent of requests over the last 10 seconds.

Class LaunchConfiguration

Describes an Auto Scaling launch configuration.

Class ListAvailableSolutionStacksRequest

Container for the parameters to the ListAvailableSolutionStacks operation. Returns a list of the available solution stack names, with the public version first and then in reverse chronological order.

Class ListAvailableSolutionStacksResponse

A list of available AWS Elastic Beanstalk solution stacks.

Class Listener

Describes the properties of a Listener for the LoadBalancer.

Class ListPlatformVersionsRequest

Container for the parameters to the ListPlatformVersions operation. Lists the available platforms.

Class ListPlatformVersionsResponse

This is the response object from the ListPlatformVersions operation.

Class LoadBalancer

Describes a LoadBalancer.

Class LoadBalancerDescription

Describes the details of a LoadBalancer.

Class ManagedAction

The record of an upcoming or in-progress managed action.

Class ManagedActionHistoryItem

The record of a completed or failed managed action.

Class ManagedActionInvalidStateException

ElasticBeanstalk exception

Class MaxAgeRule

A lifecycle rule that deletes application versions after the specified number of days.

Class MaxCountRule

A lifecycle rule that deletes the oldest application version when the maximum count is exceeded.

Class OperationInProgressException

ElasticBeanstalk exception

Class OptionRestrictionRegex

A regular expression representing a restriction on a string configuration option value.

Class OptionSpecification

A specification identifying an individual configuration option.

Class PlatformDescription

Detailed information about a platform.

Class PlatformFilter

Specify criteria to restrict the results when listing custom platforms.

The filter is evaluated as the expression:

TypeOperatorValues[i]

Class PlatformFramework

A framework supported by the custom platform.

Class PlatformProgrammingLanguage

A programming language supported by the platform.

Class PlatformSummary

Detailed information about a platform.

Class PlatformVersionStillReferencedException

ElasticBeanstalk exception

Class Queue

Describes a queue.

Class RebuildEnvironmentRequest

Container for the parameters to the RebuildEnvironment operation. 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.

Class RebuildEnvironmentResponse

This is the response object from the RebuildEnvironment operation.

Class RequestEnvironmentInfoRequest

Container for the parameters to the RequestEnvironmentInfo operation. 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

Class RequestEnvironmentInfoResponse

This is the response object from the RequestEnvironmentInfo operation.

Class RestartAppServerRequest

Container for the parameters to the RestartAppServer operation. Causes the environment to restart the application container server running on each Amazon EC2 instance.

Class RestartAppServerResponse

This is the response object from the RestartAppServer operation.

Class RetrieveEnvironmentInfoRequest

Container for the parameters to the RetrieveEnvironmentInfo operation. Retrieves the compiled information from a RequestEnvironmentInfo request.

Related Topics

Class RetrieveEnvironmentInfoResponse

Result message containing a description of the requested environment info.

Class S3Location

The bucket and key of an item stored in Amazon S3.

Class S3LocationNotInServiceRegionException

ElasticBeanstalk exception

Class S3SubscriptionRequiredException

ElasticBeanstalk exception

Class SingleInstanceHealth

Detailed health information about an Amazon EC2 instance in your Elastic Beanstalk environment.

Class SolutionStackDescription

Describes the solution stack.

Class SourceBuildInformation

Location of the source code for an application version.

Class SourceBundleDeletionException

ElasticBeanstalk exception

Class SourceConfiguration

A specification for an environment configuration

Class StatusCodes

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.

Class SwapEnvironmentCNAMEsRequest

Container for the parameters to the SwapEnvironmentCNAMEs operation. Swaps the CNAMEs of two environments.

Class SwapEnvironmentCNAMEsResponse

This is the response object from the SwapEnvironmentCNAMEs operation.

Class SystemStatus

CPU utilization and load average metrics for an Amazon EC2 instance.

Class Tag

Describes a tag applied to a resource in an environment.

Class TerminateEnvironmentRequest

Container for the parameters to the TerminateEnvironment operation. Terminates the specified environment.

Class TerminateEnvironmentResponse

Describes the properties of an environment.

Class TooManyApplicationsException

ElasticBeanstalk exception

Class TooManyApplicationVersionsException

ElasticBeanstalk exception

Class TooManyBucketsException

ElasticBeanstalk exception

Class TooManyConfigurationTemplatesException

ElasticBeanstalk exception

Class TooManyEnvironmentsException

ElasticBeanstalk exception

Class TooManyPlatformsException

ElasticBeanstalk exception

Class Trigger

Describes a trigger.

Class UpdateApplicationRequest

Container for the parameters to the UpdateApplication operation. 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.

Class UpdateApplicationResourceLifecycleRequest

Container for the parameters to the UpdateApplicationResourceLifecycle operation. Modifies lifecycle settings for an application.

Class UpdateApplicationResourceLifecycleResponse

This is the response object from the UpdateApplicationResourceLifecycle operation.

Class UpdateApplicationResponse

Result message containing a single description of an application.

Class UpdateApplicationVersionRequest

Container for the parameters to the UpdateApplicationVersion operation. 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.

Class UpdateApplicationVersionResponse

Result message wrapping a single description of an application version.

Class UpdateConfigurationTemplateRequest

Container for the parameters to the UpdateConfigurationTemplate operation. 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

Class UpdateConfigurationTemplateResponse

Describes the settings for a configuration set.

Class UpdateEnvironmentRequest

Container for the parameters to the UpdateEnvironment operation. 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.

Class UpdateEnvironmentResponse

Describes the properties of an environment.

Class ValidateConfigurationSettingsRequest

Container for the parameters to the ValidateConfigurationSettings operation. 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.

Class ValidateConfigurationSettingsResponse

Provides a list of validation messages.

Class ValidationMessage

An error or warning for a desired configuration option value.