@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonAppConfigAsyncClient extends AmazonAppConfigClient implements AmazonAppConfigAsync
AsyncHandler can be used to receive notification when
an asynchronous operation completes.
AppConfig feature flags and dynamic configurations help software builders quickly and securely adjust application behavior in production environments without full code deployments. AppConfig speeds up software release frequency, improves application resiliency, and helps you address emergent issues more quickly. With feature flags, you can gradually release new capabilities to users and measure the impact of those changes before fully deploying the new capabilities to all users. With operational flags and dynamic configurations, you can update block lists, allow lists, throttling limits, logging verbosity, and perform other operational tuning to quickly respond to issues in production environments.
AppConfig is a capability of Amazon Web Services Systems Manager.
Despite the fact that application configuration content can vary greatly from application to application, AppConfig supports the following use cases, which cover a broad spectrum of customer needs:
Feature flags and toggles - Safely release new capabilities to your customers in a controlled environment. Instantly roll back changes if you experience a problem.
Application tuning - Carefully introduce application changes while testing the impact of those changes with users in production environments.
Allow list or block list - Control access to premium features or instantly block specific users without deploying new code.
Centralized configuration storage - Keep your configuration data organized and consistent across all of your workloads. You can use AppConfig to deploy configuration data stored in the AppConfig hosted configuration store, Secrets Manager, Systems Manager, Parameter Store, or Amazon S3.
How AppConfig works
This section provides a high-level description of how AppConfig works and how you get started.
Before you start creating AppConfig artifacts, we recommend you identify configuration data in your code that you want to dynamically manage using AppConfig. Good examples include feature flags or toggles, allow and block lists, logging verbosity, service limits, and throttling rules, to name a few.
If your configuration data already exists in the cloud, you can take advantage of AppConfig validation, deployment, and extension features to further streamline configuration data management.
To create a namespace, you create an AppConfig artifact called an application. An application is simply an organizational construct like a folder.
For each AppConfig application, you define one or more environments. An environment is a logical grouping of targets,
such as applications in a Beta or Production environment, Lambda functions, or containers.
You can also define environments for application subcomponents, such as the Web, Mobile,
and Back-end.
You can configure Amazon CloudWatch alarms for each environment. The system monitors alarms during a configuration deployment. If an alarm is triggered, the system rolls back the configuration.
A configuration profile includes, among other things, a URI that enables AppConfig to locate your configuration data
in its stored location and a profile type. AppConfig supports two configuration profile types: feature flags and
freeform configurations. Feature flag configuration profiles store their data in the AppConfig hosted configuration
store and the URI is simply hosted. For freeform configuration profiles, you can store your data in the
AppConfig hosted configuration store or any Amazon Web Services service that integrates with AppConfig, as described
in
Creating a free form configuration profile in the the AppConfig User Guide.
A configuration profile can also include optional validators to ensure your configuration data is syntactically and semantically correct. AppConfig performs a check using the validators when you start a deployment. If any errors are detected, the deployment rolls back to the previous configuration data.
When you create a new deployment, you specify the following:
An application ID
A configuration profile ID
A configuration version
An environment ID where you want to deploy the configuration data
A deployment strategy ID that defines how fast you want the changes to take effect
When you call the StartDeployment API action, AppConfig performs the following tasks:
Retrieves the configuration data from the underlying data store by using the location URI in the configuration profile.
Verifies the configuration data is syntactically and semantically correct by using the validators you specified when you created your configuration profile.
Caches a copy of the data so it is ready to be retrieved by your application. This cached copy is called the deployed data.
You can configure AppConfig Agent as a local host and have the agent poll AppConfig for configuration updates. The agent calls the StartConfigurationSession and GetLatestConfiguration API actions and caches your configuration data locally. To retrieve the data, your application makes an HTTP call to the localhost server. AppConfig Agent supports several use cases, as described in Simplified retrieval methods in the the AppConfig User Guide.
If AppConfig Agent isn't supported for your use case, you can configure your application to poll AppConfig for configuration updates by directly calling the StartConfigurationSession and GetLatestConfiguration API actions.
This reference is intended to be used with the AppConfig User Guide.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIXbuilder, createApplication, createConfigurationProfile, createDeploymentStrategy, createEnvironment, createExtension, createExtensionAssociation, createHostedConfigurationVersion, deleteApplication, deleteConfigurationProfile, deleteDeploymentStrategy, deleteEnvironment, deleteExtension, deleteExtensionAssociation, deleteHostedConfigurationVersion, getApplication, getCachedResponseMetadata, getConfiguration, getConfigurationProfile, getDeployment, getDeploymentStrategy, getEnvironment, getExtension, getExtensionAssociation, getHostedConfigurationVersion, listApplications, listConfigurationProfiles, listDeployments, listDeploymentStrategies, listEnvironments, listExtensionAssociations, listExtensions, listHostedConfigurationVersions, listTagsForResource, startDeployment, stopDeployment, tagResource, untagResource, updateApplication, updateConfigurationProfile, updateDeploymentStrategy, updateEnvironment, updateExtension, updateExtensionAssociation, validateConfigurationaddRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitcreateApplication, createConfigurationProfile, createDeploymentStrategy, createEnvironment, createExtension, createExtensionAssociation, createHostedConfigurationVersion, deleteApplication, deleteConfigurationProfile, deleteDeploymentStrategy, deleteEnvironment, deleteExtension, deleteExtensionAssociation, deleteHostedConfigurationVersion, getApplication, getCachedResponseMetadata, getConfiguration, getConfigurationProfile, getDeployment, getDeploymentStrategy, getEnvironment, getExtension, getExtensionAssociation, getHostedConfigurationVersion, listApplications, listConfigurationProfiles, listDeployments, listDeploymentStrategies, listEnvironments, listExtensionAssociations, listExtensions, listHostedConfigurationVersions, listTagsForResource, startDeployment, stopDeployment, tagResource, untagResource, updateApplication, updateConfigurationProfile, updateDeploymentStrategy, updateEnvironment, updateExtension, updateExtensionAssociation, validateConfigurationpublic static AmazonAppConfigAsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<CreateApplicationResult> createApplicationAsync(CreateApplicationRequest request)
AmazonAppConfigAsyncCreates an application. In AppConfig, an application is simply an organizational construct like a folder. This organizational construct has a relationship with some unit of executable code. For example, you could create an application called MyMobileApp to organize and manage configuration data for a mobile application installed by your users.
createApplicationAsync in interface AmazonAppConfigAsyncpublic Future<CreateApplicationResult> createApplicationAsync(CreateApplicationRequest request, AsyncHandler<CreateApplicationRequest,CreateApplicationResult> asyncHandler)
AmazonAppConfigAsyncCreates an application. In AppConfig, an application is simply an organizational construct like a folder. This organizational construct has a relationship with some unit of executable code. For example, you could create an application called MyMobileApp to organize and manage configuration data for a mobile application installed by your users.
createApplicationAsync in interface AmazonAppConfigAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateConfigurationProfileResult> createConfigurationProfileAsync(CreateConfigurationProfileRequest request)
AmazonAppConfigAsyncCreates a configuration profile, which is information that enables AppConfig to access the configuration source. Valid configuration sources include the following:
Configuration data in YAML, JSON, and other formats stored in the AppConfig hosted configuration store
Configuration data stored as objects in an Amazon Simple Storage Service (Amazon S3) bucket
Pipelines stored in CodePipeline
Secrets stored in Secrets Manager
Standard and secure string parameters stored in Amazon Web Services Systems Manager Parameter Store
Configuration data in SSM documents stored in the Systems Manager document store
A configuration profile includes the following information:
The URI location of the configuration data.
The Identity and Access Management (IAM) role that provides access to the configuration data.
A validator for the configuration data. Available validators include either a JSON Schema or an Amazon Web Services Lambda function.
For more information, see Create a Configuration and a Configuration Profile in the AppConfig User Guide.
createConfigurationProfileAsync in interface AmazonAppConfigAsyncpublic Future<CreateConfigurationProfileResult> createConfigurationProfileAsync(CreateConfigurationProfileRequest request, AsyncHandler<CreateConfigurationProfileRequest,CreateConfigurationProfileResult> asyncHandler)
AmazonAppConfigAsyncCreates a configuration profile, which is information that enables AppConfig to access the configuration source. Valid configuration sources include the following:
Configuration data in YAML, JSON, and other formats stored in the AppConfig hosted configuration store
Configuration data stored as objects in an Amazon Simple Storage Service (Amazon S3) bucket
Pipelines stored in CodePipeline
Secrets stored in Secrets Manager
Standard and secure string parameters stored in Amazon Web Services Systems Manager Parameter Store
Configuration data in SSM documents stored in the Systems Manager document store
A configuration profile includes the following information:
The URI location of the configuration data.
The Identity and Access Management (IAM) role that provides access to the configuration data.
A validator for the configuration data. Available validators include either a JSON Schema or an Amazon Web Services Lambda function.
For more information, see Create a Configuration and a Configuration Profile in the AppConfig User Guide.
createConfigurationProfileAsync in interface AmazonAppConfigAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateDeploymentStrategyResult> createDeploymentStrategyAsync(CreateDeploymentStrategyRequest request)
AmazonAppConfigAsyncCreates a deployment strategy that defines important criteria for rolling out your configuration to the designated targets. A deployment strategy includes the overall duration required, a percentage of targets to receive the deployment during each interval, an algorithm that defines how percentage grows, and bake time.
createDeploymentStrategyAsync in interface AmazonAppConfigAsyncpublic Future<CreateDeploymentStrategyResult> createDeploymentStrategyAsync(CreateDeploymentStrategyRequest request, AsyncHandler<CreateDeploymentStrategyRequest,CreateDeploymentStrategyResult> asyncHandler)
AmazonAppConfigAsyncCreates a deployment strategy that defines important criteria for rolling out your configuration to the designated targets. A deployment strategy includes the overall duration required, a percentage of targets to receive the deployment during each interval, an algorithm that defines how percentage grows, and bake time.
createDeploymentStrategyAsync in interface AmazonAppConfigAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateEnvironmentResult> createEnvironmentAsync(CreateEnvironmentRequest request)
AmazonAppConfigAsync
Creates an environment. For each application, you define one or more environments. An environment is a deployment
group of AppConfig targets, such as applications in a Beta or Production environment.
You can also define environments for application subcomponents such as the Web, Mobile
and Back-end components for your application. You can configure Amazon CloudWatch alarms for each
environment. The system monitors alarms during a configuration deployment. If an alarm is triggered, the system
rolls back the configuration.
createEnvironmentAsync in interface AmazonAppConfigAsyncpublic Future<CreateEnvironmentResult> createEnvironmentAsync(CreateEnvironmentRequest request, AsyncHandler<CreateEnvironmentRequest,CreateEnvironmentResult> asyncHandler)
AmazonAppConfigAsync
Creates an environment. For each application, you define one or more environments. An environment is a deployment
group of AppConfig targets, such as applications in a Beta or Production environment.
You can also define environments for application subcomponents such as the Web, Mobile
and Back-end components for your application. You can configure Amazon CloudWatch alarms for each
environment. The system monitors alarms during a configuration deployment. If an alarm is triggered, the system
rolls back the configuration.
createEnvironmentAsync in interface AmazonAppConfigAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateExtensionResult> createExtensionAsync(CreateExtensionRequest request)
AmazonAppConfigAsyncCreates an AppConfig extension. An extension augments your ability to inject logic or behavior at different points during the AppConfig workflow of creating or deploying a configuration.
You can create your own extensions or use the Amazon Web Services authored extensions provided by AppConfig. For
an AppConfig extension that uses Lambda, you must create a Lambda function to perform any computation and
processing defined in the extension. If you plan to create custom versions of the Amazon Web Services authored
notification extensions, you only need to specify an Amazon Resource Name (ARN) in the Uri field for
the new extension version.
For a custom EventBridge notification extension, enter the ARN of the EventBridge default events in the
Uri field.
For a custom Amazon SNS notification extension, enter the ARN of an Amazon SNS topic in the Uri
field.
For a custom Amazon SQS notification extension, enter the ARN of an Amazon SQS message queue in the
Uri field.
For more information about extensions, see Extending workflows in the AppConfig User Guide.
createExtensionAsync in interface AmazonAppConfigAsyncpublic Future<CreateExtensionResult> createExtensionAsync(CreateExtensionRequest request, AsyncHandler<CreateExtensionRequest,CreateExtensionResult> asyncHandler)
AmazonAppConfigAsyncCreates an AppConfig extension. An extension augments your ability to inject logic or behavior at different points during the AppConfig workflow of creating or deploying a configuration.
You can create your own extensions or use the Amazon Web Services authored extensions provided by AppConfig. For
an AppConfig extension that uses Lambda, you must create a Lambda function to perform any computation and
processing defined in the extension. If you plan to create custom versions of the Amazon Web Services authored
notification extensions, you only need to specify an Amazon Resource Name (ARN) in the Uri field for
the new extension version.
For a custom EventBridge notification extension, enter the ARN of the EventBridge default events in the
Uri field.
For a custom Amazon SNS notification extension, enter the ARN of an Amazon SNS topic in the Uri
field.
For a custom Amazon SQS notification extension, enter the ARN of an Amazon SQS message queue in the
Uri field.
For more information about extensions, see Extending workflows in the AppConfig User Guide.
createExtensionAsync in interface AmazonAppConfigAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateExtensionAssociationResult> createExtensionAssociationAsync(CreateExtensionAssociationRequest request)
AmazonAppConfigAsync
When you create an extension or configure an Amazon Web Services authored extension, you associate the extension
with an AppConfig application, environment, or configuration profile. For example, you can choose to run the
AppConfig deployment events to Amazon SNS Amazon Web Services authored extension and receive
notifications on an Amazon SNS topic anytime a configuration deployment is started for a specific application.
Defining which extension to associate with an AppConfig resource is called an extension association. An
extension association is a specified relationship between an extension and an AppConfig resource, such as an
application or a configuration profile. For more information about extensions and associations, see Extending
workflows in the AppConfig User Guide.
createExtensionAssociationAsync in interface AmazonAppConfigAsyncpublic Future<CreateExtensionAssociationResult> createExtensionAssociationAsync(CreateExtensionAssociationRequest request, AsyncHandler<CreateExtensionAssociationRequest,CreateExtensionAssociationResult> asyncHandler)
AmazonAppConfigAsync
When you create an extension or configure an Amazon Web Services authored extension, you associate the extension
with an AppConfig application, environment, or configuration profile. For example, you can choose to run the
AppConfig deployment events to Amazon SNS Amazon Web Services authored extension and receive
notifications on an Amazon SNS topic anytime a configuration deployment is started for a specific application.
Defining which extension to associate with an AppConfig resource is called an extension association. An
extension association is a specified relationship between an extension and an AppConfig resource, such as an
application or a configuration profile. For more information about extensions and associations, see Extending
workflows in the AppConfig User Guide.
createExtensionAssociationAsync in interface AmazonAppConfigAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateHostedConfigurationVersionResult> createHostedConfigurationVersionAsync(CreateHostedConfigurationVersionRequest request)
AmazonAppConfigAsyncCreates a new configuration in the AppConfig hosted configuration store.
createHostedConfigurationVersionAsync in interface AmazonAppConfigAsyncpublic Future<CreateHostedConfigurationVersionResult> createHostedConfigurationVersionAsync(CreateHostedConfigurationVersionRequest request, AsyncHandler<CreateHostedConfigurationVersionRequest,CreateHostedConfigurationVersionResult> asyncHandler)
AmazonAppConfigAsyncCreates a new configuration in the AppConfig hosted configuration store.
createHostedConfigurationVersionAsync in interface AmazonAppConfigAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteApplicationResult> deleteApplicationAsync(DeleteApplicationRequest request)
AmazonAppConfigAsyncDeletes an application. Deleting an application does not delete a configuration from a host.
deleteApplicationAsync in interface AmazonAppConfigAsyncpublic Future<DeleteApplicationResult> deleteApplicationAsync(DeleteApplicationRequest request, AsyncHandler<DeleteApplicationRequest,DeleteApplicationResult> asyncHandler)
AmazonAppConfigAsyncDeletes an application. Deleting an application does not delete a configuration from a host.
deleteApplicationAsync in interface AmazonAppConfigAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteConfigurationProfileResult> deleteConfigurationProfileAsync(DeleteConfigurationProfileRequest request)
AmazonAppConfigAsyncDeletes a configuration profile. Deleting a configuration profile does not delete a configuration from a host.
deleteConfigurationProfileAsync in interface AmazonAppConfigAsyncpublic Future<DeleteConfigurationProfileResult> deleteConfigurationProfileAsync(DeleteConfigurationProfileRequest request, AsyncHandler<DeleteConfigurationProfileRequest,DeleteConfigurationProfileResult> asyncHandler)
AmazonAppConfigAsyncDeletes a configuration profile. Deleting a configuration profile does not delete a configuration from a host.
deleteConfigurationProfileAsync in interface AmazonAppConfigAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteDeploymentStrategyResult> deleteDeploymentStrategyAsync(DeleteDeploymentStrategyRequest request)
AmazonAppConfigAsyncDeletes a deployment strategy. Deleting a deployment strategy does not delete a configuration from a host.
deleteDeploymentStrategyAsync in interface AmazonAppConfigAsyncpublic Future<DeleteDeploymentStrategyResult> deleteDeploymentStrategyAsync(DeleteDeploymentStrategyRequest request, AsyncHandler<DeleteDeploymentStrategyRequest,DeleteDeploymentStrategyResult> asyncHandler)
AmazonAppConfigAsyncDeletes a deployment strategy. Deleting a deployment strategy does not delete a configuration from a host.
deleteDeploymentStrategyAsync in interface AmazonAppConfigAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteEnvironmentResult> deleteEnvironmentAsync(DeleteEnvironmentRequest request)
AmazonAppConfigAsyncDeletes an environment. Deleting an environment does not delete a configuration from a host.
deleteEnvironmentAsync in interface AmazonAppConfigAsyncpublic Future<DeleteEnvironmentResult> deleteEnvironmentAsync(DeleteEnvironmentRequest request, AsyncHandler<DeleteEnvironmentRequest,DeleteEnvironmentResult> asyncHandler)
AmazonAppConfigAsyncDeletes an environment. Deleting an environment does not delete a configuration from a host.
deleteEnvironmentAsync in interface AmazonAppConfigAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteExtensionResult> deleteExtensionAsync(DeleteExtensionRequest request)
AmazonAppConfigAsyncDeletes an AppConfig extension. You must delete all associations to an extension before you delete the extension.
deleteExtensionAsync in interface AmazonAppConfigAsyncpublic Future<DeleteExtensionResult> deleteExtensionAsync(DeleteExtensionRequest request, AsyncHandler<DeleteExtensionRequest,DeleteExtensionResult> asyncHandler)
AmazonAppConfigAsyncDeletes an AppConfig extension. You must delete all associations to an extension before you delete the extension.
deleteExtensionAsync in interface AmazonAppConfigAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteExtensionAssociationResult> deleteExtensionAssociationAsync(DeleteExtensionAssociationRequest request)
AmazonAppConfigAsyncDeletes an extension association. This action doesn't delete extensions defined in the association.
deleteExtensionAssociationAsync in interface AmazonAppConfigAsyncpublic Future<DeleteExtensionAssociationResult> deleteExtensionAssociationAsync(DeleteExtensionAssociationRequest request, AsyncHandler<DeleteExtensionAssociationRequest,DeleteExtensionAssociationResult> asyncHandler)
AmazonAppConfigAsyncDeletes an extension association. This action doesn't delete extensions defined in the association.
deleteExtensionAssociationAsync in interface AmazonAppConfigAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteHostedConfigurationVersionResult> deleteHostedConfigurationVersionAsync(DeleteHostedConfigurationVersionRequest request)
AmazonAppConfigAsyncDeletes a version of a configuration from the AppConfig hosted configuration store.
deleteHostedConfigurationVersionAsync in interface AmazonAppConfigAsyncpublic Future<DeleteHostedConfigurationVersionResult> deleteHostedConfigurationVersionAsync(DeleteHostedConfigurationVersionRequest request, AsyncHandler<DeleteHostedConfigurationVersionRequest,DeleteHostedConfigurationVersionResult> asyncHandler)
AmazonAppConfigAsyncDeletes a version of a configuration from the AppConfig hosted configuration store.
deleteHostedConfigurationVersionAsync in interface AmazonAppConfigAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetApplicationResult> getApplicationAsync(GetApplicationRequest request)
AmazonAppConfigAsyncRetrieves information about an application.
getApplicationAsync in interface AmazonAppConfigAsyncpublic Future<GetApplicationResult> getApplicationAsync(GetApplicationRequest request, AsyncHandler<GetApplicationRequest,GetApplicationResult> asyncHandler)
AmazonAppConfigAsyncRetrieves information about an application.
getApplicationAsync in interface AmazonAppConfigAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.@Deprecated public Future<GetConfigurationResult> getConfigurationAsync(GetConfigurationRequest request)
AmazonAppConfigAsync(Deprecated) Retrieves the latest deployed configuration.
Note the following important information.
This API action is deprecated. Calls to receive configuration data should use the StartConfigurationSession and GetLatestConfiguration APIs instead.
GetConfiguration is a priced call. For more information, see Pricing.
getConfigurationAsync in interface AmazonAppConfigAsync@Deprecated public Future<GetConfigurationResult> getConfigurationAsync(GetConfigurationRequest request, AsyncHandler<GetConfigurationRequest,GetConfigurationResult> asyncHandler)
AmazonAppConfigAsync(Deprecated) Retrieves the latest deployed configuration.
Note the following important information.
This API action is deprecated. Calls to receive configuration data should use the StartConfigurationSession and GetLatestConfiguration APIs instead.
GetConfiguration is a priced call. For more information, see Pricing.
getConfigurationAsync in interface AmazonAppConfigAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetConfigurationProfileResult> getConfigurationProfileAsync(GetConfigurationProfileRequest request)
AmazonAppConfigAsyncRetrieves information about a configuration profile.
getConfigurationProfileAsync in interface AmazonAppConfigAsyncpublic Future<GetConfigurationProfileResult> getConfigurationProfileAsync(GetConfigurationProfileRequest request, AsyncHandler<GetConfigurationProfileRequest,GetConfigurationProfileResult> asyncHandler)
AmazonAppConfigAsyncRetrieves information about a configuration profile.
getConfigurationProfileAsync in interface AmazonAppConfigAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetDeploymentResult> getDeploymentAsync(GetDeploymentRequest request)
AmazonAppConfigAsyncRetrieves information about a configuration deployment.
getDeploymentAsync in interface AmazonAppConfigAsyncpublic Future<GetDeploymentResult> getDeploymentAsync(GetDeploymentRequest request, AsyncHandler<GetDeploymentRequest,GetDeploymentResult> asyncHandler)
AmazonAppConfigAsyncRetrieves information about a configuration deployment.
getDeploymentAsync in interface AmazonAppConfigAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetDeploymentStrategyResult> getDeploymentStrategyAsync(GetDeploymentStrategyRequest request)
AmazonAppConfigAsyncRetrieves information about a deployment strategy. A deployment strategy defines important criteria for rolling out your configuration to the designated targets. A deployment strategy includes the overall duration required, a percentage of targets to receive the deployment during each interval, an algorithm that defines how percentage grows, and bake time.
getDeploymentStrategyAsync in interface AmazonAppConfigAsyncpublic Future<GetDeploymentStrategyResult> getDeploymentStrategyAsync(GetDeploymentStrategyRequest request, AsyncHandler<GetDeploymentStrategyRequest,GetDeploymentStrategyResult> asyncHandler)
AmazonAppConfigAsyncRetrieves information about a deployment strategy. A deployment strategy defines important criteria for rolling out your configuration to the designated targets. A deployment strategy includes the overall duration required, a percentage of targets to receive the deployment during each interval, an algorithm that defines how percentage grows, and bake time.
getDeploymentStrategyAsync in interface AmazonAppConfigAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetEnvironmentResult> getEnvironmentAsync(GetEnvironmentRequest request)
AmazonAppConfigAsync
Retrieves information about an environment. An environment is a deployment group of AppConfig applications, such
as applications in a Production environment or in an EU_Region environment. Each
configuration deployment targets an environment. You can enable one or more Amazon CloudWatch alarms for an
environment. If an alarm is triggered during a deployment, AppConfig roles back the configuration.
getEnvironmentAsync in interface AmazonAppConfigAsyncpublic Future<GetEnvironmentResult> getEnvironmentAsync(GetEnvironmentRequest request, AsyncHandler<GetEnvironmentRequest,GetEnvironmentResult> asyncHandler)
AmazonAppConfigAsync
Retrieves information about an environment. An environment is a deployment group of AppConfig applications, such
as applications in a Production environment or in an EU_Region environment. Each
configuration deployment targets an environment. You can enable one or more Amazon CloudWatch alarms for an
environment. If an alarm is triggered during a deployment, AppConfig roles back the configuration.
getEnvironmentAsync in interface AmazonAppConfigAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetExtensionResult> getExtensionAsync(GetExtensionRequest request)
AmazonAppConfigAsyncReturns information about an AppConfig extension.
getExtensionAsync in interface AmazonAppConfigAsyncpublic Future<GetExtensionResult> getExtensionAsync(GetExtensionRequest request, AsyncHandler<GetExtensionRequest,GetExtensionResult> asyncHandler)
AmazonAppConfigAsyncReturns information about an AppConfig extension.
getExtensionAsync in interface AmazonAppConfigAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetExtensionAssociationResult> getExtensionAssociationAsync(GetExtensionAssociationRequest request)
AmazonAppConfigAsyncReturns information about an AppConfig extension association. For more information about extensions and associations, see Extending workflows in the AppConfig User Guide.
getExtensionAssociationAsync in interface AmazonAppConfigAsyncpublic Future<GetExtensionAssociationResult> getExtensionAssociationAsync(GetExtensionAssociationRequest request, AsyncHandler<GetExtensionAssociationRequest,GetExtensionAssociationResult> asyncHandler)
AmazonAppConfigAsyncReturns information about an AppConfig extension association. For more information about extensions and associations, see Extending workflows in the AppConfig User Guide.
getExtensionAssociationAsync in interface AmazonAppConfigAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetHostedConfigurationVersionResult> getHostedConfigurationVersionAsync(GetHostedConfigurationVersionRequest request)
AmazonAppConfigAsyncRetrieves information about a specific configuration version.
getHostedConfigurationVersionAsync in interface AmazonAppConfigAsyncpublic Future<GetHostedConfigurationVersionResult> getHostedConfigurationVersionAsync(GetHostedConfigurationVersionRequest request, AsyncHandler<GetHostedConfigurationVersionRequest,GetHostedConfigurationVersionResult> asyncHandler)
AmazonAppConfigAsyncRetrieves information about a specific configuration version.
getHostedConfigurationVersionAsync in interface AmazonAppConfigAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListApplicationsResult> listApplicationsAsync(ListApplicationsRequest request)
AmazonAppConfigAsyncLists all applications in your Amazon Web Services account.
listApplicationsAsync in interface AmazonAppConfigAsyncpublic Future<ListApplicationsResult> listApplicationsAsync(ListApplicationsRequest request, AsyncHandler<ListApplicationsRequest,ListApplicationsResult> asyncHandler)
AmazonAppConfigAsyncLists all applications in your Amazon Web Services account.
listApplicationsAsync in interface AmazonAppConfigAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListConfigurationProfilesResult> listConfigurationProfilesAsync(ListConfigurationProfilesRequest request)
AmazonAppConfigAsyncLists the configuration profiles for an application.
listConfigurationProfilesAsync in interface AmazonAppConfigAsyncpublic Future<ListConfigurationProfilesResult> listConfigurationProfilesAsync(ListConfigurationProfilesRequest request, AsyncHandler<ListConfigurationProfilesRequest,ListConfigurationProfilesResult> asyncHandler)
AmazonAppConfigAsyncLists the configuration profiles for an application.
listConfigurationProfilesAsync in interface AmazonAppConfigAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListDeploymentStrategiesResult> listDeploymentStrategiesAsync(ListDeploymentStrategiesRequest request)
AmazonAppConfigAsyncLists deployment strategies.
listDeploymentStrategiesAsync in interface AmazonAppConfigAsyncpublic Future<ListDeploymentStrategiesResult> listDeploymentStrategiesAsync(ListDeploymentStrategiesRequest request, AsyncHandler<ListDeploymentStrategiesRequest,ListDeploymentStrategiesResult> asyncHandler)
AmazonAppConfigAsyncLists deployment strategies.
listDeploymentStrategiesAsync in interface AmazonAppConfigAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListDeploymentsResult> listDeploymentsAsync(ListDeploymentsRequest request)
AmazonAppConfigAsyncLists the deployments for an environment in descending deployment number order.
listDeploymentsAsync in interface AmazonAppConfigAsyncpublic Future<ListDeploymentsResult> listDeploymentsAsync(ListDeploymentsRequest request, AsyncHandler<ListDeploymentsRequest,ListDeploymentsResult> asyncHandler)
AmazonAppConfigAsyncLists the deployments for an environment in descending deployment number order.
listDeploymentsAsync in interface AmazonAppConfigAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListEnvironmentsResult> listEnvironmentsAsync(ListEnvironmentsRequest request)
AmazonAppConfigAsyncLists the environments for an application.
listEnvironmentsAsync in interface AmazonAppConfigAsyncpublic Future<ListEnvironmentsResult> listEnvironmentsAsync(ListEnvironmentsRequest request, AsyncHandler<ListEnvironmentsRequest,ListEnvironmentsResult> asyncHandler)
AmazonAppConfigAsyncLists the environments for an application.
listEnvironmentsAsync in interface AmazonAppConfigAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListExtensionAssociationsResult> listExtensionAssociationsAsync(ListExtensionAssociationsRequest request)
AmazonAppConfigAsyncLists all AppConfig extension associations in the account. For more information about extensions and associations, see Extending workflows in the AppConfig User Guide.
listExtensionAssociationsAsync in interface AmazonAppConfigAsyncpublic Future<ListExtensionAssociationsResult> listExtensionAssociationsAsync(ListExtensionAssociationsRequest request, AsyncHandler<ListExtensionAssociationsRequest,ListExtensionAssociationsResult> asyncHandler)
AmazonAppConfigAsyncLists all AppConfig extension associations in the account. For more information about extensions and associations, see Extending workflows in the AppConfig User Guide.
listExtensionAssociationsAsync in interface AmazonAppConfigAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListExtensionsResult> listExtensionsAsync(ListExtensionsRequest request)
AmazonAppConfigAsyncLists all custom and Amazon Web Services authored AppConfig extensions in the account. For more information about extensions, see Extending workflows in the AppConfig User Guide.
listExtensionsAsync in interface AmazonAppConfigAsyncpublic Future<ListExtensionsResult> listExtensionsAsync(ListExtensionsRequest request, AsyncHandler<ListExtensionsRequest,ListExtensionsResult> asyncHandler)
AmazonAppConfigAsyncLists all custom and Amazon Web Services authored AppConfig extensions in the account. For more information about extensions, see Extending workflows in the AppConfig User Guide.
listExtensionsAsync in interface AmazonAppConfigAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListHostedConfigurationVersionsResult> listHostedConfigurationVersionsAsync(ListHostedConfigurationVersionsRequest request)
AmazonAppConfigAsyncLists configurations stored in the AppConfig hosted configuration store by version.
listHostedConfigurationVersionsAsync in interface AmazonAppConfigAsyncpublic Future<ListHostedConfigurationVersionsResult> listHostedConfigurationVersionsAsync(ListHostedConfigurationVersionsRequest request, AsyncHandler<ListHostedConfigurationVersionsRequest,ListHostedConfigurationVersionsResult> asyncHandler)
AmazonAppConfigAsyncLists configurations stored in the AppConfig hosted configuration store by version.
listHostedConfigurationVersionsAsync in interface AmazonAppConfigAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request)
AmazonAppConfigAsyncRetrieves the list of key-value tags assigned to the resource.
listTagsForResourceAsync in interface AmazonAppConfigAsyncpublic Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
AmazonAppConfigAsyncRetrieves the list of key-value tags assigned to the resource.
listTagsForResourceAsync in interface AmazonAppConfigAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<StartDeploymentResult> startDeploymentAsync(StartDeploymentRequest request)
AmazonAppConfigAsyncStarts a deployment.
startDeploymentAsync in interface AmazonAppConfigAsyncpublic Future<StartDeploymentResult> startDeploymentAsync(StartDeploymentRequest request, AsyncHandler<StartDeploymentRequest,StartDeploymentResult> asyncHandler)
AmazonAppConfigAsyncStarts a deployment.
startDeploymentAsync in interface AmazonAppConfigAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<StopDeploymentResult> stopDeploymentAsync(StopDeploymentRequest request)
AmazonAppConfigAsync
Stops a deployment. This API action works only on deployments that have a status of DEPLOYING. This
action moves the deployment to a status of ROLLED_BACK.
stopDeploymentAsync in interface AmazonAppConfigAsyncpublic Future<StopDeploymentResult> stopDeploymentAsync(StopDeploymentRequest request, AsyncHandler<StopDeploymentRequest,StopDeploymentResult> asyncHandler)
AmazonAppConfigAsync
Stops a deployment. This API action works only on deployments that have a status of DEPLOYING. This
action moves the deployment to a status of ROLLED_BACK.
stopDeploymentAsync in interface AmazonAppConfigAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request)
AmazonAppConfigAsyncAssigns metadata to an AppConfig resource. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define. You can specify a maximum of 50 tags for a resource.
tagResourceAsync in interface AmazonAppConfigAsyncpublic Future<TagResourceResult> tagResourceAsync(TagResourceRequest request, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
AmazonAppConfigAsyncAssigns metadata to an AppConfig resource. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define. You can specify a maximum of 50 tags for a resource.
tagResourceAsync in interface AmazonAppConfigAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request)
AmazonAppConfigAsyncDeletes a tag key and value from an AppConfig resource.
untagResourceAsync in interface AmazonAppConfigAsyncpublic Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
AmazonAppConfigAsyncDeletes a tag key and value from an AppConfig resource.
untagResourceAsync in interface AmazonAppConfigAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateApplicationResult> updateApplicationAsync(UpdateApplicationRequest request)
AmazonAppConfigAsyncUpdates an application.
updateApplicationAsync in interface AmazonAppConfigAsyncpublic Future<UpdateApplicationResult> updateApplicationAsync(UpdateApplicationRequest request, AsyncHandler<UpdateApplicationRequest,UpdateApplicationResult> asyncHandler)
AmazonAppConfigAsyncUpdates an application.
updateApplicationAsync in interface AmazonAppConfigAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateConfigurationProfileResult> updateConfigurationProfileAsync(UpdateConfigurationProfileRequest request)
AmazonAppConfigAsyncUpdates a configuration profile.
updateConfigurationProfileAsync in interface AmazonAppConfigAsyncpublic Future<UpdateConfigurationProfileResult> updateConfigurationProfileAsync(UpdateConfigurationProfileRequest request, AsyncHandler<UpdateConfigurationProfileRequest,UpdateConfigurationProfileResult> asyncHandler)
AmazonAppConfigAsyncUpdates a configuration profile.
updateConfigurationProfileAsync in interface AmazonAppConfigAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateDeploymentStrategyResult> updateDeploymentStrategyAsync(UpdateDeploymentStrategyRequest request)
AmazonAppConfigAsyncUpdates a deployment strategy.
updateDeploymentStrategyAsync in interface AmazonAppConfigAsyncpublic Future<UpdateDeploymentStrategyResult> updateDeploymentStrategyAsync(UpdateDeploymentStrategyRequest request, AsyncHandler<UpdateDeploymentStrategyRequest,UpdateDeploymentStrategyResult> asyncHandler)
AmazonAppConfigAsyncUpdates a deployment strategy.
updateDeploymentStrategyAsync in interface AmazonAppConfigAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateEnvironmentResult> updateEnvironmentAsync(UpdateEnvironmentRequest request)
AmazonAppConfigAsyncUpdates an environment.
updateEnvironmentAsync in interface AmazonAppConfigAsyncpublic Future<UpdateEnvironmentResult> updateEnvironmentAsync(UpdateEnvironmentRequest request, AsyncHandler<UpdateEnvironmentRequest,UpdateEnvironmentResult> asyncHandler)
AmazonAppConfigAsyncUpdates an environment.
updateEnvironmentAsync in interface AmazonAppConfigAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateExtensionResult> updateExtensionAsync(UpdateExtensionRequest request)
AmazonAppConfigAsyncUpdates an AppConfig extension. For more information about extensions, see Extending workflows in the AppConfig User Guide.
updateExtensionAsync in interface AmazonAppConfigAsyncpublic Future<UpdateExtensionResult> updateExtensionAsync(UpdateExtensionRequest request, AsyncHandler<UpdateExtensionRequest,UpdateExtensionResult> asyncHandler)
AmazonAppConfigAsyncUpdates an AppConfig extension. For more information about extensions, see Extending workflows in the AppConfig User Guide.
updateExtensionAsync in interface AmazonAppConfigAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateExtensionAssociationResult> updateExtensionAssociationAsync(UpdateExtensionAssociationRequest request)
AmazonAppConfigAsyncUpdates an association. For more information about extensions and associations, see Extending workflows in the AppConfig User Guide.
updateExtensionAssociationAsync in interface AmazonAppConfigAsyncpublic Future<UpdateExtensionAssociationResult> updateExtensionAssociationAsync(UpdateExtensionAssociationRequest request, AsyncHandler<UpdateExtensionAssociationRequest,UpdateExtensionAssociationResult> asyncHandler)
AmazonAppConfigAsyncUpdates an association. For more information about extensions and associations, see Extending workflows in the AppConfig User Guide.
updateExtensionAssociationAsync in interface AmazonAppConfigAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ValidateConfigurationResult> validateConfigurationAsync(ValidateConfigurationRequest request)
AmazonAppConfigAsyncUses the validators in a configuration profile to validate a configuration.
validateConfigurationAsync in interface AmazonAppConfigAsyncpublic Future<ValidateConfigurationResult> validateConfigurationAsync(ValidateConfigurationRequest request, AsyncHandler<ValidateConfigurationRequest,ValidateConfigurationResult> asyncHandler)
AmazonAppConfigAsyncUses the validators in a configuration profile to validate a configuration.
validateConfigurationAsync in interface AmazonAppConfigAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public void shutdown()
getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to
calling this method.shutdown in interface AmazonAppConfigshutdown in class AmazonAppConfigClient