AWS SDK Version 2 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.

.NET Framework 4.5
 

Classes

NameDescription
Class AbortEnvironmentUpdateRequest Container for the parameters to the AbortEnvironmentUpdate operation. Cancels in-progress environment configuration update or application version deployment.
Class AbortEnvironmentUpdateResponse
Class ApplicationDescription Describes the properties of an application.
Class ApplicationMetrics Represents the application metrics for a specified environment.
Class ApplicationVersionDescription Describes the properties of an application version.
Class AutoScalingGroup Describes an Auto Scaling launch configuration.
Class CheckDNSAvailabilityRequest Container for the parameters to the CheckDNSAvailability operation. Checks if the specified CNAME is available.
Class CheckDNSAvailabilityResponse Configuration for accessing Amazon CheckDNSAvailability service
Class CheckDNSAvailabilityResult Indicates if the specified CNAME is available.
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 Configuration for accessing Amazon ComposeEnvironments service
Class ComposeEnvironmentsResult 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 Represents CPU utilization information from the specified instance that belongs to the AWS Elastic Beanstalk environment. Use the instanceId property to specify the application instance for which you'd like to return data.
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 Configuration for accessing Amazon CreateApplication service
Class CreateApplicationResult 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. 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 Configuration for accessing Amazon CreateApplicationVersion service
Class CreateApplicationVersionResult 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 Configuration for accessing Amazon CreateConfigurationTemplate service
Class CreateConfigurationTemplateResult 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 Configuration for accessing Amazon CreateEnvironment service
Class CreateEnvironmentResult Describes the properties of an environment.
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 Configuration for accessing Amazon CreateStorageLocation service
Class CreateStorageLocationResult Results of a CreateStorageLocationResult call.
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
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
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
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
Class DescribeApplicationsRequest Container for the parameters to the DescribeApplications operation. Returns the descriptions of existing applications.
Class DescribeApplicationsResponse Configuration for accessing Amazon DescribeApplications service
Class DescribeApplicationsResult Result message containing a list of application descriptions.
Class DescribeApplicationVersionsRequest Container for the parameters to the DescribeApplicationVersions operation. Retrieve a list of application versions stored in your AWS Elastic Beanstalk storage bucket.
Class DescribeApplicationVersionsResponse Configuration for accessing Amazon DescribeApplicationVersions service
Class DescribeApplicationVersionsResult 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 Configuration for accessing Amazon DescribeConfigurationOptions service
Class DescribeConfigurationOptionsResult 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 Configuration for accessing Amazon DescribeConfigurationSettings service
Class DescribeConfigurationSettingsResult 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 Configuration for accessing Amazon DescribeEnvironmentHealth service
Class DescribeEnvironmentHealthResult See the example below for a sample response.
Class DescribeEnvironmentResourcesRequest Container for the parameters to the DescribeEnvironmentResources operation. Returns AWS resources for this environment.
Class DescribeEnvironmentResourcesResponse Configuration for accessing Amazon DescribeEnvironmentResources service
Class DescribeEnvironmentResourcesResult 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 Configuration for accessing Amazon DescribeEnvironments service
Class DescribeEnvironmentsResult 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 Configuration for accessing Amazon DescribeEvents service
Class DescribeEventsResult Result message wrapping a list of event descriptions.
Class DescribeInstancesHealthRequest Container for the parameters to the DescribeInstancesHealth operation. Returns more detailed information about the health of the specified instances (for example, CPU utilization, load average, and causes). The DescribeInstancesHealth operation is only available with AWS Elastic Beanstalk Enhanced Health.
Class DescribeInstancesHealthResponse Configuration for accessing Amazon DescribeInstancesHealth service
Class DescribeInstancesHealthResult See the example below for a sample response.
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.
Class ListAvailableSolutionStacksResponse Configuration for accessing Amazon ListAvailableSolutionStacks service
Class ListAvailableSolutionStacksResult A list of available AWS Elastic Beanstalk solution stacks.
Class Listener Describes the properties of a Listener for the LoadBalancer.
Class LoadBalancer Describes a LoadBalancer.
Class LoadBalancerDescription Describes the details of a LoadBalancer.
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 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
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
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
Class RetrieveEnvironmentInfoRequest Container for the parameters to the RetrieveEnvironmentInfo operation. Retrieves the compiled information from a RequestEnvironmentInfo request.

Related Topics

Class RetrieveEnvironmentInfoResponse Configuration for accessing Amazon RetrieveEnvironmentInfo service
Class RetrieveEnvironmentInfoResult Result message containing a description of the requested environment info.
Class S3Location A specification of a location in Amazon S3.
Class S3LocationNotInServiceRegionException ElasticBeanstalk exception
Class S3SubscriptionRequiredException ElasticBeanstalk exception
Class SingleInstanceHealth Represents health information from the specified instance that belongs to the AWS Elastic Beanstalk environment. Use the InstanceId property to specify the application instance for which you'd like to return data.
Class SolutionStackDescription Describes the solution stack.
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
Class SystemStatus Represents CPU utilization and load average information for applications running in the specified environment.
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 Configuration for accessing Amazon TerminateEnvironment service
Class TerminateEnvironmentResult 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 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 UpdateApplicationResponse Configuration for accessing Amazon UpdateApplication service
Class UpdateApplicationResult 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 Configuration for accessing Amazon UpdateApplicationVersion service
Class UpdateApplicationVersionResult 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 Configuration for accessing Amazon UpdateConfigurationTemplate service
Class UpdateConfigurationTemplateResult 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 Configuration for accessing Amazon UpdateEnvironment service
Class UpdateEnvironmentResult 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 Configuration for accessing Amazon ValidateConfigurationSettings service
Class ValidateConfigurationSettingsResult Provides a list of validation messages.
Class ValidationMessage An error or warning for a desired configuration option value.