Interface AppConfigAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
AppConfig feature flags and dynamic configurations help software builders quickly and securely adjust application behavior in production environments without full code deployments. AppConfig speeds up software release frequency, improves application resiliency, and helps you address emergent issues more quickly. With feature flags, you can gradually release new capabilities to users and measure the impact of those changes before fully deploying the new capabilities to all users. With operational flags and dynamic configurations, you can update block lists, allow lists, throttling limits, logging verbosity, and perform other operational tuning to quickly respond to issues in production environments.
AppConfig is a capability of Amazon Web Services Systems Manager.
Despite the fact that application configuration content can vary greatly from application to application, AppConfig supports the following use cases, which cover a broad spectrum of customer needs:
-
Feature flags and toggles - Safely release new capabilities to your customers in a controlled environment. Instantly roll back changes if you experience a problem.
-
Application tuning - Carefully introduce application changes while testing the impact of those changes with users in production environments.
-
Allow list or block list - Control access to premium features or instantly block specific users without deploying new code.
-
Centralized configuration storage - Keep your configuration data organized and consistent across all of your workloads. You can use AppConfig to deploy configuration data stored in the AppConfig hosted configuration store, Secrets Manager, Systems Manager, Parameter Store, or Amazon S3.
How AppConfig works
This section provides a high-level description of how AppConfig works and how you get started.
- 1. Identify configuration values in code you want to manage in the cloud
-
Before you start creating AppConfig artifacts, we recommend you identify configuration data in your code that you want to dynamically manage using AppConfig. Good examples include feature flags or toggles, allow and block lists, logging verbosity, service limits, and throttling rules, to name a few.
If your configuration data already exists in the cloud, you can take advantage of AppConfig validation, deployment, and extension features to further streamline configuration data management.
- 2. Create an application namespace
-
To create a namespace, you create an AppConfig artifact called an application. An application is simply an organizational construct like a folder.
- 3. Create environments
-
For each AppConfig application, you define one or more environments. An environment is a logical grouping of targets, such as applications in a
Beta
orProduction
environment, Lambda functions, or containers. You can also define environments for application subcomponents, such as theWeb
,Mobile
, andBack-end
.You can configure Amazon CloudWatch alarms for each environment. The system monitors alarms during a configuration deployment. If an alarm is triggered, the system rolls back the configuration.
- 4. Create a configuration profile
-
A configuration profile includes, among other things, a URI that enables AppConfig to locate your configuration data in its stored location and a profile type. AppConfig supports two configuration profile types: feature flags and freeform configurations. Feature flag configuration profiles store their data in the AppConfig hosted configuration store and the URI is simply
hosted
. For freeform configuration profiles, you can store your data in the AppConfig hosted configuration store or any Amazon Web Services service that integrates with AppConfig, as described in Creating a free form configuration profile in the the AppConfig User Guide.A configuration profile can also include optional validators to ensure your configuration data is syntactically and semantically correct. AppConfig performs a check using the validators when you start a deployment. If any errors are detected, the deployment rolls back to the previous configuration data.
- 5. Deploy configuration data
-
When you create a new deployment, you specify the following:
-
An application ID
-
A configuration profile ID
-
A configuration version
-
An environment ID where you want to deploy the configuration data
-
A deployment strategy ID that defines how fast you want the changes to take effect
When you call the StartDeployment API action, AppConfig performs the following tasks:
-
Retrieves the configuration data from the underlying data store by using the location URI in the configuration profile.
-
Verifies the configuration data is syntactically and semantically correct by using the validators you specified when you created your configuration profile.
-
Caches a copy of the data so it is ready to be retrieved by your application. This cached copy is called the deployed data.
-
- 6. Retrieve the configuration
-
You can configure AppConfig Agent as a local host and have the agent poll AppConfig for configuration updates. The agent calls the StartConfigurationSession and GetLatestConfiguration API actions and caches your configuration data locally. To retrieve the data, your application makes an HTTP call to the localhost server. AppConfig Agent supports several use cases, as described in Simplified retrieval methods in the the AppConfig User Guide.
If AppConfig Agent isn't supported for your use case, you can configure your application to poll AppConfig for configuration updates by directly calling the StartConfigurationSession and GetLatestConfiguration API actions.
This reference is intended to be used with the AppConfig User Guide.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionstatic AppConfigAsyncClientBuilder
builder()
Create a builder that can be used to configure and create aAppConfigAsyncClient
.static AppConfigAsyncClient
create()
Create aAppConfigAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.createApplication
(Consumer<CreateApplicationRequest.Builder> createApplicationRequest) Creates an application.createApplication
(CreateApplicationRequest createApplicationRequest) Creates an application.createConfigurationProfile
(Consumer<CreateConfigurationProfileRequest.Builder> createConfigurationProfileRequest) Creates a configuration profile, which is information that enables AppConfig to access the configuration source.createConfigurationProfile
(CreateConfigurationProfileRequest createConfigurationProfileRequest) Creates a configuration profile, which is information that enables AppConfig to access the configuration source.createDeploymentStrategy
(Consumer<CreateDeploymentStrategyRequest.Builder> createDeploymentStrategyRequest) Creates a deployment strategy that defines important criteria for rolling out your configuration to the designated targets.createDeploymentStrategy
(CreateDeploymentStrategyRequest createDeploymentStrategyRequest) Creates a deployment strategy that defines important criteria for rolling out your configuration to the designated targets.createEnvironment
(Consumer<CreateEnvironmentRequest.Builder> createEnvironmentRequest) Creates an environment.createEnvironment
(CreateEnvironmentRequest createEnvironmentRequest) Creates an environment.default CompletableFuture
<CreateExtensionResponse> createExtension
(Consumer<CreateExtensionRequest.Builder> createExtensionRequest) Creates an AppConfig extension.default CompletableFuture
<CreateExtensionResponse> createExtension
(CreateExtensionRequest createExtensionRequest) Creates an AppConfig extension.createExtensionAssociation
(Consumer<CreateExtensionAssociationRequest.Builder> 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.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.createHostedConfigurationVersion
(Consumer<CreateHostedConfigurationVersionRequest.Builder> createHostedConfigurationVersionRequest) Creates a new configuration in the AppConfig hosted configuration store.createHostedConfigurationVersion
(CreateHostedConfigurationVersionRequest createHostedConfigurationVersionRequest) Creates a new configuration in the AppConfig hosted configuration store.deleteApplication
(Consumer<DeleteApplicationRequest.Builder> deleteApplicationRequest) Deletes an application.deleteApplication
(DeleteApplicationRequest deleteApplicationRequest) Deletes an application.deleteConfigurationProfile
(Consumer<DeleteConfigurationProfileRequest.Builder> deleteConfigurationProfileRequest) Deletes a configuration profile.deleteConfigurationProfile
(DeleteConfigurationProfileRequest deleteConfigurationProfileRequest) Deletes a configuration profile.deleteDeploymentStrategy
(Consumer<DeleteDeploymentStrategyRequest.Builder> deleteDeploymentStrategyRequest) Deletes a deployment strategy.deleteDeploymentStrategy
(DeleteDeploymentStrategyRequest deleteDeploymentStrategyRequest) Deletes a deployment strategy.deleteEnvironment
(Consumer<DeleteEnvironmentRequest.Builder> deleteEnvironmentRequest) Deletes an environment.deleteEnvironment
(DeleteEnvironmentRequest deleteEnvironmentRequest) Deletes an environment.default CompletableFuture
<DeleteExtensionResponse> deleteExtension
(Consumer<DeleteExtensionRequest.Builder> deleteExtensionRequest) Deletes an AppConfig extension.default CompletableFuture
<DeleteExtensionResponse> deleteExtension
(DeleteExtensionRequest deleteExtensionRequest) Deletes an AppConfig extension.deleteExtensionAssociation
(Consumer<DeleteExtensionAssociationRequest.Builder> deleteExtensionAssociationRequest) Deletes an extension association.deleteExtensionAssociation
(DeleteExtensionAssociationRequest deleteExtensionAssociationRequest) Deletes an extension association.deleteHostedConfigurationVersion
(Consumer<DeleteHostedConfigurationVersionRequest.Builder> deleteHostedConfigurationVersionRequest) Deletes a version of a configuration from the AppConfig hosted configuration store.deleteHostedConfigurationVersion
(DeleteHostedConfigurationVersionRequest deleteHostedConfigurationVersionRequest) Deletes a version of a configuration from the AppConfig hosted configuration store.default CompletableFuture
<GetApplicationResponse> getApplication
(Consumer<GetApplicationRequest.Builder> getApplicationRequest) Retrieves information about an application.default CompletableFuture
<GetApplicationResponse> getApplication
(GetApplicationRequest getApplicationRequest) Retrieves information about an application.getConfiguration
(Consumer<GetConfigurationRequest.Builder> getConfigurationRequest) Deprecated.This API has been deprecated in favor of the GetLatestConfiguration API used in conjunction with StartConfigurationSession.getConfiguration
(GetConfigurationRequest getConfigurationRequest) Deprecated.This API has been deprecated in favor of the GetLatestConfiguration API used in conjunction with StartConfigurationSession.getConfigurationProfile
(Consumer<GetConfigurationProfileRequest.Builder> getConfigurationProfileRequest) Retrieves information about a configuration profile.getConfigurationProfile
(GetConfigurationProfileRequest getConfigurationProfileRequest) Retrieves information about a configuration profile.default CompletableFuture
<GetDeploymentResponse> getDeployment
(Consumer<GetDeploymentRequest.Builder> getDeploymentRequest) Retrieves information about a configuration deployment.default CompletableFuture
<GetDeploymentResponse> getDeployment
(GetDeploymentRequest getDeploymentRequest) Retrieves information about a configuration deployment.getDeploymentStrategy
(Consumer<GetDeploymentStrategyRequest.Builder> getDeploymentStrategyRequest) Retrieves information about a deployment strategy.getDeploymentStrategy
(GetDeploymentStrategyRequest getDeploymentStrategyRequest) Retrieves information about a deployment strategy.default CompletableFuture
<GetEnvironmentResponse> getEnvironment
(Consumer<GetEnvironmentRequest.Builder> getEnvironmentRequest) Retrieves information about an environment.default CompletableFuture
<GetEnvironmentResponse> getEnvironment
(GetEnvironmentRequest getEnvironmentRequest) Retrieves information about an environment.default CompletableFuture
<GetExtensionResponse> getExtension
(Consumer<GetExtensionRequest.Builder> getExtensionRequest) Returns information about an AppConfig extension.default CompletableFuture
<GetExtensionResponse> getExtension
(GetExtensionRequest getExtensionRequest) Returns information about an AppConfig extension.getExtensionAssociation
(Consumer<GetExtensionAssociationRequest.Builder> getExtensionAssociationRequest) Returns information about an AppConfig extension association.getExtensionAssociation
(GetExtensionAssociationRequest getExtensionAssociationRequest) Returns information about an AppConfig extension association.getHostedConfigurationVersion
(Consumer<GetHostedConfigurationVersionRequest.Builder> getHostedConfigurationVersionRequest) Retrieves information about a specific configuration version.getHostedConfigurationVersion
(GetHostedConfigurationVersionRequest getHostedConfigurationVersionRequest) Retrieves information about a specific configuration version.listApplications
(Consumer<ListApplicationsRequest.Builder> listApplicationsRequest) Lists all applications in your Amazon Web Services account.listApplications
(ListApplicationsRequest listApplicationsRequest) Lists all applications in your Amazon Web Services account.default ListApplicationsPublisher
listApplicationsPaginator
(Consumer<ListApplicationsRequest.Builder> listApplicationsRequest) This is a variant oflistApplications(software.amazon.awssdk.services.appconfig.model.ListApplicationsRequest)
operation.default ListApplicationsPublisher
listApplicationsPaginator
(ListApplicationsRequest listApplicationsRequest) This is a variant oflistApplications(software.amazon.awssdk.services.appconfig.model.ListApplicationsRequest)
operation.listConfigurationProfiles
(Consumer<ListConfigurationProfilesRequest.Builder> listConfigurationProfilesRequest) Lists the configuration profiles for an application.listConfigurationProfiles
(ListConfigurationProfilesRequest listConfigurationProfilesRequest) Lists the configuration profiles for an application.listConfigurationProfilesPaginator
(Consumer<ListConfigurationProfilesRequest.Builder> listConfigurationProfilesRequest) This is a variant oflistConfigurationProfiles(software.amazon.awssdk.services.appconfig.model.ListConfigurationProfilesRequest)
operation.listConfigurationProfilesPaginator
(ListConfigurationProfilesRequest listConfigurationProfilesRequest) This is a variant oflistConfigurationProfiles(software.amazon.awssdk.services.appconfig.model.ListConfigurationProfilesRequest)
operation.default CompletableFuture
<ListDeploymentsResponse> listDeployments
(Consumer<ListDeploymentsRequest.Builder> listDeploymentsRequest) Lists the deployments for an environment in descending deployment number order.default CompletableFuture
<ListDeploymentsResponse> listDeployments
(ListDeploymentsRequest listDeploymentsRequest) Lists the deployments for an environment in descending deployment number order.default ListDeploymentsPublisher
listDeploymentsPaginator
(Consumer<ListDeploymentsRequest.Builder> listDeploymentsRequest) This is a variant oflistDeployments(software.amazon.awssdk.services.appconfig.model.ListDeploymentsRequest)
operation.default ListDeploymentsPublisher
listDeploymentsPaginator
(ListDeploymentsRequest listDeploymentsRequest) This is a variant oflistDeployments(software.amazon.awssdk.services.appconfig.model.ListDeploymentsRequest)
operation.listDeploymentStrategies
(Consumer<ListDeploymentStrategiesRequest.Builder> listDeploymentStrategiesRequest) Lists deployment strategies.listDeploymentStrategies
(ListDeploymentStrategiesRequest listDeploymentStrategiesRequest) Lists deployment strategies.listDeploymentStrategiesPaginator
(Consumer<ListDeploymentStrategiesRequest.Builder> listDeploymentStrategiesRequest) This is a variant oflistDeploymentStrategies(software.amazon.awssdk.services.appconfig.model.ListDeploymentStrategiesRequest)
operation.listDeploymentStrategiesPaginator
(ListDeploymentStrategiesRequest listDeploymentStrategiesRequest) This is a variant oflistDeploymentStrategies(software.amazon.awssdk.services.appconfig.model.ListDeploymentStrategiesRequest)
operation.listEnvironments
(Consumer<ListEnvironmentsRequest.Builder> listEnvironmentsRequest) Lists the environments for an application.listEnvironments
(ListEnvironmentsRequest listEnvironmentsRequest) Lists the environments for an application.default ListEnvironmentsPublisher
listEnvironmentsPaginator
(Consumer<ListEnvironmentsRequest.Builder> listEnvironmentsRequest) This is a variant oflistEnvironments(software.amazon.awssdk.services.appconfig.model.ListEnvironmentsRequest)
operation.default ListEnvironmentsPublisher
listEnvironmentsPaginator
(ListEnvironmentsRequest listEnvironmentsRequest) This is a variant oflistEnvironments(software.amazon.awssdk.services.appconfig.model.ListEnvironmentsRequest)
operation.listExtensionAssociations
(Consumer<ListExtensionAssociationsRequest.Builder> listExtensionAssociationsRequest) Lists all AppConfig extension associations in the account.listExtensionAssociations
(ListExtensionAssociationsRequest listExtensionAssociationsRequest) Lists all AppConfig extension associations in the account.listExtensionAssociationsPaginator
(Consumer<ListExtensionAssociationsRequest.Builder> listExtensionAssociationsRequest) This is a variant oflistExtensionAssociations(software.amazon.awssdk.services.appconfig.model.ListExtensionAssociationsRequest)
operation.listExtensionAssociationsPaginator
(ListExtensionAssociationsRequest listExtensionAssociationsRequest) This is a variant oflistExtensionAssociations(software.amazon.awssdk.services.appconfig.model.ListExtensionAssociationsRequest)
operation.default CompletableFuture
<ListExtensionsResponse> listExtensions
(Consumer<ListExtensionsRequest.Builder> listExtensionsRequest) Lists all custom and Amazon Web Services authored AppConfig extensions in the account.default CompletableFuture
<ListExtensionsResponse> listExtensions
(ListExtensionsRequest listExtensionsRequest) Lists all custom and Amazon Web Services authored AppConfig extensions in the account.default ListExtensionsPublisher
listExtensionsPaginator
(Consumer<ListExtensionsRequest.Builder> listExtensionsRequest) This is a variant oflistExtensions(software.amazon.awssdk.services.appconfig.model.ListExtensionsRequest)
operation.default ListExtensionsPublisher
listExtensionsPaginator
(ListExtensionsRequest listExtensionsRequest) This is a variant oflistExtensions(software.amazon.awssdk.services.appconfig.model.ListExtensionsRequest)
operation.listHostedConfigurationVersions
(Consumer<ListHostedConfigurationVersionsRequest.Builder> listHostedConfigurationVersionsRequest) Lists configurations stored in the AppConfig hosted configuration store by version.listHostedConfigurationVersions
(ListHostedConfigurationVersionsRequest listHostedConfigurationVersionsRequest) Lists configurations stored in the AppConfig hosted configuration store by version.listHostedConfigurationVersionsPaginator
(Consumer<ListHostedConfigurationVersionsRequest.Builder> listHostedConfigurationVersionsRequest) This is a variant oflistHostedConfigurationVersions(software.amazon.awssdk.services.appconfig.model.ListHostedConfigurationVersionsRequest)
operation.listHostedConfigurationVersionsPaginator
(ListHostedConfigurationVersionsRequest listHostedConfigurationVersionsRequest) This is a variant oflistHostedConfigurationVersions(software.amazon.awssdk.services.appconfig.model.ListHostedConfigurationVersionsRequest)
operation.listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Retrieves the list of key-value tags assigned to the resource.listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Retrieves the list of key-value tags assigned to the resource.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationdefault CompletableFuture
<StartDeploymentResponse> startDeployment
(Consumer<StartDeploymentRequest.Builder> startDeploymentRequest) Starts a deployment.default CompletableFuture
<StartDeploymentResponse> startDeployment
(StartDeploymentRequest startDeploymentRequest) Starts a deployment.default CompletableFuture
<StopDeploymentResponse> stopDeployment
(Consumer<StopDeploymentRequest.Builder> stopDeploymentRequest) Stops a deployment.default CompletableFuture
<StopDeploymentResponse> stopDeployment
(StopDeploymentRequest stopDeploymentRequest) Stops a deployment.default CompletableFuture
<TagResourceResponse> tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Assigns metadata to an AppConfig resource.default CompletableFuture
<TagResourceResponse> tagResource
(TagResourceRequest tagResourceRequest) Assigns metadata to an AppConfig resource.default CompletableFuture
<UntagResourceResponse> untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Deletes a tag key and value from an AppConfig resource.default CompletableFuture
<UntagResourceResponse> untagResource
(UntagResourceRequest untagResourceRequest) Deletes a tag key and value from an AppConfig resource.updateApplication
(Consumer<UpdateApplicationRequest.Builder> updateApplicationRequest) Updates an application.updateApplication
(UpdateApplicationRequest updateApplicationRequest) Updates an application.updateConfigurationProfile
(Consumer<UpdateConfigurationProfileRequest.Builder> updateConfigurationProfileRequest) Updates a configuration profile.updateConfigurationProfile
(UpdateConfigurationProfileRequest updateConfigurationProfileRequest) Updates a configuration profile.updateDeploymentStrategy
(Consumer<UpdateDeploymentStrategyRequest.Builder> updateDeploymentStrategyRequest) Updates a deployment strategy.updateDeploymentStrategy
(UpdateDeploymentStrategyRequest updateDeploymentStrategyRequest) Updates a deployment strategy.updateEnvironment
(Consumer<UpdateEnvironmentRequest.Builder> updateEnvironmentRequest) Updates an environment.updateEnvironment
(UpdateEnvironmentRequest updateEnvironmentRequest) Updates an environment.default CompletableFuture
<UpdateExtensionResponse> updateExtension
(Consumer<UpdateExtensionRequest.Builder> updateExtensionRequest) Updates an AppConfig extension.default CompletableFuture
<UpdateExtensionResponse> updateExtension
(UpdateExtensionRequest updateExtensionRequest) Updates an AppConfig extension.updateExtensionAssociation
(Consumer<UpdateExtensionAssociationRequest.Builder> updateExtensionAssociationRequest) Updates an association.updateExtensionAssociation
(UpdateExtensionAssociationRequest updateExtensionAssociationRequest) Updates an association.validateConfiguration
(Consumer<ValidateConfigurationRequest.Builder> validateConfigurationRequest) Uses the validators in a configuration profile to validate a configuration.validateConfiguration
(ValidateConfigurationRequest validateConfigurationRequest) Uses the validators in a configuration profile to validate a configuration.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
createApplication
default CompletableFuture<CreateApplicationResponse> 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:
- A Java Future containing the result of the CreateApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- BadRequestException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ServiceQuotaExceededException The number of one more AppConfig resources exceeds the maximum allowed.
Verify that your environment doesn't exceed the following service quotas:
Applications: 100 max
Deployment strategies: 20 max
Configuration profiles: 100 max per application
Environments: 20 max per application
To resolve this issue, you can delete one or more resources and try again. Or, you can request a quota increase. For more information about quotas and to request an increase, see Service quotas for AppConfig in the Amazon Web Services General Reference.
- InternalServerException There was an internal failure in the AppConfig service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createApplication
default CompletableFuture<CreateApplicationResponse> createApplication(Consumer<CreateApplicationRequest.Builder> 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.
This is a convenience which creates an instance of the
CreateApplicationRequest.Builder
avoiding the need to create one manually viaCreateApplicationRequest.builder()
- Parameters:
createApplicationRequest
- AConsumer
that will call methods onCreateApplicationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- BadRequestException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ServiceQuotaExceededException The number of one more AppConfig resources exceeds the maximum allowed.
Verify that your environment doesn't exceed the following service quotas:
Applications: 100 max
Deployment strategies: 20 max
Configuration profiles: 100 max per application
Environments: 20 max per application
To resolve this issue, you can delete one or more resources and try again. Or, you can request a quota increase. For more information about quotas and to request an increase, see Service quotas for AppConfig in the Amazon Web Services General Reference.
- InternalServerException There was an internal failure in the AppConfig service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createConfigurationProfile
default CompletableFuture<CreateConfigurationProfileResponse> 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:
- A Java Future containing the result of the CreateConfigurationProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- BadRequestException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ResourceNotFoundException The requested resource could not be found.
- InternalServerException There was an internal failure in the AppConfig service.
- ServiceQuotaExceededException The number of one more AppConfig resources exceeds the maximum allowed.
Verify that your environment doesn't exceed the following service quotas:
Applications: 100 max
Deployment strategies: 20 max
Configuration profiles: 100 max per application
Environments: 20 max per application
To resolve this issue, you can delete one or more resources and try again. Or, you can request a quota increase. For more information about quotas and to request an increase, see Service quotas for AppConfig in the Amazon Web Services General Reference.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
createConfigurationProfile
default CompletableFuture<CreateConfigurationProfileResponse> createConfigurationProfile(Consumer<CreateConfigurationProfileRequest.Builder> 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.
This is a convenience which creates an instance of the
CreateConfigurationProfileRequest.Builder
avoiding the need to create one manually viaCreateConfigurationProfileRequest.builder()
- Parameters:
createConfigurationProfileRequest
- AConsumer
that will call methods onCreateConfigurationProfileRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateConfigurationProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- BadRequestException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ResourceNotFoundException The requested resource could not be found.
- InternalServerException There was an internal failure in the AppConfig service.
- ServiceQuotaExceededException The number of one more AppConfig resources exceeds the maximum allowed.
Verify that your environment doesn't exceed the following service quotas:
Applications: 100 max
Deployment strategies: 20 max
Configuration profiles: 100 max per application
Environments: 20 max per application
To resolve this issue, you can delete one or more resources and try again. Or, you can request a quota increase. For more information about quotas and to request an increase, see Service quotas for AppConfig in the Amazon Web Services General Reference.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
createDeploymentStrategy
default CompletableFuture<CreateDeploymentStrategyResponse> 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:
- A Java Future containing the result of the CreateDeploymentStrategy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException There was an internal failure in the AppConfig service.
- ServiceQuotaExceededException The number of one more AppConfig resources exceeds the maximum allowed.
Verify that your environment doesn't exceed the following service quotas:
Applications: 100 max
Deployment strategies: 20 max
Configuration profiles: 100 max per application
Environments: 20 max per application
To resolve this issue, you can delete one or more resources and try again. Or, you can request a quota increase. For more information about quotas and to request an increase, see Service quotas for AppConfig in the Amazon Web Services General Reference.
- BadRequestException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createDeploymentStrategy
default CompletableFuture<CreateDeploymentStrategyResponse> createDeploymentStrategy(Consumer<CreateDeploymentStrategyRequest.Builder> 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.
This is a convenience which creates an instance of the
CreateDeploymentStrategyRequest.Builder
avoiding the need to create one manually viaCreateDeploymentStrategyRequest.builder()
- Parameters:
createDeploymentStrategyRequest
- AConsumer
that will call methods onCreateDeploymentStrategyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateDeploymentStrategy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException There was an internal failure in the AppConfig service.
- ServiceQuotaExceededException The number of one more AppConfig resources exceeds the maximum allowed.
Verify that your environment doesn't exceed the following service quotas:
Applications: 100 max
Deployment strategies: 20 max
Configuration profiles: 100 max per application
Environments: 20 max per application
To resolve this issue, you can delete one or more resources and try again. Or, you can request a quota increase. For more information about quotas and to request an increase, see Service quotas for AppConfig in the Amazon Web Services General Reference.
- BadRequestException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createEnvironment
default CompletableFuture<CreateEnvironmentResponse> 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
orProduction
environment. You can also define environments for application subcomponents such as theWeb
,Mobile
andBack-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:
- A Java Future containing the result of the CreateEnvironment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException There was an internal failure in the AppConfig service.
- ResourceNotFoundException The requested resource could not be found.
- BadRequestException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ServiceQuotaExceededException The number of one more AppConfig resources exceeds the maximum allowed.
Verify that your environment doesn't exceed the following service quotas:
Applications: 100 max
Deployment strategies: 20 max
Configuration profiles: 100 max per application
Environments: 20 max per application
To resolve this issue, you can delete one or more resources and try again. Or, you can request a quota increase. For more information about quotas and to request an increase, see Service quotas for AppConfig in the Amazon Web Services General Reference.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createEnvironment
default CompletableFuture<CreateEnvironmentResponse> createEnvironment(Consumer<CreateEnvironmentRequest.Builder> 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
orProduction
environment. You can also define environments for application subcomponents such as theWeb
,Mobile
andBack-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.
This is a convenience which creates an instance of the
CreateEnvironmentRequest.Builder
avoiding the need to create one manually viaCreateEnvironmentRequest.builder()
- Parameters:
createEnvironmentRequest
- AConsumer
that will call methods onCreateEnvironmentRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateEnvironment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException There was an internal failure in the AppConfig service.
- ResourceNotFoundException The requested resource could not be found.
- BadRequestException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ServiceQuotaExceededException The number of one more AppConfig resources exceeds the maximum allowed.
Verify that your environment doesn't exceed the following service quotas:
Applications: 100 max
Deployment strategies: 20 max
Configuration profiles: 100 max per application
Environments: 20 max per application
To resolve this issue, you can delete one or more resources and try again. Or, you can request a quota increase. For more information about quotas and to request an increase, see Service quotas for AppConfig in the Amazon Web Services General Reference.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createExtension
default CompletableFuture<CreateExtensionResponse> createExtension(CreateExtensionRequest createExtensionRequest) Creates an AppConfig extension. An extension augments your ability to inject logic or behavior at different points during the AppConfig workflow of creating or deploying a configuration.
You can create your own extensions or use the Amazon Web Services authored extensions provided by AppConfig. For an AppConfig extension that uses Lambda, you must create a Lambda function to perform any computation and processing defined in the extension. If you plan to create custom versions of the Amazon Web Services authored notification extensions, you only need to specify an Amazon Resource Name (ARN) in the
Uri
field for the new extension version.-
For a custom EventBridge notification extension, enter the ARN of the EventBridge default events in the
Uri
field. -
For a custom Amazon SNS notification extension, enter the ARN of an Amazon SNS topic in the
Uri
field. -
For a custom Amazon SQS notification extension, enter the ARN of an Amazon SQS message queue in the
Uri
field.
For more information about extensions, see Extending workflows in the AppConfig User Guide.
- Parameters:
createExtensionRequest
-- Returns:
- A Java Future containing the result of the CreateExtension operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- BadRequestException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- ServiceQuotaExceededException The number of one more AppConfig resources exceeds the maximum allowed.
Verify that your environment doesn't exceed the following service quotas:
Applications: 100 max
Deployment strategies: 20 max
Configuration profiles: 100 max per application
Environments: 20 max per application
To resolve this issue, you can delete one or more resources and try again. Or, you can request a quota increase. For more information about quotas and to request an increase, see Service quotas for AppConfig in the Amazon Web Services General Reference.
- InternalServerException There was an internal failure in the AppConfig service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
createExtension
default CompletableFuture<CreateExtensionResponse> createExtension(Consumer<CreateExtensionRequest.Builder> createExtensionRequest) Creates an AppConfig extension. An extension augments your ability to inject logic or behavior at different points during the AppConfig workflow of creating or deploying a configuration.
You can create your own extensions or use the Amazon Web Services authored extensions provided by AppConfig. For an AppConfig extension that uses Lambda, you must create a Lambda function to perform any computation and processing defined in the extension. If you plan to create custom versions of the Amazon Web Services authored notification extensions, you only need to specify an Amazon Resource Name (ARN) in the
Uri
field for the new extension version.-
For a custom EventBridge notification extension, enter the ARN of the EventBridge default events in the
Uri
field. -
For a custom Amazon SNS notification extension, enter the ARN of an Amazon SNS topic in the
Uri
field. -
For a custom Amazon SQS notification extension, enter the ARN of an Amazon SQS message queue in the
Uri
field.
For more information about extensions, see Extending workflows in the AppConfig User Guide.
This is a convenience which creates an instance of the
CreateExtensionRequest.Builder
avoiding the need to create one manually viaCreateExtensionRequest.builder()
- Parameters:
createExtensionRequest
- AConsumer
that will call methods onCreateExtensionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateExtension operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- BadRequestException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- ServiceQuotaExceededException The number of one more AppConfig resources exceeds the maximum allowed.
Verify that your environment doesn't exceed the following service quotas:
Applications: 100 max
Deployment strategies: 20 max
Configuration profiles: 100 max per application
Environments: 20 max per application
To resolve this issue, you can delete one or more resources and try again. Or, you can request a quota increase. For more information about quotas and to request an increase, see Service quotas for AppConfig in the Amazon Web Services General Reference.
- InternalServerException There was an internal failure in the AppConfig service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
createExtensionAssociation
default CompletableFuture<CreateExtensionAssociationResponse> createExtensionAssociation(CreateExtensionAssociationRequest createExtensionAssociationRequest) When you create an extension or configure an Amazon Web Services authored extension, you associate the extension with an AppConfig application, environment, or configuration profile. For example, you can choose to run the
AppConfig deployment events to Amazon SNS
Amazon Web Services authored extension and receive notifications on an Amazon SNS topic anytime a configuration deployment is started for a specific application. Defining which extension to associate with an AppConfig resource is called an extension association. An extension association is a specified relationship between an extension and an AppConfig resource, such as an application or a configuration profile. For more information about extensions and associations, see Extending workflows in the AppConfig User Guide.- Parameters:
createExtensionAssociationRequest
-- Returns:
- A Java Future containing the result of the CreateExtensionAssociation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- BadRequestException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ResourceNotFoundException The requested resource could not be found.
- InternalServerException There was an internal failure in the AppConfig service.
- ServiceQuotaExceededException The number of one more AppConfig resources exceeds the maximum allowed.
Verify that your environment doesn't exceed the following service quotas:
Applications: 100 max
Deployment strategies: 20 max
Configuration profiles: 100 max per application
Environments: 20 max per application
To resolve this issue, you can delete one or more resources and try again. Or, you can request a quota increase. For more information about quotas and to request an increase, see Service quotas for AppConfig in the Amazon Web Services General Reference.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createExtensionAssociation
default CompletableFuture<CreateExtensionAssociationResponse> createExtensionAssociation(Consumer<CreateExtensionAssociationRequest.Builder> createExtensionAssociationRequest) When you create an extension or configure an Amazon Web Services authored extension, you associate the extension with an AppConfig application, environment, or configuration profile. For example, you can choose to run the
AppConfig deployment events to Amazon SNS
Amazon Web Services authored extension and receive notifications on an Amazon SNS topic anytime a configuration deployment is started for a specific application. Defining which extension to associate with an AppConfig resource is called an extension association. An extension association is a specified relationship between an extension and an AppConfig resource, such as an application or a configuration profile. For more information about extensions and associations, see Extending workflows in the AppConfig User Guide.
This is a convenience which creates an instance of the
CreateExtensionAssociationRequest.Builder
avoiding the need to create one manually viaCreateExtensionAssociationRequest.builder()
- Parameters:
createExtensionAssociationRequest
- AConsumer
that will call methods onCreateExtensionAssociationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateExtensionAssociation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- BadRequestException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ResourceNotFoundException The requested resource could not be found.
- InternalServerException There was an internal failure in the AppConfig service.
- ServiceQuotaExceededException The number of one more AppConfig resources exceeds the maximum allowed.
Verify that your environment doesn't exceed the following service quotas:
Applications: 100 max
Deployment strategies: 20 max
Configuration profiles: 100 max per application
Environments: 20 max per application
To resolve this issue, you can delete one or more resources and try again. Or, you can request a quota increase. For more information about quotas and to request an increase, see Service quotas for AppConfig in the Amazon Web Services General Reference.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createHostedConfigurationVersion
default CompletableFuture<CreateHostedConfigurationVersionResponse> createHostedConfigurationVersion(CreateHostedConfigurationVersionRequest createHostedConfigurationVersionRequest) Creates a new configuration in the AppConfig hosted configuration store.
- Parameters:
createHostedConfigurationVersionRequest
-- Returns:
- A Java Future containing the result of the CreateHostedConfigurationVersion operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- BadRequestException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ServiceQuotaExceededException The number of one more AppConfig resources exceeds the maximum allowed.
Verify that your environment doesn't exceed the following service quotas:
Applications: 100 max
Deployment strategies: 20 max
Configuration profiles: 100 max per application
Environments: 20 max per application
To resolve this issue, you can delete one or more resources and try again. Or, you can request a quota increase. For more information about quotas and to request an increase, see Service quotas for AppConfig in the Amazon Web Services General Reference.
- ResourceNotFoundException The requested resource could not be found.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- PayloadTooLargeException The configuration size is too large.
- InternalServerException There was an internal failure in the AppConfig service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createHostedConfigurationVersion
default CompletableFuture<CreateHostedConfigurationVersionResponse> createHostedConfigurationVersion(Consumer<CreateHostedConfigurationVersionRequest.Builder> createHostedConfigurationVersionRequest) Creates a new configuration in the AppConfig hosted configuration store.
This is a convenience which creates an instance of the
CreateHostedConfigurationVersionRequest.Builder
avoiding the need to create one manually viaCreateHostedConfigurationVersionRequest.builder()
- Parameters:
createHostedConfigurationVersionRequest
- AConsumer
that will call methods onCreateHostedConfigurationVersionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateHostedConfigurationVersion operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- BadRequestException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ServiceQuotaExceededException The number of one more AppConfig resources exceeds the maximum allowed.
Verify that your environment doesn't exceed the following service quotas:
Applications: 100 max
Deployment strategies: 20 max
Configuration profiles: 100 max per application
Environments: 20 max per application
To resolve this issue, you can delete one or more resources and try again. Or, you can request a quota increase. For more information about quotas and to request an increase, see Service quotas for AppConfig in the Amazon Web Services General Reference.
- ResourceNotFoundException The requested resource could not be found.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- PayloadTooLargeException The configuration size is too large.
- InternalServerException There was an internal failure in the AppConfig service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteApplication
default CompletableFuture<DeleteApplicationResponse> deleteApplication(DeleteApplicationRequest deleteApplicationRequest) Deletes an application. Deleting an application does not delete a configuration from a host.
- Parameters:
deleteApplicationRequest
-- Returns:
- A Java Future containing the result of the DeleteApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteApplication
default CompletableFuture<DeleteApplicationResponse> deleteApplication(Consumer<DeleteApplicationRequest.Builder> deleteApplicationRequest) Deletes an application. Deleting an application does not delete a configuration from a host.
This is a convenience which creates an instance of the
DeleteApplicationRequest.Builder
avoiding the need to create one manually viaDeleteApplicationRequest.builder()
- Parameters:
deleteApplicationRequest
- AConsumer
that will call methods onDeleteApplicationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteConfigurationProfile
default CompletableFuture<DeleteConfigurationProfileResponse> deleteConfigurationProfile(DeleteConfigurationProfileRequest deleteConfigurationProfileRequest) Deletes a configuration profile. Deleting a configuration profile does not delete a configuration from a host.
- Parameters:
deleteConfigurationProfileRequest
-- Returns:
- A Java Future containing the result of the DeleteConfigurationProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteConfigurationProfile
default CompletableFuture<DeleteConfigurationProfileResponse> deleteConfigurationProfile(Consumer<DeleteConfigurationProfileRequest.Builder> deleteConfigurationProfileRequest) Deletes a configuration profile. Deleting a configuration profile does not delete a configuration from a host.
This is a convenience which creates an instance of the
DeleteConfigurationProfileRequest.Builder
avoiding the need to create one manually viaDeleteConfigurationProfileRequest.builder()
- Parameters:
deleteConfigurationProfileRequest
- AConsumer
that will call methods onDeleteConfigurationProfileRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteConfigurationProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDeploymentStrategy
default CompletableFuture<DeleteDeploymentStrategyResponse> deleteDeploymentStrategy(DeleteDeploymentStrategyRequest deleteDeploymentStrategyRequest) Deletes a deployment strategy. Deleting a deployment strategy does not delete a configuration from a host.
- Parameters:
deleteDeploymentStrategyRequest
-- Returns:
- A Java Future containing the result of the DeleteDeploymentStrategy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDeploymentStrategy
default CompletableFuture<DeleteDeploymentStrategyResponse> deleteDeploymentStrategy(Consumer<DeleteDeploymentStrategyRequest.Builder> deleteDeploymentStrategyRequest) Deletes a deployment strategy. Deleting a deployment strategy does not delete a configuration from a host.
This is a convenience which creates an instance of the
DeleteDeploymentStrategyRequest.Builder
avoiding the need to create one manually viaDeleteDeploymentStrategyRequest.builder()
- Parameters:
deleteDeploymentStrategyRequest
- AConsumer
that will call methods onDeleteDeploymentStrategyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteDeploymentStrategy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteEnvironment
default CompletableFuture<DeleteEnvironmentResponse> deleteEnvironment(DeleteEnvironmentRequest deleteEnvironmentRequest) Deletes an environment. Deleting an environment does not delete a configuration from a host.
- Parameters:
deleteEnvironmentRequest
-- Returns:
- A Java Future containing the result of the DeleteEnvironment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteEnvironment
default CompletableFuture<DeleteEnvironmentResponse> deleteEnvironment(Consumer<DeleteEnvironmentRequest.Builder> deleteEnvironmentRequest) Deletes an environment. Deleting an environment does not delete a configuration from a host.
This is a convenience which creates an instance of the
DeleteEnvironmentRequest.Builder
avoiding the need to create one manually viaDeleteEnvironmentRequest.builder()
- Parameters:
deleteEnvironmentRequest
- AConsumer
that will call methods onDeleteEnvironmentRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteEnvironment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteExtension
default CompletableFuture<DeleteExtensionResponse> deleteExtension(DeleteExtensionRequest deleteExtensionRequest) Deletes an AppConfig extension. You must delete all associations to an extension before you delete the extension.
- Parameters:
deleteExtensionRequest
-- Returns:
- A Java Future containing the result of the DeleteExtension operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteExtension
default CompletableFuture<DeleteExtensionResponse> deleteExtension(Consumer<DeleteExtensionRequest.Builder> deleteExtensionRequest) Deletes an AppConfig extension. You must delete all associations to an extension before you delete the extension.
This is a convenience which creates an instance of the
DeleteExtensionRequest.Builder
avoiding the need to create one manually viaDeleteExtensionRequest.builder()
- Parameters:
deleteExtensionRequest
- AConsumer
that will call methods onDeleteExtensionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteExtension operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteExtensionAssociation
default CompletableFuture<DeleteExtensionAssociationResponse> deleteExtensionAssociation(DeleteExtensionAssociationRequest deleteExtensionAssociationRequest) Deletes an extension association. This action doesn't delete extensions defined in the association.
- Parameters:
deleteExtensionAssociationRequest
-- Returns:
- A Java Future containing the result of the DeleteExtensionAssociation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteExtensionAssociation
default CompletableFuture<DeleteExtensionAssociationResponse> deleteExtensionAssociation(Consumer<DeleteExtensionAssociationRequest.Builder> deleteExtensionAssociationRequest) Deletes an extension association. This action doesn't delete extensions defined in the association.
This is a convenience which creates an instance of the
DeleteExtensionAssociationRequest.Builder
avoiding the need to create one manually viaDeleteExtensionAssociationRequest.builder()
- Parameters:
deleteExtensionAssociationRequest
- AConsumer
that will call methods onDeleteExtensionAssociationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteExtensionAssociation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteHostedConfigurationVersion
default CompletableFuture<DeleteHostedConfigurationVersionResponse> deleteHostedConfigurationVersion(DeleteHostedConfigurationVersionRequest deleteHostedConfigurationVersionRequest) Deletes a version of a configuration from the AppConfig hosted configuration store.
- Parameters:
deleteHostedConfigurationVersionRequest
-- Returns:
- A Java Future containing the result of the DeleteHostedConfigurationVersion operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteHostedConfigurationVersion
default CompletableFuture<DeleteHostedConfigurationVersionResponse> deleteHostedConfigurationVersion(Consumer<DeleteHostedConfigurationVersionRequest.Builder> deleteHostedConfigurationVersionRequest) Deletes a version of a configuration from the AppConfig hosted configuration store.
This is a convenience which creates an instance of the
DeleteHostedConfigurationVersionRequest.Builder
avoiding the need to create one manually viaDeleteHostedConfigurationVersionRequest.builder()
- Parameters:
deleteHostedConfigurationVersionRequest
- AConsumer
that will call methods onDeleteHostedConfigurationVersionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteHostedConfigurationVersion operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getApplication
default CompletableFuture<GetApplicationResponse> getApplication(GetApplicationRequest getApplicationRequest) Retrieves information about an application.
- Parameters:
getApplicationRequest
-- Returns:
- A Java Future containing the result of the GetApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getApplication
default CompletableFuture<GetApplicationResponse> getApplication(Consumer<GetApplicationRequest.Builder> getApplicationRequest) Retrieves information about an application.
This is a convenience which creates an instance of the
GetApplicationRequest.Builder
avoiding the need to create one manually viaGetApplicationRequest.builder()
- Parameters:
getApplicationRequest
- AConsumer
that will call methods onGetApplicationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getConfiguration
@Deprecated default CompletableFuture<GetConfigurationResponse> getConfiguration(GetConfigurationRequest getConfigurationRequest) Deprecated.This API has been deprecated in favor of the GetLatestConfiguration API used in conjunction with StartConfigurationSession.(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:
- A Java Future containing the result of the GetConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
getConfiguration
@Deprecated default CompletableFuture<GetConfigurationResponse> getConfiguration(Consumer<GetConfigurationRequest.Builder> getConfigurationRequest) Deprecated.This API has been deprecated in favor of the GetLatestConfiguration API used in conjunction with StartConfigurationSession.(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.
This is a convenience which creates an instance of the
GetConfigurationRequest.Builder
avoiding the need to create one manually viaGetConfigurationRequest.builder()
- Parameters:
getConfigurationRequest
- AConsumer
that will call methods onGetConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
getConfigurationProfile
default CompletableFuture<GetConfigurationProfileResponse> getConfigurationProfile(GetConfigurationProfileRequest getConfigurationProfileRequest) Retrieves information about a configuration profile.
- Parameters:
getConfigurationProfileRequest
-- Returns:
- A Java Future containing the result of the GetConfigurationProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getConfigurationProfile
default CompletableFuture<GetConfigurationProfileResponse> getConfigurationProfile(Consumer<GetConfigurationProfileRequest.Builder> getConfigurationProfileRequest) Retrieves information about a configuration profile.
This is a convenience which creates an instance of the
GetConfigurationProfileRequest.Builder
avoiding the need to create one manually viaGetConfigurationProfileRequest.builder()
- Parameters:
getConfigurationProfileRequest
- AConsumer
that will call methods onGetConfigurationProfileRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetConfigurationProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDeployment
default CompletableFuture<GetDeploymentResponse> getDeployment(GetDeploymentRequest getDeploymentRequest) Retrieves information about a configuration deployment.
- Parameters:
getDeploymentRequest
-- Returns:
- A Java Future containing the result of the GetDeployment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDeployment
default CompletableFuture<GetDeploymentResponse> getDeployment(Consumer<GetDeploymentRequest.Builder> getDeploymentRequest) Retrieves information about a configuration deployment.
This is a convenience which creates an instance of the
GetDeploymentRequest.Builder
avoiding the need to create one manually viaGetDeploymentRequest.builder()
- Parameters:
getDeploymentRequest
- AConsumer
that will call methods onGetDeploymentRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetDeployment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDeploymentStrategy
default CompletableFuture<GetDeploymentStrategyResponse> 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:
- A Java Future containing the result of the GetDeploymentStrategy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDeploymentStrategy
default CompletableFuture<GetDeploymentStrategyResponse> getDeploymentStrategy(Consumer<GetDeploymentStrategyRequest.Builder> 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.
This is a convenience which creates an instance of the
GetDeploymentStrategyRequest.Builder
avoiding the need to create one manually viaGetDeploymentStrategyRequest.builder()
- Parameters:
getDeploymentStrategyRequest
- AConsumer
that will call methods onGetDeploymentStrategyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetDeploymentStrategy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getEnvironment
default CompletableFuture<GetEnvironmentResponse> 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 anEU_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:
- A Java Future containing the result of the GetEnvironment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getEnvironment
default CompletableFuture<GetEnvironmentResponse> getEnvironment(Consumer<GetEnvironmentRequest.Builder> getEnvironmentRequest) Retrieves information about an environment. An environment is a deployment group of AppConfig applications, such as applications in a
Production
environment or in anEU_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.
This is a convenience which creates an instance of the
GetEnvironmentRequest.Builder
avoiding the need to create one manually viaGetEnvironmentRequest.builder()
- Parameters:
getEnvironmentRequest
- AConsumer
that will call methods onGetEnvironmentRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetEnvironment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getExtension
default CompletableFuture<GetExtensionResponse> getExtension(GetExtensionRequest getExtensionRequest) Returns information about an AppConfig extension.
- Parameters:
getExtensionRequest
-- Returns:
- A Java Future containing the result of the GetExtension operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getExtension
default CompletableFuture<GetExtensionResponse> getExtension(Consumer<GetExtensionRequest.Builder> getExtensionRequest) Returns information about an AppConfig extension.
This is a convenience which creates an instance of the
GetExtensionRequest.Builder
avoiding the need to create one manually viaGetExtensionRequest.builder()
- Parameters:
getExtensionRequest
- AConsumer
that will call methods onGetExtensionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetExtension operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getExtensionAssociation
default CompletableFuture<GetExtensionAssociationResponse> getExtensionAssociation(GetExtensionAssociationRequest getExtensionAssociationRequest) Returns information about an AppConfig extension association. For more information about extensions and associations, see Extending workflows in the AppConfig User Guide.
- Parameters:
getExtensionAssociationRequest
-- Returns:
- A Java Future containing the result of the GetExtensionAssociation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getExtensionAssociation
default CompletableFuture<GetExtensionAssociationResponse> getExtensionAssociation(Consumer<GetExtensionAssociationRequest.Builder> getExtensionAssociationRequest) Returns information about an AppConfig extension association. For more information about extensions and associations, see Extending workflows in the AppConfig User Guide.
This is a convenience which creates an instance of the
GetExtensionAssociationRequest.Builder
avoiding the need to create one manually viaGetExtensionAssociationRequest.builder()
- Parameters:
getExtensionAssociationRequest
- AConsumer
that will call methods onGetExtensionAssociationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetExtensionAssociation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getHostedConfigurationVersion
default CompletableFuture<GetHostedConfigurationVersionResponse> getHostedConfigurationVersion(GetHostedConfigurationVersionRequest getHostedConfigurationVersionRequest) Retrieves information about a specific configuration version.
- Parameters:
getHostedConfigurationVersionRequest
-- Returns:
- A Java Future containing the result of the GetHostedConfigurationVersion operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getHostedConfigurationVersion
default CompletableFuture<GetHostedConfigurationVersionResponse> getHostedConfigurationVersion(Consumer<GetHostedConfigurationVersionRequest.Builder> getHostedConfigurationVersionRequest) Retrieves information about a specific configuration version.
This is a convenience which creates an instance of the
GetHostedConfigurationVersionRequest.Builder
avoiding the need to create one manually viaGetHostedConfigurationVersionRequest.builder()
- Parameters:
getHostedConfigurationVersionRequest
- AConsumer
that will call methods onGetHostedConfigurationVersionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetHostedConfigurationVersion operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listApplications
default CompletableFuture<ListApplicationsResponse> listApplications(ListApplicationsRequest listApplicationsRequest) Lists all applications in your Amazon Web Services account.
- Parameters:
listApplicationsRequest
-- Returns:
- A Java Future containing the result of the ListApplications operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listApplications
default CompletableFuture<ListApplicationsResponse> listApplications(Consumer<ListApplicationsRequest.Builder> listApplicationsRequest) Lists all applications in your Amazon Web Services account.
This is a convenience which creates an instance of the
ListApplicationsRequest.Builder
avoiding the need to create one manually viaListApplicationsRequest.builder()
- Parameters:
listApplicationsRequest
- AConsumer
that will call methods onListApplicationsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListApplications operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listApplicationsPaginator
default ListApplicationsPublisher listApplicationsPaginator(ListApplicationsRequest listApplicationsRequest) This is a variant of
listApplications(software.amazon.awssdk.services.appconfig.model.ListApplicationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.appconfig.paginators.ListApplicationsPublisher publisher = client.listApplicationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.appconfig.paginators.ListApplicationsPublisher publisher = client.listApplicationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.appconfig.model.ListApplicationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.appconfig.model.ListApplicationsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listApplications(software.amazon.awssdk.services.appconfig.model.ListApplicationsRequest)
operation.- Parameters:
listApplicationsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listApplicationsPaginator
default ListApplicationsPublisher listApplicationsPaginator(Consumer<ListApplicationsRequest.Builder> listApplicationsRequest) This is a variant of
listApplications(software.amazon.awssdk.services.appconfig.model.ListApplicationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.appconfig.paginators.ListApplicationsPublisher publisher = client.listApplicationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.appconfig.paginators.ListApplicationsPublisher publisher = client.listApplicationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.appconfig.model.ListApplicationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.appconfig.model.ListApplicationsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listApplications(software.amazon.awssdk.services.appconfig.model.ListApplicationsRequest)
operation.
This is a convenience which creates an instance of the
ListApplicationsRequest.Builder
avoiding the need to create one manually viaListApplicationsRequest.builder()
- Parameters:
listApplicationsRequest
- AConsumer
that will call methods onListApplicationsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listConfigurationProfiles
default CompletableFuture<ListConfigurationProfilesResponse> listConfigurationProfiles(ListConfigurationProfilesRequest listConfigurationProfilesRequest) Lists the configuration profiles for an application.
- Parameters:
listConfigurationProfilesRequest
-- Returns:
- A Java Future containing the result of the ListConfigurationProfiles operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listConfigurationProfiles
default CompletableFuture<ListConfigurationProfilesResponse> listConfigurationProfiles(Consumer<ListConfigurationProfilesRequest.Builder> listConfigurationProfilesRequest) Lists the configuration profiles for an application.
This is a convenience which creates an instance of the
ListConfigurationProfilesRequest.Builder
avoiding the need to create one manually viaListConfigurationProfilesRequest.builder()
- Parameters:
listConfigurationProfilesRequest
- AConsumer
that will call methods onListConfigurationProfilesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListConfigurationProfiles operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listConfigurationProfilesPaginator
default ListConfigurationProfilesPublisher listConfigurationProfilesPaginator(ListConfigurationProfilesRequest listConfigurationProfilesRequest) This is a variant of
listConfigurationProfiles(software.amazon.awssdk.services.appconfig.model.ListConfigurationProfilesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.appconfig.paginators.ListConfigurationProfilesPublisher publisher = client.listConfigurationProfilesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.appconfig.paginators.ListConfigurationProfilesPublisher publisher = client.listConfigurationProfilesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.appconfig.model.ListConfigurationProfilesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.appconfig.model.ListConfigurationProfilesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listConfigurationProfiles(software.amazon.awssdk.services.appconfig.model.ListConfigurationProfilesRequest)
operation.- Parameters:
listConfigurationProfilesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listConfigurationProfilesPaginator
default ListConfigurationProfilesPublisher listConfigurationProfilesPaginator(Consumer<ListConfigurationProfilesRequest.Builder> listConfigurationProfilesRequest) This is a variant of
listConfigurationProfiles(software.amazon.awssdk.services.appconfig.model.ListConfigurationProfilesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.appconfig.paginators.ListConfigurationProfilesPublisher publisher = client.listConfigurationProfilesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.appconfig.paginators.ListConfigurationProfilesPublisher publisher = client.listConfigurationProfilesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.appconfig.model.ListConfigurationProfilesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.appconfig.model.ListConfigurationProfilesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listConfigurationProfiles(software.amazon.awssdk.services.appconfig.model.ListConfigurationProfilesRequest)
operation.
This is a convenience which creates an instance of the
ListConfigurationProfilesRequest.Builder
avoiding the need to create one manually viaListConfigurationProfilesRequest.builder()
- Parameters:
listConfigurationProfilesRequest
- AConsumer
that will call methods onListConfigurationProfilesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDeploymentStrategies
default CompletableFuture<ListDeploymentStrategiesResponse> listDeploymentStrategies(ListDeploymentStrategiesRequest listDeploymentStrategiesRequest) Lists deployment strategies.
- Parameters:
listDeploymentStrategiesRequest
-- Returns:
- A Java Future containing the result of the ListDeploymentStrategies operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDeploymentStrategies
default CompletableFuture<ListDeploymentStrategiesResponse> listDeploymentStrategies(Consumer<ListDeploymentStrategiesRequest.Builder> listDeploymentStrategiesRequest) Lists deployment strategies.
This is a convenience which creates an instance of the
ListDeploymentStrategiesRequest.Builder
avoiding the need to create one manually viaListDeploymentStrategiesRequest.builder()
- Parameters:
listDeploymentStrategiesRequest
- AConsumer
that will call methods onListDeploymentStrategiesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListDeploymentStrategies operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDeploymentStrategiesPaginator
default ListDeploymentStrategiesPublisher listDeploymentStrategiesPaginator(ListDeploymentStrategiesRequest listDeploymentStrategiesRequest) This is a variant of
listDeploymentStrategies(software.amazon.awssdk.services.appconfig.model.ListDeploymentStrategiesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.appconfig.paginators.ListDeploymentStrategiesPublisher publisher = client.listDeploymentStrategiesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.appconfig.paginators.ListDeploymentStrategiesPublisher publisher = client.listDeploymentStrategiesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.appconfig.model.ListDeploymentStrategiesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.appconfig.model.ListDeploymentStrategiesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDeploymentStrategies(software.amazon.awssdk.services.appconfig.model.ListDeploymentStrategiesRequest)
operation.- Parameters:
listDeploymentStrategiesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDeploymentStrategiesPaginator
default ListDeploymentStrategiesPublisher listDeploymentStrategiesPaginator(Consumer<ListDeploymentStrategiesRequest.Builder> listDeploymentStrategiesRequest) This is a variant of
listDeploymentStrategies(software.amazon.awssdk.services.appconfig.model.ListDeploymentStrategiesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.appconfig.paginators.ListDeploymentStrategiesPublisher publisher = client.listDeploymentStrategiesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.appconfig.paginators.ListDeploymentStrategiesPublisher publisher = client.listDeploymentStrategiesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.appconfig.model.ListDeploymentStrategiesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.appconfig.model.ListDeploymentStrategiesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDeploymentStrategies(software.amazon.awssdk.services.appconfig.model.ListDeploymentStrategiesRequest)
operation.
This is a convenience which creates an instance of the
ListDeploymentStrategiesRequest.Builder
avoiding the need to create one manually viaListDeploymentStrategiesRequest.builder()
- Parameters:
listDeploymentStrategiesRequest
- AConsumer
that will call methods onListDeploymentStrategiesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDeployments
default CompletableFuture<ListDeploymentsResponse> listDeployments(ListDeploymentsRequest listDeploymentsRequest) Lists the deployments for an environment in descending deployment number order.
- Parameters:
listDeploymentsRequest
-- Returns:
- A Java Future containing the result of the ListDeployments operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDeployments
default CompletableFuture<ListDeploymentsResponse> listDeployments(Consumer<ListDeploymentsRequest.Builder> listDeploymentsRequest) Lists the deployments for an environment in descending deployment number order.
This is a convenience which creates an instance of the
ListDeploymentsRequest.Builder
avoiding the need to create one manually viaListDeploymentsRequest.builder()
- Parameters:
listDeploymentsRequest
- AConsumer
that will call methods onListDeploymentsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListDeployments operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDeploymentsPaginator
default ListDeploymentsPublisher listDeploymentsPaginator(ListDeploymentsRequest listDeploymentsRequest) This is a variant of
listDeployments(software.amazon.awssdk.services.appconfig.model.ListDeploymentsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.appconfig.paginators.ListDeploymentsPublisher publisher = client.listDeploymentsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.appconfig.paginators.ListDeploymentsPublisher publisher = client.listDeploymentsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.appconfig.model.ListDeploymentsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.appconfig.model.ListDeploymentsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDeployments(software.amazon.awssdk.services.appconfig.model.ListDeploymentsRequest)
operation.- Parameters:
listDeploymentsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDeploymentsPaginator
default ListDeploymentsPublisher listDeploymentsPaginator(Consumer<ListDeploymentsRequest.Builder> listDeploymentsRequest) This is a variant of
listDeployments(software.amazon.awssdk.services.appconfig.model.ListDeploymentsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.appconfig.paginators.ListDeploymentsPublisher publisher = client.listDeploymentsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.appconfig.paginators.ListDeploymentsPublisher publisher = client.listDeploymentsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.appconfig.model.ListDeploymentsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.appconfig.model.ListDeploymentsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDeployments(software.amazon.awssdk.services.appconfig.model.ListDeploymentsRequest)
operation.
This is a convenience which creates an instance of the
ListDeploymentsRequest.Builder
avoiding the need to create one manually viaListDeploymentsRequest.builder()
- Parameters:
listDeploymentsRequest
- AConsumer
that will call methods onListDeploymentsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listEnvironments
default CompletableFuture<ListEnvironmentsResponse> listEnvironments(ListEnvironmentsRequest listEnvironmentsRequest) Lists the environments for an application.
- Parameters:
listEnvironmentsRequest
-- Returns:
- A Java Future containing the result of the ListEnvironments operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listEnvironments
default CompletableFuture<ListEnvironmentsResponse> listEnvironments(Consumer<ListEnvironmentsRequest.Builder> listEnvironmentsRequest) Lists the environments for an application.
This is a convenience which creates an instance of the
ListEnvironmentsRequest.Builder
avoiding the need to create one manually viaListEnvironmentsRequest.builder()
- Parameters:
listEnvironmentsRequest
- AConsumer
that will call methods onListEnvironmentsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListEnvironments operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listEnvironmentsPaginator
default ListEnvironmentsPublisher listEnvironmentsPaginator(ListEnvironmentsRequest listEnvironmentsRequest) This is a variant of
listEnvironments(software.amazon.awssdk.services.appconfig.model.ListEnvironmentsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.appconfig.paginators.ListEnvironmentsPublisher publisher = client.listEnvironmentsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.appconfig.paginators.ListEnvironmentsPublisher publisher = client.listEnvironmentsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.appconfig.model.ListEnvironmentsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.appconfig.model.ListEnvironmentsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listEnvironments(software.amazon.awssdk.services.appconfig.model.ListEnvironmentsRequest)
operation.- Parameters:
listEnvironmentsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listEnvironmentsPaginator
default ListEnvironmentsPublisher listEnvironmentsPaginator(Consumer<ListEnvironmentsRequest.Builder> listEnvironmentsRequest) This is a variant of
listEnvironments(software.amazon.awssdk.services.appconfig.model.ListEnvironmentsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.appconfig.paginators.ListEnvironmentsPublisher publisher = client.listEnvironmentsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.appconfig.paginators.ListEnvironmentsPublisher publisher = client.listEnvironmentsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.appconfig.model.ListEnvironmentsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.appconfig.model.ListEnvironmentsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listEnvironments(software.amazon.awssdk.services.appconfig.model.ListEnvironmentsRequest)
operation.
This is a convenience which creates an instance of the
ListEnvironmentsRequest.Builder
avoiding the need to create one manually viaListEnvironmentsRequest.builder()
- Parameters:
listEnvironmentsRequest
- AConsumer
that will call methods onListEnvironmentsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listExtensionAssociations
default CompletableFuture<ListExtensionAssociationsResponse> listExtensionAssociations(ListExtensionAssociationsRequest listExtensionAssociationsRequest) Lists all AppConfig extension associations in the account. For more information about extensions and associations, see Extending workflows in the AppConfig User Guide.
- Parameters:
listExtensionAssociationsRequest
-- Returns:
- A Java Future containing the result of the ListExtensionAssociations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listExtensionAssociations
default CompletableFuture<ListExtensionAssociationsResponse> listExtensionAssociations(Consumer<ListExtensionAssociationsRequest.Builder> listExtensionAssociationsRequest) Lists all AppConfig extension associations in the account. For more information about extensions and associations, see Extending workflows in the AppConfig User Guide.
This is a convenience which creates an instance of the
ListExtensionAssociationsRequest.Builder
avoiding the need to create one manually viaListExtensionAssociationsRequest.builder()
- Parameters:
listExtensionAssociationsRequest
- AConsumer
that will call methods onListExtensionAssociationsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListExtensionAssociations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listExtensionAssociationsPaginator
default ListExtensionAssociationsPublisher listExtensionAssociationsPaginator(ListExtensionAssociationsRequest listExtensionAssociationsRequest) This is a variant of
listExtensionAssociations(software.amazon.awssdk.services.appconfig.model.ListExtensionAssociationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.appconfig.paginators.ListExtensionAssociationsPublisher publisher = client.listExtensionAssociationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.appconfig.paginators.ListExtensionAssociationsPublisher publisher = client.listExtensionAssociationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.appconfig.model.ListExtensionAssociationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.appconfig.model.ListExtensionAssociationsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listExtensionAssociations(software.amazon.awssdk.services.appconfig.model.ListExtensionAssociationsRequest)
operation.- Parameters:
listExtensionAssociationsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listExtensionAssociationsPaginator
default ListExtensionAssociationsPublisher listExtensionAssociationsPaginator(Consumer<ListExtensionAssociationsRequest.Builder> listExtensionAssociationsRequest) This is a variant of
listExtensionAssociations(software.amazon.awssdk.services.appconfig.model.ListExtensionAssociationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.appconfig.paginators.ListExtensionAssociationsPublisher publisher = client.listExtensionAssociationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.appconfig.paginators.ListExtensionAssociationsPublisher publisher = client.listExtensionAssociationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.appconfig.model.ListExtensionAssociationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.appconfig.model.ListExtensionAssociationsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listExtensionAssociations(software.amazon.awssdk.services.appconfig.model.ListExtensionAssociationsRequest)
operation.
This is a convenience which creates an instance of the
ListExtensionAssociationsRequest.Builder
avoiding the need to create one manually viaListExtensionAssociationsRequest.builder()
- Parameters:
listExtensionAssociationsRequest
- AConsumer
that will call methods onListExtensionAssociationsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listExtensions
default CompletableFuture<ListExtensionsResponse> listExtensions(ListExtensionsRequest listExtensionsRequest) Lists all custom and Amazon Web Services authored AppConfig extensions in the account. For more information about extensions, see Extending workflows in the AppConfig User Guide.
- Parameters:
listExtensionsRequest
-- Returns:
- A Java Future containing the result of the ListExtensions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listExtensions
default CompletableFuture<ListExtensionsResponse> listExtensions(Consumer<ListExtensionsRequest.Builder> listExtensionsRequest) Lists all custom and Amazon Web Services authored AppConfig extensions in the account. For more information about extensions, see Extending workflows in the AppConfig User Guide.
This is a convenience which creates an instance of the
ListExtensionsRequest.Builder
avoiding the need to create one manually viaListExtensionsRequest.builder()
- Parameters:
listExtensionsRequest
- AConsumer
that will call methods onListExtensionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListExtensions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listExtensionsPaginator
default ListExtensionsPublisher listExtensionsPaginator(ListExtensionsRequest listExtensionsRequest) This is a variant of
listExtensions(software.amazon.awssdk.services.appconfig.model.ListExtensionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.appconfig.paginators.ListExtensionsPublisher publisher = client.listExtensionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.appconfig.paginators.ListExtensionsPublisher publisher = client.listExtensionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.appconfig.model.ListExtensionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.appconfig.model.ListExtensionsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listExtensions(software.amazon.awssdk.services.appconfig.model.ListExtensionsRequest)
operation.- Parameters:
listExtensionsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listExtensionsPaginator
default ListExtensionsPublisher listExtensionsPaginator(Consumer<ListExtensionsRequest.Builder> listExtensionsRequest) This is a variant of
listExtensions(software.amazon.awssdk.services.appconfig.model.ListExtensionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.appconfig.paginators.ListExtensionsPublisher publisher = client.listExtensionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.appconfig.paginators.ListExtensionsPublisher publisher = client.listExtensionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.appconfig.model.ListExtensionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.appconfig.model.ListExtensionsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listExtensions(software.amazon.awssdk.services.appconfig.model.ListExtensionsRequest)
operation.
This is a convenience which creates an instance of the
ListExtensionsRequest.Builder
avoiding the need to create one manually viaListExtensionsRequest.builder()
- Parameters:
listExtensionsRequest
- AConsumer
that will call methods onListExtensionsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listHostedConfigurationVersions
default CompletableFuture<ListHostedConfigurationVersionsResponse> listHostedConfigurationVersions(ListHostedConfigurationVersionsRequest listHostedConfigurationVersionsRequest) Lists configurations stored in the AppConfig hosted configuration store by version.
- Parameters:
listHostedConfigurationVersionsRequest
-- Returns:
- A Java Future containing the result of the ListHostedConfigurationVersions operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listHostedConfigurationVersions
default CompletableFuture<ListHostedConfigurationVersionsResponse> listHostedConfigurationVersions(Consumer<ListHostedConfigurationVersionsRequest.Builder> listHostedConfigurationVersionsRequest) Lists configurations stored in the AppConfig hosted configuration store by version.
This is a convenience which creates an instance of the
ListHostedConfigurationVersionsRequest.Builder
avoiding the need to create one manually viaListHostedConfigurationVersionsRequest.builder()
- Parameters:
listHostedConfigurationVersionsRequest
- AConsumer
that will call methods onListHostedConfigurationVersionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListHostedConfigurationVersions operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listHostedConfigurationVersionsPaginator
default ListHostedConfigurationVersionsPublisher listHostedConfigurationVersionsPaginator(ListHostedConfigurationVersionsRequest listHostedConfigurationVersionsRequest) This is a variant of
listHostedConfigurationVersions(software.amazon.awssdk.services.appconfig.model.ListHostedConfigurationVersionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.appconfig.paginators.ListHostedConfigurationVersionsPublisher publisher = client.listHostedConfigurationVersionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.appconfig.paginators.ListHostedConfigurationVersionsPublisher publisher = client.listHostedConfigurationVersionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.appconfig.model.ListHostedConfigurationVersionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.appconfig.model.ListHostedConfigurationVersionsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listHostedConfigurationVersions(software.amazon.awssdk.services.appconfig.model.ListHostedConfigurationVersionsRequest)
operation.- Parameters:
listHostedConfigurationVersionsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listHostedConfigurationVersionsPaginator
default ListHostedConfigurationVersionsPublisher listHostedConfigurationVersionsPaginator(Consumer<ListHostedConfigurationVersionsRequest.Builder> listHostedConfigurationVersionsRequest) This is a variant of
listHostedConfigurationVersions(software.amazon.awssdk.services.appconfig.model.ListHostedConfigurationVersionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.appconfig.paginators.ListHostedConfigurationVersionsPublisher publisher = client.listHostedConfigurationVersionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.appconfig.paginators.ListHostedConfigurationVersionsPublisher publisher = client.listHostedConfigurationVersionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.appconfig.model.ListHostedConfigurationVersionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.appconfig.model.ListHostedConfigurationVersionsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listHostedConfigurationVersions(software.amazon.awssdk.services.appconfig.model.ListHostedConfigurationVersionsRequest)
operation.
This is a convenience which creates an instance of the
ListHostedConfigurationVersionsRequest.Builder
avoiding the need to create one manually viaListHostedConfigurationVersionsRequest.builder()
- Parameters:
listHostedConfigurationVersionsRequest
- AConsumer
that will call methods onListHostedConfigurationVersionsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Retrieves the list of key-value tags assigned to the resource.
- Parameters:
listTagsForResourceRequest
-- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Retrieves the list of key-value tags assigned to the resource.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startDeployment
default CompletableFuture<StartDeploymentResponse> startDeployment(StartDeploymentRequest startDeploymentRequest) Starts a deployment.
- Parameters:
startDeploymentRequest
-- Returns:
- A Java Future containing the result of the StartDeployment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startDeployment
default CompletableFuture<StartDeploymentResponse> startDeployment(Consumer<StartDeploymentRequest.Builder> startDeploymentRequest) Starts a deployment.
This is a convenience which creates an instance of the
StartDeploymentRequest.Builder
avoiding the need to create one manually viaStartDeploymentRequest.builder()
- Parameters:
startDeploymentRequest
- AConsumer
that will call methods onStartDeploymentRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StartDeployment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopDeployment
default CompletableFuture<StopDeploymentResponse> 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 ofROLLED_BACK
.- Parameters:
stopDeploymentRequest
-- Returns:
- A Java Future containing the result of the StopDeployment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopDeployment
default CompletableFuture<StopDeploymentResponse> stopDeployment(Consumer<StopDeploymentRequest.Builder> 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 ofROLLED_BACK
.
This is a convenience which creates an instance of the
StopDeploymentRequest.Builder
avoiding the need to create one manually viaStopDeploymentRequest.builder()
- Parameters:
stopDeploymentRequest
- AConsumer
that will call methods onStopDeploymentRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StopDeployment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
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:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> 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.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Deletes a tag key and value from an AppConfig resource.
- Parameters:
untagResourceRequest
-- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Deletes a tag key and value from an AppConfig resource.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateApplication
default CompletableFuture<UpdateApplicationResponse> updateApplication(UpdateApplicationRequest updateApplicationRequest) Updates an application.
- Parameters:
updateApplicationRequest
-- Returns:
- A Java Future containing the result of the UpdateApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateApplication
default CompletableFuture<UpdateApplicationResponse> updateApplication(Consumer<UpdateApplicationRequest.Builder> updateApplicationRequest) Updates an application.
This is a convenience which creates an instance of the
UpdateApplicationRequest.Builder
avoiding the need to create one manually viaUpdateApplicationRequest.builder()
- Parameters:
updateApplicationRequest
- AConsumer
that will call methods onUpdateApplicationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateConfigurationProfile
default CompletableFuture<UpdateConfigurationProfileResponse> updateConfigurationProfile(UpdateConfigurationProfileRequest updateConfigurationProfileRequest) Updates a configuration profile.
- Parameters:
updateConfigurationProfileRequest
-- Returns:
- A Java Future containing the result of the UpdateConfigurationProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateConfigurationProfile
default CompletableFuture<UpdateConfigurationProfileResponse> updateConfigurationProfile(Consumer<UpdateConfigurationProfileRequest.Builder> updateConfigurationProfileRequest) Updates a configuration profile.
This is a convenience which creates an instance of the
UpdateConfigurationProfileRequest.Builder
avoiding the need to create one manually viaUpdateConfigurationProfileRequest.builder()
- Parameters:
updateConfigurationProfileRequest
- AConsumer
that will call methods onUpdateConfigurationProfileRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateConfigurationProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateDeploymentStrategy
default CompletableFuture<UpdateDeploymentStrategyResponse> updateDeploymentStrategy(UpdateDeploymentStrategyRequest updateDeploymentStrategyRequest) Updates a deployment strategy.
- Parameters:
updateDeploymentStrategyRequest
-- Returns:
- A Java Future containing the result of the UpdateDeploymentStrategy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateDeploymentStrategy
default CompletableFuture<UpdateDeploymentStrategyResponse> updateDeploymentStrategy(Consumer<UpdateDeploymentStrategyRequest.Builder> updateDeploymentStrategyRequest) Updates a deployment strategy.
This is a convenience which creates an instance of the
UpdateDeploymentStrategyRequest.Builder
avoiding the need to create one manually viaUpdateDeploymentStrategyRequest.builder()
- Parameters:
updateDeploymentStrategyRequest
- AConsumer
that will call methods onUpdateDeploymentStrategyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateDeploymentStrategy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateEnvironment
default CompletableFuture<UpdateEnvironmentResponse> updateEnvironment(UpdateEnvironmentRequest updateEnvironmentRequest) Updates an environment.
- Parameters:
updateEnvironmentRequest
-- Returns:
- A Java Future containing the result of the UpdateEnvironment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateEnvironment
default CompletableFuture<UpdateEnvironmentResponse> updateEnvironment(Consumer<UpdateEnvironmentRequest.Builder> updateEnvironmentRequest) Updates an environment.
This is a convenience which creates an instance of the
UpdateEnvironmentRequest.Builder
avoiding the need to create one manually viaUpdateEnvironmentRequest.builder()
- Parameters:
updateEnvironmentRequest
- AConsumer
that will call methods onUpdateEnvironmentRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateEnvironment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateExtension
default CompletableFuture<UpdateExtensionResponse> updateExtension(UpdateExtensionRequest updateExtensionRequest) Updates an AppConfig extension. For more information about extensions, see Extending workflows in the AppConfig User Guide.
- Parameters:
updateExtensionRequest
-- Returns:
- A Java Future containing the result of the UpdateExtension operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateExtension
default CompletableFuture<UpdateExtensionResponse> updateExtension(Consumer<UpdateExtensionRequest.Builder> updateExtensionRequest) Updates an AppConfig extension. For more information about extensions, see Extending workflows in the AppConfig User Guide.
This is a convenience which creates an instance of the
UpdateExtensionRequest.Builder
avoiding the need to create one manually viaUpdateExtensionRequest.builder()
- Parameters:
updateExtensionRequest
- AConsumer
that will call methods onUpdateExtensionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateExtension operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateExtensionAssociation
default CompletableFuture<UpdateExtensionAssociationResponse> updateExtensionAssociation(UpdateExtensionAssociationRequest updateExtensionAssociationRequest) Updates an association. For more information about extensions and associations, see Extending workflows in the AppConfig User Guide.
- Parameters:
updateExtensionAssociationRequest
-- Returns:
- A Java Future containing the result of the UpdateExtensionAssociation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateExtensionAssociation
default CompletableFuture<UpdateExtensionAssociationResponse> updateExtensionAssociation(Consumer<UpdateExtensionAssociationRequest.Builder> updateExtensionAssociationRequest) Updates an association. For more information about extensions and associations, see Extending workflows in the AppConfig User Guide.
This is a convenience which creates an instance of the
UpdateExtensionAssociationRequest.Builder
avoiding the need to create one manually viaUpdateExtensionAssociationRequest.builder()
- Parameters:
updateExtensionAssociationRequest
- AConsumer
that will call methods onUpdateExtensionAssociationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateExtensionAssociation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
validateConfiguration
default CompletableFuture<ValidateConfigurationResponse> validateConfiguration(ValidateConfigurationRequest validateConfigurationRequest) Uses the validators in a configuration profile to validate a configuration.
- Parameters:
validateConfigurationRequest
-- Returns:
- A Java Future containing the result of the ValidateConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
validateConfiguration
default CompletableFuture<ValidateConfigurationResponse> validateConfiguration(Consumer<ValidateConfigurationRequest.Builder> validateConfigurationRequest) Uses the validators in a configuration profile to validate a configuration.
This is a convenience which creates an instance of the
ValidateConfigurationRequest.Builder
avoiding the need to create one manually viaValidateConfigurationRequest.builder()
- Parameters:
validateConfigurationRequest
- AConsumer
that will call methods onValidateConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ValidateConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AppConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aAppConfigAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aAppConfigAsyncClient
.
-