@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonAppConfig
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonAppConfig
instead.
Use AWS AppConfig, a capability of AWS Systems Manager, to create, manage, and quickly deploy application configurations. AppConfig supports controlled deployments to applications of any size and includes built-in validation checks and monitoring. You can use AppConfig with applications hosted on Amazon EC2 instances, AWS Lambda, containers, mobile applications, or IoT devices.
To prevent errors when deploying application configurations, especially for production systems where a simple typo could cause an unexpected outage, AppConfig includes validators. A validator provides a syntactic or semantic check to ensure that the configuration you want to deploy works as intended. To validate your application configuration data, you provide a schema or a Lambda function that runs against the configuration. The configuration deployment or update can only proceed when the configuration data is valid.
During a configuration deployment, AppConfig monitors the application to ensure that the deployment is successful. If the system encounters an error, AppConfig rolls back the change to minimize impact for your application users. You can configure a deployment strategy for each application or environment that includes deployment criteria, including velocity, bake time, and alarms to monitor. Similar to error monitoring, if a deployment triggers an alarm, AppConfig automatically rolls back to the previous version.
AppConfig supports multiple use cases. Here are some examples.
Application tuning: Use AppConfig to carefully introduce changes to your application that can only be tested with production traffic.
Feature toggle: Use AppConfig to turn on new features that require a timely deployment, such as a product launch or announcement.
Allow list: Use AppConfig to allow premium subscribers to access paid content.
Operational issues: Use AppConfig to reduce stress on your application when a dependency or other external factor impacts the system.
This reference is intended to be used with the AWS AppConfig User Guide.
Modifier and Type | Field and Description |
---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
Modifier and Type | Method and Description |
---|---|
CreateApplicationResult |
createApplication(CreateApplicationRequest createApplicationRequest)
An application in AppConfig is a logical unit of code that provides capabilities for your customers.
|
CreateConfigurationProfileResult |
createConfigurationProfile(CreateConfigurationProfileRequest createConfigurationProfileRequest)
Information that enables AppConfig to access the configuration source.
|
CreateDeploymentStrategyResult |
createDeploymentStrategy(CreateDeploymentStrategyRequest createDeploymentStrategyRequest)
A deployment strategy defines important criteria for rolling out your configuration to the designated targets.
|
CreateEnvironmentResult |
createEnvironment(CreateEnvironmentRequest createEnvironmentRequest)
For each application, you define one or more environments.
|
CreateHostedConfigurationVersionResult |
createHostedConfigurationVersion(CreateHostedConfigurationVersionRequest createHostedConfigurationVersionRequest)
Create a new configuration in the AppConfig configuration store.
|
DeleteApplicationResult |
deleteApplication(DeleteApplicationRequest deleteApplicationRequest)
Delete an application.
|
DeleteConfigurationProfileResult |
deleteConfigurationProfile(DeleteConfigurationProfileRequest deleteConfigurationProfileRequest)
Delete a configuration profile.
|
DeleteDeploymentStrategyResult |
deleteDeploymentStrategy(DeleteDeploymentStrategyRequest deleteDeploymentStrategyRequest)
Delete a deployment strategy.
|
DeleteEnvironmentResult |
deleteEnvironment(DeleteEnvironmentRequest deleteEnvironmentRequest)
Delete an environment.
|
DeleteHostedConfigurationVersionResult |
deleteHostedConfigurationVersion(DeleteHostedConfigurationVersionRequest deleteHostedConfigurationVersionRequest)
Delete a version of a configuration from the AppConfig configuration store.
|
GetApplicationResult |
getApplication(GetApplicationRequest getApplicationRequest)
Retrieve information about an application.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetConfigurationResult |
getConfiguration(GetConfigurationRequest getConfigurationRequest)
Receive information about a configuration.
|
GetConfigurationProfileResult |
getConfigurationProfile(GetConfigurationProfileRequest getConfigurationProfileRequest)
Retrieve information about a configuration profile.
|
GetDeploymentResult |
getDeployment(GetDeploymentRequest getDeploymentRequest)
Retrieve information about a configuration deployment.
|
GetDeploymentStrategyResult |
getDeploymentStrategy(GetDeploymentStrategyRequest getDeploymentStrategyRequest)
Retrieve information about a deployment strategy.
|
GetEnvironmentResult |
getEnvironment(GetEnvironmentRequest getEnvironmentRequest)
Retrieve information about an environment.
|
GetHostedConfigurationVersionResult |
getHostedConfigurationVersion(GetHostedConfigurationVersionRequest getHostedConfigurationVersionRequest)
Get information about a specific configuration version.
|
ListApplicationsResult |
listApplications(ListApplicationsRequest listApplicationsRequest)
List all applications in your AWS account.
|
ListConfigurationProfilesResult |
listConfigurationProfiles(ListConfigurationProfilesRequest listConfigurationProfilesRequest)
Lists the configuration profiles for an application.
|
ListDeploymentsResult |
listDeployments(ListDeploymentsRequest listDeploymentsRequest)
Lists the deployments for an environment.
|
ListDeploymentStrategiesResult |
listDeploymentStrategies(ListDeploymentStrategiesRequest listDeploymentStrategiesRequest)
List deployment strategies.
|
ListEnvironmentsResult |
listEnvironments(ListEnvironmentsRequest listEnvironmentsRequest)
List the environments for an application.
|
ListHostedConfigurationVersionsResult |
listHostedConfigurationVersions(ListHostedConfigurationVersionsRequest listHostedConfigurationVersionsRequest)
View a list of configurations stored in the AppConfig configuration store by version.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Retrieves the list of key-value tags assigned to the resource.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
StartDeploymentResult |
startDeployment(StartDeploymentRequest startDeploymentRequest)
Starts a deployment.
|
StopDeploymentResult |
stopDeployment(StopDeploymentRequest stopDeploymentRequest)
Stops a deployment.
|
TagResourceResult |
tagResource(TagResourceRequest tagResourceRequest)
Metadata to assign to an AppConfig resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest untagResourceRequest)
Deletes a tag key and value from an AppConfig resource.
|
UpdateApplicationResult |
updateApplication(UpdateApplicationRequest updateApplicationRequest)
Updates an application.
|
UpdateConfigurationProfileResult |
updateConfigurationProfile(UpdateConfigurationProfileRequest updateConfigurationProfileRequest)
Updates a configuration profile.
|
UpdateDeploymentStrategyResult |
updateDeploymentStrategy(UpdateDeploymentStrategyRequest updateDeploymentStrategyRequest)
Updates a deployment strategy.
|
UpdateEnvironmentResult |
updateEnvironment(UpdateEnvironmentRequest updateEnvironmentRequest)
Updates an environment.
|
ValidateConfigurationResult |
validateConfiguration(ValidateConfigurationRequest validateConfigurationRequest)
Uses the validators in a configuration profile to validate a configuration.
|
static final String ENDPOINT_PREFIX
CreateApplicationResult createApplication(CreateApplicationRequest createApplicationRequest)
An application in AppConfig is a logical unit of code that provides capabilities for your customers. For example, an application can be a microservice that runs on Amazon EC2 instances, a mobile application installed by your users, a serverless application using Amazon API Gateway and AWS Lambda, or any system you run on behalf of others.
createApplicationRequest
- BadRequestException
- The input fails to satisfy the constraints specified by an AWS service.InternalServerException
- There was an internal failure in the AppConfig service.CreateConfigurationProfileResult createConfigurationProfile(CreateConfigurationProfileRequest createConfigurationProfileRequest)
Information that enables AppConfig to access the configuration source. Valid configuration sources include Systems Manager (SSM) documents, SSM Parameter Store parameters, and Amazon S3 objects. A configuration profile includes the following information.
The Uri location of the configuration data.
The AWS 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 AWS Lambda function.
For more information, see Create a Configuration and a Configuration Profile in the AWS AppConfig User Guide.
createConfigurationProfileRequest
- BadRequestException
- The input fails to satisfy the constraints specified by an AWS service.ResourceNotFoundException
- The requested resource could not be found.InternalServerException
- There was an internal failure in the AppConfig service.CreateDeploymentStrategyResult createDeploymentStrategy(CreateDeploymentStrategyRequest createDeploymentStrategyRequest)
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.
createDeploymentStrategyRequest
- InternalServerException
- There was an internal failure in the AppConfig service.BadRequestException
- The input fails to satisfy the constraints specified by an AWS service.CreateEnvironmentResult createEnvironment(CreateEnvironmentRequest createEnvironmentRequest)
For each application, you define one or more environments. An environment is a logical 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.
createEnvironmentRequest
- InternalServerException
- There was an internal failure in the AppConfig service.ResourceNotFoundException
- The requested resource could not be found.BadRequestException
- The input fails to satisfy the constraints specified by an AWS service.CreateHostedConfigurationVersionResult createHostedConfigurationVersion(CreateHostedConfigurationVersionRequest createHostedConfigurationVersionRequest)
Create a new configuration in the AppConfig configuration store.
createHostedConfigurationVersionRequest
- BadRequestException
- The input fails to satisfy the constraints specified by an AWS service.ServiceQuotaExceededException
- The number of hosted configuration versions exceeds the limit for the AppConfig configuration store.
Delete one or more versions and try again.ResourceNotFoundException
- The requested resource could not be found.ConflictException
- The request could not be processed because of conflict in the current state of the resource.PayloadTooLargeException
- The configuration size is too large.InternalServerException
- There was an internal failure in the AppConfig service.DeleteApplicationResult deleteApplication(DeleteApplicationRequest deleteApplicationRequest)
Delete an application. Deleting an application does not delete a configuration from a host.
deleteApplicationRequest
- ResourceNotFoundException
- The requested resource could not be found.InternalServerException
- There was an internal failure in the AppConfig service.BadRequestException
- The input fails to satisfy the constraints specified by an AWS service.DeleteConfigurationProfileResult deleteConfigurationProfile(DeleteConfigurationProfileRequest deleteConfigurationProfileRequest)
Delete a configuration profile. Deleting a configuration profile does not delete a configuration from a host.
deleteConfigurationProfileRequest
- ResourceNotFoundException
- The requested resource could not be found.ConflictException
- The request could not be processed because of conflict in the current state of the resource.InternalServerException
- There was an internal failure in the AppConfig service.BadRequestException
- The input fails to satisfy the constraints specified by an AWS service.DeleteDeploymentStrategyResult deleteDeploymentStrategy(DeleteDeploymentStrategyRequest deleteDeploymentStrategyRequest)
Delete a deployment strategy. Deleting a deployment strategy does not delete a configuration from a host.
deleteDeploymentStrategyRequest
- ResourceNotFoundException
- The requested resource could not be found.InternalServerException
- There was an internal failure in the AppConfig service.BadRequestException
- The input fails to satisfy the constraints specified by an AWS service.DeleteEnvironmentResult deleteEnvironment(DeleteEnvironmentRequest deleteEnvironmentRequest)
Delete an environment. Deleting an environment does not delete a configuration from a host.
deleteEnvironmentRequest
- ResourceNotFoundException
- The requested resource could not be found.ConflictException
- The request could not be processed because of conflict in the current state of the resource.InternalServerException
- There was an internal failure in the AppConfig service.BadRequestException
- The input fails to satisfy the constraints specified by an AWS service.DeleteHostedConfigurationVersionResult deleteHostedConfigurationVersion(DeleteHostedConfigurationVersionRequest deleteHostedConfigurationVersionRequest)
Delete a version of a configuration from the AppConfig configuration store.
deleteHostedConfigurationVersionRequest
- BadRequestException
- The input fails to satisfy the constraints specified by an AWS service.ResourceNotFoundException
- The requested resource could not be found.InternalServerException
- There was an internal failure in the AppConfig service.GetApplicationResult getApplication(GetApplicationRequest getApplicationRequest)
Retrieve information about an application.
getApplicationRequest
- ResourceNotFoundException
- The requested resource could not be found.InternalServerException
- There was an internal failure in the AppConfig service.BadRequestException
- The input fails to satisfy the constraints specified by an AWS service.GetConfigurationResult getConfiguration(GetConfigurationRequest getConfigurationRequest)
Receive information about a configuration.
AWS AppConfig uses the value of the ClientConfigurationVersion
parameter to identify the
configuration version on your clients. If you don’t send ClientConfigurationVersion
with each call
to GetConfiguration
, 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 to GetConfiguration
. This value must be saved on your client. Subsequent calls to
GetConfiguration
must pass this value by using the ClientConfigurationVersion
parameter.
getConfigurationRequest
- ResourceNotFoundException
- The requested resource could not be found.InternalServerException
- There was an internal failure in the AppConfig service.BadRequestException
- The input fails to satisfy the constraints specified by an AWS service.GetConfigurationProfileResult getConfigurationProfile(GetConfigurationProfileRequest getConfigurationProfileRequest)
Retrieve information about a configuration profile.
getConfigurationProfileRequest
- ResourceNotFoundException
- The requested resource could not be found.InternalServerException
- There was an internal failure in the AppConfig service.BadRequestException
- The input fails to satisfy the constraints specified by an AWS service.GetDeploymentResult getDeployment(GetDeploymentRequest getDeploymentRequest)
Retrieve information about a configuration deployment.
getDeploymentRequest
- ResourceNotFoundException
- The requested resource could not be found.InternalServerException
- There was an internal failure in the AppConfig service.BadRequestException
- The input fails to satisfy the constraints specified by an AWS service.GetDeploymentStrategyResult getDeploymentStrategy(GetDeploymentStrategyRequest getDeploymentStrategyRequest)
Retrieve 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.
getDeploymentStrategyRequest
- ResourceNotFoundException
- The requested resource could not be found.InternalServerException
- There was an internal failure in the AppConfig service.BadRequestException
- The input fails to satisfy the constraints specified by an AWS service.GetEnvironmentResult getEnvironment(GetEnvironmentRequest getEnvironmentRequest)
Retrieve information about an environment. An environment is a logical 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.
getEnvironmentRequest
- ResourceNotFoundException
- The requested resource could not be found.InternalServerException
- There was an internal failure in the AppConfig service.BadRequestException
- The input fails to satisfy the constraints specified by an AWS service.GetHostedConfigurationVersionResult getHostedConfigurationVersion(GetHostedConfigurationVersionRequest getHostedConfigurationVersionRequest)
Get information about a specific configuration version.
getHostedConfigurationVersionRequest
- BadRequestException
- The input fails to satisfy the constraints specified by an AWS service.ResourceNotFoundException
- The requested resource could not be found.InternalServerException
- There was an internal failure in the AppConfig service.ListApplicationsResult listApplications(ListApplicationsRequest listApplicationsRequest)
List all applications in your AWS account.
listApplicationsRequest
- InternalServerException
- There was an internal failure in the AppConfig service.BadRequestException
- The input fails to satisfy the constraints specified by an AWS service.ListConfigurationProfilesResult listConfigurationProfiles(ListConfigurationProfilesRequest listConfigurationProfilesRequest)
Lists the configuration profiles for an application.
listConfigurationProfilesRequest
- ResourceNotFoundException
- The requested resource could not be found.InternalServerException
- There was an internal failure in the AppConfig service.BadRequestException
- The input fails to satisfy the constraints specified by an AWS service.ListDeploymentStrategiesResult listDeploymentStrategies(ListDeploymentStrategiesRequest listDeploymentStrategiesRequest)
List deployment strategies.
listDeploymentStrategiesRequest
- InternalServerException
- There was an internal failure in the AppConfig service.BadRequestException
- The input fails to satisfy the constraints specified by an AWS service.ListDeploymentsResult listDeployments(ListDeploymentsRequest listDeploymentsRequest)
Lists the deployments for an environment.
listDeploymentsRequest
- ResourceNotFoundException
- The requested resource could not be found.InternalServerException
- There was an internal failure in the AppConfig service.BadRequestException
- The input fails to satisfy the constraints specified by an AWS service.ListEnvironmentsResult listEnvironments(ListEnvironmentsRequest listEnvironmentsRequest)
List the environments for an application.
listEnvironmentsRequest
- ResourceNotFoundException
- The requested resource could not be found.InternalServerException
- There was an internal failure in the AppConfig service.BadRequestException
- The input fails to satisfy the constraints specified by an AWS service.ListHostedConfigurationVersionsResult listHostedConfigurationVersions(ListHostedConfigurationVersionsRequest listHostedConfigurationVersionsRequest)
View a list of configurations stored in the AppConfig configuration store by version.
listHostedConfigurationVersionsRequest
- BadRequestException
- The input fails to satisfy the constraints specified by an AWS service.ResourceNotFoundException
- The requested resource could not be found.InternalServerException
- There was an internal failure in the AppConfig service.ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Retrieves the list of key-value tags assigned to the resource.
listTagsForResourceRequest
- ResourceNotFoundException
- The requested resource could not be found.BadRequestException
- The input fails to satisfy the constraints specified by an AWS service.InternalServerException
- There was an internal failure in the AppConfig service.StartDeploymentResult startDeployment(StartDeploymentRequest startDeploymentRequest)
Starts a deployment.
startDeploymentRequest
- BadRequestException
- The input fails to satisfy the constraints specified by an AWS service.ResourceNotFoundException
- The requested resource could not be found.ConflictException
- The request could not be processed because of conflict in the current state of the resource.InternalServerException
- There was an internal failure in the AppConfig service.StopDeploymentResult stopDeployment(StopDeploymentRequest stopDeploymentRequest)
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
.
stopDeploymentRequest
- ResourceNotFoundException
- The requested resource could not be found.InternalServerException
- There was an internal failure in the AppConfig service.BadRequestException
- The input fails to satisfy the constraints specified by an AWS service.TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
Metadata to assign 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.
tagResourceRequest
- ResourceNotFoundException
- The requested resource could not be found.BadRequestException
- The input fails to satisfy the constraints specified by an AWS service.InternalServerException
- There was an internal failure in the AppConfig service.UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
Deletes a tag key and value from an AppConfig resource.
untagResourceRequest
- ResourceNotFoundException
- The requested resource could not be found.BadRequestException
- The input fails to satisfy the constraints specified by an AWS service.InternalServerException
- There was an internal failure in the AppConfig service.UpdateApplicationResult updateApplication(UpdateApplicationRequest updateApplicationRequest)
Updates an application.
updateApplicationRequest
- BadRequestException
- The input fails to satisfy the constraints specified by an AWS service.ResourceNotFoundException
- The requested resource could not be found.InternalServerException
- There was an internal failure in the AppConfig service.UpdateConfigurationProfileResult updateConfigurationProfile(UpdateConfigurationProfileRequest updateConfigurationProfileRequest)
Updates a configuration profile.
updateConfigurationProfileRequest
- BadRequestException
- The input fails to satisfy the constraints specified by an AWS service.ResourceNotFoundException
- The requested resource could not be found.InternalServerException
- There was an internal failure in the AppConfig service.UpdateDeploymentStrategyResult updateDeploymentStrategy(UpdateDeploymentStrategyRequest updateDeploymentStrategyRequest)
Updates a deployment strategy.
updateDeploymentStrategyRequest
- BadRequestException
- The input fails to satisfy the constraints specified by an AWS service.ResourceNotFoundException
- The requested resource could not be found.InternalServerException
- There was an internal failure in the AppConfig service.UpdateEnvironmentResult updateEnvironment(UpdateEnvironmentRequest updateEnvironmentRequest)
Updates an environment.
updateEnvironmentRequest
- BadRequestException
- The input fails to satisfy the constraints specified by an AWS service.ResourceNotFoundException
- The requested resource could not be found.InternalServerException
- There was an internal failure in the AppConfig service.ValidateConfigurationResult validateConfiguration(ValidateConfigurationRequest validateConfigurationRequest)
Uses the validators in a configuration profile to validate a configuration.
validateConfigurationRequest
- BadRequestException
- The input fails to satisfy the constraints specified by an AWS service.ResourceNotFoundException
- The requested resource could not be found.InternalServerException
- There was an internal failure in the AppConfig service.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
request
- The originally executed request.