@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.
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.
| 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)
Creates an application.
|
CreateConfigurationProfileResult |
createConfigurationProfile(CreateConfigurationProfileRequest createConfigurationProfileRequest)
Creates a configuration profile, which is information that enables AppConfig to access the configuration source.
|
CreateDeploymentStrategyResult |
createDeploymentStrategy(CreateDeploymentStrategyRequest createDeploymentStrategyRequest)
Creates a deployment strategy that defines important criteria for rolling out your configuration to the
designated targets.
|
CreateEnvironmentResult |
createEnvironment(CreateEnvironmentRequest createEnvironmentRequest)
Creates an environment.
|
CreateExtensionResult |
createExtension(CreateExtensionRequest createExtensionRequest)
Creates an AppConfig extension.
|
CreateExtensionAssociationResult |
createExtensionAssociation(CreateExtensionAssociationRequest createExtensionAssociationRequest)
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.
|
CreateHostedConfigurationVersionResult |
createHostedConfigurationVersion(CreateHostedConfigurationVersionRequest createHostedConfigurationVersionRequest)
Creates a new configuration in the AppConfig hosted configuration store.
|
DeleteApplicationResult |
deleteApplication(DeleteApplicationRequest deleteApplicationRequest)
Deletes an application.
|
DeleteConfigurationProfileResult |
deleteConfigurationProfile(DeleteConfigurationProfileRequest deleteConfigurationProfileRequest)
Deletes a configuration profile.
|
DeleteDeploymentStrategyResult |
deleteDeploymentStrategy(DeleteDeploymentStrategyRequest deleteDeploymentStrategyRequest)
Deletes a deployment strategy.
|
DeleteEnvironmentResult |
deleteEnvironment(DeleteEnvironmentRequest deleteEnvironmentRequest)
Deletes an environment.
|
DeleteExtensionResult |
deleteExtension(DeleteExtensionRequest deleteExtensionRequest)
Deletes an AppConfig extension.
|
DeleteExtensionAssociationResult |
deleteExtensionAssociation(DeleteExtensionAssociationRequest deleteExtensionAssociationRequest)
Deletes an extension association.
|
DeleteHostedConfigurationVersionResult |
deleteHostedConfigurationVersion(DeleteHostedConfigurationVersionRequest deleteHostedConfigurationVersionRequest)
Deletes a version of a configuration from the AppConfig hosted configuration store.
|
GetApplicationResult |
getApplication(GetApplicationRequest getApplicationRequest)
Retrieves 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)
Deprecated.
|
GetConfigurationProfileResult |
getConfigurationProfile(GetConfigurationProfileRequest getConfigurationProfileRequest)
Retrieves information about a configuration profile.
|
GetDeploymentResult |
getDeployment(GetDeploymentRequest getDeploymentRequest)
Retrieves information about a configuration deployment.
|
GetDeploymentStrategyResult |
getDeploymentStrategy(GetDeploymentStrategyRequest getDeploymentStrategyRequest)
Retrieves information about a deployment strategy.
|
GetEnvironmentResult |
getEnvironment(GetEnvironmentRequest getEnvironmentRequest)
Retrieves information about an environment.
|
GetExtensionResult |
getExtension(GetExtensionRequest getExtensionRequest)
Returns information about an AppConfig extension.
|
GetExtensionAssociationResult |
getExtensionAssociation(GetExtensionAssociationRequest getExtensionAssociationRequest)
Returns information about an AppConfig extension association.
|
GetHostedConfigurationVersionResult |
getHostedConfigurationVersion(GetHostedConfigurationVersionRequest getHostedConfigurationVersionRequest)
Retrieves information about a specific configuration version.
|
ListApplicationsResult |
listApplications(ListApplicationsRequest listApplicationsRequest)
Lists all applications in your Amazon Web Services account.
|
ListConfigurationProfilesResult |
listConfigurationProfiles(ListConfigurationProfilesRequest listConfigurationProfilesRequest)
Lists the configuration profiles for an application.
|
ListDeploymentsResult |
listDeployments(ListDeploymentsRequest listDeploymentsRequest)
Lists the deployments for an environment in descending deployment number order.
|
ListDeploymentStrategiesResult |
listDeploymentStrategies(ListDeploymentStrategiesRequest listDeploymentStrategiesRequest)
Lists deployment strategies.
|
ListEnvironmentsResult |
listEnvironments(ListEnvironmentsRequest listEnvironmentsRequest)
Lists the environments for an application.
|
ListExtensionAssociationsResult |
listExtensionAssociations(ListExtensionAssociationsRequest listExtensionAssociationsRequest)
Lists all AppConfig extension associations in the account.
|
ListExtensionsResult |
listExtensions(ListExtensionsRequest listExtensionsRequest)
Lists all custom and Amazon Web Services authored AppConfig extensions in the account.
|
ListHostedConfigurationVersionsResult |
listHostedConfigurationVersions(ListHostedConfigurationVersionsRequest listHostedConfigurationVersionsRequest)
Lists configurations stored in the AppConfig hosted 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)
Assigns metadata 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.
|
UpdateExtensionResult |
updateExtension(UpdateExtensionRequest updateExtensionRequest)
Updates an AppConfig extension.
|
UpdateExtensionAssociationResult |
updateExtensionAssociation(UpdateExtensionAssociationRequest updateExtensionAssociationRequest)
Updates an association.
|
ValidateConfigurationResult |
validateConfiguration(ValidateConfigurationRequest validateConfigurationRequest)
Uses the validators in a configuration profile to validate a configuration.
|
static final String ENDPOINT_PREFIX
CreateApplicationResult createApplication(CreateApplicationRequest createApplicationRequest)
Creates 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.
createApplicationRequest - BadRequestException - The input fails to satisfy the constraints specified by an Amazon Web Services service.ServiceQuotaExceededException - The number of one more AppConfig resources exceeds the maximum allowed. Verify that your environment
doesn't exceed the following service quotas:
Applications: 100 max
Deployment strategies: 20 max
Configuration profiles: 100 max per application
Environments: 20 max per application
To resolve this issue, you can delete one or more resources and try again. Or, you can request a quota increase. For more information about quotas and to request an increase, see Service quotas for AppConfig in the Amazon Web Services General Reference.
InternalServerException - There was an internal failure in the AppConfig service.CreateConfigurationProfileResult createConfigurationProfile(CreateConfigurationProfileRequest createConfigurationProfileRequest)
Creates 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.
createConfigurationProfileRequest - BadRequestException - The input fails to satisfy the constraints specified by an Amazon Web Services service.ResourceNotFoundException - The requested resource could not be found.InternalServerException - There was an internal failure in the AppConfig service.ServiceQuotaExceededException - The number of one more AppConfig resources exceeds the maximum allowed. Verify that your environment
doesn't exceed the following service quotas:
Applications: 100 max
Deployment strategies: 20 max
Configuration profiles: 100 max per application
Environments: 20 max per application
To resolve this issue, you can delete one or more resources and try again. Or, you can request a quota increase. For more information about quotas and to request an increase, see Service quotas for AppConfig in the Amazon Web Services General Reference.
CreateDeploymentStrategyResult createDeploymentStrategy(CreateDeploymentStrategyRequest createDeploymentStrategyRequest)
Creates 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.
createDeploymentStrategyRequest - InternalServerException - There was an internal failure in the AppConfig service.ServiceQuotaExceededException - The number of one more AppConfig resources exceeds the maximum allowed. Verify that your environment
doesn't exceed the following service quotas:
Applications: 100 max
Deployment strategies: 20 max
Configuration profiles: 100 max per application
Environments: 20 max per application
To resolve this issue, you can delete one or more resources and try again. Or, you can request a quota increase. For more information about quotas and to request an increase, see Service quotas for AppConfig in the Amazon Web Services General Reference.
BadRequestException - The input fails to satisfy the constraints specified by an Amazon Web Services service.CreateEnvironmentResult createEnvironment(CreateEnvironmentRequest createEnvironmentRequest)
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.
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 Amazon Web Services service.ServiceQuotaExceededException - The number of one more AppConfig resources exceeds the maximum allowed. Verify that your environment
doesn't exceed the following service quotas:
Applications: 100 max
Deployment strategies: 20 max
Configuration profiles: 100 max per application
Environments: 20 max per application
To resolve this issue, you can delete one or more resources and try again. Or, you can request a quota increase. For more information about quotas and to request an increase, see Service quotas for AppConfig in the Amazon Web Services General Reference.
CreateExtensionResult createExtension(CreateExtensionRequest createExtensionRequest)
Creates 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.
createExtensionRequest - BadRequestException - The input fails to satisfy the constraints specified by an Amazon Web Services service.ConflictException - The request could not be processed because of conflict in the current state of the resource.ServiceQuotaExceededException - The number of one more AppConfig resources exceeds the maximum allowed. Verify that your environment
doesn't exceed the following service quotas:
Applications: 100 max
Deployment strategies: 20 max
Configuration profiles: 100 max per application
Environments: 20 max per application
To resolve this issue, you can delete one or more resources and try again. Or, you can request a quota increase. For more information about quotas and to request an increase, see Service quotas for AppConfig in the Amazon Web Services General Reference.
InternalServerException - There was an internal failure in the AppConfig service.CreateExtensionAssociationResult createExtensionAssociation(CreateExtensionAssociationRequest createExtensionAssociationRequest)
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.
createExtensionAssociationRequest - BadRequestException - The input fails to satisfy the constraints specified by an Amazon Web Services service.ResourceNotFoundException - The requested resource could not be found.InternalServerException - There was an internal failure in the AppConfig service.ServiceQuotaExceededException - The number of one more AppConfig resources exceeds the maximum allowed. Verify that your environment
doesn't exceed the following service quotas:
Applications: 100 max
Deployment strategies: 20 max
Configuration profiles: 100 max per application
Environments: 20 max per application
To resolve this issue, you can delete one or more resources and try again. Or, you can request a quota increase. For more information about quotas and to request an increase, see Service quotas for AppConfig in the Amazon Web Services General Reference.
CreateHostedConfigurationVersionResult createHostedConfigurationVersion(CreateHostedConfigurationVersionRequest createHostedConfigurationVersionRequest)
Creates a new configuration in the AppConfig hosted configuration store.
createHostedConfigurationVersionRequest - BadRequestException - The input fails to satisfy the constraints specified by an Amazon Web Services service.ServiceQuotaExceededException - The number of one more AppConfig resources exceeds the maximum allowed. Verify that your environment
doesn't exceed the following service quotas:
Applications: 100 max
Deployment strategies: 20 max
Configuration profiles: 100 max per application
Environments: 20 max per application
To resolve this issue, you can delete one or more resources and try again. Or, you can request a quota increase. For more information about quotas and to request an increase, see Service quotas for AppConfig in the Amazon Web Services General Reference.
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)
Deletes 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 Amazon Web Services service.DeleteConfigurationProfileResult deleteConfigurationProfile(DeleteConfigurationProfileRequest deleteConfigurationProfileRequest)
Deletes 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 Amazon Web Services service.DeleteDeploymentStrategyResult deleteDeploymentStrategy(DeleteDeploymentStrategyRequest deleteDeploymentStrategyRequest)
Deletes 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 Amazon Web Services service.DeleteEnvironmentResult deleteEnvironment(DeleteEnvironmentRequest deleteEnvironmentRequest)
Deletes 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 Amazon Web Services service.DeleteExtensionResult deleteExtension(DeleteExtensionRequest deleteExtensionRequest)
Deletes an AppConfig extension. You must delete all associations to an extension before you delete the extension.
deleteExtensionRequest - 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 Amazon Web Services service.DeleteExtensionAssociationResult deleteExtensionAssociation(DeleteExtensionAssociationRequest deleteExtensionAssociationRequest)
Deletes an extension association. This action doesn't delete extensions defined in the association.
deleteExtensionAssociationRequest - BadRequestException - The input fails to satisfy the constraints specified by an Amazon Web Services service.ResourceNotFoundException - The requested resource could not be found.InternalServerException - There was an internal failure in the AppConfig service.DeleteHostedConfigurationVersionResult deleteHostedConfigurationVersion(DeleteHostedConfigurationVersionRequest deleteHostedConfigurationVersionRequest)
Deletes a version of a configuration from the AppConfig hosted configuration store.
deleteHostedConfigurationVersionRequest - BadRequestException - The input fails to satisfy the constraints specified by an Amazon Web Services service.ResourceNotFoundException - The requested resource could not be found.InternalServerException - There was an internal failure in the AppConfig service.GetApplicationResult getApplication(GetApplicationRequest getApplicationRequest)
Retrieves 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 Amazon Web Services service.@Deprecated GetConfigurationResult getConfiguration(GetConfigurationRequest getConfigurationRequest)
(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.
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 Amazon Web Services service.GetConfigurationProfileResult getConfigurationProfile(GetConfigurationProfileRequest getConfigurationProfileRequest)
Retrieves 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 Amazon Web Services service.GetDeploymentResult getDeployment(GetDeploymentRequest getDeploymentRequest)
Retrieves 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 Amazon Web Services service.GetDeploymentStrategyResult getDeploymentStrategy(GetDeploymentStrategyRequest getDeploymentStrategyRequest)
Retrieves 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 Amazon Web Services service.GetEnvironmentResult getEnvironment(GetEnvironmentRequest getEnvironmentRequest)
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.
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 Amazon Web Services service.GetExtensionResult getExtension(GetExtensionRequest getExtensionRequest)
Returns information about an AppConfig extension.
getExtensionRequest - 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 Amazon Web Services service.GetExtensionAssociationResult getExtensionAssociation(GetExtensionAssociationRequest getExtensionAssociationRequest)
Returns information about an AppConfig extension association. For more information about extensions and associations, see Extending workflows in the AppConfig User Guide.
getExtensionAssociationRequest - BadRequestException - The input fails to satisfy the constraints specified by an Amazon Web Services service.ResourceNotFoundException - The requested resource could not be found.InternalServerException - There was an internal failure in the AppConfig service.GetHostedConfigurationVersionResult getHostedConfigurationVersion(GetHostedConfigurationVersionRequest getHostedConfigurationVersionRequest)
Retrieves information about a specific configuration version.
getHostedConfigurationVersionRequest - BadRequestException - The input fails to satisfy the constraints specified by an Amazon Web Services service.ResourceNotFoundException - The requested resource could not be found.InternalServerException - There was an internal failure in the AppConfig service.ListApplicationsResult listApplications(ListApplicationsRequest listApplicationsRequest)
Lists all applications in your Amazon Web Services account.
listApplicationsRequest - InternalServerException - There was an internal failure in the AppConfig service.BadRequestException - The input fails to satisfy the constraints specified by an Amazon Web Services 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 Amazon Web Services service.ListDeploymentStrategiesResult listDeploymentStrategies(ListDeploymentStrategiesRequest listDeploymentStrategiesRequest)
Lists deployment strategies.
listDeploymentStrategiesRequest - InternalServerException - There was an internal failure in the AppConfig service.BadRequestException - The input fails to satisfy the constraints specified by an Amazon Web Services service.ListDeploymentsResult listDeployments(ListDeploymentsRequest listDeploymentsRequest)
Lists the deployments for an environment in descending deployment number order.
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 Amazon Web Services service.ListEnvironmentsResult listEnvironments(ListEnvironmentsRequest listEnvironmentsRequest)
Lists 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 Amazon Web Services service.ListExtensionAssociationsResult listExtensionAssociations(ListExtensionAssociationsRequest listExtensionAssociationsRequest)
Lists all AppConfig extension associations in the account. For more information about extensions and associations, see Extending workflows in the AppConfig User Guide.
listExtensionAssociationsRequest - InternalServerException - There was an internal failure in the AppConfig service.BadRequestException - The input fails to satisfy the constraints specified by an Amazon Web Services service.ListExtensionsResult listExtensions(ListExtensionsRequest listExtensionsRequest)
Lists 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.
listExtensionsRequest - InternalServerException - There was an internal failure in the AppConfig service.BadRequestException - The input fails to satisfy the constraints specified by an Amazon Web Services service.ListHostedConfigurationVersionsResult listHostedConfigurationVersions(ListHostedConfigurationVersionsRequest listHostedConfigurationVersionsRequest)
Lists configurations stored in the AppConfig hosted configuration store by version.
listHostedConfigurationVersionsRequest - BadRequestException - The input fails to satisfy the constraints specified by an Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services service.TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
Assigns 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.
tagResourceRequest - ResourceNotFoundException - The requested resource could not be found.BadRequestException - The input fails to satisfy the constraints specified by an Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services service.ResourceNotFoundException - The requested resource could not be found.InternalServerException - There was an internal failure in the AppConfig service.UpdateExtensionResult updateExtension(UpdateExtensionRequest updateExtensionRequest)
Updates an AppConfig extension. For more information about extensions, see Extending workflows in the AppConfig User Guide.
updateExtensionRequest - BadRequestException - The input fails to satisfy the constraints specified by an Amazon Web Services 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.UpdateExtensionAssociationResult updateExtensionAssociation(UpdateExtensionAssociationRequest updateExtensionAssociationRequest)
Updates an association. For more information about extensions and associations, see Extending workflows in the AppConfig User Guide.
updateExtensionAssociationRequest - BadRequestException - The input fails to satisfy the constraints specified by an Amazon Web Services 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 Amazon Web Services 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.