com.amazonaws.services.appconfig

Class AmazonAppConfigClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.appconfig.AmazonAppConfigClient

All Implemented Interfaces:

AmazonAppConfig

Direct Known Subclasses:

AmazonAppConfigAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonAppConfigClient
extends AmazonWebServiceClient
implements AmazonAppConfig

Client for accessing AppConfig. All service calls made using this client are blocking, and will not return until the service call completes.

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 inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.appconfig.AmazonAppConfig

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AmazonAppConfigClientBuilder	builder()
CreateApplicationResult	createApplication(CreateApplicationRequest request) Creates an application.
CreateConfigurationProfileResult	createConfigurationProfile(CreateConfigurationProfileRequest request) Creates a configuration profile, which is information that enables AppConfig to access the configuration source.
CreateDeploymentStrategyResult	createDeploymentStrategy(CreateDeploymentStrategyRequest request) Creates a deployment strategy that defines important criteria for rolling out your configuration to the designated targets.
CreateEnvironmentResult	createEnvironment(CreateEnvironmentRequest request) Creates an environment.
CreateExtensionResult	createExtension(CreateExtensionRequest request) Creates an AppConfig extension.
CreateExtensionAssociationResult	createExtensionAssociation(CreateExtensionAssociationRequest request) 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 request) Creates a new configuration in the AppConfig hosted configuration store.
DeleteApplicationResult	deleteApplication(DeleteApplicationRequest request) Deletes an application.
DeleteConfigurationProfileResult	deleteConfigurationProfile(DeleteConfigurationProfileRequest request) Deletes a configuration profile.
DeleteDeploymentStrategyResult	deleteDeploymentStrategy(DeleteDeploymentStrategyRequest request) Deletes a deployment strategy.
DeleteEnvironmentResult	deleteEnvironment(DeleteEnvironmentRequest request) Deletes an environment.
DeleteExtensionResult	deleteExtension(DeleteExtensionRequest request) Deletes an AppConfig extension.
DeleteExtensionAssociationResult	deleteExtensionAssociation(DeleteExtensionAssociationRequest request) Deletes an extension association.
DeleteHostedConfigurationVersionResult	deleteHostedConfigurationVersion(DeleteHostedConfigurationVersionRequest request) Deletes a version of a configuration from the AppConfig hosted configuration store.
GetApplicationResult	getApplication(GetApplicationRequest request) 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 request) Deprecated.
GetConfigurationProfileResult	getConfigurationProfile(GetConfigurationProfileRequest request) Retrieves information about a configuration profile.
GetDeploymentResult	getDeployment(GetDeploymentRequest request) Retrieves information about a configuration deployment.
GetDeploymentStrategyResult	getDeploymentStrategy(GetDeploymentStrategyRequest request) Retrieves information about a deployment strategy.
GetEnvironmentResult	getEnvironment(GetEnvironmentRequest request) Retrieves information about an environment.
GetExtensionResult	getExtension(GetExtensionRequest request) Returns information about an AppConfig extension.
GetExtensionAssociationResult	getExtensionAssociation(GetExtensionAssociationRequest request) Returns information about an AppConfig extension association.
GetHostedConfigurationVersionResult	getHostedConfigurationVersion(GetHostedConfigurationVersionRequest request) Retrieves information about a specific configuration version.
ListApplicationsResult	listApplications(ListApplicationsRequest request) Lists all applications in your Amazon Web Services account.
ListConfigurationProfilesResult	listConfigurationProfiles(ListConfigurationProfilesRequest request) Lists the configuration profiles for an application.
ListDeploymentsResult	listDeployments(ListDeploymentsRequest request) Lists the deployments for an environment in descending deployment number order.
ListDeploymentStrategiesResult	listDeploymentStrategies(ListDeploymentStrategiesRequest request) Lists deployment strategies.
ListEnvironmentsResult	listEnvironments(ListEnvironmentsRequest request) Lists the environments for an application.
ListExtensionAssociationsResult	listExtensionAssociations(ListExtensionAssociationsRequest request) Lists all AppConfig extension associations in the account.
ListExtensionsResult	listExtensions(ListExtensionsRequest request) Lists all custom and Amazon Web Services-authored AppConfig extensions in the account.
ListHostedConfigurationVersionsResult	listHostedConfigurationVersions(ListHostedConfigurationVersionsRequest request) Lists configurations stored in the AppConfig hosted configuration store by version.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) 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 request) Starts a deployment.
StopDeploymentResult	stopDeployment(StopDeploymentRequest request) Stops a deployment.
TagResourceResult	tagResource(TagResourceRequest request) Assigns metadata to an AppConfig resource.
UntagResourceResult	untagResource(UntagResourceRequest request) Deletes a tag key and value from an AppConfig resource.
UpdateApplicationResult	updateApplication(UpdateApplicationRequest request) Updates an application.
UpdateConfigurationProfileResult	updateConfigurationProfile(UpdateConfigurationProfileRequest request) Updates a configuration profile.
UpdateDeploymentStrategyResult	updateDeploymentStrategy(UpdateDeploymentStrategyRequest request) Updates a deployment strategy.
UpdateEnvironmentResult	updateEnvironment(UpdateEnvironmentRequest request) Updates an environment.
UpdateExtensionResult	updateExtension(UpdateExtensionRequest request) Updates an AppConfig extension.
UpdateExtensionAssociationResult	updateExtensionAssociation(UpdateExtensionAssociationRequest request) Updates an association.
ValidateConfigurationResult	validateConfiguration(ValidateConfigurationRequest request) Uses the validators in a configuration profile to validate a configuration.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static AmazonAppConfigClientBuilder builder()

createApplication

public CreateApplicationResult createApplication(CreateApplicationRequest request)

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.

Specified by:

createApplication in interface AmazonAppConfig

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

public CreateConfigurationProfileResult createConfigurationProfile(CreateConfigurationProfileRequest request)

Creates a configuration profile, which is information that enables AppConfig to access the configuration source. Valid configuration sources include the AppConfig hosted configuration store, Amazon Web Services Systems Manager (SSM) documents, SSM Parameter Store parameters, Amazon S3 objects, or any integration source action supported by CodePipeline. 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.

Specified by:

createConfigurationProfile in interface AmazonAppConfig

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

public CreateDeploymentStrategyResult createDeploymentStrategy(CreateDeploymentStrategyRequest request)

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.

Specified by:

createDeploymentStrategy in interface AmazonAppConfig

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

public CreateEnvironmentResult createEnvironment(CreateEnvironmentRequest request)

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.

Specified by:

createEnvironment in interface AmazonAppConfig

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

public CreateExtensionResult createExtension(CreateExtensionRequest request)

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.

Specified by:

createExtension in interface AmazonAppConfig

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

public CreateExtensionAssociationResult createExtensionAssociation(CreateExtensionAssociationRequest request)

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.

Specified by:

createExtensionAssociation in interface AmazonAppConfig

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

public CreateHostedConfigurationVersionResult createHostedConfigurationVersion(CreateHostedConfigurationVersionRequest request)

Creates a new configuration in the AppConfig hosted configuration store.

Specified by:

createHostedConfigurationVersion in interface AmazonAppConfig

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

public DeleteApplicationResult deleteApplication(DeleteApplicationRequest request)

Deletes an application. Deleting an application does not delete a configuration from a host.

Specified by:

deleteApplication in interface AmazonAppConfig

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

public DeleteConfigurationProfileResult deleteConfigurationProfile(DeleteConfigurationProfileRequest request)

Deletes a configuration profile. Deleting a configuration profile does not delete a configuration from a host.

Specified by:

deleteConfigurationProfile in interface AmazonAppConfig

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

public DeleteDeploymentStrategyResult deleteDeploymentStrategy(DeleteDeploymentStrategyRequest request)

Deletes a deployment strategy. Deleting a deployment strategy does not delete a configuration from a host.

Specified by:

deleteDeploymentStrategy in interface AmazonAppConfig

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

public DeleteEnvironmentResult deleteEnvironment(DeleteEnvironmentRequest request)

Deletes an environment. Deleting an environment does not delete a configuration from a host.

Specified by:

deleteEnvironment in interface AmazonAppConfig

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

public DeleteExtensionResult deleteExtension(DeleteExtensionRequest request)

Deletes an AppConfig extension. You must delete all associations to an extension before you delete the extension.

Specified by:

deleteExtension in interface AmazonAppConfig

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

public DeleteExtensionAssociationResult deleteExtensionAssociation(DeleteExtensionAssociationRequest request)

Deletes an extension association. This action doesn't delete extensions defined in the association.

Specified by:

deleteExtensionAssociation in interface AmazonAppConfig

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

public DeleteHostedConfigurationVersionResult deleteHostedConfigurationVersion(DeleteHostedConfigurationVersionRequest request)

Deletes a version of a configuration from the AppConfig hosted configuration store.

Specified by:

deleteHostedConfigurationVersion in interface AmazonAppConfig

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

public GetApplicationResult getApplication(GetApplicationRequest request)

Retrieves information about an application.

Specified by:

getApplication in interface AmazonAppConfig

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
public GetConfigurationResult getConfiguration(GetConfigurationRequest request)

Deprecated.

Retrieves the latest deployed configuration.

Note the following important information.

• This API action has been deprecated. Calls to receive configuration data should use the StartConfigurationSession and GetLatestConfiguration APIs instead.

• GetConfiguration is a priced call. For more information, see Pricing.

• AppConfig uses the value of the ClientConfigurationVersion parameter to identify the configuration version on your clients. If you don’t send ClientConfigurationVersion with each call to GetConfiguration, your clients receive the current configuration. You are charged each time your clients receive a configuration.

  To avoid excess charges, we recommend you use the StartConfigurationSession and GetLatestConfiguration APIs, which track the client configuration version on your behalf. If you choose to continue using GetConfiguration, we recommend that you include the ClientConfigurationVersion value with every call to GetConfiguration. The value to use for ClientConfigurationVersion comes from the ConfigurationVersion attribute returned by GetConfiguration when there is new or updated data, and should be saved for subsequent calls to GetConfiguration.

Specified by:

getConfiguration in interface AmazonAppConfig

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

public GetConfigurationProfileResult getConfigurationProfile(GetConfigurationProfileRequest request)

Retrieves information about a configuration profile.

Specified by:

getConfigurationProfile in interface AmazonAppConfig

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

public GetDeploymentResult getDeployment(GetDeploymentRequest request)

Retrieves information about a configuration deployment.

Specified by:

getDeployment in interface AmazonAppConfig

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

public GetDeploymentStrategyResult getDeploymentStrategy(GetDeploymentStrategyRequest request)

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.

Specified by:

getDeploymentStrategy in interface AmazonAppConfig

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

public GetEnvironmentResult getEnvironment(GetEnvironmentRequest request)

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.

Specified by:

getEnvironment in interface AmazonAppConfig

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

public GetExtensionResult getExtension(GetExtensionRequest request)

Returns information about an AppConfig extension.

Specified by:

getExtension in interface AmazonAppConfig

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

public GetExtensionAssociationResult getExtensionAssociation(GetExtensionAssociationRequest request)

Returns information about an AppConfig extension association. For more information about extensions and associations, see Working with AppConfig extensions in the AppConfig User Guide.

Specified by:

getExtensionAssociation in interface AmazonAppConfig

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

public GetHostedConfigurationVersionResult getHostedConfigurationVersion(GetHostedConfigurationVersionRequest request)

Retrieves information about a specific configuration version.

Specified by:

getHostedConfigurationVersion in interface AmazonAppConfig

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

public ListApplicationsResult listApplications(ListApplicationsRequest request)

Lists all applications in your Amazon Web Services account.

Specified by:

listApplications in interface AmazonAppConfig

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

public ListConfigurationProfilesResult listConfigurationProfiles(ListConfigurationProfilesRequest request)

Lists the configuration profiles for an application.

Specified by:

listConfigurationProfiles in interface AmazonAppConfig

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

public ListDeploymentStrategiesResult listDeploymentStrategies(ListDeploymentStrategiesRequest request)

Lists deployment strategies.

Specified by:

listDeploymentStrategies in interface AmazonAppConfig

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

public ListDeploymentsResult listDeployments(ListDeploymentsRequest request)

Lists the deployments for an environment in descending deployment number order.

Specified by:

listDeployments in interface AmazonAppConfig

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

public ListEnvironmentsResult listEnvironments(ListEnvironmentsRequest request)

Lists the environments for an application.

Specified by:

listEnvironments in interface AmazonAppConfig

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

public ListExtensionAssociationsResult listExtensionAssociations(ListExtensionAssociationsRequest request)

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.

Specified by:

listExtensionAssociations in interface AmazonAppConfig

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

public ListExtensionsResult listExtensions(ListExtensionsRequest request)

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.

Specified by:

listExtensions in interface AmazonAppConfig

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

public ListHostedConfigurationVersionsResult listHostedConfigurationVersions(ListHostedConfigurationVersionsRequest request)

Lists configurations stored in the AppConfig hosted configuration store by version.

Specified by:

listHostedConfigurationVersions in interface AmazonAppConfig

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

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

Retrieves the list of key-value tags assigned to the resource.

Specified by:

listTagsForResource in interface AmazonAppConfig

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

public StartDeploymentResult startDeployment(StartDeploymentRequest request)

Starts a deployment.

Specified by:

startDeployment in interface AmazonAppConfig

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

public StopDeploymentResult stopDeployment(StopDeploymentRequest request)

Stops a deployment. This API action works only on deployments that have a status of DEPLOYING. This action moves the deployment to a status of ROLLED_BACK.

Specified by:

stopDeployment in interface AmazonAppConfig

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

public TagResourceResult tagResource(TagResourceRequest request)

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.

Specified by:

tagResource in interface AmazonAppConfig

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

public UntagResourceResult untagResource(UntagResourceRequest request)

Deletes a tag key and value from an AppConfig resource.

Specified by:

untagResource in interface AmazonAppConfig

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

public UpdateApplicationResult updateApplication(UpdateApplicationRequest request)

Updates an application.

Specified by:

updateApplication in interface AmazonAppConfig

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

public UpdateConfigurationProfileResult updateConfigurationProfile(UpdateConfigurationProfileRequest request)

Updates a configuration profile.

Specified by:

updateConfigurationProfile in interface AmazonAppConfig

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

public UpdateDeploymentStrategyResult updateDeploymentStrategy(UpdateDeploymentStrategyRequest request)

Updates a deployment strategy.

Specified by:

updateDeploymentStrategy in interface AmazonAppConfig

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

public UpdateEnvironmentResult updateEnvironment(UpdateEnvironmentRequest request)

Updates an environment.

Specified by:

updateEnvironment in interface AmazonAppConfig

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

public UpdateExtensionResult updateExtension(UpdateExtensionRequest request)

Updates an AppConfig extension. For more information about extensions, see Working with AppConfig extensions in the AppConfig User Guide.

Specified by:

updateExtension in interface AmazonAppConfig

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

public UpdateExtensionAssociationResult updateExtensionAssociation(UpdateExtensionAssociationRequest request)

Updates an association. For more information about extensions and associations, see Working with AppConfig extensions in the AppConfig User Guide.

Specified by:

updateExtensionAssociation in interface AmazonAppConfig

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

public ValidateConfigurationResult validateConfiguration(ValidateConfigurationRequest request)

Uses the validators in a configuration profile to validate a configuration.

Specified by:

validateConfiguration in interface AmazonAppConfig

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

getCachedResponseMetadata

public 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 the request.

Specified by:

getCachedResponseMetadata in interface AmazonAppConfig

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.

shutdown

public void shutdown()

Description copied from class: AmazonWebServiceClient

Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AmazonAppConfig

Overrides:

shutdown in class AmazonWebServiceClient