com.amazonaws.services.appconfig.AmazonAppConfig Maven / Gradle / Ivy
/*
* Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.appconfig;
import javax.annotation.Generated;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.appconfig.model.*;
/**
* Interface for accessing AppConfig.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.appconfig.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.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonAppConfig {
/**
* 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 RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "appconfig";
/**
*
* 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.
*
*
* @param createApplicationRequest
* @return 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.
* @throws 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.
* @throws InternalServerException
* There was an internal failure in the AppConfig service.
* @sample AmazonAppConfig.CreateApplication
* @see AWS
* API Documentation
*/
CreateApplicationResult createApplication(CreateApplicationRequest createApplicationRequest);
/**
*
* 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.
*
*
* @param createConfigurationProfileRequest
* @return 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.
* @throws ResourceNotFoundException
* The requested resource could not be found.
* @throws InternalServerException
* There was an internal failure in the AppConfig service.
* @throws 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.
* @sample AmazonAppConfig.CreateConfigurationProfile
* @see AWS API Documentation
*/
CreateConfigurationProfileResult createConfigurationProfile(CreateConfigurationProfileRequest createConfigurationProfileRequest);
/**
*
* 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.
*
*
* @param createDeploymentStrategyRequest
* @return Result of the CreateDeploymentStrategy operation returned by the service.
* @throws InternalServerException
* There was an internal failure in the AppConfig service.
* @throws 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.
* @throws BadRequestException
* The input fails to satisfy the constraints specified by an Amazon Web Services service.
* @sample AmazonAppConfig.CreateDeploymentStrategy
* @see AWS API Documentation
*/
CreateDeploymentStrategyResult createDeploymentStrategy(CreateDeploymentStrategyRequest createDeploymentStrategyRequest);
/**
*
* 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.
*
*
* @param createEnvironmentRequest
* @return Result of the CreateEnvironment operation returned by the service.
* @throws InternalServerException
* There was an internal failure in the AppConfig service.
* @throws ResourceNotFoundException
* The requested resource could not be found.
* @throws BadRequestException
* The input fails to satisfy the constraints specified by an Amazon Web Services service.
* @throws 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.
* @sample AmazonAppConfig.CreateEnvironment
* @see AWS
* API Documentation
*/
CreateEnvironmentResult createEnvironment(CreateEnvironmentRequest createEnvironmentRequest);
/**
*
* 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 Working with
* AppConfig extensions in the AppConfig User Guide.
*
*
* @param createExtensionRequest
* @return 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.
* @throws ConflictException
* The request could not be processed because of conflict in the current state of the resource.
* @throws 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.
* @throws InternalServerException
* There was an internal failure in the AppConfig service.
* @sample AmazonAppConfig.CreateExtension
* @see AWS API
* Documentation
*/
CreateExtensionResult createExtension(CreateExtensionRequest createExtensionRequest);
/**
*
* 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.
*
*
* @param createExtensionAssociationRequest
* @return 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.
* @throws ResourceNotFoundException
* The requested resource could not be found.
* @throws InternalServerException
* There was an internal failure in the AppConfig service.
* @throws 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.
* @sample AmazonAppConfig.CreateExtensionAssociation
* @see AWS API Documentation
*/
CreateExtensionAssociationResult createExtensionAssociation(CreateExtensionAssociationRequest createExtensionAssociationRequest);
/**
*
* Creates a new configuration in the AppConfig hosted configuration store.
*
*
* @param createHostedConfigurationVersionRequest
* @return 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.
* @throws 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.
* @throws ResourceNotFoundException
* The requested resource could not be found.
* @throws ConflictException
* The request could not be processed because of conflict in the current state of the resource.
* @throws PayloadTooLargeException
* The configuration size is too large.
* @throws InternalServerException
* There was an internal failure in the AppConfig service.
* @sample AmazonAppConfig.CreateHostedConfigurationVersion
* @see AWS API Documentation
*/
CreateHostedConfigurationVersionResult createHostedConfigurationVersion(CreateHostedConfigurationVersionRequest createHostedConfigurationVersionRequest);
/**
*
* Deletes an application. Deleting an application does not delete a configuration from a host.
*
*
* @param deleteApplicationRequest
* @return Result of the DeleteApplication operation returned by the service.
* @throws ResourceNotFoundException
* The requested resource could not be found.
* @throws InternalServerException
* There was an internal failure in the AppConfig service.
* @throws BadRequestException
* The input fails to satisfy the constraints specified by an Amazon Web Services service.
* @sample AmazonAppConfig.DeleteApplication
* @see AWS
* API Documentation
*/
DeleteApplicationResult deleteApplication(DeleteApplicationRequest deleteApplicationRequest);
/**
*
* Deletes a configuration profile. Deleting a configuration profile does not delete a configuration from a host.
*
*
* @param deleteConfigurationProfileRequest
* @return Result of the DeleteConfigurationProfile operation returned by the service.
* @throws ResourceNotFoundException
* The requested resource could not be found.
* @throws ConflictException
* The request could not be processed because of conflict in the current state of the resource.
* @throws InternalServerException
* There was an internal failure in the AppConfig service.
* @throws BadRequestException
* The input fails to satisfy the constraints specified by an Amazon Web Services service.
* @sample AmazonAppConfig.DeleteConfigurationProfile
* @see AWS API Documentation
*/
DeleteConfigurationProfileResult deleteConfigurationProfile(DeleteConfigurationProfileRequest deleteConfigurationProfileRequest);
/**
*
* Deletes a deployment strategy. Deleting a deployment strategy does not delete a configuration from a host.
*
*
* @param deleteDeploymentStrategyRequest
* @return Result of the DeleteDeploymentStrategy operation returned by the service.
* @throws ResourceNotFoundException
* The requested resource could not be found.
* @throws InternalServerException
* There was an internal failure in the AppConfig service.
* @throws BadRequestException
* The input fails to satisfy the constraints specified by an Amazon Web Services service.
* @sample AmazonAppConfig.DeleteDeploymentStrategy
* @see AWS API Documentation
*/
DeleteDeploymentStrategyResult deleteDeploymentStrategy(DeleteDeploymentStrategyRequest deleteDeploymentStrategyRequest);
/**
*
* Deletes an environment. Deleting an environment does not delete a configuration from a host.
*
*
* @param deleteEnvironmentRequest
* @return Result of the DeleteEnvironment operation returned by the service.
* @throws ResourceNotFoundException
* The requested resource could not be found.
* @throws ConflictException
* The request could not be processed because of conflict in the current state of the resource.
* @throws InternalServerException
* There was an internal failure in the AppConfig service.
* @throws BadRequestException
* The input fails to satisfy the constraints specified by an Amazon Web Services service.
* @sample AmazonAppConfig.DeleteEnvironment
* @see AWS
* API Documentation
*/
DeleteEnvironmentResult deleteEnvironment(DeleteEnvironmentRequest deleteEnvironmentRequest);
/**
*
* Deletes an AppConfig extension. You must delete all associations to an extension before you delete the extension.
*
*
* @param deleteExtensionRequest
* @return Result of the DeleteExtension operation returned by the service.
* @throws ResourceNotFoundException
* The requested resource could not be found.
* @throws InternalServerException
* There was an internal failure in the AppConfig service.
* @throws BadRequestException
* The input fails to satisfy the constraints specified by an Amazon Web Services service.
* @sample AmazonAppConfig.DeleteExtension
* @see AWS API
* Documentation
*/
DeleteExtensionResult deleteExtension(DeleteExtensionRequest deleteExtensionRequest);
/**
*
* Deletes an extension association. This action doesn't delete extensions defined in the association.
*
*
* @param deleteExtensionAssociationRequest
* @return 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.
* @throws ResourceNotFoundException
* The requested resource could not be found.
* @throws InternalServerException
* There was an internal failure in the AppConfig service.
* @sample AmazonAppConfig.DeleteExtensionAssociation
* @see AWS API Documentation
*/
DeleteExtensionAssociationResult deleteExtensionAssociation(DeleteExtensionAssociationRequest deleteExtensionAssociationRequest);
/**
*
* Deletes a version of a configuration from the AppConfig hosted configuration store.
*
*
* @param deleteHostedConfigurationVersionRequest
* @return 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.
* @throws ResourceNotFoundException
* The requested resource could not be found.
* @throws InternalServerException
* There was an internal failure in the AppConfig service.
* @sample AmazonAppConfig.DeleteHostedConfigurationVersion
* @see AWS API Documentation
*/
DeleteHostedConfigurationVersionResult deleteHostedConfigurationVersion(DeleteHostedConfigurationVersionRequest deleteHostedConfigurationVersionRequest);
/**
*
* Retrieves information about an application.
*
*
* @param getApplicationRequest
* @return Result of the GetApplication operation returned by the service.
* @throws ResourceNotFoundException
* The requested resource could not be found.
* @throws InternalServerException
* There was an internal failure in the AppConfig service.
* @throws BadRequestException
* The input fails to satisfy the constraints specified by an Amazon Web Services service.
* @sample AmazonAppConfig.GetApplication
* @see AWS API
* Documentation
*/
GetApplicationResult getApplication(GetApplicationRequest getApplicationRequest);
/**
*
* (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.
*
*
*
*
*
* @param getConfigurationRequest
* @return Result of the GetConfiguration operation returned by the service.
* @throws ResourceNotFoundException
* The requested resource could not be found.
* @throws InternalServerException
* There was an internal failure in the AppConfig service.
* @throws BadRequestException
* The input fails to satisfy the constraints specified by an Amazon Web Services service.
* @sample AmazonAppConfig.GetConfiguration
* @see AWS API
* Documentation
*/
@Deprecated
GetConfigurationResult getConfiguration(GetConfigurationRequest getConfigurationRequest);
/**
*
* Retrieves information about a configuration profile.
*
*
* @param getConfigurationProfileRequest
* @return Result of the GetConfigurationProfile operation returned by the service.
* @throws ResourceNotFoundException
* The requested resource could not be found.
* @throws InternalServerException
* There was an internal failure in the AppConfig service.
* @throws BadRequestException
* The input fails to satisfy the constraints specified by an Amazon Web Services service.
* @sample AmazonAppConfig.GetConfigurationProfile
* @see AWS API Documentation
*/
GetConfigurationProfileResult getConfigurationProfile(GetConfigurationProfileRequest getConfigurationProfileRequest);
/**
*
* Retrieves information about a configuration deployment.
*
*
* @param getDeploymentRequest
* @return Result of the GetDeployment operation returned by the service.
* @throws ResourceNotFoundException
* The requested resource could not be found.
* @throws InternalServerException
* There was an internal failure in the AppConfig service.
* @throws BadRequestException
* The input fails to satisfy the constraints specified by an Amazon Web Services service.
* @sample AmazonAppConfig.GetDeployment
* @see AWS API
* Documentation
*/
GetDeploymentResult getDeployment(GetDeploymentRequest getDeploymentRequest);
/**
*
* 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.
*
*
* @param getDeploymentStrategyRequest
* @return Result of the GetDeploymentStrategy operation returned by the service.
* @throws ResourceNotFoundException
* The requested resource could not be found.
* @throws InternalServerException
* There was an internal failure in the AppConfig service.
* @throws BadRequestException
* The input fails to satisfy the constraints specified by an Amazon Web Services service.
* @sample AmazonAppConfig.GetDeploymentStrategy
* @see AWS API Documentation
*/
GetDeploymentStrategyResult getDeploymentStrategy(GetDeploymentStrategyRequest getDeploymentStrategyRequest);
/**
*
* 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.
*
*
* @param getEnvironmentRequest
* @return Result of the GetEnvironment operation returned by the service.
* @throws ResourceNotFoundException
* The requested resource could not be found.
* @throws InternalServerException
* There was an internal failure in the AppConfig service.
* @throws BadRequestException
* The input fails to satisfy the constraints specified by an Amazon Web Services service.
* @sample AmazonAppConfig.GetEnvironment
* @see AWS API
* Documentation
*/
GetEnvironmentResult getEnvironment(GetEnvironmentRequest getEnvironmentRequest);
/**
*
* Returns information about an AppConfig extension.
*
*
* @param getExtensionRequest
* @return Result of the GetExtension operation returned by the service.
* @throws ResourceNotFoundException
* The requested resource could not be found.
* @throws InternalServerException
* There was an internal failure in the AppConfig service.
* @throws BadRequestException
* The input fails to satisfy the constraints specified by an Amazon Web Services service.
* @sample AmazonAppConfig.GetExtension
* @see AWS API
* Documentation
*/
GetExtensionResult getExtension(GetExtensionRequest getExtensionRequest);
/**
*
* Returns information about an AppConfig extension association. For more information about extensions and
* associations, see Working with
* AppConfig extensions in the AppConfig User Guide.
*
*
* @param getExtensionAssociationRequest
* @return 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.
* @throws ResourceNotFoundException
* The requested resource could not be found.
* @throws InternalServerException
* There was an internal failure in the AppConfig service.
* @sample AmazonAppConfig.GetExtensionAssociation
* @see AWS API Documentation
*/
GetExtensionAssociationResult getExtensionAssociation(GetExtensionAssociationRequest getExtensionAssociationRequest);
/**
*
* Retrieves information about a specific configuration version.
*
*
* @param getHostedConfigurationVersionRequest
* @return 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.
* @throws ResourceNotFoundException
* The requested resource could not be found.
* @throws InternalServerException
* There was an internal failure in the AppConfig service.
* @sample AmazonAppConfig.GetHostedConfigurationVersion
* @see AWS API Documentation
*/
GetHostedConfigurationVersionResult getHostedConfigurationVersion(GetHostedConfigurationVersionRequest getHostedConfigurationVersionRequest);
/**
*
* Lists all applications in your Amazon Web Services account.
*
*
* @param listApplicationsRequest
* @return Result of the ListApplications operation returned by the service.
* @throws InternalServerException
* There was an internal failure in the AppConfig service.
* @throws BadRequestException
* The input fails to satisfy the constraints specified by an Amazon Web Services service.
* @sample AmazonAppConfig.ListApplications
* @see AWS API
* Documentation
*/
ListApplicationsResult listApplications(ListApplicationsRequest listApplicationsRequest);
/**
*
* Lists the configuration profiles for an application.
*
*
* @param listConfigurationProfilesRequest
* @return Result of the ListConfigurationProfiles operation returned by the service.
* @throws ResourceNotFoundException
* The requested resource could not be found.
* @throws InternalServerException
* There was an internal failure in the AppConfig service.
* @throws BadRequestException
* The input fails to satisfy the constraints specified by an Amazon Web Services service.
* @sample AmazonAppConfig.ListConfigurationProfiles
* @see AWS API Documentation
*/
ListConfigurationProfilesResult listConfigurationProfiles(ListConfigurationProfilesRequest listConfigurationProfilesRequest);
/**
*
* Lists deployment strategies.
*
*
* @param listDeploymentStrategiesRequest
* @return Result of the ListDeploymentStrategies operation returned by the service.
* @throws InternalServerException
* There was an internal failure in the AppConfig service.
* @throws BadRequestException
* The input fails to satisfy the constraints specified by an Amazon Web Services service.
* @sample AmazonAppConfig.ListDeploymentStrategies
* @see AWS API Documentation
*/
ListDeploymentStrategiesResult listDeploymentStrategies(ListDeploymentStrategiesRequest listDeploymentStrategiesRequest);
/**
*
* Lists the deployments for an environment in descending deployment number order.
*
*
* @param listDeploymentsRequest
* @return Result of the ListDeployments operation returned by the service.
* @throws ResourceNotFoundException
* The requested resource could not be found.
* @throws InternalServerException
* There was an internal failure in the AppConfig service.
* @throws BadRequestException
* The input fails to satisfy the constraints specified by an Amazon Web Services service.
* @sample AmazonAppConfig.ListDeployments
* @see AWS API
* Documentation
*/
ListDeploymentsResult listDeployments(ListDeploymentsRequest listDeploymentsRequest);
/**
*
* Lists the environments for an application.
*
*
* @param listEnvironmentsRequest
* @return Result of the ListEnvironments operation returned by the service.
* @throws ResourceNotFoundException
* The requested resource could not be found.
* @throws InternalServerException
* There was an internal failure in the AppConfig service.
* @throws BadRequestException
* The input fails to satisfy the constraints specified by an Amazon Web Services service.
* @sample AmazonAppConfig.ListEnvironments
* @see AWS API
* Documentation
*/
ListEnvironmentsResult listEnvironments(ListEnvironmentsRequest listEnvironmentsRequest);
/**
*
* 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.
*
*
* @param listExtensionAssociationsRequest
* @return Result of the ListExtensionAssociations operation returned by the service.
* @throws InternalServerException
* There was an internal failure in the AppConfig service.
* @throws BadRequestException
* The input fails to satisfy the constraints specified by an Amazon Web Services service.
* @sample AmazonAppConfig.ListExtensionAssociations
* @see AWS API Documentation
*/
ListExtensionAssociationsResult listExtensionAssociations(ListExtensionAssociationsRequest listExtensionAssociationsRequest);
/**
*
* 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.
*
*
* @param listExtensionsRequest
* @return Result of the ListExtensions operation returned by the service.
* @throws InternalServerException
* There was an internal failure in the AppConfig service.
* @throws BadRequestException
* The input fails to satisfy the constraints specified by an Amazon Web Services service.
* @sample AmazonAppConfig.ListExtensions
* @see AWS API
* Documentation
*/
ListExtensionsResult listExtensions(ListExtensionsRequest listExtensionsRequest);
/**
*
* Lists configurations stored in the AppConfig hosted configuration store by version.
*
*
* @param listHostedConfigurationVersionsRequest
* @return 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.
* @throws ResourceNotFoundException
* The requested resource could not be found.
* @throws InternalServerException
* There was an internal failure in the AppConfig service.
* @sample AmazonAppConfig.ListHostedConfigurationVersions
* @see AWS API Documentation
*/
ListHostedConfigurationVersionsResult listHostedConfigurationVersions(ListHostedConfigurationVersionsRequest listHostedConfigurationVersionsRequest);
/**
*
* Retrieves the list of key-value tags assigned to the resource.
*
*
* @param listTagsForResourceRequest
* @return Result of the ListTagsForResource operation returned by the service.
* @throws ResourceNotFoundException
* The requested resource could not be found.
* @throws BadRequestException
* The input fails to satisfy the constraints specified by an Amazon Web Services service.
* @throws InternalServerException
* There was an internal failure in the AppConfig service.
* @sample AmazonAppConfig.ListTagsForResource
* @see AWS
* API Documentation
*/
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest);
/**
*
* Starts a deployment.
*
*
* @param startDeploymentRequest
* @return 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.
* @throws ResourceNotFoundException
* The requested resource could not be found.
* @throws ConflictException
* The request could not be processed because of conflict in the current state of the resource.
* @throws InternalServerException
* There was an internal failure in the AppConfig service.
* @sample AmazonAppConfig.StartDeployment
* @see AWS API
* Documentation
*/
StartDeploymentResult startDeployment(StartDeploymentRequest startDeploymentRequest);
/**
*
* 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.
*
*
* @param stopDeploymentRequest
* @return Result of the StopDeployment operation returned by the service.
* @throws ResourceNotFoundException
* The requested resource could not be found.
* @throws InternalServerException
* There was an internal failure in the AppConfig service.
* @throws BadRequestException
* The input fails to satisfy the constraints specified by an Amazon Web Services service.
* @sample AmazonAppConfig.StopDeployment
* @see AWS API
* Documentation
*/
StopDeploymentResult stopDeployment(StopDeploymentRequest stopDeploymentRequest);
/**
*
* 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.
*
*
* @param tagResourceRequest
* @return Result of the TagResource operation returned by the service.
* @throws ResourceNotFoundException
* The requested resource could not be found.
* @throws BadRequestException
* The input fails to satisfy the constraints specified by an Amazon Web Services service.
* @throws InternalServerException
* There was an internal failure in the AppConfig service.
* @sample AmazonAppConfig.TagResource
* @see AWS API
* Documentation
*/
TagResourceResult tagResource(TagResourceRequest tagResourceRequest);
/**
*
* Deletes a tag key and value from an AppConfig resource.
*
*
* @param untagResourceRequest
* @return Result of the UntagResource operation returned by the service.
* @throws ResourceNotFoundException
* The requested resource could not be found.
* @throws BadRequestException
* The input fails to satisfy the constraints specified by an Amazon Web Services service.
* @throws InternalServerException
* There was an internal failure in the AppConfig service.
* @sample AmazonAppConfig.UntagResource
* @see AWS API
* Documentation
*/
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest);
/**
*
* Updates an application.
*
*
* @param updateApplicationRequest
* @return 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.
* @throws ResourceNotFoundException
* The requested resource could not be found.
* @throws InternalServerException
* There was an internal failure in the AppConfig service.
* @sample AmazonAppConfig.UpdateApplication
* @see AWS
* API Documentation
*/
UpdateApplicationResult updateApplication(UpdateApplicationRequest updateApplicationRequest);
/**
*
* Updates a configuration profile.
*
*
* @param updateConfigurationProfileRequest
* @return 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.
* @throws ResourceNotFoundException
* The requested resource could not be found.
* @throws InternalServerException
* There was an internal failure in the AppConfig service.
* @sample AmazonAppConfig.UpdateConfigurationProfile
* @see AWS API Documentation
*/
UpdateConfigurationProfileResult updateConfigurationProfile(UpdateConfigurationProfileRequest updateConfigurationProfileRequest);
/**
*
* Updates a deployment strategy.
*
*
* @param updateDeploymentStrategyRequest
* @return 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.
* @throws ResourceNotFoundException
* The requested resource could not be found.
* @throws InternalServerException
* There was an internal failure in the AppConfig service.
* @sample AmazonAppConfig.UpdateDeploymentStrategy
* @see AWS API Documentation
*/
UpdateDeploymentStrategyResult updateDeploymentStrategy(UpdateDeploymentStrategyRequest updateDeploymentStrategyRequest);
/**
*
* Updates an environment.
*
*
* @param updateEnvironmentRequest
* @return 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.
* @throws ResourceNotFoundException
* The requested resource could not be found.
* @throws InternalServerException
* There was an internal failure in the AppConfig service.
* @sample AmazonAppConfig.UpdateEnvironment
* @see AWS
* API Documentation
*/
UpdateEnvironmentResult updateEnvironment(UpdateEnvironmentRequest updateEnvironmentRequest);
/**
*
* Updates an AppConfig extension. For more information about extensions, see Working with
* AppConfig extensions in the AppConfig User Guide.
*
*
* @param updateExtensionRequest
* @return 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.
* @throws ResourceNotFoundException
* The requested resource could not be found.
* @throws ConflictException
* The request could not be processed because of conflict in the current state of the resource.
* @throws InternalServerException
* There was an internal failure in the AppConfig service.
* @sample AmazonAppConfig.UpdateExtension
* @see AWS API
* Documentation
*/
UpdateExtensionResult updateExtension(UpdateExtensionRequest updateExtensionRequest);
/**
*
* Updates an association. For more information about extensions and associations, see Working with
* AppConfig extensions in the AppConfig User Guide.
*
*
* @param updateExtensionAssociationRequest
* @return 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.
* @throws ResourceNotFoundException
* The requested resource could not be found.
* @throws InternalServerException
* There was an internal failure in the AppConfig service.
* @sample AmazonAppConfig.UpdateExtensionAssociation
* @see AWS API Documentation
*/
UpdateExtensionAssociationResult updateExtensionAssociation(UpdateExtensionAssociationRequest updateExtensionAssociationRequest);
/**
*
* Uses the validators in a configuration profile to validate a configuration.
*
*
* @param validateConfigurationRequest
* @return 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.
* @throws ResourceNotFoundException
* The requested resource could not be found.
* @throws InternalServerException
* There was an internal failure in the AppConfig service.
* @sample AmazonAppConfig.ValidateConfiguration
* @see AWS API Documentation
*/
ValidateConfigurationResult validateConfiguration(ValidateConfigurationRequest validateConfigurationRequest);
/**
* 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.
*/
void shutdown();
/**
* 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.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none is available.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}