Module Values.EnvironmentDescriptionSource

Describes the properties of an environment.

Sourcetype createEnvironmentResult = {
  1. environmentName : EnvironmentName.t option;
    (*

    The name of this environment.

    *)
  2. environmentId : EnvironmentId.t option;
    (*

    The ID of this environment.

    *)
  3. applicationName : ApplicationName.t option;
    (*

    The name of the application associated with this environment.

    *)
  4. versionLabel : VersionLabel.t option;
    (*

    The application version deployed in this environment.

    *)
  5. solutionStackName : SolutionStackName.t option;
    (*

    The name of the SolutionStack deployed with this environment.

    *)
  6. platformArn : PlatformArn.t option;
    (*

    The ARN of the platform version.

    *)
  7. templateName : ConfigurationTemplateName.t option;
    (*

    The name of the configuration template used to originally launch this environment.

    *)
  8. description : Description.t option;
    (*

    Describes this environment.

    *)
  9. endpointURL : EndpointURL.t option;
    (*

    For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.

    *)
  10. cNAME : DNSCname.t option;
    (*

    The URL to the CNAME for this environment.

    *)
  11. dateCreated : CreationDate.t option;
    (*

    The creation date for this environment.

    *)
  12. dateUpdated : UpdateDate.t option;
    (*

    The last modified date for this environment.

    *)
  13. status : EnvironmentStatus.t option;
    (*

    The current operational status of the environment: Launching: Environment is in the process of initial deployment. Updating: Environment is in the process of updating its configuration settings or application version. Ready: Environment is available to have an action performed on it, such as update or terminate. Terminating: Environment is in the shut-down process. Terminated: Environment is not running.

    *)
  14. abortableOperationInProgress : AbortableOperationInProgress.t option;
    (*

    Indicates if there is an in-progress environment configuration update or application version deployment that you can cancel. true: There is an update in progress. false: There are no updates currently in progress.

    *)
  15. health : EnvironmentHealth.t option;
    (*

    Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment: Red: Indicates the environment is not responsive. Occurs when three or more consecutive failures occur for an environment. Yellow: Indicates that something is wrong. Occurs when two consecutive failures occur for an environment. Green: Indicates the environment is healthy and fully functional. Grey: Default health for a new environment. The environment is not fully launched and health checks have not started or health checks are suspended during an UpdateEnvironment or RestartEnvironment request. Default: Grey

    *)
  16. healthStatus : EnvironmentHealthStatus.t option;
    (*

    Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses.

    *)
  17. resources : EnvironmentResourcesDescription.t option;
    (*

    The description of the AWS resources used by this environment.

    *)
  18. tier : EnvironmentTier.t option;
    (*

    Describes the current tier of this environment.

    *)
  19. environmentArn : EnvironmentArn.t option;
    (*

    The environment's Amazon Resource Name (ARN), which can be used in other API requests that require an ARN.

    *)
  20. operationsRole : OperationsRole.t option;
    (*

    The Amazon Resource Name (ARN) of the environment's operations role. For more information, see Operations roles in the AWS Elastic Beanstalk Developer Guide.

    *)
}
Sourceand responseMetaData = unit
Sourceand t = {
  1. createEnvironmentResult : createEnvironmentResult;
  2. responseMetaData : responseMetaData;
}
Sourcetype error = [
  1. | `InsufficientPrivilegesException of InsufficientPrivilegesException.t
  2. | `TooManyEnvironmentsException of TooManyEnvironmentsException.t
  3. | `Unknown_operation_error of string * string option
]
Sourceval context_ : string
Sourceval make : ?environmentName:??? -> ?environmentId:??? -> ?applicationName:??? -> ?versionLabel:??? -> ?solutionStackName:??? -> ?platformArn:??? -> ?templateName:??? -> ?description:??? -> ?endpointURL:??? -> ?cNAME:??? -> ?dateCreated:??? -> ?dateUpdated:??? -> ?status:??? -> ?abortableOperationInProgress:??? -> ?health:??? -> ?healthStatus:??? -> ?resources:??? -> ?tier:??? -> ?environmentLinks:??? -> ?environmentArn:??? -> ?operationsRole:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `InsufficientPrivilegesException of unit | `TooManyEnvironmentsException of unit | `Unknown_operation_error of string * string option ]
Sourceval error_of_xml : string -> Awso.Xml.t -> [> `InsufficientPrivilegesException of unit | `TooManyEnvironmentsException of unit | `Unknown_operation_error of string * string option ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval to_value : t -> [> `Structure of (string * [> `Structure of (string * [> `Boolean of AbortableOperationInProgress.t | `Enum of string | `List of [> `Structure of (string * [> `String of String_.t ]) list ] list | `String of EnvironmentName.t | `Structure of (string * [> `String of String_.t | `Structure of (string * [> `List of [> `Structure of (string * [> `Integer of Integer.t | `String of String_.t ]) list ] list | `String of String_.t ]) list ]) list | `Timestamp of CreationDate.t ]) list ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t