pub struct Client { /* private fields */ }
Expand description
Client for AWS Elastic Beanstalk
Client for invoking operations on AWS Elastic Beanstalk. Each operation on AWS Elastic Beanstalk is a method on this
this struct. .send()
MUST be invoked on the generated operations to dispatch the request to the service.
§Constructing a Client
A Config
is required to construct a client. For most use cases, the aws-config
crate should be used to automatically resolve this config using
aws_config::load_from_env()
, since this will resolve an SdkConfig
which can be shared
across multiple different AWS SDK clients. This config resolution process can be customized
by calling aws_config::from_env()
instead, which returns a ConfigLoader
that uses
the builder pattern to customize the default config.
In the simplest case, creating a client looks as follows:
let config = aws_config::load_from_env().await;
let client = aws_sdk_elasticbeanstalk::Client::new(&config);
Occasionally, SDKs may have additional service-specific values that can be set on the Config
that
is absent from SdkConfig
, or slightly different settings for a specific client may be desired.
The Builder
struct implements From<&SdkConfig>
, so setting these specific settings can be
done as follows:
let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_elasticbeanstalk::config::Builder::from(&sdk_config)
.some_service_specific_setting("value")
.build();
See the aws-config
docs and Config
for more information on customizing configuration.
Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.
§Using the Client
A client has a function for every operation that can be performed by the service.
For example, the AbortEnvironmentUpdate
operation has
a Client::abort_environment_update
, function which returns a builder for that operation.
The fluent builder ultimately has a send()
function that returns an async future that
returns a result, as illustrated below:
let result = client.abort_environment_update()
.environment_id("example")
.send()
.await;
The underlying HTTP requests that get made by this can be modified with the customize_operation
function on the fluent builder. See the customize
module for more
information.
§Waiters
This client provides wait_until
methods behind the Waiters
trait.
To use them, simply import the trait, and then call one of the wait_until
methods. This will
return a waiter fluent builder that takes various parameters, which are documented on the builder
type. Once parameters have been provided, the wait
method can be called to initiate waiting.
For example, if there was a wait_until_thing
method, it could look like:
let result = client.wait_until_thing()
.thing_id("someId")
.wait(Duration::from_secs(120))
.await;
Implementations§
Source§impl Client
impl Client
Sourcepub fn abort_environment_update(&self) -> AbortEnvironmentUpdateFluentBuilder
pub fn abort_environment_update(&self) -> AbortEnvironmentUpdateFluentBuilder
Constructs a fluent builder for the AbortEnvironmentUpdate
operation.
- The fluent builder is configurable:
environment_id(impl Into<String>)
/set_environment_id(Option<String>)
:
required: falseThis specifies the ID of the environment with the in-progress update that you want to cancel.
environment_name(impl Into<String>)
/set_environment_name(Option<String>)
:
required: falseThis specifies the name of the environment with the in-progress update that you want to cancel.
- On success, responds with
AbortEnvironmentUpdateOutput
- On failure, responds with
SdkError<AbortEnvironmentUpdateError>
Source§impl Client
impl Client
Sourcepub fn apply_environment_managed_action(
&self,
) -> ApplyEnvironmentManagedActionFluentBuilder
pub fn apply_environment_managed_action( &self, ) -> ApplyEnvironmentManagedActionFluentBuilder
Constructs a fluent builder for the ApplyEnvironmentManagedAction
operation.
- The fluent builder is configurable:
environment_name(impl Into<String>)
/set_environment_name(Option<String>)
:
required: falseThe name of the target environment.
environment_id(impl Into<String>)
/set_environment_id(Option<String>)
:
required: falseThe environment ID of the target environment.
action_id(impl Into<String>)
/set_action_id(Option<String>)
:
required: trueThe action ID of the scheduled managed action to execute.
- On success, responds with
ApplyEnvironmentManagedActionOutput
with field(s):action_id(Option<String>)
:The action ID of the managed action.
action_description(Option<String>)
:A description of the managed action.
action_type(Option<ActionType>)
:The type of managed action.
status(Option<String>)
:The status of the managed action.
- On failure, responds with
SdkError<ApplyEnvironmentManagedActionError>
Source§impl Client
impl Client
Sourcepub fn associate_environment_operations_role(
&self,
) -> AssociateEnvironmentOperationsRoleFluentBuilder
pub fn associate_environment_operations_role( &self, ) -> AssociateEnvironmentOperationsRoleFluentBuilder
Constructs a fluent builder for the AssociateEnvironmentOperationsRole
operation.
- The fluent builder is configurable:
environment_name(impl Into<String>)
/set_environment_name(Option<String>)
:
required: trueThe name of the environment to which to set the operations role.
operations_role(impl Into<String>)
/set_operations_role(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of an existing IAM role to be used as the environment’s operations role.
- On success, responds with
AssociateEnvironmentOperationsRoleOutput
- On failure, responds with
SdkError<AssociateEnvironmentOperationsRoleError>
Source§impl Client
impl Client
Sourcepub fn check_dns_availability(&self) -> CheckDNSAvailabilityFluentBuilder
pub fn check_dns_availability(&self) -> CheckDNSAvailabilityFluentBuilder
Constructs a fluent builder for the CheckDNSAvailability
operation.
- The fluent builder is configurable:
cname_prefix(impl Into<String>)
/set_cname_prefix(Option<String>)
:
required: trueThe prefix used when this CNAME is reserved.
- On success, responds with
CheckDnsAvailabilityOutput
with field(s):available(Option<bool>)
:Indicates if the specified CNAME is available:
-
true
: The CNAME is available. -
false
: The CNAME is not available.
-
fully_qualified_cname(Option<String>)
:The fully qualified CNAME to reserve when
CreateEnvironment
is called with the provided prefix.
- On failure, responds with
SdkError<CheckDNSAvailabilityError>
Source§impl Client
impl Client
Sourcepub fn compose_environments(&self) -> ComposeEnvironmentsFluentBuilder
pub fn compose_environments(&self) -> ComposeEnvironmentsFluentBuilder
Constructs a fluent builder for the ComposeEnvironments
operation.
- The fluent builder is configurable:
application_name(impl Into<String>)
/set_application_name(Option<String>)
:
required: falseThe name of the application to which the specified source bundles belong.
group_name(impl Into<String>)
/set_group_name(Option<String>)
:
required: falseThe name of the group to which the target environments belong. Specify a group name only if the environment name defined in each target environment’s manifest ends with a + (plus) character. See Environment Manifest (env.yaml) for details.
version_labels(impl Into<String>)
/set_version_labels(Option<Vec::<String>>)
:
required: falseA list of version labels, specifying one or more application source bundles that belong to the target application. Each source bundle must include an environment manifest that specifies the name of the environment and the name of the solution stack to use, and optionally can specify environment links to create.
- On success, responds with
ComposeEnvironmentsOutput
with field(s):environments(Option<Vec::<EnvironmentDescription>>)
:Returns an
EnvironmentDescription
list.next_token(Option<String>)
:In a paginated request, the token that you can pass in a subsequent request to get the next response page.
- On failure, responds with
SdkError<ComposeEnvironmentsError>
Source§impl Client
impl Client
Sourcepub fn create_application(&self) -> CreateApplicationFluentBuilder
pub fn create_application(&self) -> CreateApplicationFluentBuilder
Constructs a fluent builder for the CreateApplication
operation.
- The fluent builder is configurable:
application_name(impl Into<String>)
/set_application_name(Option<String>)
:
required: trueThe name of the application. Must be unique within your account.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseYour description of the application.
resource_lifecycle_config(ApplicationResourceLifecycleConfig)
/set_resource_lifecycle_config(Option<ApplicationResourceLifecycleConfig>)
:
required: falseSpecifies an application resource lifecycle configuration to prevent your application from accumulating too many versions.
tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: falseSpecifies the tags applied to the application.
Elastic Beanstalk applies these tags only to the application. Environments that you create in the application don’t inherit the tags.
- On success, responds with
CreateApplicationOutput
with field(s):application(Option<ApplicationDescription>)
:The
ApplicationDescription
of the application.
- On failure, responds with
SdkError<CreateApplicationError>
Source§impl Client
impl Client
Sourcepub fn create_application_version(
&self,
) -> CreateApplicationVersionFluentBuilder
pub fn create_application_version( &self, ) -> CreateApplicationVersionFluentBuilder
Constructs a fluent builder for the CreateApplicationVersion
operation.
- The fluent builder is configurable:
application_name(impl Into<String>)
/set_application_name(Option<String>)
:
required: trueThe name of the application. If no application is found with this name, and
AutoCreateApplication
isfalse
, returns anInvalidParameterValue
error.version_label(impl Into<String>)
/set_version_label(Option<String>)
:
required: trueA label identifying this version.
Constraint: Must be unique per application. If an application version already exists with this label for the specified application, AWS Elastic Beanstalk returns an
InvalidParameterValue
error.description(impl Into<String>)
/set_description(Option<String>)
:
required: falseA description of this application version.
source_build_information(SourceBuildInformation)
/set_source_build_information(Option<SourceBuildInformation>)
:
required: falseSpecify a commit in an AWS CodeCommit Git repository to use as the source code for the application version.
source_bundle(S3Location)
/set_source_bundle(Option<S3Location>)
:
required: falseThe Amazon S3 bucket and key that identify the location of the source bundle for this version.
The Amazon S3 bucket must be in the same region as the environment.
Specify a source bundle in S3 or a commit in an AWS CodeCommit repository (with
SourceBuildInformation
), but not both. If neitherSourceBundle
norSourceBuildInformation
are provided, Elastic Beanstalk uses a sample application.build_configuration(BuildConfiguration)
/set_build_configuration(Option<BuildConfiguration>)
:
required: falseSettings for an AWS CodeBuild build.
auto_create_application(bool)
/set_auto_create_application(Option<bool>)
:
required: falseSet to
true
to create an application with the specified name if it doesn’t already exist.process(bool)
/set_process(Option<bool>)
:
required: falsePre-processes and validates the environment manifest (
env.yaml
) and configuration files (*.config
files in the.ebextensions
folder) in the source bundle. Validating configuration files can identify issues prior to deploying the application version to an environment.You must turn processing on for application versions that you create using AWS CodeBuild or AWS CodeCommit. For application versions built from a source bundle in Amazon S3, processing is optional.
The
Process
option validates Elastic Beanstalk configuration files. It doesn’t validate your application’s configuration files, like proxy server or Docker configuration.tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: falseSpecifies the tags applied to the application version.
Elastic Beanstalk applies these tags only to the application version. Environments that use the application version don’t inherit the tags.
- On success, responds with
CreateApplicationVersionOutput
with field(s):application_version(Option<ApplicationVersionDescription>)
:The
ApplicationVersionDescription
of the application version.
- On failure, responds with
SdkError<CreateApplicationVersionError>
Source§impl Client
impl Client
Sourcepub fn create_configuration_template(
&self,
) -> CreateConfigurationTemplateFluentBuilder
pub fn create_configuration_template( &self, ) -> CreateConfigurationTemplateFluentBuilder
Constructs a fluent builder for the CreateConfigurationTemplate
operation.
- The fluent builder is configurable:
application_name(impl Into<String>)
/set_application_name(Option<String>)
:
required: trueThe name of the Elastic Beanstalk application to associate with this configuration template.
template_name(impl Into<String>)
/set_template_name(Option<String>)
:
required: trueThe name of the configuration template.
Constraint: This name must be unique per application.
solution_stack_name(impl Into<String>)
/set_solution_stack_name(Option<String>)
:
required: falseThe name of an Elastic Beanstalk solution stack (platform version) that this configuration uses. For example,
64bit Amazon Linux 2013.09 running Tomcat 7 Java 7
. A solution stack specifies the operating system, runtime, and application server for a configuration template. It also determines the set of configuration options as well as the possible and default values. For more information, see Supported Platforms in the AWS Elastic Beanstalk Developer Guide.You must specify
SolutionStackName
if you don’t specifyPlatformArn
,EnvironmentId
, orSourceConfiguration
.Use the
ListAvailableSolutionStacks
API to obtain a list of available solution stacks.platform_arn(impl Into<String>)
/set_platform_arn(Option<String>)
:
required: falseThe Amazon Resource Name (ARN) of the custom platform. For more information, see Custom Platforms in the AWS Elastic Beanstalk Developer Guide.
If you specify
PlatformArn
, then don’t specifySolutionStackName
.source_configuration(SourceConfiguration)
/set_source_configuration(Option<SourceConfiguration>)
:
required: falseAn Elastic Beanstalk configuration template to base this one on. If specified, Elastic Beanstalk uses the configuration values from the specified configuration template to create a new configuration.
Values specified in
OptionSettings
override any values obtained from theSourceConfiguration
.You must specify
SourceConfiguration
if you don’t specifyPlatformArn
,EnvironmentId
, orSolutionStackName
.Constraint: If both solution stack name and source configuration are specified, the solution stack of the source configuration template must match the specified solution stack name.
environment_id(impl Into<String>)
/set_environment_id(Option<String>)
:
required: falseThe ID of an environment whose settings you want to use to create the configuration template. You must specify
EnvironmentId
if you don’t specifyPlatformArn
,SolutionStackName
, orSourceConfiguration
.description(impl Into<String>)
/set_description(Option<String>)
:
required: falseAn optional description for this configuration.
option_settings(ConfigurationOptionSetting)
/set_option_settings(Option<Vec::<ConfigurationOptionSetting>>)
:
required: falseOption values for the Elastic Beanstalk configuration, such as the instance type. If specified, these values override the values obtained from the solution stack or the source configuration template. For a complete list of Elastic Beanstalk configuration options, see Option Values in the AWS Elastic Beanstalk Developer Guide.
tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: falseSpecifies the tags applied to the configuration template.
- On success, responds with
CreateConfigurationTemplateOutput
with field(s):solution_stack_name(Option<String>)
:The name of the solution stack this configuration set uses.
platform_arn(Option<String>)
:The ARN of the platform version.
application_name(Option<String>)
:The name of the application associated with this configuration set.
template_name(Option<String>)
:If not
null
, the name of the configuration template for this configuration set.description(Option<String>)
:Describes this configuration set.
environment_name(Option<String>)
:If not
null
, the name of the environment for this configuration set.deployment_status(Option<ConfigurationDeploymentStatus>)
:If this configuration set is associated with an environment, the
DeploymentStatus
parameter indicates the deployment status of this configuration set:-
null
: This configuration is not associated with a running environment. -
pending
: This is a draft configuration that is not deployed to the associated environment but is in the process of deploying. -
deployed
: This is the configuration that is currently deployed to the associated running environment. -
failed
: This is a draft configuration that failed to successfully deploy.
-
date_created(Option<DateTime>)
:The date (in UTC time) when this configuration set was created.
date_updated(Option<DateTime>)
:The date (in UTC time) when this configuration set was last modified.
option_settings(Option<Vec::<ConfigurationOptionSetting>>)
:A list of the configuration options and their values in this configuration set.
- On failure, responds with
SdkError<CreateConfigurationTemplateError>
Source§impl Client
impl Client
Sourcepub fn create_environment(&self) -> CreateEnvironmentFluentBuilder
pub fn create_environment(&self) -> CreateEnvironmentFluentBuilder
Constructs a fluent builder for the CreateEnvironment
operation.
- The fluent builder is configurable:
application_name(impl Into<String>)
/set_application_name(Option<String>)
:
required: trueThe name of the application that is associated with this environment.
environment_name(impl Into<String>)
/set_environment_name(Option<String>)
:
required: falseA unique name for the environment.
Constraint: Must be from 4 to 40 characters in length. The name can contain only letters, numbers, and hyphens. It can’t start or end with a hyphen. This name must be unique within a region in your account. If the specified name already exists in the region, Elastic Beanstalk returns an
InvalidParameterValue
error.If you don’t specify the
CNAMEPrefix
parameter, the environment name becomes part of the CNAME, and therefore part of the visible URL for your application.group_name(impl Into<String>)
/set_group_name(Option<String>)
:
required: falseThe name of the group to which the target environment belongs. Specify a group name only if the environment’s name is specified in an environment manifest and not with the environment name parameter. See Environment Manifest (env.yaml) for details.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseYour description for this environment.
cname_prefix(impl Into<String>)
/set_cname_prefix(Option<String>)
:
required: falseIf specified, the environment attempts to use this value as the prefix for the CNAME in your Elastic Beanstalk environment URL. If not specified, the CNAME is generated automatically by appending a random alphanumeric string to the environment name.
tier(EnvironmentTier)
/set_tier(Option<EnvironmentTier>)
:
required: falseSpecifies the tier to use in creating this environment. The environment tier that you choose determines whether Elastic Beanstalk provisions resources to support a web application that handles HTTP(S) requests or a web application that handles background-processing tasks.
tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: falseSpecifies the tags applied to resources in the environment.
version_label(impl Into<String>)
/set_version_label(Option<String>)
:
required: falseThe name of the application version to deploy.
Default: If not specified, Elastic Beanstalk attempts to deploy the sample application.
template_name(impl Into<String>)
/set_template_name(Option<String>)
:
required: falseThe name of the Elastic Beanstalk configuration template to use with the environment.
If you specify
TemplateName
, then don’t specifySolutionStackName
.solution_stack_name(impl Into<String>)
/set_solution_stack_name(Option<String>)
:
required: falseThe name of an Elastic Beanstalk solution stack (platform version) to use with the environment. If specified, Elastic Beanstalk sets the configuration values to the default values associated with the specified solution stack. For a list of current solution stacks, see Elastic Beanstalk Supported Platforms in the AWS Elastic Beanstalk Platforms guide.
If you specify
SolutionStackName
, don’t specifyPlatformArn
orTemplateName
.platform_arn(impl Into<String>)
/set_platform_arn(Option<String>)
:
required: falseThe Amazon Resource Name (ARN) of the custom platform to use with the environment. For more information, see Custom Platforms in the AWS Elastic Beanstalk Developer Guide.
If you specify
PlatformArn
, don’t specifySolutionStackName
.option_settings(ConfigurationOptionSetting)
/set_option_settings(Option<Vec::<ConfigurationOptionSetting>>)
:
required: falseIf specified, AWS Elastic Beanstalk sets the specified configuration options to the requested value in the configuration set for the new environment. These override the values obtained from the solution stack or the configuration template.
options_to_remove(OptionSpecification)
/set_options_to_remove(Option<Vec::<OptionSpecification>>)
:
required: falseA list of custom user-defined configuration options to remove from the configuration set for this new environment.
operations_role(impl Into<String>)
/set_operations_role(Option<String>)
:
required: falseThe Amazon Resource Name (ARN) of an existing IAM role to be used as the environment’s operations role. If specified, Elastic Beanstalk uses the operations role for permissions to downstream services during this call and during subsequent calls acting on this environment. To specify an operations role, you must have the
iam:PassRole
permission for the role. For more information, see Operations roles in the AWS Elastic Beanstalk Developer Guide.
- On success, responds with
CreateEnvironmentOutput
with field(s):environment_name(Option<String>)
:The name of this environment.
environment_id(Option<String>)
:The ID of this environment.
application_name(Option<String>)
:The name of the application associated with this environment.
version_label(Option<String>)
:The application version deployed in this environment.
solution_stack_name(Option<String>)
:The name of the
SolutionStack
deployed with this environment.platform_arn(Option<String>)
:The ARN of the platform version.
template_name(Option<String>)
:The name of the configuration template used to originally launch this environment.
description(Option<String>)
:Describes this environment.
endpoint_url(Option<String>)
:For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.
cname(Option<String>)
:The URL to the CNAME for this environment.
date_created(Option<DateTime>)
:The creation date for this environment.
date_updated(Option<DateTime>)
:The last modified date for this environment.
status(Option<EnvironmentStatus>)
: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.
-
abortable_operation_in_progress(Option<bool>)
: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.health(Option<EnvironmentHealth>)
: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 anUpdateEnvironment
orRestartEnvironment
request.
Default:
Grey
-
health_status(Option<EnvironmentHealthStatus>)
:Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses.
resources(Option<EnvironmentResourcesDescription>)
:The description of the AWS resources used by this environment.
tier(Option<EnvironmentTier>)
:Describes the current tier of this environment.
environment_links(Option<Vec::<EnvironmentLink>>)
:A list of links to other environments in the same group.
environment_arn(Option<String>)
:The environment’s Amazon Resource Name (ARN), which can be used in other API requests that require an ARN.
operations_role(Option<String>)
:The Amazon Resource Name (ARN) of the environment’s operations role. For more information, see Operations roles in the AWS Elastic Beanstalk Developer Guide.
- On failure, responds with
SdkError<CreateEnvironmentError>
Source§impl Client
impl Client
Sourcepub fn create_platform_version(&self) -> CreatePlatformVersionFluentBuilder
pub fn create_platform_version(&self) -> CreatePlatformVersionFluentBuilder
Constructs a fluent builder for the CreatePlatformVersion
operation.
- The fluent builder is configurable:
platform_name(impl Into<String>)
/set_platform_name(Option<String>)
:
required: trueThe name of your custom platform.
platform_version(impl Into<String>)
/set_platform_version(Option<String>)
:
required: trueThe number, such as 1.0.2, for the new platform version.
platform_definition_bundle(S3Location)
/set_platform_definition_bundle(Option<S3Location>)
:
required: trueThe location of the platform definition archive in Amazon S3.
environment_name(impl Into<String>)
/set_environment_name(Option<String>)
:
required: falseThe name of the builder environment.
option_settings(ConfigurationOptionSetting)
/set_option_settings(Option<Vec::<ConfigurationOptionSetting>>)
:
required: falseThe configuration option settings to apply to the builder environment.
tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: falseSpecifies the tags applied to the new platform version.
Elastic Beanstalk applies these tags only to the platform version. Environments that you create using the platform version don’t inherit the tags.
- On success, responds with
CreatePlatformVersionOutput
with field(s):platform_summary(Option<PlatformSummary>)
:Detailed information about the new version of the custom platform.
builder_value(Option<Builder>)
:The builder used to create the custom platform.
- On failure, responds with
SdkError<CreatePlatformVersionError>
Source§impl Client
impl Client
Sourcepub fn create_storage_location(&self) -> CreateStorageLocationFluentBuilder
pub fn create_storage_location(&self) -> CreateStorageLocationFluentBuilder
Constructs a fluent builder for the CreateStorageLocation
operation.
- The fluent builder takes no input, just
send
it. - On success, responds with
CreateStorageLocationOutput
with field(s):s3_bucket(Option<String>)
:The name of the Amazon S3 bucket created.
- On failure, responds with
SdkError<CreateStorageLocationError>
Source§impl Client
impl Client
Sourcepub fn delete_application(&self) -> DeleteApplicationFluentBuilder
pub fn delete_application(&self) -> DeleteApplicationFluentBuilder
Constructs a fluent builder for the DeleteApplication
operation.
- The fluent builder is configurable:
application_name(impl Into<String>)
/set_application_name(Option<String>)
:
required: trueThe name of the application to delete.
terminate_env_by_force(bool)
/set_terminate_env_by_force(Option<bool>)
:
required: falseWhen set to true, running environments will be terminated before deleting the application.
- On success, responds with
DeleteApplicationOutput
- On failure, responds with
SdkError<DeleteApplicationError>
Source§impl Client
impl Client
Sourcepub fn delete_application_version(
&self,
) -> DeleteApplicationVersionFluentBuilder
pub fn delete_application_version( &self, ) -> DeleteApplicationVersionFluentBuilder
Constructs a fluent builder for the DeleteApplicationVersion
operation.
- The fluent builder is configurable:
application_name(impl Into<String>)
/set_application_name(Option<String>)
:
required: trueThe name of the application to which the version belongs.
version_label(impl Into<String>)
/set_version_label(Option<String>)
:
required: trueThe label of the version to delete.
delete_source_bundle(bool)
/set_delete_source_bundle(Option<bool>)
:
required: falseSet to
true
to delete the source bundle from your storage bucket. Otherwise, the application version is deleted only from Elastic Beanstalk and the source bundle remains in Amazon S3.
- On success, responds with
DeleteApplicationVersionOutput
- On failure, responds with
SdkError<DeleteApplicationVersionError>
Source§impl Client
impl Client
Sourcepub fn delete_configuration_template(
&self,
) -> DeleteConfigurationTemplateFluentBuilder
pub fn delete_configuration_template( &self, ) -> DeleteConfigurationTemplateFluentBuilder
Constructs a fluent builder for the DeleteConfigurationTemplate
operation.
- The fluent builder is configurable:
application_name(impl Into<String>)
/set_application_name(Option<String>)
:
required: trueThe name of the application to delete the configuration template from.
template_name(impl Into<String>)
/set_template_name(Option<String>)
:
required: trueThe name of the configuration template to delete.
- On success, responds with
DeleteConfigurationTemplateOutput
- On failure, responds with
SdkError<DeleteConfigurationTemplateError>
Source§impl Client
impl Client
Sourcepub fn delete_environment_configuration(
&self,
) -> DeleteEnvironmentConfigurationFluentBuilder
pub fn delete_environment_configuration( &self, ) -> DeleteEnvironmentConfigurationFluentBuilder
Constructs a fluent builder for the DeleteEnvironmentConfiguration
operation.
- The fluent builder is configurable:
application_name(impl Into<String>)
/set_application_name(Option<String>)
:
required: trueThe name of the application the environment is associated with.
environment_name(impl Into<String>)
/set_environment_name(Option<String>)
:
required: trueThe name of the environment to delete the draft configuration from.
- On success, responds with
DeleteEnvironmentConfigurationOutput
- On failure, responds with
SdkError<DeleteEnvironmentConfigurationError>
Source§impl Client
impl Client
Sourcepub fn delete_platform_version(&self) -> DeletePlatformVersionFluentBuilder
pub fn delete_platform_version(&self) -> DeletePlatformVersionFluentBuilder
Constructs a fluent builder for the DeletePlatformVersion
operation.
- The fluent builder is configurable:
platform_arn(impl Into<String>)
/set_platform_arn(Option<String>)
:
required: falseThe ARN of the version of the custom platform.
- On success, responds with
DeletePlatformVersionOutput
with field(s):platform_summary(Option<PlatformSummary>)
:Detailed information about the version of the custom platform.
- On failure, responds with
SdkError<DeletePlatformVersionError>
Source§impl Client
impl Client
Sourcepub fn describe_account_attributes(
&self,
) -> DescribeAccountAttributesFluentBuilder
pub fn describe_account_attributes( &self, ) -> DescribeAccountAttributesFluentBuilder
Constructs a fluent builder for the DescribeAccountAttributes
operation.
- The fluent builder takes no input, just
send
it. - On success, responds with
DescribeAccountAttributesOutput
with field(s):resource_quotas(Option<ResourceQuotas>)
:The Elastic Beanstalk resource quotas associated with the calling AWS account.
- On failure, responds with
SdkError<DescribeAccountAttributesError>
Source§impl Client
impl Client
Sourcepub fn describe_application_versions(
&self,
) -> DescribeApplicationVersionsFluentBuilder
pub fn describe_application_versions( &self, ) -> DescribeApplicationVersionsFluentBuilder
Constructs a fluent builder for the DescribeApplicationVersions
operation.
- The fluent builder is configurable:
application_name(impl Into<String>)
/set_application_name(Option<String>)
:
required: falseSpecify an application name to show only application versions for that application.
version_labels(impl Into<String>)
/set_version_labels(Option<Vec::<String>>)
:
required: falseSpecify a version label to show a specific application version.
max_records(i32)
/set_max_records(Option<i32>)
:
required: falseFor a paginated request. Specify a maximum number of application versions to include in each response.
If no
MaxRecords
is specified, all available application versions are retrieved in a single response.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseFor a paginated request. Specify a token from a previous response page to retrieve the next response page. All other parameter values must be identical to the ones specified in the initial request.
If no
NextToken
is specified, the first page is retrieved.
- On success, responds with
DescribeApplicationVersionsOutput
with field(s):application_versions(Option<Vec::<ApplicationVersionDescription>>)
:List of
ApplicationVersionDescription
objects sorted in order of creation.next_token(Option<String>)
:In a paginated request, the token that you can pass in a subsequent request to get the next response page.
- On failure, responds with
SdkError<DescribeApplicationVersionsError>
Source§impl Client
impl Client
Sourcepub fn describe_applications(&self) -> DescribeApplicationsFluentBuilder
pub fn describe_applications(&self) -> DescribeApplicationsFluentBuilder
Constructs a fluent builder for the DescribeApplications
operation.
- The fluent builder is configurable:
application_names(impl Into<String>)
/set_application_names(Option<Vec::<String>>)
:
required: falseIf specified, AWS Elastic Beanstalk restricts the returned descriptions to only include those with the specified names.
- On success, responds with
DescribeApplicationsOutput
with field(s):applications(Option<Vec::<ApplicationDescription>>)
:This parameter contains a list of
ApplicationDescription
.
- On failure, responds with
SdkError<DescribeApplicationsError>
Source§impl Client
impl Client
Sourcepub fn describe_configuration_options(
&self,
) -> DescribeConfigurationOptionsFluentBuilder
pub fn describe_configuration_options( &self, ) -> DescribeConfigurationOptionsFluentBuilder
Constructs a fluent builder for the DescribeConfigurationOptions
operation.
- The fluent builder is configurable:
application_name(impl Into<String>)
/set_application_name(Option<String>)
:
required: falseThe 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.
template_name(impl Into<String>)
/set_template_name(Option<String>)
:
required: falseThe name of the configuration template whose configuration options you want to describe.
environment_name(impl Into<String>)
/set_environment_name(Option<String>)
:
required: falseThe name of the environment whose configuration options you want to describe.
solution_stack_name(impl Into<String>)
/set_solution_stack_name(Option<String>)
:
required: falseThe name of the solution stack whose configuration options you want to describe.
platform_arn(impl Into<String>)
/set_platform_arn(Option<String>)
:
required: falseThe ARN of the custom platform.
options(OptionSpecification)
/set_options(Option<Vec::<OptionSpecification>>)
:
required: falseIf specified, restricts the descriptions to only the specified options.
- On success, responds with
DescribeConfigurationOptionsOutput
with field(s):solution_stack_name(Option<String>)
:The name of the solution stack these configuration options belong to.
platform_arn(Option<String>)
:The ARN of the platform version.
options(Option<Vec::<ConfigurationOptionDescription>>)
:A list of
ConfigurationOptionDescription
.
- On failure, responds with
SdkError<DescribeConfigurationOptionsError>
Source§impl Client
impl Client
Sourcepub fn describe_configuration_settings(
&self,
) -> DescribeConfigurationSettingsFluentBuilder
pub fn describe_configuration_settings( &self, ) -> DescribeConfigurationSettingsFluentBuilder
Constructs a fluent builder for the DescribeConfigurationSettings
operation.
- The fluent builder is configurable:
application_name(impl Into<String>)
/set_application_name(Option<String>)
:
required: trueThe application for the environment or configuration template.
template_name(impl Into<String>)
/set_template_name(Option<String>)
:
required: falseThe 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 aMissingRequiredParameter
error.environment_name(impl Into<String>)
/set_environment_name(Option<String>)
:
required: falseThe 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 returnsMissingRequiredParameter
error.
- On success, responds with
DescribeConfigurationSettingsOutput
with field(s):configuration_settings(Option<Vec::<ConfigurationSettingsDescription>>)
:A list of
ConfigurationSettingsDescription
.
- On failure, responds with
SdkError<DescribeConfigurationSettingsError>
Source§impl Client
impl Client
Sourcepub fn describe_environment_health(
&self,
) -> DescribeEnvironmentHealthFluentBuilder
pub fn describe_environment_health( &self, ) -> DescribeEnvironmentHealthFluentBuilder
Constructs a fluent builder for the DescribeEnvironmentHealth
operation.
- The fluent builder is configurable:
environment_name(impl Into<String>)
/set_environment_name(Option<String>)
:
required: falseSpecify the environment by name.
You must specify either this or an EnvironmentName, or both.
environment_id(impl Into<String>)
/set_environment_id(Option<String>)
:
required: falseSpecify the environment by ID.
You must specify either this or an EnvironmentName, or both.
attribute_names(EnvironmentHealthAttribute)
/set_attribute_names(Option<Vec::<EnvironmentHealthAttribute>>)
:
required: falseSpecify the response elements to return. To retrieve all attributes, set to
All
. If no attribute names are specified, returns the name of the environment.
- On success, responds with
DescribeEnvironmentHealthOutput
with field(s):environment_name(Option<String>)
:The environment’s name.
health_status(Option<String>)
:The health status of the environment. For example,
Ok
.status(Option<EnvironmentHealth>)
:The environment’s operational status.
Ready
,Launching
,Updating
,Terminating
, orTerminated
.color(Option<String>)
:The health color of the environment.
causes(Option<Vec::<String>>)
:Descriptions of the data that contributed to the environment’s current health status.
application_metrics(Option<ApplicationMetrics>)
:Application request metrics for the environment.
instances_health(Option<InstanceHealthSummary>)
:Summary health information for the instances in the environment.
refreshed_at(Option<DateTime>)
:The date and time that the health information was retrieved.
- On failure, responds with
SdkError<DescribeEnvironmentHealthError>
Source§impl Client
impl Client
Sourcepub fn describe_environment_managed_action_history(
&self,
) -> DescribeEnvironmentManagedActionHistoryFluentBuilder
pub fn describe_environment_managed_action_history( &self, ) -> DescribeEnvironmentManagedActionHistoryFluentBuilder
Constructs a fluent builder for the DescribeEnvironmentManagedActionHistory
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
environment_id(impl Into<String>)
/set_environment_id(Option<String>)
:
required: falseThe environment ID of the target environment.
environment_name(impl Into<String>)
/set_environment_name(Option<String>)
:
required: falseThe name of the target environment.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe pagination token returned by a previous request.
max_items(i32)
/set_max_items(Option<i32>)
:
required: falseThe maximum number of items to return for a single request.
- On success, responds with
DescribeEnvironmentManagedActionHistoryOutput
with field(s):managed_action_history_items(Option<Vec::<ManagedActionHistoryItem>>)
:A list of completed and failed managed actions.
next_token(Option<String>)
:A pagination token that you pass to
DescribeEnvironmentManagedActionHistory
to get the next page of results.
- On failure, responds with
SdkError<DescribeEnvironmentManagedActionHistoryError>
Source§impl Client
impl Client
Sourcepub fn describe_environment_managed_actions(
&self,
) -> DescribeEnvironmentManagedActionsFluentBuilder
pub fn describe_environment_managed_actions( &self, ) -> DescribeEnvironmentManagedActionsFluentBuilder
Constructs a fluent builder for the DescribeEnvironmentManagedActions
operation.
- The fluent builder is configurable:
environment_name(impl Into<String>)
/set_environment_name(Option<String>)
:
required: falseThe name of the target environment.
environment_id(impl Into<String>)
/set_environment_id(Option<String>)
:
required: falseThe environment ID of the target environment.
status(ActionStatus)
/set_status(Option<ActionStatus>)
:
required: falseTo show only actions with a particular status, specify a status.
- On success, responds with
DescribeEnvironmentManagedActionsOutput
with field(s):managed_actions(Option<Vec::<ManagedAction>>)
:A list of upcoming and in-progress managed actions.
- On failure, responds with
SdkError<DescribeEnvironmentManagedActionsError>
Source§impl Client
impl Client
Sourcepub fn describe_environment_resources(
&self,
) -> DescribeEnvironmentResourcesFluentBuilder
pub fn describe_environment_resources( &self, ) -> DescribeEnvironmentResourcesFluentBuilder
Constructs a fluent builder for the DescribeEnvironmentResources
operation.
- The fluent builder is configurable:
environment_id(impl Into<String>)
/set_environment_id(Option<String>)
:
required: falseThe ID of the environment to retrieve AWS resource usage data.
Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter
error.environment_name(impl Into<String>)
/set_environment_name(Option<String>)
:
required: falseThe name of the environment to retrieve AWS resource usage data.
Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter
error.
- On success, responds with
DescribeEnvironmentResourcesOutput
with field(s):environment_resources(Option<EnvironmentResourceDescription>)
:A list of
EnvironmentResourceDescription
.
- On failure, responds with
SdkError<DescribeEnvironmentResourcesError>
Source§impl Client
impl Client
Sourcepub fn describe_environments(&self) -> DescribeEnvironmentsFluentBuilder
pub fn describe_environments(&self) -> DescribeEnvironmentsFluentBuilder
Constructs a fluent builder for the DescribeEnvironments
operation.
- The fluent builder is configurable:
application_name(impl Into<String>)
/set_application_name(Option<String>)
:
required: falseIf specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.
version_label(impl Into<String>)
/set_version_label(Option<String>)
:
required: falseIf specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.
environment_ids(impl Into<String>)
/set_environment_ids(Option<Vec::<String>>)
:
required: falseIf specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.
environment_names(impl Into<String>)
/set_environment_names(Option<Vec::<String>>)
:
required: falseIf specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.
include_deleted(bool)
/set_include_deleted(Option<bool>)
:
required: falseIndicates whether to include deleted environments:
true
: Environments that have been deleted afterIncludedDeletedBackTo
are displayed.false
: Do not include deleted environments.included_deleted_back_to(DateTime)
/set_included_deleted_back_to(Option<DateTime>)
:
required: falseIf specified when
IncludeDeleted
is set totrue
, then environments deleted after this date are displayed.max_records(i32)
/set_max_records(Option<i32>)
:
required: falseFor a paginated request. Specify a maximum number of environments to include in each response.
If no
MaxRecords
is specified, all available environments are retrieved in a single response.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseFor a paginated request. Specify a token from a previous response page to retrieve the next response page. All other parameter values must be identical to the ones specified in the initial request.
If no
NextToken
is specified, the first page is retrieved.
- On success, responds with
DescribeEnvironmentsOutput
with field(s):environments(Option<Vec::<EnvironmentDescription>>)
:Returns an
EnvironmentDescription
list.next_token(Option<String>)
:In a paginated request, the token that you can pass in a subsequent request to get the next response page.
- On failure, responds with
SdkError<DescribeEnvironmentsError>
Source§impl Client
impl Client
Sourcepub fn describe_events(&self) -> DescribeEventsFluentBuilder
pub fn describe_events(&self) -> DescribeEventsFluentBuilder
Constructs a fluent builder for the DescribeEvents
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
application_name(impl Into<String>)
/set_application_name(Option<String>)
:
required: falseIf specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those associated with this application.
version_label(impl Into<String>)
/set_version_label(Option<String>)
:
required: falseIf specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this application version.
template_name(impl Into<String>)
/set_template_name(Option<String>)
:
required: falseIf specified, AWS Elastic Beanstalk restricts the returned descriptions to those that are associated with this environment configuration.
environment_id(impl Into<String>)
/set_environment_id(Option<String>)
:
required: falseIf specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment.
environment_name(impl Into<String>)
/set_environment_name(Option<String>)
:
required: falseIf specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment.
platform_arn(impl Into<String>)
/set_platform_arn(Option<String>)
:
required: falseThe ARN of a custom platform version. If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this custom platform version.
request_id(impl Into<String>)
/set_request_id(Option<String>)
:
required: falseIf specified, AWS Elastic Beanstalk restricts the described events to include only those associated with this request ID.
severity(EventSeverity)
/set_severity(Option<EventSeverity>)
:
required: falseIf specified, limits the events returned from this call to include only those with the specified severity or higher.
start_time(DateTime)
/set_start_time(Option<DateTime>)
:
required: falseIf specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur on or after this time.
end_time(DateTime)
/set_end_time(Option<DateTime>)
:
required: falseIf specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur up to, but not including, the
EndTime
.max_records(i32)
/set_max_records(Option<i32>)
:
required: falseSpecifies the maximum number of events that can be returned, beginning with the most recent event.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falsePagination token. If specified, the events return the next batch of results.
- On success, responds with
DescribeEventsOutput
with field(s):events(Option<Vec::<EventDescription>>)
:A list of
EventDescription
.next_token(Option<String>)
:If returned, this indicates that there are more results to obtain. Use this token in the next
DescribeEvents
call to get the next batch of events.
- On failure, responds with
SdkError<DescribeEventsError>
Source§impl Client
impl Client
Sourcepub fn describe_instances_health(&self) -> DescribeInstancesHealthFluentBuilder
pub fn describe_instances_health(&self) -> DescribeInstancesHealthFluentBuilder
Constructs a fluent builder for the DescribeInstancesHealth
operation.
- The fluent builder is configurable:
environment_name(impl Into<String>)
/set_environment_name(Option<String>)
:
required: falseSpecify the AWS Elastic Beanstalk environment by name.
environment_id(impl Into<String>)
/set_environment_id(Option<String>)
:
required: falseSpecify the AWS Elastic Beanstalk environment by ID.
attribute_names(InstancesHealthAttribute)
/set_attribute_names(Option<Vec::<InstancesHealthAttribute>>)
:
required: falseSpecifies the response elements you wish to receive. To retrieve all attributes, set to
All
. If no attribute names are specified, returns a list of instances.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseSpecify the pagination token returned by a previous call.
- On success, responds with
DescribeInstancesHealthOutput
with field(s):instance_health_list(Option<Vec::<SingleInstanceHealth>>)
:Detailed health information about each instance.
The output differs slightly between Linux and Windows environments. There is a difference in the members that are supported under the
type.refreshed_at(Option<DateTime>)
:The date and time that the health information was retrieved.
next_token(Option<String>)
:Pagination token for the next page of results, if available.
- On failure, responds with
SdkError<DescribeInstancesHealthError>
Source§impl Client
impl Client
Sourcepub fn describe_platform_version(&self) -> DescribePlatformVersionFluentBuilder
pub fn describe_platform_version(&self) -> DescribePlatformVersionFluentBuilder
Constructs a fluent builder for the DescribePlatformVersion
operation.
- The fluent builder is configurable:
platform_arn(impl Into<String>)
/set_platform_arn(Option<String>)
:
required: falseThe ARN of the platform version.
- On success, responds with
DescribePlatformVersionOutput
with field(s):platform_description(Option<PlatformDescription>)
:Detailed information about the platform version.
- On failure, responds with
SdkError<DescribePlatformVersionError>
Source§impl Client
impl Client
Sourcepub fn disassociate_environment_operations_role(
&self,
) -> DisassociateEnvironmentOperationsRoleFluentBuilder
pub fn disassociate_environment_operations_role( &self, ) -> DisassociateEnvironmentOperationsRoleFluentBuilder
Constructs a fluent builder for the DisassociateEnvironmentOperationsRole
operation.
- The fluent builder is configurable:
environment_name(impl Into<String>)
/set_environment_name(Option<String>)
:
required: trueThe name of the environment from which to disassociate the operations role.
- On success, responds with
DisassociateEnvironmentOperationsRoleOutput
- On failure, responds with
SdkError<DisassociateEnvironmentOperationsRoleError>
Source§impl Client
impl Client
Sourcepub fn list_available_solution_stacks(
&self,
) -> ListAvailableSolutionStacksFluentBuilder
pub fn list_available_solution_stacks( &self, ) -> ListAvailableSolutionStacksFluentBuilder
Constructs a fluent builder for the ListAvailableSolutionStacks
operation.
- The fluent builder takes no input, just
send
it. - On success, responds with
ListAvailableSolutionStacksOutput
with field(s):solution_stacks(Option<Vec::<String>>)
:A list of available solution stacks.
solution_stack_details(Option<Vec::<SolutionStackDescription>>)
:A list of available solution stacks and their
SolutionStackDescription
.
- On failure, responds with
SdkError<ListAvailableSolutionStacksError>
Source§impl Client
impl Client
Sourcepub fn list_platform_branches(&self) -> ListPlatformBranchesFluentBuilder
pub fn list_platform_branches(&self) -> ListPlatformBranchesFluentBuilder
Constructs a fluent builder for the ListPlatformBranches
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
filters(SearchFilter)
/set_filters(Option<Vec::<SearchFilter>>)
:
required: falseCriteria for restricting the resulting list of platform branches. The filter is evaluated as a logical conjunction (AND) of the separate
SearchFilter
terms.The following list shows valid attribute values for each of the
SearchFilter
terms. Most operators take a single value. Thein
andnot_in
operators can take multiple values.-
Attribute = BranchName
:-
Operator
:=
|!=
|begins_with
|ends_with
|contains
|in
|not_in
-
-
Attribute = LifecycleState
:-
Operator
:=
|!=
|in
|not_in
-
Values
:beta
|supported
|deprecated
|retired
-
-
Attribute = PlatformName
:-
Operator
:=
|!=
|begins_with
|ends_with
|contains
|in
|not_in
-
-
Attribute = TierType
:-
Operator
:=
|!=
-
Values
:WebServer/Standard
|Worker/SQS/HTTP
-
Array size: limited to 10
SearchFilter
objects.Within each
SearchFilter
item, theValues
array is limited to 10 items.-
max_records(i32)
/set_max_records(Option<i32>)
:
required: falseThe maximum number of platform branch values returned in one call.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseFor a paginated request. Specify a token from a previous response page to retrieve the next response page. All other parameter values must be identical to the ones specified in the initial request.
If no
NextToken
is specified, the first page is retrieved.
- On success, responds with
ListPlatformBranchesOutput
with field(s):platform_branch_summary_list(Option<Vec::<PlatformBranchSummary>>)
:Summary information about the platform branches.
next_token(Option<String>)
:In a paginated request, if this value isn’t
null
, it’s the token that you can pass in a subsequent request to get the next response page.
- On failure, responds with
SdkError<ListPlatformBranchesError>
Source§impl Client
impl Client
Sourcepub fn list_platform_versions(&self) -> ListPlatformVersionsFluentBuilder
pub fn list_platform_versions(&self) -> ListPlatformVersionsFluentBuilder
Constructs a fluent builder for the ListPlatformVersions
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
filters(PlatformFilter)
/set_filters(Option<Vec::<PlatformFilter>>)
:
required: falseCriteria for restricting the resulting list of platform versions. The filter is interpreted as a logical conjunction (AND) of the separate
PlatformFilter
terms.max_records(i32)
/set_max_records(Option<i32>)
:
required: falseThe maximum number of platform version values returned in one call.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseFor a paginated request. Specify a token from a previous response page to retrieve the next response page. All other parameter values must be identical to the ones specified in the initial request.
If no
NextToken
is specified, the first page is retrieved.
- On success, responds with
ListPlatformVersionsOutput
with field(s):platform_summary_list(Option<Vec::<PlatformSummary>>)
:Summary information about the platform versions.
next_token(Option<String>)
:In a paginated request, if this value isn’t
null
, it’s the token that you can pass in a subsequent request to get the next response page.
- On failure, responds with
SdkError<ListPlatformVersionsError>
Source§impl Client
impl Client
Constructs a fluent builder for the ListTagsForResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the resouce for which a tag list is requested.
Must be the ARN of an Elastic Beanstalk resource.
- On success, responds with
ListTagsForResourceOutput
with field(s):resource_arn(Option<String>)
:The Amazon Resource Name (ARN) of the resource for which a tag list was requested.
resource_tags(Option<Vec::<Tag>>)
:A list of tag key-value pairs.
- On failure, responds with
SdkError<ListTagsForResourceError>
Source§impl Client
impl Client
Sourcepub fn rebuild_environment(&self) -> RebuildEnvironmentFluentBuilder
pub fn rebuild_environment(&self) -> RebuildEnvironmentFluentBuilder
Constructs a fluent builder for the RebuildEnvironment
operation.
- The fluent builder is configurable:
environment_id(impl Into<String>)
/set_environment_id(Option<String>)
:
required: falseThe ID of the environment to rebuild.
Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter
error.environment_name(impl Into<String>)
/set_environment_name(Option<String>)
:
required: falseThe name of the environment to rebuild.
Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter
error.
- On success, responds with
RebuildEnvironmentOutput
- On failure, responds with
SdkError<RebuildEnvironmentError>
Source§impl Client
impl Client
Sourcepub fn request_environment_info(&self) -> RequestEnvironmentInfoFluentBuilder
pub fn request_environment_info(&self) -> RequestEnvironmentInfoFluentBuilder
Constructs a fluent builder for the RequestEnvironmentInfo
operation.
- The fluent builder is configurable:
environment_id(impl Into<String>)
/set_environment_id(Option<String>)
:
required: falseThe ID of the environment of the requested data.
If no such environment is found,
RequestEnvironmentInfo
returns anInvalidParameterValue
error.Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter
error.environment_name(impl Into<String>)
/set_environment_name(Option<String>)
:
required: falseThe name of the environment of the requested data.
If no such environment is found,
RequestEnvironmentInfo
returns anInvalidParameterValue
error.Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter
error.info_type(EnvironmentInfoType)
/set_info_type(Option<EnvironmentInfoType>)
:
required: trueThe type of information to request.
- On success, responds with
RequestEnvironmentInfoOutput
- On failure, responds with
SdkError<RequestEnvironmentInfoError>
Source§impl Client
impl Client
Sourcepub fn restart_app_server(&self) -> RestartAppServerFluentBuilder
pub fn restart_app_server(&self) -> RestartAppServerFluentBuilder
Constructs a fluent builder for the RestartAppServer
operation.
- The fluent builder is configurable:
environment_id(impl Into<String>)
/set_environment_id(Option<String>)
:
required: falseThe ID of the environment to restart the server for.
Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter
error.environment_name(impl Into<String>)
/set_environment_name(Option<String>)
:
required: falseThe name of the environment to restart the server for.
Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter
error.
- On success, responds with
RestartAppServerOutput
- On failure, responds with
SdkError<RestartAppServerError>
Source§impl Client
impl Client
Sourcepub fn retrieve_environment_info(&self) -> RetrieveEnvironmentInfoFluentBuilder
pub fn retrieve_environment_info(&self) -> RetrieveEnvironmentInfoFluentBuilder
Constructs a fluent builder for the RetrieveEnvironmentInfo
operation.
- The fluent builder is configurable:
environment_id(impl Into<String>)
/set_environment_id(Option<String>)
:
required: falseThe 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.environment_name(impl Into<String>)
/set_environment_name(Option<String>)
:
required: falseThe 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.info_type(EnvironmentInfoType)
/set_info_type(Option<EnvironmentInfoType>)
:
required: trueThe type of information to retrieve.
- On success, responds with
RetrieveEnvironmentInfoOutput
with field(s):environment_info(Option<Vec::<EnvironmentInfoDescription>>)
:The
EnvironmentInfoDescription
of the environment.
- On failure, responds with
SdkError<RetrieveEnvironmentInfoError>
Source§impl Client
impl Client
Sourcepub fn swap_environment_cnames(&self) -> SwapEnvironmentCNAMEsFluentBuilder
pub fn swap_environment_cnames(&self) -> SwapEnvironmentCNAMEsFluentBuilder
Constructs a fluent builder for the SwapEnvironmentCNAMEs
operation.
- The fluent builder is configurable:
source_environment_id(impl Into<String>)
/set_source_environment_id(Option<String>)
:
required: falseThe ID of the source environment.
Condition: You must specify at least the
SourceEnvironmentID
or theSourceEnvironmentName
. You may also specify both. If you specify theSourceEnvironmentId
, you must specify theDestinationEnvironmentId
.source_environment_name(impl Into<String>)
/set_source_environment_name(Option<String>)
:
required: falseThe name of the source environment.
Condition: You must specify at least the
SourceEnvironmentID
or theSourceEnvironmentName
. You may also specify both. If you specify theSourceEnvironmentName
, you must specify theDestinationEnvironmentName
.destination_environment_id(impl Into<String>)
/set_destination_environment_id(Option<String>)
:
required: falseThe ID of the destination environment.
Condition: You must specify at least the
DestinationEnvironmentID
or theDestinationEnvironmentName
. You may also specify both. You must specify theSourceEnvironmentId
with theDestinationEnvironmentId
.destination_environment_name(impl Into<String>)
/set_destination_environment_name(Option<String>)
:
required: falseThe name of the destination environment.
Condition: You must specify at least the
DestinationEnvironmentID
or theDestinationEnvironmentName
. You may also specify both. You must specify theSourceEnvironmentName
with theDestinationEnvironmentName
.
- On success, responds with
SwapEnvironmentCnamEsOutput
- On failure, responds with
SdkError<SwapEnvironmentCNAMEsError>
Source§impl Client
impl Client
Sourcepub fn terminate_environment(&self) -> TerminateEnvironmentFluentBuilder
pub fn terminate_environment(&self) -> TerminateEnvironmentFluentBuilder
Constructs a fluent builder for the TerminateEnvironment
operation.
- The fluent builder is configurable:
environment_id(impl Into<String>)
/set_environment_id(Option<String>)
:
required: falseThe ID of the environment to terminate.
Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter
error.environment_name(impl Into<String>)
/set_environment_name(Option<String>)
:
required: falseThe name of the environment to terminate.
Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter
error.terminate_resources(bool)
/set_terminate_resources(Option<bool>)
:
required: falseIndicates whether the associated AWS resources should shut down when the environment is terminated:
-
true
: The specified environment as well as the associated AWS resources, such as Auto Scaling group and LoadBalancer, are terminated. -
false
: AWS Elastic Beanstalk resource management is removed from the environment, but the AWS resources continue to operate.
For more information, see the AWS Elastic Beanstalk User Guide.
Default:
true
Valid Values:
true
|false
-
force_terminate(bool)
/set_force_terminate(Option<bool>)
:
required: falseTerminates the target environment even if another environment in the same group is dependent on it.
- On success, responds with
TerminateEnvironmentOutput
with field(s):environment_name(Option<String>)
:The name of this environment.
environment_id(Option<String>)
:The ID of this environment.
application_name(Option<String>)
:The name of the application associated with this environment.
version_label(Option<String>)
:The application version deployed in this environment.
solution_stack_name(Option<String>)
:The name of the
SolutionStack
deployed with this environment.platform_arn(Option<String>)
:The ARN of the platform version.
template_name(Option<String>)
:The name of the configuration template used to originally launch this environment.
description(Option<String>)
:Describes this environment.
endpoint_url(Option<String>)
:For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.
cname(Option<String>)
:The URL to the CNAME for this environment.
date_created(Option<DateTime>)
:The creation date for this environment.
date_updated(Option<DateTime>)
:The last modified date for this environment.
status(Option<EnvironmentStatus>)
: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.
-
abortable_operation_in_progress(Option<bool>)
: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.health(Option<EnvironmentHealth>)
: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 anUpdateEnvironment
orRestartEnvironment
request.
Default:
Grey
-
health_status(Option<EnvironmentHealthStatus>)
:Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses.
resources(Option<EnvironmentResourcesDescription>)
:The description of the AWS resources used by this environment.
tier(Option<EnvironmentTier>)
:Describes the current tier of this environment.
environment_links(Option<Vec::<EnvironmentLink>>)
:A list of links to other environments in the same group.
environment_arn(Option<String>)
:The environment’s Amazon Resource Name (ARN), which can be used in other API requests that require an ARN.
operations_role(Option<String>)
:The Amazon Resource Name (ARN) of the environment’s operations role. For more information, see Operations roles in the AWS Elastic Beanstalk Developer Guide.
- On failure, responds with
SdkError<TerminateEnvironmentError>
Source§impl Client
impl Client
Sourcepub fn update_application(&self) -> UpdateApplicationFluentBuilder
pub fn update_application(&self) -> UpdateApplicationFluentBuilder
Constructs a fluent builder for the UpdateApplication
operation.
- The fluent builder is configurable:
application_name(impl Into<String>)
/set_application_name(Option<String>)
:
required: trueThe name of the application to update. If no such application is found,
UpdateApplication
returns anInvalidParameterValue
error.description(impl Into<String>)
/set_description(Option<String>)
:
required: falseA new description for the application.
Default: If not specified, AWS Elastic Beanstalk does not update the description.
- On success, responds with
UpdateApplicationOutput
with field(s):application(Option<ApplicationDescription>)
:The
ApplicationDescription
of the application.
- On failure, responds with
SdkError<UpdateApplicationError>
Source§impl Client
impl Client
Sourcepub fn update_application_resource_lifecycle(
&self,
) -> UpdateApplicationResourceLifecycleFluentBuilder
pub fn update_application_resource_lifecycle( &self, ) -> UpdateApplicationResourceLifecycleFluentBuilder
Constructs a fluent builder for the UpdateApplicationResourceLifecycle
operation.
- The fluent builder is configurable:
application_name(impl Into<String>)
/set_application_name(Option<String>)
:
required: trueThe name of the application.
resource_lifecycle_config(ApplicationResourceLifecycleConfig)
/set_resource_lifecycle_config(Option<ApplicationResourceLifecycleConfig>)
:
required: trueThe lifecycle configuration.
- On success, responds with
UpdateApplicationResourceLifecycleOutput
with field(s):application_name(Option<String>)
:The name of the application.
resource_lifecycle_config(Option<ApplicationResourceLifecycleConfig>)
:The lifecycle configuration.
- On failure, responds with
SdkError<UpdateApplicationResourceLifecycleError>
Source§impl Client
impl Client
Sourcepub fn update_application_version(
&self,
) -> UpdateApplicationVersionFluentBuilder
pub fn update_application_version( &self, ) -> UpdateApplicationVersionFluentBuilder
Constructs a fluent builder for the UpdateApplicationVersion
operation.
- The fluent builder is configurable:
application_name(impl Into<String>)
/set_application_name(Option<String>)
:
required: trueThe name of the application associated with this version.
If no application is found with this name,
UpdateApplication
returns anInvalidParameterValue
error.version_label(impl Into<String>)
/set_version_label(Option<String>)
:
required: trueThe name of the version to update.
If no application version is found with this label,
UpdateApplication
returns anInvalidParameterValue
error.description(impl Into<String>)
/set_description(Option<String>)
:
required: falseA new description for this version.
- On success, responds with
UpdateApplicationVersionOutput
with field(s):application_version(Option<ApplicationVersionDescription>)
:The
ApplicationVersionDescription
of the application version.
- On failure, responds with
SdkError<UpdateApplicationVersionError>
Source§impl Client
impl Client
Sourcepub fn update_configuration_template(
&self,
) -> UpdateConfigurationTemplateFluentBuilder
pub fn update_configuration_template( &self, ) -> UpdateConfigurationTemplateFluentBuilder
Constructs a fluent builder for the UpdateConfigurationTemplate
operation.
- The fluent builder is configurable:
application_name(impl Into<String>)
/set_application_name(Option<String>)
:
required: trueThe name of the application associated with the configuration template to update.
If no application is found with this name,
UpdateConfigurationTemplate
returns anInvalidParameterValue
error.template_name(impl Into<String>)
/set_template_name(Option<String>)
:
required: trueThe name of the configuration template to update.
If no configuration template is found with this name,
UpdateConfigurationTemplate
returns anInvalidParameterValue
error.description(impl Into<String>)
/set_description(Option<String>)
:
required: falseA new description for the configuration.
option_settings(ConfigurationOptionSetting)
/set_option_settings(Option<Vec::<ConfigurationOptionSetting>>)
:
required: falseA list of configuration option settings to update with the new specified option value.
options_to_remove(OptionSpecification)
/set_options_to_remove(Option<Vec::<OptionSpecification>>)
:
required: falseA list of configuration options to remove from the configuration set.
Constraint: You can remove only
UserDefined
configuration options.
- On success, responds with
UpdateConfigurationTemplateOutput
with field(s):solution_stack_name(Option<String>)
:The name of the solution stack this configuration set uses.
platform_arn(Option<String>)
:The ARN of the platform version.
application_name(Option<String>)
:The name of the application associated with this configuration set.
template_name(Option<String>)
:If not
null
, the name of the configuration template for this configuration set.description(Option<String>)
:Describes this configuration set.
environment_name(Option<String>)
:If not
null
, the name of the environment for this configuration set.deployment_status(Option<ConfigurationDeploymentStatus>)
:If this configuration set is associated with an environment, the
DeploymentStatus
parameter indicates the deployment status of this configuration set:-
null
: This configuration is not associated with a running environment. -
pending
: This is a draft configuration that is not deployed to the associated environment but is in the process of deploying. -
deployed
: This is the configuration that is currently deployed to the associated running environment. -
failed
: This is a draft configuration that failed to successfully deploy.
-
date_created(Option<DateTime>)
:The date (in UTC time) when this configuration set was created.
date_updated(Option<DateTime>)
:The date (in UTC time) when this configuration set was last modified.
option_settings(Option<Vec::<ConfigurationOptionSetting>>)
:A list of the configuration options and their values in this configuration set.
- On failure, responds with
SdkError<UpdateConfigurationTemplateError>
Source§impl Client
impl Client
Sourcepub fn update_environment(&self) -> UpdateEnvironmentFluentBuilder
pub fn update_environment(&self) -> UpdateEnvironmentFluentBuilder
Constructs a fluent builder for the UpdateEnvironment
operation.
- The fluent builder is configurable:
application_name(impl Into<String>)
/set_application_name(Option<String>)
:
required: falseThe name of the application with which the environment is associated.
environment_id(impl Into<String>)
/set_environment_id(Option<String>)
:
required: falseThe ID of the environment to update.
If no environment with this ID exists, AWS Elastic Beanstalk 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.environment_name(impl Into<String>)
/set_environment_name(Option<String>)
:
required: falseThe name of the environment to update. If no environment with this name exists, AWS Elastic Beanstalk 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.group_name(impl Into<String>)
/set_group_name(Option<String>)
:
required: falseThe name of the group to which the target environment belongs. Specify a group name only if the environment’s name is specified in an environment manifest and not with the environment name or environment ID parameters. See Environment Manifest (env.yaml) for details.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseIf this parameter is specified, AWS Elastic Beanstalk updates the description of this environment.
tier(EnvironmentTier)
/set_tier(Option<EnvironmentTier>)
:
required: falseThis specifies the tier to use to update the environment.
Condition: At this time, if you change the tier version, name, or type, AWS Elastic Beanstalk returns
InvalidParameterValue
error.version_label(impl Into<String>)
/set_version_label(Option<String>)
:
required: falseIf this parameter is specified, AWS Elastic Beanstalk deploys the named application version to the environment. If no such application version is found, returns an
InvalidParameterValue
error.template_name(impl Into<String>)
/set_template_name(Option<String>)
:
required: falseIf this parameter is specified, AWS Elastic Beanstalk deploys this configuration template to the environment. If no such configuration template is found, AWS Elastic Beanstalk returns an
InvalidParameterValue
error.solution_stack_name(impl Into<String>)
/set_solution_stack_name(Option<String>)
:
required: falseThis specifies the platform version that the environment will run after the environment is updated.
platform_arn(impl Into<String>)
/set_platform_arn(Option<String>)
:
required: falseThe ARN of the platform, if used.
option_settings(ConfigurationOptionSetting)
/set_option_settings(Option<Vec::<ConfigurationOptionSetting>>)
:
required: falseIf specified, AWS Elastic Beanstalk updates the configuration set associated with the running environment and sets the specified configuration options to the requested value.
options_to_remove(OptionSpecification)
/set_options_to_remove(Option<Vec::<OptionSpecification>>)
:
required: falseA list of custom user-defined configuration options to remove from the configuration set for this environment.
- On success, responds with
UpdateEnvironmentOutput
with field(s):environment_name(Option<String>)
:The name of this environment.
environment_id(Option<String>)
:The ID of this environment.
application_name(Option<String>)
:The name of the application associated with this environment.
version_label(Option<String>)
:The application version deployed in this environment.
solution_stack_name(Option<String>)
:The name of the
SolutionStack
deployed with this environment.platform_arn(Option<String>)
:The ARN of the platform version.
template_name(Option<String>)
:The name of the configuration template used to originally launch this environment.
description(Option<String>)
:Describes this environment.
endpoint_url(Option<String>)
:For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.
cname(Option<String>)
:The URL to the CNAME for this environment.
date_created(Option<DateTime>)
:The creation date for this environment.
date_updated(Option<DateTime>)
:The last modified date for this environment.
status(Option<EnvironmentStatus>)
: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.
-
abortable_operation_in_progress(Option<bool>)
: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.health(Option<EnvironmentHealth>)
: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 anUpdateEnvironment
orRestartEnvironment
request.
Default:
Grey
-
health_status(Option<EnvironmentHealthStatus>)
:Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses.
resources(Option<EnvironmentResourcesDescription>)
:The description of the AWS resources used by this environment.
tier(Option<EnvironmentTier>)
:Describes the current tier of this environment.
environment_links(Option<Vec::<EnvironmentLink>>)
:A list of links to other environments in the same group.
environment_arn(Option<String>)
:The environment’s Amazon Resource Name (ARN), which can be used in other API requests that require an ARN.
operations_role(Option<String>)
:The Amazon Resource Name (ARN) of the environment’s operations role. For more information, see Operations roles in the AWS Elastic Beanstalk Developer Guide.
- On failure, responds with
SdkError<UpdateEnvironmentError>
Source§impl Client
impl Client
Constructs a fluent builder for the UpdateTagsForResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the resouce to be updated.
Must be the ARN of an Elastic Beanstalk resource.
tags_to_add(Tag)
/set_tags_to_add(Option<Vec::<Tag>>)
:
required: falseA list of tags to add or update. If a key of an existing tag is added, the tag’s value is updated.
Specify at least one of these parameters:
TagsToAdd
,TagsToRemove
.tags_to_remove(impl Into<String>)
/set_tags_to_remove(Option<Vec::<String>>)
:
required: falseA list of tag keys to remove. If a tag key doesn’t exist, it is silently ignored.
Specify at least one of these parameters:
TagsToAdd
,TagsToRemove
.
- On success, responds with
UpdateTagsForResourceOutput
- On failure, responds with
SdkError<UpdateTagsForResourceError>
Source§impl Client
impl Client
Sourcepub fn validate_configuration_settings(
&self,
) -> ValidateConfigurationSettingsFluentBuilder
pub fn validate_configuration_settings( &self, ) -> ValidateConfigurationSettingsFluentBuilder
Constructs a fluent builder for the ValidateConfigurationSettings
operation.
- The fluent builder is configurable:
application_name(impl Into<String>)
/set_application_name(Option<String>)
:
required: trueThe name of the application that the configuration template or environment belongs to.
template_name(impl Into<String>)
/set_template_name(Option<String>)
:
required: falseThe name of the configuration template to validate the settings against.
Condition: You cannot specify both this and an environment name.
environment_name(impl Into<String>)
/set_environment_name(Option<String>)
:
required: falseThe name of the environment to validate the settings against.
Condition: You cannot specify both this and a configuration template name.
option_settings(ConfigurationOptionSetting)
/set_option_settings(Option<Vec::<ConfigurationOptionSetting>>)
:
required: trueA list of the options and desired values to evaluate.
- On success, responds with
ValidateConfigurationSettingsOutput
with field(s):messages(Option<Vec::<ValidationMessage>>)
:A list of
ValidationMessage
.
- On failure, responds with
SdkError<ValidateConfigurationSettingsError>
Source§impl Client
impl Client
Sourcepub fn from_conf(conf: Config) -> Self
pub fn from_conf(conf: Config) -> Self
Creates a new client from the service Config
.
§Panics
This method will panic in the following cases:
- Retries or timeouts are enabled without a
sleep_impl
configured. - Identity caching is enabled without a
sleep_impl
andtime_source
configured. - No
behavior_version
is provided.
The panic message for each of these will have instructions on how to resolve them.
Source§impl Client
impl Client
Sourcepub fn new(sdk_config: &SdkConfig) -> Self
pub fn new(sdk_config: &SdkConfig) -> Self
Creates a new client from an SDK Config.
§Panics
- This method will panic if the
sdk_config
is missing an async sleep implementation. If you experience this panic, set thesleep_impl
on the Config passed into this function to fix it. - This method will panic if the
sdk_config
is missing an HTTP connector. If you experience this panic, set thehttp_connector
on the Config passed into this function to fix it. - This method will panic if no
BehaviorVersion
is provided. If you experience this panic, setbehavior_version
on the Config or enable thebehavior-version-latest
Cargo feature.
Trait Implementations§
Source§impl Waiters for Client
impl Waiters for Client
Source§fn wait_until_environment_exists(&self) -> EnvironmentExistsFluentBuilder
fn wait_until_environment_exists(&self) -> EnvironmentExistsFluentBuilder
environment_exists
Source§fn wait_until_environment_terminated(
&self,
) -> EnvironmentTerminatedFluentBuilder
fn wait_until_environment_terminated( &self, ) -> EnvironmentTerminatedFluentBuilder
environment_terminated
Source§fn wait_until_environment_updated(&self) -> EnvironmentUpdatedFluentBuilder
fn wait_until_environment_updated(&self) -> EnvironmentUpdatedFluentBuilder
environment_updated
Auto Trait Implementations§
impl Freeze for Client
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl !UnwindSafe for Client
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);