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.
Examples
Constructing a client and invoking an operation
// create a shared configuration. This can be used & shared between multiple service clients.
let shared_config = aws_config::load_from_env().await;
let client = aws_sdk_appconfig::Client::new(&shared_config);
// invoke an operation
/* let rsp = client
.<operation_name>().
.<param>("some value")
.send().await; */
Constructing a client with custom configuration
use aws_config::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_appconfig::config::Builder::from(&shared_config)
.retry_config(RetryConfig::disabled())
.build();
let client = aws_sdk_appconfig::Client::from_conf(config);
Implementations
sourceimpl Client
impl Client
sourcepub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self
pub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self
Creates a client with the given service configuration.
sourceimpl Client
impl Client
sourcepub fn create_application(&self) -> CreateApplication
pub fn create_application(&self) -> CreateApplication
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(HashMap<String, 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
CreateApplicationOutput
with 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>
sourcepub fn create_configuration_profile(&self) -> CreateConfigurationProfile
pub fn create_configuration_profile(&self) -> CreateConfigurationProfile
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 AppConfig hosted configuration store, Systems Manager (SSM) document, an SSM Parameter Store parameter, or an Amazon S3 object. For the hosted configuration store and for feature flags, specify
hosted
. For an SSM document, specify either the document name in the formatssm-document:// <document_name></document_name>
or the Amazon Resource Name (ARN). For a parameter, specify either the parameter name in the formatssm-parameter:// <parameter_name></parameter_name>
or the ARN. 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
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(Vec<Validator>)
/set_validators(Option<Vec<Validator>>)
:A list of methods for validating the configuration.
tags(HashMap<String, 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 flags
andfreeform
configurations. 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.FeatureFlags
AWS.Freeform
- On success, responds with
CreateConfigurationProfileOutput
with 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 flags
andfreeform
configurations. 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.FeatureFlags
AWS.Freeform
- On failure, responds with
SdkError<CreateConfigurationProfileError>
sourcepub fn create_deployment_strategy(&self) -> CreateDeploymentStrategy
pub fn create_deployment_strategy(&self) -> CreateDeploymentStrategy
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(i32)
:The amount of time AppConfig monitors for alarms before considering the deployment to be complete and no longer eligible for automatic roll back.
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 percentage
of 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,G
is the growth factor specified by the user andN
is 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(HashMap<String, 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
CreateDeploymentStrategyOutput
with 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>
sourcepub fn create_environment(&self) -> CreateEnvironment
pub fn create_environment(&self) -> CreateEnvironment
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(Vec<Monitor>)
/set_monitors(Option<Vec<Monitor>>)
:Amazon CloudWatch alarms to monitor during the deployment process.
tags(HashMap<String, 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
CreateEnvironmentOutput
with 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_BACK
monitors(Option<Vec<Monitor>>)
:Amazon CloudWatch alarms monitored during the deployment.
- On failure, responds with
SdkError<CreateEnvironmentError>
sourcepub fn create_hosted_configuration_version(
&self
) -> CreateHostedConfigurationVersion
pub fn create_hosted_configuration_version(
&self
) -> CreateHostedConfigurationVersion
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.
- On success, responds with
CreateHostedConfigurationVersionOutput
with 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.
- On failure, responds with
SdkError<CreateHostedConfigurationVersionError>
sourcepub fn delete_application(&self) -> DeleteApplication
pub fn delete_application(&self) -> DeleteApplication
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>
sourcepub fn delete_configuration_profile(&self) -> DeleteConfigurationProfile
pub fn delete_configuration_profile(&self) -> DeleteConfigurationProfile
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>
sourcepub fn delete_deployment_strategy(&self) -> DeleteDeploymentStrategy
pub fn delete_deployment_strategy(&self) -> DeleteDeploymentStrategy
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>
sourcepub fn delete_environment(&self) -> DeleteEnvironment
pub fn delete_environment(&self) -> DeleteEnvironment
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>
sourcepub fn delete_hosted_configuration_version(
&self
) -> DeleteHostedConfigurationVersion
pub fn delete_hosted_configuration_version(
&self
) -> DeleteHostedConfigurationVersion
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(i32)
:The versions number to delete.
- On success, responds with
DeleteHostedConfigurationVersionOutput
- On failure, responds with
SdkError<DeleteHostedConfigurationVersionError>
sourcepub fn get_application(&self) -> GetApplication
pub fn get_application(&self) -> GetApplication
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
GetApplicationOutput
with 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>
sourcepub fn get_configuration(&self) -> GetConfiguration
pub fn get_configuration(&self) -> GetConfiguration
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
GetConfiguration
response.AppConfig uses the value of the
ClientConfigurationVersion
parameter to identify the configuration version on your clients. If you don’t sendClientConfigurationVersion
with 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 that you include the
ClientConfigurationVersion
value with every call toGetConfiguration
. This value must be saved on your client. Subsequent calls toGetConfiguration
must pass this value by using theClientConfigurationVersion
parameter.For more information about working with configurations, see Retrieving the Configuration in the AppConfig User Guide.
- On success, responds with
GetConfigurationOutput
with field(s):content(Option<Blob>)
:The content of the configuration or the configuration data.
The
Content
attribute only contains data if the system finds new or updated configuration data. If there is no new or updated data andClientConfigurationVersion
matches the version of the current configuration, AppConfig returns a204 No Content
HTTP response code and theContent
value 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>
sourcepub fn get_configuration_profile(&self) -> GetConfigurationProfile
pub fn get_configuration_profile(&self) -> GetConfigurationProfile
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
GetConfigurationProfileOutput
with 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 flags
andfreeform
configurations. 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.FeatureFlags
AWS.Freeform
- On failure, responds with
SdkError<GetConfigurationProfileError>
sourcepub fn get_deployment(&self) -> GetDeployment
pub fn get_deployment(&self) -> GetDeployment
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
GetDeploymentOutput
with 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.
- On failure, responds with
SdkError<GetDeploymentError>
sourcepub fn get_deployment_strategy(&self) -> GetDeploymentStrategy
pub fn get_deployment_strategy(&self) -> GetDeploymentStrategy
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
GetDeploymentStrategyOutput
with 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>
sourcepub fn get_environment(&self) -> GetEnvironment
pub fn get_environment(&self) -> GetEnvironment
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
GetEnvironmentOutput
with 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_BACK
monitors(Option<Vec<Monitor>>)
:Amazon CloudWatch alarms monitored during the deployment.
- On failure, responds with
SdkError<GetEnvironmentError>
sourcepub fn get_hosted_configuration_version(&self) -> GetHostedConfigurationVersion
pub fn get_hosted_configuration_version(&self) -> GetHostedConfigurationVersion
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(i32)
:The version.
- On success, responds with
GetHostedConfigurationVersionOutput
with 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.
- On failure, responds with
SdkError<GetHostedConfigurationVersionError>
sourcepub fn list_applications(&self) -> ListApplications
pub fn list_applications(&self) -> ListApplications
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
ListApplicationsOutput
with 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>
sourcepub fn list_configuration_profiles(&self) -> ListConfigurationProfiles
pub fn list_configuration_profiles(&self) -> ListConfigurationProfiles
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
ListConfigurationProfilesOutput
with 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>
sourcepub fn list_deployments(&self) -> ListDeployments
pub fn list_deployments(&self) -> ListDeployments
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
NextToken
that 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
ListDeploymentsOutput
with 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>
sourcepub fn list_deployment_strategies(&self) -> ListDeploymentStrategies
pub fn list_deployment_strategies(&self) -> ListDeploymentStrategies
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
ListDeploymentStrategiesOutput
with 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>
sourcepub fn list_environments(&self) -> ListEnvironments
pub fn list_environments(&self) -> ListEnvironments
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
ListEnvironmentsOutput
with 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>
sourcepub fn list_hosted_configuration_versions(
&self
) -> ListHostedConfigurationVersions
pub fn list_hosted_configuration_versions(
&self
) -> ListHostedConfigurationVersions
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.
- On success, responds with
ListHostedConfigurationVersionsOutput
with 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>
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
ListTagsForResourceOutput
with 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>
sourcepub fn start_deployment(&self) -> StartDeployment
pub fn start_deployment(&self) -> StartDeployment
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.
description(impl Into<String>)
/set_description(Option<String>)
:A description of the deployment.
tags(HashMap<String, 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.
- On success, responds with
StartDeploymentOutput
with 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.
- On failure, responds with
SdkError<StartDeploymentError>
sourcepub fn stop_deployment(&self) -> StopDeployment
pub fn stop_deployment(&self) -> StopDeployment
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
StopDeploymentOutput
with 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.
- On failure, responds with
SdkError<StopDeploymentError>
sourcepub fn tag_resource(&self) -> TagResource
pub fn tag_resource(&self) -> TagResource
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(HashMap<String, 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>
sourcepub fn untag_resource(&self) -> UntagResource
pub fn untag_resource(&self) -> UntagResource
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(Vec<String>)
/set_tag_keys(Option<Vec<String>>)
:The tag keys to delete.
- On success, responds with
UntagResourceOutput
- On failure, responds with
SdkError<UntagResourceError>
sourcepub fn update_application(&self) -> UpdateApplication
pub fn update_application(&self) -> UpdateApplication
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
UpdateApplicationOutput
with 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>
sourcepub fn update_configuration_profile(&self) -> UpdateConfigurationProfile
pub fn update_configuration_profile(&self) -> UpdateConfigurationProfile
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(Vec<Validator>)
/set_validators(Option<Vec<Validator>>)
:A list of methods for validating the configuration.
- On success, responds with
UpdateConfigurationProfileOutput
with 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 flags
andfreeform
configurations. 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.FeatureFlags
AWS.Freeform
- On failure, responds with
SdkError<UpdateConfigurationProfileError>
sourcepub fn update_deployment_strategy(&self) -> UpdateDeploymentStrategy
pub fn update_deployment_strategy(&self) -> UpdateDeploymentStrategy
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,G
is the growth factor specified by the user andN
is 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
UpdateDeploymentStrategyOutput
with 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>
sourcepub fn update_environment(&self) -> UpdateEnvironment
pub fn update_environment(&self) -> UpdateEnvironment
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(Vec<Monitor>)
/set_monitors(Option<Vec<Monitor>>)
:Amazon CloudWatch alarms to monitor during the deployment process.
- On success, responds with
UpdateEnvironmentOutput
with 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_BACK
monitors(Option<Vec<Monitor>>)
:Amazon CloudWatch alarms monitored during the deployment.
- On failure, responds with
SdkError<UpdateEnvironmentError>
sourcepub fn validate_configuration(&self) -> ValidateConfiguration
pub fn validate_configuration(&self) -> ValidateConfiguration
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>
sourceimpl Client
impl Client
sourcepub fn from_conf_conn<C, E>(conf: Config, conn: C) -> Self where
C: SmithyConnector<Error = E> + Send + 'static,
E: Into<ConnectorError>,
pub fn from_conf_conn<C, E>(conf: Config, conn: C) -> Self where
C: SmithyConnector<Error = E> + Send + 'static,
E: Into<ConnectorError>,
Creates a client with the given service config and connector override.
Trait Implementations
sourceimpl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client
impl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client
sourcefn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self
fn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self
Converts to this type from the input type.
Auto Trait Implementations
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl !UnwindSafe for Client
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more