AppConfigClient

public class AppConfigClient 

Inheritance

AppConfigClientProtocol

Initializers

init(config:)

public init(config: AWSClientRuntime.AWSClientConfiguration) 

init(region:)

public convenience init(region: Swift.String? = nil) throws 

Properties

clientName

public static let clientName = "AppConfigClient"

Methods

createApplication(input:completion:)

An application in AppConfig is a logical unit of code that provides capabilities for your customers. For example, an application can be a microservice that runs on Amazon EC2 instances, a mobile application installed by your users, a serverless application using Amazon API Gateway and AWS Lambda, or any system you run on behalf of others.

public func createApplication(input: CreateApplicationInput, completion: @escaping (ClientRuntime.SdkResult<CreateApplicationOutputResponse, CreateApplicationOutputError>) -> Void)

createConfigurationProfile(input:completion:)

Information that enables AppConfig to access the configuration source. Valid configuration sources include Systems Manager (SSM) documents, SSM Parameter Store parameters, and Amazon S3 objects. A configuration profile includes the following information.

public func createConfigurationProfile(input: CreateConfigurationProfileInput, completion: @escaping (ClientRuntime.SdkResult<CreateConfigurationProfileOutputResponse, CreateConfigurationProfileOutputError>) -> Void)

• The Uri location of the configuration data.

• The AWS 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 AWS Lambda function.

For more information, see Create a Configuration and a Configuration Profile in the AWS AppConfig User Guide.

createDeploymentStrategy(input:completion:)

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.

public func createDeploymentStrategy(input: CreateDeploymentStrategyInput, completion: @escaping (ClientRuntime.SdkResult<CreateDeploymentStrategyOutputResponse, CreateDeploymentStrategyOutputError>) -> Void)

createEnvironment(input:completion:)

For each application, you define one or more environments. An environment is a logical deployment group of AppConfig targets, such as applications in a Beta or Production environment. You can also define environments for application subcomponents such as the Web, Mobile and Back-end components for your application. You can configure Amazon CloudWatch alarms for each environment. The system monitors alarms during a configuration deployment. If an alarm is triggered, the system rolls back the configuration.

public func createEnvironment(input: CreateEnvironmentInput, completion: @escaping (ClientRuntime.SdkResult<CreateEnvironmentOutputResponse, CreateEnvironmentOutputError>) -> Void)

createHostedConfigurationVersion(input:completion:)

Create a new configuration in the AppConfig configuration store.

public func createHostedConfigurationVersion(input: CreateHostedConfigurationVersionInput, completion: @escaping (ClientRuntime.SdkResult<CreateHostedConfigurationVersionOutputResponse, CreateHostedConfigurationVersionOutputError>) -> Void)

deleteApplication(input:completion:)

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

public func deleteApplication(input: DeleteApplicationInput, completion: @escaping (ClientRuntime.SdkResult<DeleteApplicationOutputResponse, DeleteApplicationOutputError>) -> Void)

deleteConfigurationProfile(input:completion:)

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

public func deleteConfigurationProfile(input: DeleteConfigurationProfileInput, completion: @escaping (ClientRuntime.SdkResult<DeleteConfigurationProfileOutputResponse, DeleteConfigurationProfileOutputError>) -> Void)

deleteDeploymentStrategy(input:completion:)

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

public func deleteDeploymentStrategy(input: DeleteDeploymentStrategyInput, completion: @escaping (ClientRuntime.SdkResult<DeleteDeploymentStrategyOutputResponse, DeleteDeploymentStrategyOutputError>) -> Void)

deleteEnvironment(input:completion:)

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

public func deleteEnvironment(input: DeleteEnvironmentInput, completion: @escaping (ClientRuntime.SdkResult<DeleteEnvironmentOutputResponse, DeleteEnvironmentOutputError>) -> Void)

deleteHostedConfigurationVersion(input:completion:)

Delete a version of a configuration from the AppConfig configuration store.

public func deleteHostedConfigurationVersion(input: DeleteHostedConfigurationVersionInput, completion: @escaping (ClientRuntime.SdkResult<DeleteHostedConfigurationVersionOutputResponse, DeleteHostedConfigurationVersionOutputError>) -> Void)

getApplication(input:completion:)

Retrieve information about an application.

public func getApplication(input: GetApplicationInput, completion: @escaping (ClientRuntime.SdkResult<GetApplicationOutputResponse, GetApplicationOutputError>) -> Void)

getConfiguration(input:completion:)

Receive information about a configuration. AWS AppConfig uses the value of the ClientConfigurationVersion parameter to identify the configuration version on your clients. If you don’t send ClientConfigurationVersion with each call to GetConfiguration, your clients receive the current configuration. You are charged each time your clients receive a configuration. To avoid excess charges, we recommend that you include the ClientConfigurationVersion value with every call to GetConfiguration. This value must be saved on your client. Subsequent calls to GetConfiguration must pass this value by using the ClientConfigurationVersion parameter.

public func getConfiguration(input: GetConfigurationInput, completion: @escaping (ClientRuntime.SdkResult<GetConfigurationOutputResponse, GetConfigurationOutputError>) -> Void)

getConfigurationProfile(input:completion:)

Retrieve information about a configuration profile.

public func getConfigurationProfile(input: GetConfigurationProfileInput, completion: @escaping (ClientRuntime.SdkResult<GetConfigurationProfileOutputResponse, GetConfigurationProfileOutputError>) -> Void)

getDeployment(input:completion:)

Retrieve information about a configuration deployment.

public func getDeployment(input: GetDeploymentInput, completion: @escaping (ClientRuntime.SdkResult<GetDeploymentOutputResponse, GetDeploymentOutputError>) -> Void)

getDeploymentStrategy(input:completion:)

Retrieve 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.

public func getDeploymentStrategy(input: GetDeploymentStrategyInput, completion: @escaping (ClientRuntime.SdkResult<GetDeploymentStrategyOutputResponse, GetDeploymentStrategyOutputError>) -> Void)

getEnvironment(input:completion:)

Retrieve information about an environment. An environment is a logical deployment group of AppConfig applications, such as applications in a Production environment or in an EU_Region environment. Each configuration deployment targets an environment. You can enable one or more Amazon CloudWatch alarms for an environment. If an alarm is triggered during a deployment, AppConfig roles back the configuration.

public func getEnvironment(input: GetEnvironmentInput, completion: @escaping (ClientRuntime.SdkResult<GetEnvironmentOutputResponse, GetEnvironmentOutputError>) -> Void)

getHostedConfigurationVersion(input:completion:)

Get information about a specific configuration version.

public func getHostedConfigurationVersion(input: GetHostedConfigurationVersionInput, completion: @escaping (ClientRuntime.SdkResult<GetHostedConfigurationVersionOutputResponse, GetHostedConfigurationVersionOutputError>) -> Void)

listApplications(input:completion:)

List all applications in your AWS account.

public func listApplications(input: ListApplicationsInput, completion: @escaping (ClientRuntime.SdkResult<ListApplicationsOutputResponse, ListApplicationsOutputError>) -> Void)

listConfigurationProfiles(input:completion:)

Lists the configuration profiles for an application.

public func listConfigurationProfiles(input: ListConfigurationProfilesInput, completion: @escaping (ClientRuntime.SdkResult<ListConfigurationProfilesOutputResponse, ListConfigurationProfilesOutputError>) -> Void)

listDeploymentStrategies(input:completion:)

List deployment strategies.

public func listDeploymentStrategies(input: ListDeploymentStrategiesInput, completion: @escaping (ClientRuntime.SdkResult<ListDeploymentStrategiesOutputResponse, ListDeploymentStrategiesOutputError>) -> Void)

listDeployments(input:completion:)

Lists the deployments for an environment.

public func listDeployments(input: ListDeploymentsInput, completion: @escaping (ClientRuntime.SdkResult<ListDeploymentsOutputResponse, ListDeploymentsOutputError>) -> Void)

listEnvironments(input:completion:)

List the environments for an application.

public func listEnvironments(input: ListEnvironmentsInput, completion: @escaping (ClientRuntime.SdkResult<ListEnvironmentsOutputResponse, ListEnvironmentsOutputError>) -> Void)

listHostedConfigurationVersions(input:completion:)

View a list of configurations stored in the AppConfig configuration store by version.

public func listHostedConfigurationVersions(input: ListHostedConfigurationVersionsInput, completion: @escaping (ClientRuntime.SdkResult<ListHostedConfigurationVersionsOutputResponse, ListHostedConfigurationVersionsOutputError>) -> Void)

listTagsForResource(input:completion:)

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

public func listTagsForResource(input: ListTagsForResourceInput, completion: @escaping (ClientRuntime.SdkResult<ListTagsForResourceOutputResponse, ListTagsForResourceOutputError>) -> Void)

startDeployment(input:completion:)

Starts a deployment.

public func startDeployment(input: StartDeploymentInput, completion: @escaping (ClientRuntime.SdkResult<StartDeploymentOutputResponse, StartDeploymentOutputError>) -> Void)

stopDeployment(input:completion:)

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

public func stopDeployment(input: StopDeploymentInput, completion: @escaping (ClientRuntime.SdkResult<StopDeploymentOutputResponse, StopDeploymentOutputError>) -> Void)

tagResource(input:completion:)

Metadata to assign 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.

public func tagResource(input: TagResourceInput, completion: @escaping (ClientRuntime.SdkResult<TagResourceOutputResponse, TagResourceOutputError>) -> Void)

untagResource(input:completion:)

Deletes a tag key and value from an AppConfig resource.

public func untagResource(input: UntagResourceInput, completion: @escaping (ClientRuntime.SdkResult<UntagResourceOutputResponse, UntagResourceOutputError>) -> Void)

updateApplication(input:completion:)

Updates an application.

public func updateApplication(input: UpdateApplicationInput, completion: @escaping (ClientRuntime.SdkResult<UpdateApplicationOutputResponse, UpdateApplicationOutputError>) -> Void)

updateConfigurationProfile(input:completion:)

Updates a configuration profile.

public func updateConfigurationProfile(input: UpdateConfigurationProfileInput, completion: @escaping (ClientRuntime.SdkResult<UpdateConfigurationProfileOutputResponse, UpdateConfigurationProfileOutputError>) -> Void)

updateDeploymentStrategy(input:completion:)

Updates a deployment strategy.

public func updateDeploymentStrategy(input: UpdateDeploymentStrategyInput, completion: @escaping (ClientRuntime.SdkResult<UpdateDeploymentStrategyOutputResponse, UpdateDeploymentStrategyOutputError>) -> Void)

updateEnvironment(input:completion:)

Updates an environment.

public func updateEnvironment(input: UpdateEnvironmentInput, completion: @escaping (ClientRuntime.SdkResult<UpdateEnvironmentOutputResponse, UpdateEnvironmentOutputError>) -> Void)

validateConfiguration(input:completion:)

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

public func validateConfiguration(input: ValidateConfigurationInput, completion: @escaping (ClientRuntime.SdkResult<ValidateConfigurationOutputResponse, ValidateConfigurationOutputError>) -> Void)