AmazonAppConfig (AWS SDK for Java

All Known Subinterfaces:

AmazonAppConfigAsync

All Known Implementing Classes:

AbstractAmazonAppConfig, AbstractAmazonAppConfigAsync, AmazonAppConfigAsyncClient, AmazonAppConfigClient
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonAppConfig
```
Interface for accessing AppConfig.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonAppConfig instead.

Use AppConfig, a capability of Amazon Web Services 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, 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 an Amazon Web Services 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:
- Feature flags: Use AppConfig to turn on new features that require a timely deployment, such as a product launch or announcement.
- Application tuning: Use AppConfig to carefully introduce changes to your application that can only be tested with production traffic.
- 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 AppConfig User Guide.

Field Summary

Fields
Modifier and Type Field and Description

static String ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.

Fields
Modifier and Type	Field and Description
`static String`	`ENDPOINT_PREFIX` The region metadata service name for computing region endpoints.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
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.

- Field Detail
  - ENDPOINT_PREFIX
```
static final String ENDPOINT_PREFIX
```
    The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.
    
    See Also:
    
    RegionUtils.getRegionsForService(String), Constant Field Values
- Method Detail
  - createApplication
```
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.
    
    Parameters:
    
    createApplicationRequest -
    
    Returns:
    
    Result of the CreateApplication operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - createConfigurationProfile
```
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.
    Parameters:
    
    createConfigurationProfileRequest -
    
    Returns:
    
    Result of the CreateConfigurationProfile operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - createDeploymentStrategy
```
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.
    
    Parameters:
    
    createDeploymentStrategyRequest -
    
    Returns:
    
    Result of the CreateDeploymentStrategy operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - createEnvironment
```
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.
    
    Parameters:
    
    createEnvironmentRequest -
    
    Returns:
    
    Result of the CreateEnvironment operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - createExtension
```
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 most use cases, to create your own extension, you must create an Lambda function to perform any computation and processing defined in the extension. For more information about extensions, see Working with AppConfig extensions in the AppConfig User Guide.
    
    Parameters:
    
    createExtensionRequest -
    
    Returns:
    
    Result of the CreateExtension operation returned by the service.
    
    Throws:
    
    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 hosted configuration versions exceeds the limit for the AppConfig hosted configuration store. Delete one or more versions and try again.
    
    InternalServerException - There was an internal failure in the AppConfig service.
    
    See Also:
    
    AWS API Documentation
  - createExtensionAssociation
```
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 Working with AppConfig extensions in the AppConfig User Guide.
    
    Parameters:
    
    createExtensionAssociationRequest -
    
    Returns:
    
    Result of the CreateExtensionAssociation operation returned by the service.
    
    Throws:
    
    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 hosted configuration versions exceeds the limit for the AppConfig hosted configuration store. Delete one or more versions and try again.
    
    See Also:
    
    AWS API Documentation
  - createHostedConfigurationVersion
```
CreateHostedConfigurationVersionResult createHostedConfigurationVersion(CreateHostedConfigurationVersionRequest createHostedConfigurationVersionRequest)
```
    Creates a new configuration in the AppConfig hosted configuration store.
    
    Parameters:
    
    createHostedConfigurationVersionRequest -
    
    Returns:
    
    Result of the CreateHostedConfigurationVersion operation returned by the service.
    
    Throws:
    
    BadRequestException - The input fails to satisfy the constraints specified by an Amazon Web Services service.
    
    ServiceQuotaExceededException - The number of hosted configuration versions exceeds the limit for the AppConfig hosted 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.
    
    See Also:
    
    AWS API Documentation
  - deleteApplication
```
DeleteApplicationResult deleteApplication(DeleteApplicationRequest deleteApplicationRequest)
```
    Deletes an application. Deleting an application does not delete a configuration from a host.
    
    Parameters:
    
    deleteApplicationRequest -
    
    Returns:
    
    Result of the DeleteApplication operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - deleteConfigurationProfile
```
DeleteConfigurationProfileResult deleteConfigurationProfile(DeleteConfigurationProfileRequest deleteConfigurationProfileRequest)
```
    Deletes a configuration profile. Deleting a configuration profile does not delete a configuration from a host.
    
    Parameters:
    
    deleteConfigurationProfileRequest -
    
    Returns:
    
    Result of the DeleteConfigurationProfile operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - deleteDeploymentStrategy
```
DeleteDeploymentStrategyResult deleteDeploymentStrategy(DeleteDeploymentStrategyRequest deleteDeploymentStrategyRequest)
```
    Deletes a deployment strategy. Deleting a deployment strategy does not delete a configuration from a host.
    
    Parameters:
    
    deleteDeploymentStrategyRequest -
    
    Returns:
    
    Result of the DeleteDeploymentStrategy operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - deleteEnvironment
```
DeleteEnvironmentResult deleteEnvironment(DeleteEnvironmentRequest deleteEnvironmentRequest)
```
    Deletes an environment. Deleting an environment does not delete a configuration from a host.
    
    Parameters:
    
    deleteEnvironmentRequest -
    
    Returns:
    
    Result of the DeleteEnvironment operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - deleteExtension
```
DeleteExtensionResult deleteExtension(DeleteExtensionRequest deleteExtensionRequest)
```
    Deletes an AppConfig extension. You must delete all associations to an extension before you delete the extension.
    
    Parameters:
    
    deleteExtensionRequest -
    
    Returns:
    
    Result of the DeleteExtension operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - deleteExtensionAssociation
```
DeleteExtensionAssociationResult deleteExtensionAssociation(DeleteExtensionAssociationRequest deleteExtensionAssociationRequest)
```
    Deletes an extension association. This action doesn't delete extensions defined in the association.
    
    Parameters:
    
    deleteExtensionAssociationRequest -
    
    Returns:
    
    Result of the DeleteExtensionAssociation operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - deleteHostedConfigurationVersion
```
DeleteHostedConfigurationVersionResult deleteHostedConfigurationVersion(DeleteHostedConfigurationVersionRequest deleteHostedConfigurationVersionRequest)
```
    Deletes a version of a configuration from the AppConfig hosted configuration store.
    
    Parameters:
    
    deleteHostedConfigurationVersionRequest -
    
    Returns:
    
    Result of the DeleteHostedConfigurationVersion operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - getApplication
```
GetApplicationResult getApplication(GetApplicationRequest getApplicationRequest)
```
    Retrieves information about an application.
    
    Parameters:
    
    getApplicationRequest -
    
    Returns:
    
    Result of the GetApplication operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - getConfiguration
```
@Deprecated
GetConfigurationResult getConfiguration(GetConfigurationRequest getConfigurationRequest)
```
    Deprecated.
    (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.
    Parameters:
    
    getConfigurationRequest -
    
    Returns:
    
    Result of the GetConfiguration operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - getConfigurationProfile
```
GetConfigurationProfileResult getConfigurationProfile(GetConfigurationProfileRequest getConfigurationProfileRequest)
```
    Retrieves information about a configuration profile.
    
    Parameters:
    
    getConfigurationProfileRequest -
    
    Returns:
    
    Result of the GetConfigurationProfile operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - getDeployment
```
GetDeploymentResult getDeployment(GetDeploymentRequest getDeploymentRequest)
```
    Retrieves information about a configuration deployment.
    
    Parameters:
    
    getDeploymentRequest -
    
    Returns:
    
    Result of the GetDeployment operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - getDeploymentStrategy
```
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.
    
    Parameters:
    
    getDeploymentStrategyRequest -
    
    Returns:
    
    Result of the GetDeploymentStrategy operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - getEnvironment
```
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.
    
    Parameters:
    
    getEnvironmentRequest -
    
    Returns:
    
    Result of the GetEnvironment operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - getExtension
```
GetExtensionResult getExtension(GetExtensionRequest getExtensionRequest)
```
    Returns information about an AppConfig extension.
    
    Parameters:
    
    getExtensionRequest -
    
    Returns:
    
    Result of the GetExtension operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - getExtensionAssociation
```
GetExtensionAssociationResult getExtensionAssociation(GetExtensionAssociationRequest getExtensionAssociationRequest)
```
    Returns information about an AppConfig extension association. For more information about extensions and associations, see Working with AppConfig extensions in the AppConfig User Guide.
    
    Parameters:
    
    getExtensionAssociationRequest -
    
    Returns:
    
    Result of the GetExtensionAssociation operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - getHostedConfigurationVersion
```
GetHostedConfigurationVersionResult getHostedConfigurationVersion(GetHostedConfigurationVersionRequest getHostedConfigurationVersionRequest)
```
    Retrieves information about a specific configuration version.
    
    Parameters:
    
    getHostedConfigurationVersionRequest -
    
    Returns:
    
    Result of the GetHostedConfigurationVersion operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listApplications
```
ListApplicationsResult listApplications(ListApplicationsRequest listApplicationsRequest)
```
    Lists all applications in your Amazon Web Services account.
    
    Parameters:
    
    listApplicationsRequest -
    
    Returns:
    
    Result of the ListApplications operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listConfigurationProfiles
```
ListConfigurationProfilesResult listConfigurationProfiles(ListConfigurationProfilesRequest listConfigurationProfilesRequest)
```
    Lists the configuration profiles for an application.
    
    Parameters:
    
    listConfigurationProfilesRequest -
    
    Returns:
    
    Result of the ListConfigurationProfiles operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listDeploymentStrategies
```
ListDeploymentStrategiesResult listDeploymentStrategies(ListDeploymentStrategiesRequest listDeploymentStrategiesRequest)
```
    Lists deployment strategies.
    
    Parameters:
    
    listDeploymentStrategiesRequest -
    
    Returns:
    
    Result of the ListDeploymentStrategies operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listDeployments
```
ListDeploymentsResult listDeployments(ListDeploymentsRequest listDeploymentsRequest)
```
    Lists the deployments for an environment in descending deployment number order.
    
    Parameters:
    
    listDeploymentsRequest -
    
    Returns:
    
    Result of the ListDeployments operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listEnvironments
```
ListEnvironmentsResult listEnvironments(ListEnvironmentsRequest listEnvironmentsRequest)
```
    Lists the environments for an application.
    
    Parameters:
    
    listEnvironmentsRequest -
    
    Returns:
    
    Result of the ListEnvironments operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listExtensionAssociations
```
ListExtensionAssociationsResult listExtensionAssociations(ListExtensionAssociationsRequest listExtensionAssociationsRequest)
```
    Lists all AppConfig extension associations in the account. For more information about extensions and associations, see Working with AppConfig extensions in the AppConfig User Guide.
    
    Parameters:
    
    listExtensionAssociationsRequest -
    
    Returns:
    
    Result of the ListExtensionAssociations operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listExtensions
```
ListExtensionsResult listExtensions(ListExtensionsRequest listExtensionsRequest)
```
    Lists all custom and Amazon Web Services authored AppConfig extensions in the account. For more information about extensions, see Working with AppConfig extensions in the AppConfig User Guide.
    
    Parameters:
    
    listExtensionsRequest -
    
    Returns:
    
    Result of the ListExtensions operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listHostedConfigurationVersions
```
ListHostedConfigurationVersionsResult listHostedConfigurationVersions(ListHostedConfigurationVersionsRequest listHostedConfigurationVersionsRequest)
```
    Lists configurations stored in the AppConfig hosted configuration store by version.
    
    Parameters:
    
    listHostedConfigurationVersionsRequest -
    
    Returns:
    
    Result of the ListHostedConfigurationVersions operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
```
    Retrieves the list of key-value tags assigned to the resource.
    
    Parameters:
    
    listTagsForResourceRequest -
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - startDeployment
```
StartDeploymentResult startDeployment(StartDeploymentRequest startDeploymentRequest)
```
    Starts a deployment.
    
    Parameters:
    
    startDeploymentRequest -
    
    Returns:
    
    Result of the StartDeployment operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - stopDeployment
```
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.
    
    Parameters:
    
    stopDeploymentRequest -
    
    Returns:
    
    Result of the StopDeployment operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
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.
    
    Parameters:
    
    tagResourceRequest -
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
```
    Deletes a tag key and value from an AppConfig resource.
    
    Parameters:
    
    untagResourceRequest -
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - updateApplication
```
UpdateApplicationResult updateApplication(UpdateApplicationRequest updateApplicationRequest)
```
    Updates an application.
    
    Parameters:
    
    updateApplicationRequest -
    
    Returns:
    
    Result of the UpdateApplication operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - updateConfigurationProfile
```
UpdateConfigurationProfileResult updateConfigurationProfile(UpdateConfigurationProfileRequest updateConfigurationProfileRequest)
```
    Updates a configuration profile.
    
    Parameters:
    
    updateConfigurationProfileRequest -
    
    Returns:
    
    Result of the UpdateConfigurationProfile operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - updateDeploymentStrategy
```
UpdateDeploymentStrategyResult updateDeploymentStrategy(UpdateDeploymentStrategyRequest updateDeploymentStrategyRequest)
```
    Updates a deployment strategy.
    
    Parameters:
    
    updateDeploymentStrategyRequest -
    
    Returns:
    
    Result of the UpdateDeploymentStrategy operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - updateEnvironment
```
UpdateEnvironmentResult updateEnvironment(UpdateEnvironmentRequest updateEnvironmentRequest)
```
    Updates an environment.
    
    Parameters:
    
    updateEnvironmentRequest -
    
    Returns:
    
    Result of the UpdateEnvironment operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - updateExtension
```
UpdateExtensionResult updateExtension(UpdateExtensionRequest updateExtensionRequest)
```
    Updates an AppConfig extension. For more information about extensions, see Working with AppConfig extensions in the AppConfig User Guide.
    
    Parameters:
    
    updateExtensionRequest -
    
    Returns:
    
    Result of the UpdateExtension operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - updateExtensionAssociation
```
UpdateExtensionAssociationResult updateExtensionAssociation(UpdateExtensionAssociationRequest updateExtensionAssociationRequest)
```
    Updates an association. For more information about extensions and associations, see Working with AppConfig extensions in the AppConfig User Guide.
    
    Parameters:
    
    updateExtensionAssociationRequest -
    
    Returns:
    
    Result of the UpdateExtensionAssociation operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - validateConfiguration
```
ValidateConfigurationResult validateConfiguration(ValidateConfigurationRequest validateConfigurationRequest)
```
    Uses the validators in a configuration profile to validate a configuration.
    
    Parameters:
    
    validateConfigurationRequest -
    
    Returns:
    
    Result of the ValidateConfiguration operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
void shutdown()
```
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
  - getCachedResponseMetadata
```
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. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    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.
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Did this page help you?

Interface AmazonAppConfig

Field Summary

Method Summary

Field Detail

ENDPOINT_PREFIX

Method Detail

createApplication

createConfigurationProfile

createDeploymentStrategy

createEnvironment

createExtension

createExtensionAssociation

createHostedConfigurationVersion

deleteApplication

deleteConfigurationProfile

deleteDeploymentStrategy

deleteEnvironment

deleteExtension

deleteExtensionAssociation

deleteHostedConfigurationVersion

getApplication

getConfiguration

getConfigurationProfile

getDeployment

getDeploymentStrategy

getEnvironment

getExtension

getExtensionAssociation

getHostedConfigurationVersion

listApplications

listConfigurationProfiles

listDeploymentStrategies

listDeployments

listEnvironments

listExtensionAssociations

listExtensions

listHostedConfigurationVersions

listTagsForResource

startDeployment

stopDeployment

tagResource

untagResource

updateApplication

updateConfigurationProfile

updateDeploymentStrategy

updateEnvironment

updateExtension

updateExtensionAssociation

validateConfiguration

shutdown

getCachedResponseMetadata