Struct aws_sdk_appconfig::Client
source · pub struct Client { /* private fields */ }Expand description
Client for Amazon AppConfig
Client for invoking operations on Amazon AppConfig. Each operation on Amazon AppConfig 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_appconfig::Client::new(&config);Occasionally, SDKs may have additional service-specific that can be set on the Config that
is absent from SdkConfig, or slightly different settings for a specific client may be desired.
The Config 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_appconfig::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 CreateApplication operation has
a Client::create_application, 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.create_application()
.name("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.
Implementations§
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:
name(impl Into<String>)/set_name(Option<String>):A name for the application.
description(impl Into<String>)/set_description(Option<String>):A description of the application.
tags(impl Into<String>, impl Into<String>)/set_tags(Option<HashMap<String, String>>):Metadata to assign to the application. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define.
- On success, responds with
CreateApplicationOutputwith field(s):id(Option<String>):The application ID.
name(Option<String>):The application name.
description(Option<String>):The description of the application.
- On failure, responds with
SdkError<CreateApplicationError>
source§impl Client
impl Client
sourcepub fn create_configuration_profile(
&self
) -> CreateConfigurationProfileFluentBuilder
pub fn create_configuration_profile( &self ) -> CreateConfigurationProfileFluentBuilder
Constructs a fluent builder for the CreateConfigurationProfile operation.
- The fluent builder is configurable:
application_id(impl Into<String>)/set_application_id(Option<String>):The application ID.
name(impl Into<String>)/set_name(Option<String>):A name for the configuration profile.
description(impl Into<String>)/set_description(Option<String>):A description of the configuration profile.
location_uri(impl Into<String>)/set_location_uri(Option<String>):A URI to locate the configuration. You can specify the following:
-
For the AppConfig hosted configuration store and for feature flags, specify
hosted. -
For an Amazon Web Services Systems Manager Parameter Store parameter, specify either the parameter name in the format
ssm-parameter://or the ARN. -
For an Secrets Manager secret, specify the URI in the following format:
secrets-manager://. -
For an Amazon S3 object, specify the URI in the following format:
s3://. Here is an example:/ s3://my-bucket/my-app/us-east-1/my-config.json -
For an SSM document, specify either the document name in the format
ssm-document://or the Amazon Resource Name (ARN).
-
retrieval_role_arn(impl Into<String>)/set_retrieval_role_arn(Option<String>):The ARN of an IAM role with permission to access the configuration at the specified
LocationUri.A retrieval role ARN is not required for configurations stored in the AppConfig hosted configuration store. It is required for all other sources that store your configuration.
validators(Validator)/set_validators(Option<Vec<Validator>>):A list of methods for validating the configuration.
tags(impl Into<String>, impl Into<String>)/set_tags(Option<HashMap<String, String>>):Metadata to assign to the configuration profile. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define.
r#type(impl Into<String>)/set_type(Option<String>):The type of configurations contained in the profile. AppConfig supports
feature flagsandfreeformconfigurations. We recommend you create feature flag configurations to enable or disable new features and freeform configurations to distribute configurations to an application. When calling this API, enter one of the following values forType:AWS.AppConfig.FeatureFlagsAWS.Freeform
- On success, responds with
CreateConfigurationProfileOutputwith field(s):application_id(Option<String>):The application ID.
id(Option<String>):The configuration profile ID.
name(Option<String>):The name of the configuration profile.
description(Option<String>):The configuration profile description.
location_uri(Option<String>):The URI location of the configuration.
retrieval_role_arn(Option<String>):The ARN of an IAM role with permission to access the configuration at the specified
LocationUri.validators(Option<Vec<Validator>>):A list of methods for validating the configuration.
r#type(Option<String>):The type of configurations contained in the profile. AppConfig supports
feature flagsandfreeformconfigurations. We recommend you create feature flag configurations to enable or disable new features and freeform configurations to distribute configurations to an application. When calling this API, enter one of the following values forType:AWS.AppConfig.FeatureFlagsAWS.Freeform
- On failure, responds with
SdkError<CreateConfigurationProfileError>
source§impl Client
impl Client
sourcepub fn create_deployment_strategy(
&self
) -> CreateDeploymentStrategyFluentBuilder
pub fn create_deployment_strategy( &self ) -> CreateDeploymentStrategyFluentBuilder
Constructs a fluent builder for the CreateDeploymentStrategy operation.
- The fluent builder is configurable:
name(impl Into<String>)/set_name(Option<String>):A name for the deployment strategy.
description(impl Into<String>)/set_description(Option<String>):A description of the deployment strategy.
deployment_duration_in_minutes(i32)/set_deployment_duration_in_minutes(Option<i32>):Total amount of time for a deployment to last.
final_bake_time_in_minutes(i32)/set_final_bake_time_in_minutes(Option<i32>):Specifies the amount of time AppConfig monitors for Amazon CloudWatch alarms after the configuration has been deployed to 100% of its targets, before considering the deployment to be complete. If an alarm is triggered during this time, AppConfig rolls back the deployment. You must configure permissions for AppConfig to roll back based on CloudWatch alarms. For more information, see Configuring permissions for rollback based on Amazon CloudWatch alarms in the AppConfig User Guide.
growth_factor(f32)/set_growth_factor(Option<f32>):The percentage of targets to receive a deployed configuration during each interval.
growth_type(GrowthType)/set_growth_type(Option<GrowthType>):The algorithm used to define how percentage grows over time. AppConfig supports the following growth types:
Linear: For this type, AppConfig processes the deployment by dividing the total number of targets by the value specified for
Step percentage. For example, a linear deployment that uses aStep percentageof 10 deploys the configuration to 10 percent of the hosts. After those deployments are complete, the system deploys the configuration to the next 10 percent. This continues until 100% of the targets have successfully received the configuration.Exponential: For this type, AppConfig processes the deployment exponentially using the following formula:
G*(2^N). In this formula,Gis the growth factor specified by the user andNis the number of steps until the configuration is deployed to all targets. For example, if you specify a growth factor of 2, then the system rolls out the configuration as follows:2*(2^0)2*(2^1)2*(2^2)Expressed numerically, the deployment rolls out as follows: 2% of the targets, 4% of the targets, 8% of the targets, and continues until the configuration has been deployed to all targets.
replicate_to(ReplicateTo)/set_replicate_to(Option<ReplicateTo>):Save the deployment strategy to a Systems Manager (SSM) document.
tags(impl Into<String>, impl Into<String>)/set_tags(Option<HashMap<String, String>>):Metadata to assign to the deployment strategy. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define.
- On success, responds with
CreateDeploymentStrategyOutputwith field(s):id(Option<String>):The deployment strategy ID.
name(Option<String>):The name of the deployment strategy.
description(Option<String>):The description of the deployment strategy.
deployment_duration_in_minutes(i32):Total amount of time the deployment lasted.
growth_type(Option<GrowthType>):The algorithm used to define how percentage grew over time.
growth_factor(f32):The percentage of targets that received a deployed configuration during each interval.
final_bake_time_in_minutes(i32):The amount of time that AppConfig monitored for alarms before considering the deployment to be complete and no longer eligible for automatic rollback.
replicate_to(Option<ReplicateTo>):Save the deployment strategy to a Systems Manager (SSM) document.
- On failure, responds with
SdkError<CreateDeploymentStrategyError>
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_id(impl Into<String>)/set_application_id(Option<String>):The application ID.
name(impl Into<String>)/set_name(Option<String>):A name for the environment.
description(impl Into<String>)/set_description(Option<String>):A description of the environment.
monitors(Monitor)/set_monitors(Option<Vec<Monitor>>):Amazon CloudWatch alarms to monitor during the deployment process.
tags(impl Into<String>, impl Into<String>)/set_tags(Option<HashMap<String, String>>):Metadata to assign to the environment. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define.
- On success, responds with
CreateEnvironmentOutputwith field(s):application_id(Option<String>):The application ID.
id(Option<String>):The environment ID.
name(Option<String>):The name of the environment.
description(Option<String>):The description of the environment.
state(Option<EnvironmentState>):The state of the environment. An environment can be in one of the following states:
READY_FOR_DEPLOYMENT,DEPLOYING,ROLLING_BACK, orROLLED_BACKmonitors(Option<Vec<Monitor>>):Amazon CloudWatch alarms monitored during the deployment.
- On failure, responds with
SdkError<CreateEnvironmentError>
source§impl Client
impl Client
sourcepub fn create_extension(&self) -> CreateExtensionFluentBuilder
pub fn create_extension(&self) -> CreateExtensionFluentBuilder
Constructs a fluent builder for the CreateExtension operation.
- The fluent builder is configurable:
name(impl Into<String>)/set_name(Option<String>):A name for the extension. Each extension name in your account must be unique. Extension versions use the same name.
description(impl Into<String>)/set_description(Option<String>):Information about the extension.
actions(ActionPoint, Vec<Action>)/set_actions(Option<HashMap<ActionPoint, Vec<Action>>>):The actions defined in the extension.
parameters(impl Into<String>, Parameter)/set_parameters(Option<HashMap<String, Parameter>>):The parameters accepted by the extension. You specify parameter values when you associate the extension to an AppConfig resource by using the
CreateExtensionAssociationAPI action. For Lambda extension actions, these parameters are included in the Lambda request object.tags(impl Into<String>, impl Into<String>)/set_tags(Option<HashMap<String, String>>):Adds one or more tags for the specified extension. Tags are metadata that help you categorize resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define.
latest_version_number(i32)/set_latest_version_number(Option<i32>):You can omit this field when you create an extension. When you create a new version, specify the most recent current version number. For example, you create version 3, enter 2 for this field.
- On success, responds with
CreateExtensionOutputwith field(s):id(Option<String>):The system-generated ID of the extension.
name(Option<String>):The extension name.
version_number(i32):The extension version number.
arn(Option<String>):The system-generated Amazon Resource Name (ARN) for the extension.
description(Option<String>):Information about the extension.
actions(Option<HashMap<ActionPoint, Vec<Action>>>):The actions defined in the extension.
parameters(Option<HashMap<String, Parameter>>):The parameters accepted by the extension. You specify parameter values when you associate the extension to an AppConfig resource by using the
CreateExtensionAssociationAPI action. For Lambda extension actions, these parameters are included in the Lambda request object.
- On failure, responds with
SdkError<CreateExtensionError>
source§impl Client
impl Client
sourcepub fn create_extension_association(
&self
) -> CreateExtensionAssociationFluentBuilder
pub fn create_extension_association( &self ) -> CreateExtensionAssociationFluentBuilder
Constructs a fluent builder for the CreateExtensionAssociation operation.
- The fluent builder is configurable:
extension_identifier(impl Into<String>)/set_extension_identifier(Option<String>):The name, the ID, or the Amazon Resource Name (ARN) of the extension.
extension_version_number(i32)/set_extension_version_number(Option<i32>):The version number of the extension. If not specified, AppConfig uses the maximum version of the extension.
resource_identifier(impl Into<String>)/set_resource_identifier(Option<String>):The ARN of an application, configuration profile, or environment.
parameters(impl Into<String>, impl Into<String>)/set_parameters(Option<HashMap<String, String>>):The parameter names and values defined in the extensions. Extension parameters marked
Requiredmust be entered for this field.tags(impl Into<String>, impl Into<String>)/set_tags(Option<HashMap<String, String>>):Adds one or more tags for the specified extension association. Tags are metadata that help you categorize resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define.
- On success, responds with
CreateExtensionAssociationOutputwith field(s):id(Option<String>):The system-generated ID for the association.
extension_arn(Option<String>):The ARN of the extension defined in the association.
resource_arn(Option<String>):The ARNs of applications, configuration profiles, or environments defined in the association.
arn(Option<String>):The system-generated Amazon Resource Name (ARN) for the extension.
parameters(Option<HashMap<String, String>>):The parameter names and values defined in the association.
extension_version_number(i32):The version number for the extension defined in the association.
- On failure, responds with
SdkError<CreateExtensionAssociationError>
source§impl Client
impl Client
sourcepub fn create_hosted_configuration_version(
&self
) -> CreateHostedConfigurationVersionFluentBuilder
pub fn create_hosted_configuration_version( &self ) -> CreateHostedConfigurationVersionFluentBuilder
Constructs a fluent builder for the CreateHostedConfigurationVersion operation.
- The fluent builder is configurable:
application_id(impl Into<String>)/set_application_id(Option<String>):The application ID.
configuration_profile_id(impl Into<String>)/set_configuration_profile_id(Option<String>):The configuration profile ID.
description(impl Into<String>)/set_description(Option<String>):A description of the configuration.
content(Blob)/set_content(Option<Blob>):The content of the configuration or the configuration data.
content_type(impl Into<String>)/set_content_type(Option<String>):A standard MIME type describing the format of the configuration content. For more information, see Content-Type.
latest_version_number(i32)/set_latest_version_number(Option<i32>):An optional locking token used to prevent race conditions from overwriting configuration updates when creating a new version. To ensure your data is not overwritten when creating multiple hosted configuration versions in rapid succession, specify the version number of the latest hosted configuration version.
version_label(impl Into<String>)/set_version_label(Option<String>):An optional, user-defined label for the AppConfig hosted configuration version. This value must contain at least one non-numeric character. For example, “v2.2.0”.
- On success, responds with
CreateHostedConfigurationVersionOutputwith field(s):application_id(Option<String>):The application ID.
configuration_profile_id(Option<String>):The configuration profile ID.
version_number(i32):The configuration version.
description(Option<String>):A description of the configuration.
content(Option<Blob>):The content of the configuration or the configuration data.
content_type(Option<String>):A standard MIME type describing the format of the configuration content. For more information, see Content-Type.
version_label(Option<String>):A user-defined label for an AppConfig hosted configuration version.
- On failure, responds with
SdkError<CreateHostedConfigurationVersionError>
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_id(impl Into<String>)/set_application_id(Option<String>):The ID of the application to delete.
- On success, responds with
DeleteApplicationOutput - On failure, responds with
SdkError<DeleteApplicationError>
source§impl Client
impl Client
sourcepub fn delete_configuration_profile(
&self
) -> DeleteConfigurationProfileFluentBuilder
pub fn delete_configuration_profile( &self ) -> DeleteConfigurationProfileFluentBuilder
Constructs a fluent builder for the DeleteConfigurationProfile operation.
- The fluent builder is configurable:
application_id(impl Into<String>)/set_application_id(Option<String>):The application ID that includes the configuration profile you want to delete.
configuration_profile_id(impl Into<String>)/set_configuration_profile_id(Option<String>):The ID of the configuration profile you want to delete.
- On success, responds with
DeleteConfigurationProfileOutput - On failure, responds with
SdkError<DeleteConfigurationProfileError>
source§impl Client
impl Client
sourcepub fn delete_deployment_strategy(
&self
) -> DeleteDeploymentStrategyFluentBuilder
pub fn delete_deployment_strategy( &self ) -> DeleteDeploymentStrategyFluentBuilder
Constructs a fluent builder for the DeleteDeploymentStrategy operation.
- The fluent builder is configurable:
deployment_strategy_id(impl Into<String>)/set_deployment_strategy_id(Option<String>):The ID of the deployment strategy you want to delete.
- On success, responds with
DeleteDeploymentStrategyOutput - On failure, responds with
SdkError<DeleteDeploymentStrategyError>
source§impl Client
impl Client
sourcepub fn delete_environment(&self) -> DeleteEnvironmentFluentBuilder
pub fn delete_environment(&self) -> DeleteEnvironmentFluentBuilder
Constructs a fluent builder for the DeleteEnvironment operation.
- The fluent builder is configurable:
application_id(impl Into<String>)/set_application_id(Option<String>):The application ID that includes the environment that you want to delete.
environment_id(impl Into<String>)/set_environment_id(Option<String>):The ID of the environment that you want to delete.
- On success, responds with
DeleteEnvironmentOutput - On failure, responds with
SdkError<DeleteEnvironmentError>
source§impl Client
impl Client
sourcepub fn delete_extension(&self) -> DeleteExtensionFluentBuilder
pub fn delete_extension(&self) -> DeleteExtensionFluentBuilder
Constructs a fluent builder for the DeleteExtension operation.
- The fluent builder is configurable:
extension_identifier(impl Into<String>)/set_extension_identifier(Option<String>):The name, ID, or Amazon Resource Name (ARN) of the extension you want to delete.
version_number(i32)/set_version_number(Option<i32>):A specific version of an extension to delete. If omitted, the highest version is deleted.
- On success, responds with
DeleteExtensionOutput - On failure, responds with
SdkError<DeleteExtensionError>
source§impl Client
impl Client
sourcepub fn delete_extension_association(
&self
) -> DeleteExtensionAssociationFluentBuilder
pub fn delete_extension_association( &self ) -> DeleteExtensionAssociationFluentBuilder
Constructs a fluent builder for the DeleteExtensionAssociation operation.
- The fluent builder is configurable:
extension_association_id(impl Into<String>)/set_extension_association_id(Option<String>):The ID of the extension association to delete.
- On success, responds with
DeleteExtensionAssociationOutput - On failure, responds with
SdkError<DeleteExtensionAssociationError>
source§impl Client
impl Client
sourcepub fn delete_hosted_configuration_version(
&self
) -> DeleteHostedConfigurationVersionFluentBuilder
pub fn delete_hosted_configuration_version( &self ) -> DeleteHostedConfigurationVersionFluentBuilder
Constructs a fluent builder for the DeleteHostedConfigurationVersion operation.
- The fluent builder is configurable:
application_id(impl Into<String>)/set_application_id(Option<String>):The application ID.
configuration_profile_id(impl Into<String>)/set_configuration_profile_id(Option<String>):The configuration profile ID.
version_number(i32)/set_version_number(Option<i32>):The versions number to delete.
- On success, responds with
DeleteHostedConfigurationVersionOutput - On failure, responds with
SdkError<DeleteHostedConfigurationVersionError>
source§impl Client
impl Client
sourcepub fn get_application(&self) -> GetApplicationFluentBuilder
pub fn get_application(&self) -> GetApplicationFluentBuilder
Constructs a fluent builder for the GetApplication operation.
- The fluent builder is configurable:
application_id(impl Into<String>)/set_application_id(Option<String>):The ID of the application you want to get.
- On success, responds with
GetApplicationOutputwith field(s):id(Option<String>):The application ID.
name(Option<String>):The application name.
description(Option<String>):The description of the application.
- On failure, responds with
SdkError<GetApplicationError>
source§impl Client
impl Client
sourcepub fn get_configuration(&self) -> GetConfigurationFluentBuilder
👎Deprecated: This API has been deprecated in favor of the GetLatestConfiguration API used in conjunction with StartConfigurationSession.
pub fn get_configuration(&self) -> GetConfigurationFluentBuilder
Constructs a fluent builder for the GetConfiguration operation.
- The fluent builder is configurable:
application(impl Into<String>)/set_application(Option<String>):The application to get. Specify either the application name or the application ID.
environment(impl Into<String>)/set_environment(Option<String>):The environment to get. Specify either the environment name or the environment ID.
configuration(impl Into<String>)/set_configuration(Option<String>):The configuration to get. Specify either the configuration name or the configuration ID.
client_id(impl Into<String>)/set_client_id(Option<String>):The clientId parameter in the following command is a unique, user-specified ID to identify the client for the configuration. This ID enables AppConfig to deploy the configuration in intervals, as defined in the deployment strategy.
client_configuration_version(impl Into<String>)/set_client_configuration_version(Option<String>):The configuration version returned in the most recent
GetConfigurationresponse.AppConfig uses the value of the
ClientConfigurationVersionparameter to identify the configuration version on your clients. If you don’t sendClientConfigurationVersionwith each call toGetConfiguration, your clients receive the current configuration. You are charged each time your clients receive a configuration.To avoid excess charges, we recommend you use the StartConfigurationSession and GetLatestConfiguration APIs, which track the client configuration version on your behalf. If you choose to continue using
GetConfiguration, we recommend that you include theClientConfigurationVersionvalue with every call toGetConfiguration. The value to use forClientConfigurationVersioncomes from theConfigurationVersionattribute returned byGetConfigurationwhen there is new or updated data, and should be saved for subsequent calls toGetConfiguration.For more information about working with configurations, see Retrieving the Configuration in the AppConfig User Guide.
- On success, responds with
GetConfigurationOutputwith field(s):content(Option<Blob>):The content of the configuration or the configuration data.
The
Contentattribute only contains data if the system finds new or updated configuration data. If there is no new or updated data andClientConfigurationVersionmatches the version of the current configuration, AppConfig returns a204 No ContentHTTP response code and theContentvalue will be empty.configuration_version(Option<String>):The configuration version.
content_type(Option<String>):A standard MIME type describing the format of the configuration content. For more information, see Content-Type.
- On failure, responds with
SdkError<GetConfigurationError>
source§impl Client
impl Client
sourcepub fn get_configuration_profile(&self) -> GetConfigurationProfileFluentBuilder
pub fn get_configuration_profile(&self) -> GetConfigurationProfileFluentBuilder
Constructs a fluent builder for the GetConfigurationProfile operation.
- The fluent builder is configurable:
application_id(impl Into<String>)/set_application_id(Option<String>):The ID of the application that includes the configuration profile you want to get.
configuration_profile_id(impl Into<String>)/set_configuration_profile_id(Option<String>):The ID of the configuration profile that you want to get.
- On success, responds with
GetConfigurationProfileOutputwith field(s):application_id(Option<String>):The application ID.
id(Option<String>):The configuration profile ID.
name(Option<String>):The name of the configuration profile.
description(Option<String>):The configuration profile description.
location_uri(Option<String>):The URI location of the configuration.
retrieval_role_arn(Option<String>):The ARN of an IAM role with permission to access the configuration at the specified
LocationUri.validators(Option<Vec<Validator>>):A list of methods for validating the configuration.
r#type(Option<String>):The type of configurations contained in the profile. AppConfig supports
feature flagsandfreeformconfigurations. We recommend you create feature flag configurations to enable or disable new features and freeform configurations to distribute configurations to an application. When calling this API, enter one of the following values forType:AWS.AppConfig.FeatureFlagsAWS.Freeform
- On failure, responds with
SdkError<GetConfigurationProfileError>
source§impl Client
impl Client
sourcepub fn get_deployment(&self) -> GetDeploymentFluentBuilder
pub fn get_deployment(&self) -> GetDeploymentFluentBuilder
Constructs a fluent builder for the GetDeployment operation.
- The fluent builder is configurable:
application_id(impl Into<String>)/set_application_id(Option<String>):The ID of the application that includes the deployment you want to get.
environment_id(impl Into<String>)/set_environment_id(Option<String>):The ID of the environment that includes the deployment you want to get.
deployment_number(i32)/set_deployment_number(Option<i32>):The sequence number of the deployment.
- On success, responds with
GetDeploymentOutputwith field(s):application_id(Option<String>):The ID of the application that was deployed.
environment_id(Option<String>):The ID of the environment that was deployed.
deployment_strategy_id(Option<String>):The ID of the deployment strategy that was deployed.
configuration_profile_id(Option<String>):The ID of the configuration profile that was deployed.
deployment_number(i32):The sequence number of the deployment.
configuration_name(Option<String>):The name of the configuration.
configuration_location_uri(Option<String>):Information about the source location of the configuration.
configuration_version(Option<String>):The configuration version that was deployed.
description(Option<String>):The description of the deployment.
deployment_duration_in_minutes(i32):Total amount of time the deployment lasted.
growth_type(Option<GrowthType>):The algorithm used to define how percentage grew over time.
growth_factor(f32):The percentage of targets to receive a deployed configuration during each interval.
final_bake_time_in_minutes(i32):The amount of time that AppConfig monitored for alarms before considering the deployment to be complete and no longer eligible for automatic rollback.
state(Option<DeploymentState>):The state of the deployment.
event_log(Option<Vec<DeploymentEvent>>):A list containing all events related to a deployment. The most recent events are displayed first.
percentage_complete(f32):The percentage of targets for which the deployment is available.
started_at(Option<DateTime>):The time the deployment started.
completed_at(Option<DateTime>):The time the deployment completed.
applied_extensions(Option<Vec<AppliedExtension>>):A list of extensions that were processed as part of the deployment. The extensions that were previously associated to the configuration profile, environment, or the application when
StartDeploymentwas called.kms_key_arn(Option<String>):The Amazon Resource Name of the Key Management Service key used to encrypt configuration data. You can encrypt secrets stored in Secrets Manager, Amazon Simple Storage Service (Amazon S3) objects encrypted with SSE-KMS, or secure string parameters stored in Amazon Web Services Systems Manager Parameter Store.
kms_key_identifier(Option<String>):The KMS key identifier (key ID, key alias, or key ARN). AppConfig uses this ID to encrypt the configuration data using a customer managed key.
- On failure, responds with
SdkError<GetDeploymentError>
source§impl Client
impl Client
sourcepub fn get_deployment_strategy(&self) -> GetDeploymentStrategyFluentBuilder
pub fn get_deployment_strategy(&self) -> GetDeploymentStrategyFluentBuilder
Constructs a fluent builder for the GetDeploymentStrategy operation.
- The fluent builder is configurable:
deployment_strategy_id(impl Into<String>)/set_deployment_strategy_id(Option<String>):The ID of the deployment strategy to get.
- On success, responds with
GetDeploymentStrategyOutputwith field(s):id(Option<String>):The deployment strategy ID.
name(Option<String>):The name of the deployment strategy.
description(Option<String>):The description of the deployment strategy.
deployment_duration_in_minutes(i32):Total amount of time the deployment lasted.
growth_type(Option<GrowthType>):The algorithm used to define how percentage grew over time.
growth_factor(f32):The percentage of targets that received a deployed configuration during each interval.
final_bake_time_in_minutes(i32):The amount of time that AppConfig monitored for alarms before considering the deployment to be complete and no longer eligible for automatic rollback.
replicate_to(Option<ReplicateTo>):Save the deployment strategy to a Systems Manager (SSM) document.
- On failure, responds with
SdkError<GetDeploymentStrategyError>
source§impl Client
impl Client
sourcepub fn get_environment(&self) -> GetEnvironmentFluentBuilder
pub fn get_environment(&self) -> GetEnvironmentFluentBuilder
Constructs a fluent builder for the GetEnvironment operation.
- The fluent builder is configurable:
application_id(impl Into<String>)/set_application_id(Option<String>):The ID of the application that includes the environment you want to get.
environment_id(impl Into<String>)/set_environment_id(Option<String>):The ID of the environment that you want to get.
- On success, responds with
GetEnvironmentOutputwith field(s):application_id(Option<String>):The application ID.
id(Option<String>):The environment ID.
name(Option<String>):The name of the environment.
description(Option<String>):The description of the environment.
state(Option<EnvironmentState>):The state of the environment. An environment can be in one of the following states:
READY_FOR_DEPLOYMENT,DEPLOYING,ROLLING_BACK, orROLLED_BACKmonitors(Option<Vec<Monitor>>):Amazon CloudWatch alarms monitored during the deployment.
- On failure, responds with
SdkError<GetEnvironmentError>
source§impl Client
impl Client
sourcepub fn get_extension(&self) -> GetExtensionFluentBuilder
pub fn get_extension(&self) -> GetExtensionFluentBuilder
Constructs a fluent builder for the GetExtension operation.
- The fluent builder is configurable:
extension_identifier(impl Into<String>)/set_extension_identifier(Option<String>):The name, the ID, or the Amazon Resource Name (ARN) of the extension.
version_number(i32)/set_version_number(Option<i32>):The extension version number. If no version number was defined, AppConfig uses the highest version.
- On success, responds with
GetExtensionOutputwith field(s):id(Option<String>):The system-generated ID of the extension.
name(Option<String>):The extension name.
version_number(i32):The extension version number.
arn(Option<String>):The system-generated Amazon Resource Name (ARN) for the extension.
description(Option<String>):Information about the extension.
actions(Option<HashMap<ActionPoint, Vec<Action>>>):The actions defined in the extension.
parameters(Option<HashMap<String, Parameter>>):The parameters accepted by the extension. You specify parameter values when you associate the extension to an AppConfig resource by using the
CreateExtensionAssociationAPI action. For Lambda extension actions, these parameters are included in the Lambda request object.
- On failure, responds with
SdkError<GetExtensionError>
source§impl Client
impl Client
sourcepub fn get_extension_association(&self) -> GetExtensionAssociationFluentBuilder
pub fn get_extension_association(&self) -> GetExtensionAssociationFluentBuilder
Constructs a fluent builder for the GetExtensionAssociation operation.
- The fluent builder is configurable:
extension_association_id(impl Into<String>)/set_extension_association_id(Option<String>):The extension association ID to get.
- On success, responds with
GetExtensionAssociationOutputwith field(s):id(Option<String>):The system-generated ID for the association.
extension_arn(Option<String>):The ARN of the extension defined in the association.
resource_arn(Option<String>):The ARNs of applications, configuration profiles, or environments defined in the association.
arn(Option<String>):The system-generated Amazon Resource Name (ARN) for the extension.
parameters(Option<HashMap<String, String>>):The parameter names and values defined in the association.
extension_version_number(i32):The version number for the extension defined in the association.
- On failure, responds with
SdkError<GetExtensionAssociationError>
source§impl Client
impl Client
sourcepub fn get_hosted_configuration_version(
&self
) -> GetHostedConfigurationVersionFluentBuilder
pub fn get_hosted_configuration_version( &self ) -> GetHostedConfigurationVersionFluentBuilder
Constructs a fluent builder for the GetHostedConfigurationVersion operation.
- The fluent builder is configurable:
application_id(impl Into<String>)/set_application_id(Option<String>):The application ID.
configuration_profile_id(impl Into<String>)/set_configuration_profile_id(Option<String>):The configuration profile ID.
version_number(i32)/set_version_number(Option<i32>):The version.
- On success, responds with
GetHostedConfigurationVersionOutputwith field(s):application_id(Option<String>):The application ID.
configuration_profile_id(Option<String>):The configuration profile ID.
version_number(i32):The configuration version.
description(Option<String>):A description of the configuration.
content(Option<Blob>):The content of the configuration or the configuration data.
content_type(Option<String>):A standard MIME type describing the format of the configuration content. For more information, see Content-Type.
version_label(Option<String>):A user-defined label for an AppConfig hosted configuration version.
- On failure, responds with
SdkError<GetHostedConfigurationVersionError>
source§impl Client
impl Client
sourcepub fn list_applications(&self) -> ListApplicationsFluentBuilder
pub fn list_applications(&self) -> ListApplicationsFluentBuilder
Constructs a fluent builder for the ListApplications operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
max_results(i32)/set_max_results(Option<i32>):The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
next_token(impl Into<String>)/set_next_token(Option<String>):A token to start the list. Next token is a pagination token generated by AppConfig to describe what page the previous List call ended on. For the first List request, the nextToken should not be set. On subsequent calls, the nextToken parameter should be set to the previous responses nextToken value. Use this token to get the next set of results.
- On success, responds with
ListApplicationsOutputwith field(s):items(Option<Vec<Application>>):The elements from this collection.
next_token(Option<String>):The token for the next set of items to return. Use this token to get the next set of results.
- On failure, responds with
SdkError<ListApplicationsError>
source§impl Client
impl Client
sourcepub fn list_configuration_profiles(
&self
) -> ListConfigurationProfilesFluentBuilder
pub fn list_configuration_profiles( &self ) -> ListConfigurationProfilesFluentBuilder
Constructs a fluent builder for the ListConfigurationProfiles operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
application_id(impl Into<String>)/set_application_id(Option<String>):The application ID.
max_results(i32)/set_max_results(Option<i32>):The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
next_token(impl Into<String>)/set_next_token(Option<String>):A token to start the list. Use this token to get the next set of results.
r#type(impl Into<String>)/set_type(Option<String>):A filter based on the type of configurations that the configuration profile contains. A configuration can be a feature flag or a freeform configuration.
- On success, responds with
ListConfigurationProfilesOutputwith field(s):items(Option<Vec<ConfigurationProfileSummary>>):The elements from this collection.
next_token(Option<String>):The token for the next set of items to return. Use this token to get the next set of results.
- On failure, responds with
SdkError<ListConfigurationProfilesError>
source§impl Client
impl Client
sourcepub fn list_deployment_strategies(
&self
) -> ListDeploymentStrategiesFluentBuilder
pub fn list_deployment_strategies( &self ) -> ListDeploymentStrategiesFluentBuilder
Constructs a fluent builder for the ListDeploymentStrategies operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
max_results(i32)/set_max_results(Option<i32>):The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
next_token(impl Into<String>)/set_next_token(Option<String>):A token to start the list. Use this token to get the next set of results.
- On success, responds with
ListDeploymentStrategiesOutputwith field(s):items(Option<Vec<DeploymentStrategy>>):The elements from this collection.
next_token(Option<String>):The token for the next set of items to return. Use this token to get the next set of results.
- On failure, responds with
SdkError<ListDeploymentStrategiesError>
source§impl Client
impl Client
sourcepub fn list_deployments(&self) -> ListDeploymentsFluentBuilder
pub fn list_deployments(&self) -> ListDeploymentsFluentBuilder
Constructs a fluent builder for the ListDeployments operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
application_id(impl Into<String>)/set_application_id(Option<String>):The application ID.
environment_id(impl Into<String>)/set_environment_id(Option<String>):The environment ID.
max_results(i32)/set_max_results(Option<i32>):The maximum number of items that may be returned for this call. If there are items that have not yet been returned, the response will include a non-null
NextTokenthat you can provide in a subsequent call to get the next set of results.next_token(impl Into<String>)/set_next_token(Option<String>):The token returned by a prior call to this operation indicating the next set of results to be returned. If not specified, the operation will return the first set of results.
- On success, responds with
ListDeploymentsOutputwith field(s):items(Option<Vec<DeploymentSummary>>):The elements from this collection.
next_token(Option<String>):The token for the next set of items to return. Use this token to get the next set of results.
- On failure, responds with
SdkError<ListDeploymentsError>
source§impl Client
impl Client
sourcepub fn list_environments(&self) -> ListEnvironmentsFluentBuilder
pub fn list_environments(&self) -> ListEnvironmentsFluentBuilder
Constructs a fluent builder for the ListEnvironments operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
application_id(impl Into<String>)/set_application_id(Option<String>):The application ID.
max_results(i32)/set_max_results(Option<i32>):The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
next_token(impl Into<String>)/set_next_token(Option<String>):A token to start the list. Use this token to get the next set of results.
- On success, responds with
ListEnvironmentsOutputwith field(s):items(Option<Vec<Environment>>):The elements from this collection.
next_token(Option<String>):The token for the next set of items to return. Use this token to get the next set of results.
- On failure, responds with
SdkError<ListEnvironmentsError>
source§impl Client
impl Client
sourcepub fn list_extension_associations(
&self
) -> ListExtensionAssociationsFluentBuilder
pub fn list_extension_associations( &self ) -> ListExtensionAssociationsFluentBuilder
Constructs a fluent builder for the ListExtensionAssociations operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
resource_identifier(impl Into<String>)/set_resource_identifier(Option<String>):The ARN of an application, configuration profile, or environment.
extension_identifier(impl Into<String>)/set_extension_identifier(Option<String>):The name, the ID, or the Amazon Resource Name (ARN) of the extension.
extension_version_number(i32)/set_extension_version_number(Option<i32>):The version number for the extension defined in the association.
max_results(i32)/set_max_results(Option<i32>):The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
next_token(impl Into<String>)/set_next_token(Option<String>):A token to start the list. Use this token to get the next set of results or pass null to get the first set of results.
- On success, responds with
ListExtensionAssociationsOutputwith field(s):items(Option<Vec<ExtensionAssociationSummary>>):The list of extension associations. Each item represents an extension association to an application, environment, or configuration profile.
next_token(Option<String>):The token for the next set of items to return. Use this token to get the next set of results.
- On failure, responds with
SdkError<ListExtensionAssociationsError>
source§impl Client
impl Client
sourcepub fn list_extensions(&self) -> ListExtensionsFluentBuilder
pub fn list_extensions(&self) -> ListExtensionsFluentBuilder
Constructs a fluent builder for the ListExtensions operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
max_results(i32)/set_max_results(Option<i32>):The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
next_token(impl Into<String>)/set_next_token(Option<String>):A token to start the list. Use this token to get the next set of results.
name(impl Into<String>)/set_name(Option<String>):The extension name.
- On success, responds with
ListExtensionsOutputwith field(s):items(Option<Vec<ExtensionSummary>>):The list of available extensions. The list includes Amazon Web Services authored and user-created extensions.
next_token(Option<String>):The token for the next set of items to return. Use this token to get the next set of results.
- On failure, responds with
SdkError<ListExtensionsError>
source§impl Client
impl Client
sourcepub fn list_hosted_configuration_versions(
&self
) -> ListHostedConfigurationVersionsFluentBuilder
pub fn list_hosted_configuration_versions( &self ) -> ListHostedConfigurationVersionsFluentBuilder
Constructs a fluent builder for the ListHostedConfigurationVersions operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
application_id(impl Into<String>)/set_application_id(Option<String>):The application ID.
configuration_profile_id(impl Into<String>)/set_configuration_profile_id(Option<String>):The configuration profile ID.
max_results(i32)/set_max_results(Option<i32>):The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
next_token(impl Into<String>)/set_next_token(Option<String>):A token to start the list. Use this token to get the next set of results.
version_label(impl Into<String>)/set_version_label(Option<String>):An optional filter that can be used to specify the version label of an AppConfig hosted configuration version. This parameter supports filtering by prefix using a wildcard, for example “v2*”. If you don’t specify an asterisk at the end of the value, only an exact match is returned.
- On success, responds with
ListHostedConfigurationVersionsOutputwith field(s):items(Option<Vec<HostedConfigurationVersionSummary>>):The elements from this collection.
next_token(Option<String>):The token for the next set of items to return. Use this token to get the next set of results.
- On failure, responds with
SdkError<ListHostedConfigurationVersionsError>
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>):The resource ARN.
- On success, responds with
ListTagsForResourceOutputwith field(s):tags(Option<HashMap<String, String>>):Metadata to assign to AppConfig resources. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define.
- On failure, responds with
SdkError<ListTagsForResourceError>
source§impl Client
impl Client
sourcepub fn start_deployment(&self) -> StartDeploymentFluentBuilder
pub fn start_deployment(&self) -> StartDeploymentFluentBuilder
Constructs a fluent builder for the StartDeployment operation.
- The fluent builder is configurable:
application_id(impl Into<String>)/set_application_id(Option<String>):The application ID.
environment_id(impl Into<String>)/set_environment_id(Option<String>):The environment ID.
deployment_strategy_id(impl Into<String>)/set_deployment_strategy_id(Option<String>):The deployment strategy ID.
configuration_profile_id(impl Into<String>)/set_configuration_profile_id(Option<String>):The configuration profile ID.
configuration_version(impl Into<String>)/set_configuration_version(Option<String>):The configuration version to deploy. If deploying an AppConfig hosted configuration version, you can specify either the version number or version label.
description(impl Into<String>)/set_description(Option<String>):A description of the deployment.
tags(impl Into<String>, impl Into<String>)/set_tags(Option<HashMap<String, String>>):Metadata to assign to the deployment. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define.
kms_key_identifier(impl Into<String>)/set_kms_key_identifier(Option<String>):The KMS key identifier (key ID, key alias, or key ARN). AppConfig uses this ID to encrypt the configuration data using a customer managed key.
- On success, responds with
StartDeploymentOutputwith field(s):application_id(Option<String>):The ID of the application that was deployed.
environment_id(Option<String>):The ID of the environment that was deployed.
deployment_strategy_id(Option<String>):The ID of the deployment strategy that was deployed.
configuration_profile_id(Option<String>):The ID of the configuration profile that was deployed.
deployment_number(i32):The sequence number of the deployment.
configuration_name(Option<String>):The name of the configuration.
configuration_location_uri(Option<String>):Information about the source location of the configuration.
configuration_version(Option<String>):The configuration version that was deployed.
description(Option<String>):The description of the deployment.
deployment_duration_in_minutes(i32):Total amount of time the deployment lasted.
growth_type(Option<GrowthType>):The algorithm used to define how percentage grew over time.
growth_factor(f32):The percentage of targets to receive a deployed configuration during each interval.
final_bake_time_in_minutes(i32):The amount of time that AppConfig monitored for alarms before considering the deployment to be complete and no longer eligible for automatic rollback.
state(Option<DeploymentState>):The state of the deployment.
event_log(Option<Vec<DeploymentEvent>>):A list containing all events related to a deployment. The most recent events are displayed first.
percentage_complete(f32):The percentage of targets for which the deployment is available.
started_at(Option<DateTime>):The time the deployment started.
completed_at(Option<DateTime>):The time the deployment completed.
applied_extensions(Option<Vec<AppliedExtension>>):A list of extensions that were processed as part of the deployment. The extensions that were previously associated to the configuration profile, environment, or the application when
StartDeploymentwas called.kms_key_arn(Option<String>):The Amazon Resource Name of the Key Management Service key used to encrypt configuration data. You can encrypt secrets stored in Secrets Manager, Amazon Simple Storage Service (Amazon S3) objects encrypted with SSE-KMS, or secure string parameters stored in Amazon Web Services Systems Manager Parameter Store.
kms_key_identifier(Option<String>):The KMS key identifier (key ID, key alias, or key ARN). AppConfig uses this ID to encrypt the configuration data using a customer managed key.
- On failure, responds with
SdkError<StartDeploymentError>
source§impl Client
impl Client
sourcepub fn stop_deployment(&self) -> StopDeploymentFluentBuilder
pub fn stop_deployment(&self) -> StopDeploymentFluentBuilder
Constructs a fluent builder for the StopDeployment operation.
- The fluent builder is configurable:
application_id(impl Into<String>)/set_application_id(Option<String>):The application ID.
environment_id(impl Into<String>)/set_environment_id(Option<String>):The environment ID.
deployment_number(i32)/set_deployment_number(Option<i32>):The sequence number of the deployment.
- On success, responds with
StopDeploymentOutputwith field(s):application_id(Option<String>):The ID of the application that was deployed.
environment_id(Option<String>):The ID of the environment that was deployed.
deployment_strategy_id(Option<String>):The ID of the deployment strategy that was deployed.
configuration_profile_id(Option<String>):The ID of the configuration profile that was deployed.
deployment_number(i32):The sequence number of the deployment.
configuration_name(Option<String>):The name of the configuration.
configuration_location_uri(Option<String>):Information about the source location of the configuration.
configuration_version(Option<String>):The configuration version that was deployed.
description(Option<String>):The description of the deployment.
deployment_duration_in_minutes(i32):Total amount of time the deployment lasted.
growth_type(Option<GrowthType>):The algorithm used to define how percentage grew over time.
growth_factor(f32):The percentage of targets to receive a deployed configuration during each interval.
final_bake_time_in_minutes(i32):The amount of time that AppConfig monitored for alarms before considering the deployment to be complete and no longer eligible for automatic rollback.
state(Option<DeploymentState>):The state of the deployment.
event_log(Option<Vec<DeploymentEvent>>):A list containing all events related to a deployment. The most recent events are displayed first.
percentage_complete(f32):The percentage of targets for which the deployment is available.
started_at(Option<DateTime>):The time the deployment started.
completed_at(Option<DateTime>):The time the deployment completed.
applied_extensions(Option<Vec<AppliedExtension>>):A list of extensions that were processed as part of the deployment. The extensions that were previously associated to the configuration profile, environment, or the application when
StartDeploymentwas called.kms_key_arn(Option<String>):The Amazon Resource Name of the Key Management Service key used to encrypt configuration data. You can encrypt secrets stored in Secrets Manager, Amazon Simple Storage Service (Amazon S3) objects encrypted with SSE-KMS, or secure string parameters stored in Amazon Web Services Systems Manager Parameter Store.
kms_key_identifier(Option<String>):The KMS key identifier (key ID, key alias, or key ARN). AppConfig uses this ID to encrypt the configuration data using a customer managed key.
- On failure, responds with
SdkError<StopDeploymentError>
source§impl Client
impl Client
sourcepub fn tag_resource(&self) -> TagResourceFluentBuilder
pub fn tag_resource(&self) -> TagResourceFluentBuilder
Constructs a fluent builder for the TagResource operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)/set_resource_arn(Option<String>):The ARN of the resource for which to retrieve tags.
tags(impl Into<String>, impl Into<String>)/set_tags(Option<HashMap<String, String>>):The key-value string map. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with
aws:. The tag value can be up to 256 characters.
- On success, responds with
TagResourceOutput - On failure, responds with
SdkError<TagResourceError>
source§impl Client
impl Client
sourcepub fn untag_resource(&self) -> UntagResourceFluentBuilder
pub fn untag_resource(&self) -> UntagResourceFluentBuilder
Constructs a fluent builder for the UntagResource operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)/set_resource_arn(Option<String>):The ARN of the resource for which to remove tags.
tag_keys(impl Into<String>)/set_tag_keys(Option<Vec<String>>):The tag keys to delete.
- On success, responds with
UntagResourceOutput - On failure, responds with
SdkError<UntagResourceError>
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_id(impl Into<String>)/set_application_id(Option<String>):The application ID.
name(impl Into<String>)/set_name(Option<String>):The name of the application.
description(impl Into<String>)/set_description(Option<String>):A description of the application.
- On success, responds with
UpdateApplicationOutputwith field(s):id(Option<String>):The application ID.
name(Option<String>):The application name.
description(Option<String>):The description of the application.
- On failure, responds with
SdkError<UpdateApplicationError>
source§impl Client
impl Client
sourcepub fn update_configuration_profile(
&self
) -> UpdateConfigurationProfileFluentBuilder
pub fn update_configuration_profile( &self ) -> UpdateConfigurationProfileFluentBuilder
Constructs a fluent builder for the UpdateConfigurationProfile operation.
- The fluent builder is configurable:
application_id(impl Into<String>)/set_application_id(Option<String>):The application ID.
configuration_profile_id(impl Into<String>)/set_configuration_profile_id(Option<String>):The ID of the configuration profile.
name(impl Into<String>)/set_name(Option<String>):The name of the configuration profile.
description(impl Into<String>)/set_description(Option<String>):A description of the configuration profile.
retrieval_role_arn(impl Into<String>)/set_retrieval_role_arn(Option<String>):The ARN of an IAM role with permission to access the configuration at the specified
LocationUri.validators(Validator)/set_validators(Option<Vec<Validator>>):A list of methods for validating the configuration.
- On success, responds with
UpdateConfigurationProfileOutputwith field(s):application_id(Option<String>):The application ID.
id(Option<String>):The configuration profile ID.
name(Option<String>):The name of the configuration profile.
description(Option<String>):The configuration profile description.
location_uri(Option<String>):The URI location of the configuration.
retrieval_role_arn(Option<String>):The ARN of an IAM role with permission to access the configuration at the specified
LocationUri.validators(Option<Vec<Validator>>):A list of methods for validating the configuration.
r#type(Option<String>):The type of configurations contained in the profile. AppConfig supports
feature flagsandfreeformconfigurations. We recommend you create feature flag configurations to enable or disable new features and freeform configurations to distribute configurations to an application. When calling this API, enter one of the following values forType:AWS.AppConfig.FeatureFlagsAWS.Freeform
- On failure, responds with
SdkError<UpdateConfigurationProfileError>
source§impl Client
impl Client
sourcepub fn update_deployment_strategy(
&self
) -> UpdateDeploymentStrategyFluentBuilder
pub fn update_deployment_strategy( &self ) -> UpdateDeploymentStrategyFluentBuilder
Constructs a fluent builder for the UpdateDeploymentStrategy operation.
- The fluent builder is configurable:
deployment_strategy_id(impl Into<String>)/set_deployment_strategy_id(Option<String>):The deployment strategy ID.
description(impl Into<String>)/set_description(Option<String>):A description of the deployment strategy.
deployment_duration_in_minutes(i32)/set_deployment_duration_in_minutes(Option<i32>):Total amount of time for a deployment to last.
final_bake_time_in_minutes(i32)/set_final_bake_time_in_minutes(Option<i32>):The amount of time that AppConfig monitors for alarms before considering the deployment to be complete and no longer eligible for automatic rollback.
growth_factor(f32)/set_growth_factor(Option<f32>):The percentage of targets to receive a deployed configuration during each interval.
growth_type(GrowthType)/set_growth_type(Option<GrowthType>):The algorithm used to define how percentage grows over time. AppConfig supports the following growth types:
Linear: For this type, AppConfig processes the deployment by increments of the growth factor evenly distributed over the deployment time. For example, a linear deployment that uses a growth factor of 20 initially makes the configuration available to 20 percent of the targets. After 1/5th of the deployment time has passed, the system updates the percentage to 40 percent. This continues until 100% of the targets are set to receive the deployed configuration.
Exponential: For this type, AppConfig processes the deployment exponentially using the following formula:
G*(2^N). In this formula,Gis the growth factor specified by the user andNis the number of steps until the configuration is deployed to all targets. For example, if you specify a growth factor of 2, then the system rolls out the configuration as follows:2*(2^0)2*(2^1)2*(2^2)Expressed numerically, the deployment rolls out as follows: 2% of the targets, 4% of the targets, 8% of the targets, and continues until the configuration has been deployed to all targets.
- On success, responds with
UpdateDeploymentStrategyOutputwith field(s):id(Option<String>):The deployment strategy ID.
name(Option<String>):The name of the deployment strategy.
description(Option<String>):The description of the deployment strategy.
deployment_duration_in_minutes(i32):Total amount of time the deployment lasted.
growth_type(Option<GrowthType>):The algorithm used to define how percentage grew over time.
growth_factor(f32):The percentage of targets that received a deployed configuration during each interval.
final_bake_time_in_minutes(i32):The amount of time that AppConfig monitored for alarms before considering the deployment to be complete and no longer eligible for automatic rollback.
replicate_to(Option<ReplicateTo>):Save the deployment strategy to a Systems Manager (SSM) document.
- On failure, responds with
SdkError<UpdateDeploymentStrategyError>
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_id(impl Into<String>)/set_application_id(Option<String>):The application ID.
environment_id(impl Into<String>)/set_environment_id(Option<String>):The environment ID.
name(impl Into<String>)/set_name(Option<String>):The name of the environment.
description(impl Into<String>)/set_description(Option<String>):A description of the environment.
monitors(Monitor)/set_monitors(Option<Vec<Monitor>>):Amazon CloudWatch alarms to monitor during the deployment process.
- On success, responds with
UpdateEnvironmentOutputwith field(s):application_id(Option<String>):The application ID.
id(Option<String>):The environment ID.
name(Option<String>):The name of the environment.
description(Option<String>):The description of the environment.
state(Option<EnvironmentState>):The state of the environment. An environment can be in one of the following states:
READY_FOR_DEPLOYMENT,DEPLOYING,ROLLING_BACK, orROLLED_BACKmonitors(Option<Vec<Monitor>>):Amazon CloudWatch alarms monitored during the deployment.
- On failure, responds with
SdkError<UpdateEnvironmentError>
source§impl Client
impl Client
sourcepub fn update_extension(&self) -> UpdateExtensionFluentBuilder
pub fn update_extension(&self) -> UpdateExtensionFluentBuilder
Constructs a fluent builder for the UpdateExtension operation.
- The fluent builder is configurable:
extension_identifier(impl Into<String>)/set_extension_identifier(Option<String>):The name, the ID, or the Amazon Resource Name (ARN) of the extension.
description(impl Into<String>)/set_description(Option<String>):Information about the extension.
actions(ActionPoint, Vec<Action>)/set_actions(Option<HashMap<ActionPoint, Vec<Action>>>):The actions defined in the extension.
parameters(impl Into<String>, Parameter)/set_parameters(Option<HashMap<String, Parameter>>):One or more parameters for the actions called by the extension.
version_number(i32)/set_version_number(Option<i32>):The extension version number.
- On success, responds with
UpdateExtensionOutputwith field(s):id(Option<String>):The system-generated ID of the extension.
name(Option<String>):The extension name.
version_number(i32):The extension version number.
arn(Option<String>):The system-generated Amazon Resource Name (ARN) for the extension.
description(Option<String>):Information about the extension.
actions(Option<HashMap<ActionPoint, Vec<Action>>>):The actions defined in the extension.
parameters(Option<HashMap<String, Parameter>>):The parameters accepted by the extension. You specify parameter values when you associate the extension to an AppConfig resource by using the
CreateExtensionAssociationAPI action. For Lambda extension actions, these parameters are included in the Lambda request object.
- On failure, responds with
SdkError<UpdateExtensionError>
source§impl Client
impl Client
sourcepub fn update_extension_association(
&self
) -> UpdateExtensionAssociationFluentBuilder
pub fn update_extension_association( &self ) -> UpdateExtensionAssociationFluentBuilder
Constructs a fluent builder for the UpdateExtensionAssociation operation.
- The fluent builder is configurable:
extension_association_id(impl Into<String>)/set_extension_association_id(Option<String>):The system-generated ID for the association.
parameters(impl Into<String>, impl Into<String>)/set_parameters(Option<HashMap<String, String>>):The parameter names and values defined in the extension.
- On success, responds with
UpdateExtensionAssociationOutputwith field(s):id(Option<String>):The system-generated ID for the association.
extension_arn(Option<String>):The ARN of the extension defined in the association.
resource_arn(Option<String>):The ARNs of applications, configuration profiles, or environments defined in the association.
arn(Option<String>):The system-generated Amazon Resource Name (ARN) for the extension.
parameters(Option<HashMap<String, String>>):The parameter names and values defined in the association.
extension_version_number(i32):The version number for the extension defined in the association.
- On failure, responds with
SdkError<UpdateExtensionAssociationError>
source§impl Client
impl Client
sourcepub fn validate_configuration(&self) -> ValidateConfigurationFluentBuilder
pub fn validate_configuration(&self) -> ValidateConfigurationFluentBuilder
Constructs a fluent builder for the ValidateConfiguration operation.
- The fluent builder is configurable:
application_id(impl Into<String>)/set_application_id(Option<String>):The application ID.
configuration_profile_id(impl Into<String>)/set_configuration_profile_id(Option<String>):The configuration profile ID.
configuration_version(impl Into<String>)/set_configuration_version(Option<String>):The version of the configuration to validate.
- On success, responds with
ValidateConfigurationOutput - On failure, responds with
SdkError<ValidateConfigurationError>
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_configis missing an async sleep implementation. If you experience this panic, set thesleep_implon the Config passed into this function to fix it. - This method will panic if the
sdk_configis missing an HTTP connector. If you experience this panic, set thehttp_connectoron the Config passed into this function to fix it.