@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonAppConfigClient extends AmazonWebServiceClient implements AmazonAppConfig
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.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
shutdown
public static AmazonAppConfigClientBuilder builder()
public CreateApplicationResult createApplication(CreateApplicationRequest request)
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.
createApplication
in interface AmazonAppConfig
createApplicationRequest
- BadRequestException
- The input fails to satisfy the constraints specified by an AWS service.InternalServerException
- There was an internal failure in the AppConfig service.public CreateConfigurationProfileResult createConfigurationProfile(CreateConfigurationProfileRequest request)
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.
createConfigurationProfile
in interface AmazonAppConfig
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.public CreateDeploymentStrategyResult createDeploymentStrategy(CreateDeploymentStrategyRequest request)
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.
createDeploymentStrategy
in interface AmazonAppConfig
createDeploymentStrategyRequest
- InternalServerException
- There was an internal failure in the AppConfig service.BadRequestException
- The input fails to satisfy the constraints specified by an AWS service.public CreateEnvironmentResult createEnvironment(CreateEnvironmentRequest request)
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.
createEnvironment
in interface AmazonAppConfig
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.public CreateHostedConfigurationVersionResult createHostedConfigurationVersion(CreateHostedConfigurationVersionRequest request)
Create a new configuration in the AppConfig configuration store.
createHostedConfigurationVersion
in interface AmazonAppConfig
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.public DeleteApplicationResult deleteApplication(DeleteApplicationRequest request)
Delete an application. Deleting an application does not delete a configuration from a host.
deleteApplication
in interface AmazonAppConfig
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.public DeleteConfigurationProfileResult deleteConfigurationProfile(DeleteConfigurationProfileRequest request)
Delete a configuration profile. Deleting a configuration profile does not delete a configuration from a host.
deleteConfigurationProfile
in interface AmazonAppConfig
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.public DeleteDeploymentStrategyResult deleteDeploymentStrategy(DeleteDeploymentStrategyRequest request)
Delete a deployment strategy. Deleting a deployment strategy does not delete a configuration from a host.
deleteDeploymentStrategy
in interface AmazonAppConfig
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.public DeleteEnvironmentResult deleteEnvironment(DeleteEnvironmentRequest request)
Delete an environment. Deleting an environment does not delete a configuration from a host.
deleteEnvironment
in interface AmazonAppConfig
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.public DeleteHostedConfigurationVersionResult deleteHostedConfigurationVersion(DeleteHostedConfigurationVersionRequest request)
Delete a version of a configuration from the AppConfig configuration store.
deleteHostedConfigurationVersion
in interface AmazonAppConfig
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.public GetApplicationResult getApplication(GetApplicationRequest request)
Retrieve information about an application.
getApplication
in interface AmazonAppConfig
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.public GetConfigurationResult getConfiguration(GetConfigurationRequest request)
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.
getConfiguration
in interface AmazonAppConfig
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.public GetConfigurationProfileResult getConfigurationProfile(GetConfigurationProfileRequest request)
Retrieve information about a configuration profile.
getConfigurationProfile
in interface AmazonAppConfig
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.public GetDeploymentResult getDeployment(GetDeploymentRequest request)
Retrieve information about a configuration deployment.
getDeployment
in interface AmazonAppConfig
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.public GetDeploymentStrategyResult getDeploymentStrategy(GetDeploymentStrategyRequest request)
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.
getDeploymentStrategy
in interface AmazonAppConfig
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.public GetEnvironmentResult getEnvironment(GetEnvironmentRequest request)
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.
getEnvironment
in interface AmazonAppConfig
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.public GetHostedConfigurationVersionResult getHostedConfigurationVersion(GetHostedConfigurationVersionRequest request)
Get information about a specific configuration version.
getHostedConfigurationVersion
in interface AmazonAppConfig
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.public ListApplicationsResult listApplications(ListApplicationsRequest request)
List all applications in your AWS account.
listApplications
in interface AmazonAppConfig
listApplicationsRequest
- InternalServerException
- There was an internal failure in the AppConfig service.BadRequestException
- The input fails to satisfy the constraints specified by an AWS service.public ListConfigurationProfilesResult listConfigurationProfiles(ListConfigurationProfilesRequest request)
Lists the configuration profiles for an application.
listConfigurationProfiles
in interface AmazonAppConfig
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.public ListDeploymentStrategiesResult listDeploymentStrategies(ListDeploymentStrategiesRequest request)
List deployment strategies.
listDeploymentStrategies
in interface AmazonAppConfig
listDeploymentStrategiesRequest
- InternalServerException
- There was an internal failure in the AppConfig service.BadRequestException
- The input fails to satisfy the constraints specified by an AWS service.public ListDeploymentsResult listDeployments(ListDeploymentsRequest request)
Lists the deployments for an environment.
listDeployments
in interface AmazonAppConfig
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.public ListEnvironmentsResult listEnvironments(ListEnvironmentsRequest request)
List the environments for an application.
listEnvironments
in interface AmazonAppConfig
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.public ListHostedConfigurationVersionsResult listHostedConfigurationVersions(ListHostedConfigurationVersionsRequest request)
View a list of configurations stored in the AppConfig configuration store by version.
listHostedConfigurationVersions
in interface AmazonAppConfig
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.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
Retrieves the list of key-value tags assigned to the resource.
listTagsForResource
in interface AmazonAppConfig
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.public StartDeploymentResult startDeployment(StartDeploymentRequest request)
Starts a deployment.
startDeployment
in interface AmazonAppConfig
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.public StopDeploymentResult stopDeployment(StopDeploymentRequest request)
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
.
stopDeployment
in interface AmazonAppConfig
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.public TagResourceResult tagResource(TagResourceRequest request)
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.
tagResource
in interface AmazonAppConfig
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.public UntagResourceResult untagResource(UntagResourceRequest request)
Deletes a tag key and value from an AppConfig resource.
untagResource
in interface AmazonAppConfig
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.public UpdateApplicationResult updateApplication(UpdateApplicationRequest request)
Updates an application.
updateApplication
in interface AmazonAppConfig
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.public UpdateConfigurationProfileResult updateConfigurationProfile(UpdateConfigurationProfileRequest request)
Updates a configuration profile.
updateConfigurationProfile
in interface AmazonAppConfig
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.public UpdateDeploymentStrategyResult updateDeploymentStrategy(UpdateDeploymentStrategyRequest request)
Updates a deployment strategy.
updateDeploymentStrategy
in interface AmazonAppConfig
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.public UpdateEnvironmentResult updateEnvironment(UpdateEnvironmentRequest request)
Updates an environment.
updateEnvironment
in interface AmazonAppConfig
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.public ValidateConfigurationResult validateConfiguration(ValidateConfigurationRequest request)
Uses the validators in a configuration profile to validate a configuration.
validateConfiguration
in interface AmazonAppConfig
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.public 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 the request.
getCachedResponseMetadata
in interface AmazonAppConfig
request
- The originally executed requestCopyright © 2013 Amazon Web Services, Inc. All Rights Reserved.