Module Awso_appconfig_syncSource

Sourceval delete_application : ?endpoint_url:string -> ?cfg:Awso.Cfg.t -> Awso_appconfig.Values.DeleteApplicationRequest.t -> (unit, unit) Result.t
Sourceval delete_configuration_profile : ?endpoint_url:string -> ?cfg:Awso.Cfg.t -> Awso_appconfig.Values.DeleteConfigurationProfileRequest.t -> (unit, unit) Result.t
Sourceval delete_deployment_strategy : ?endpoint_url:string -> ?cfg:Awso.Cfg.t -> Awso_appconfig.Values.DeleteDeploymentStrategyRequest.t -> (unit, unit) Result.t
Sourceval delete_environment : ?endpoint_url:string -> ?cfg:Awso.Cfg.t -> Awso_appconfig.Values.DeleteEnvironmentRequest.t -> (unit, unit) Result.t
Sourceval delete_extension : ?endpoint_url:string -> ?cfg:Awso.Cfg.t -> Awso_appconfig.Values.DeleteExtensionRequest.t -> (unit, unit) Result.t
Sourceval delete_extension_association : ?endpoint_url:string -> ?cfg:Awso.Cfg.t -> Awso_appconfig.Values.DeleteExtensionAssociationRequest.t -> (unit, unit) Result.t
Sourceval delete_hosted_configuration_version : ?endpoint_url:string -> ?cfg:Awso.Cfg.t -> Awso_appconfig.Values.DeleteHostedConfigurationVersionRequest.t -> (unit, unit) Result.t
Sourceval get_account_settings : ?endpoint_url:string -> ?cfg:Awso.Cfg.t -> unit -> (Awso_appconfig.Values.AccountSettings.t, Awso_appconfig.Values.AccountSettings.error) Result.t
Sourceval tag_resource : ?endpoint_url:string -> ?cfg:Awso.Cfg.t -> Awso_appconfig.Values.TagResourceRequest.t -> (unit, unit) Result.t
Sourceval untag_resource : ?endpoint_url:string -> ?cfg:Awso.Cfg.t -> Awso_appconfig.Values.UntagResourceRequest.t -> (unit, unit) Result.t
Sourceval validate_configuration : ?endpoint_url:string -> ?cfg:Awso.Cfg.t -> Awso_appconfig.Values.ValidateConfigurationRequest.t -> (unit, unit) Result.t
include module type of struct include Awso_appconfig.Values end
Sourceval service : Awso.Service.t
Sourceval apiVersion : string
Sourceval endpointPrefix : string
Sourceval serviceFullName : string
Sourceval signatureVersion : string
Sourceval protocol : string
Sourceval globalEndpoint : string
Sourceval serviceAbbreviation : string
Sourceval simple_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval composed_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval to_query : ('a -> Awso.Client.Query.value) -> 'a -> Awso.Client.Query.t
Sourceval structure_to_value_aux : ('a * 'b option) list -> f:(('a * 'b) list -> 'c) -> [> `Structure of 'c ]
Sourceval structure_to_value : ('a * 'b option) list -> [> `Structure of ('a * 'b) list ]
Sourceval structure_to_wrapped_value : wrapper:'a -> response:'a -> ('b * 'c option) list -> [> `Structure of ('a * [> `Structure of ('b * 'c) list ]) list ]
Sourcemodule InvalidConfigurationDetail = Awso_appconfig.Values.InvalidConfigurationDetail

Detailed information about the bad request exception error when creating a hosted configuration version.

Sourcemodule InvalidConfigurationDetailList = Awso_appconfig.Values.InvalidConfigurationDetailList
Sourcemodule StringWithLengthBetween1And2048 = Awso_appconfig.Values.StringWithLengthBetween1And2048

Detailed information about the input that failed to satisfy the constraints specified by a call.

Amazon CloudWatch alarms to monitor during the deployment process.

An extension that was invoked as part of a deployment event.

An action defines the tasks that the extension performs during the AppConfig workflow. Each action includes an action point, as shown in the following list: PRE_CREATE_HOSTED_CONFIGURATION_VERSION PRE_START_DEPLOYMENT AT_DEPLOYMENT_TICK ON_DEPLOYMENT_START ON_DEPLOYMENT_STEP ON_DEPLOYMENT_BAKING ON_DEPLOYMENT_COMPLETE ON_DEPLOYMENT_ROLLED_BACK Each action also includes a name, a URI to an Lambda function, and an Amazon Resource Name (ARN) for an Identity and Access Management assume role. You specify the name, URI, and ARN for each action point defined in the extension.

Sourcemodule StringWithLengthBetween0And32768 = Awso_appconfig.Values.StringWithLengthBetween0And32768
Sourcemodule StringWithLengthBetween1And255 = Awso_appconfig.Values.StringWithLengthBetween1And255

The input fails to satisfy the constraints specified by an Amazon Web Services service.

There was an internal failure in the AppConfig service.

The requested resource could not be found.

Sourcemodule ServiceQuotaExceededException = Awso_appconfig.Values.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.

A value such as an Amazon Resource Name (ARN) or an Amazon Simple Notification Service topic entered in an extension when invoked. Parameter values are specified in an extension association. For more information about extensions, see Extending workflows in the AppConfig User Guide.

A validator provides a syntactic or semantic check to ensure the configuration that you want to deploy functions as intended. To validate your application configuration data, you provide a schema or an Amazon Web Services Lambda function that runs against the configuration. The configuration deployment or update can only proceed when the configuration data is valid. For more information, see About validators in the AppConfig User Guide.

Sourcemodule DeletionProtectionDuration = Awso_appconfig.Values.DeletionProtectionDuration
Sourcemodule HostedConfigurationVersionSummary = Awso_appconfig.Values.HostedConfigurationVersionSummary

Information about the configuration.

Information about an extension. Call GetExtension to get more information about an extension.

Sourcemodule ExtensionAssociationSummary = Awso_appconfig.Values.ExtensionAssociationSummary

Information about an association between an extension and an AppConfig resource such as an application, environment, or configuration profile. Call GetExtensionAssociation to get more information about an association.

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

Information about the deployment.

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.

An extension that was invoked during a deployment.

An object that describes a deployment event.

Sourcemodule ConfigurationProfileSummary = Awso_appconfig.Values.ConfigurationProfileSummary

A summary of a configuration profile.

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.

Sourcemodule DeletionProtectionSettings = Awso_appconfig.Values.DeletionProtectionSettings

A parameter to configure deletion protection. Deletion protection prevents a user from deleting a configuration profile or an environment if AppConfig has called either GetLatestConfiguration or for the configuration profile or from the environment during the specified interval. The default interval specified by ProtectionPeriodInMinutes is 60. DeletionProtectionCheck skips configuration profiles and environments that were created in the past hour.

Sourcemodule HostedConfigurationVersionSummaryList = Awso_appconfig.Values.HostedConfigurationVersionSummaryList

The request could not be processed because of conflict in the current state of the resource.

The configuration size is too large.

Sourcemodule StringWithLengthBetween1And64 = Awso_appconfig.Values.StringWithLengthBetween1And64
Sourcemodule ExtensionAssociationSummaries = Awso_appconfig.Values.ExtensionAssociationSummaries
Sourcemodule ConfigurationProfileSummaryList = Awso_appconfig.Values.ConfigurationProfileSummaryList
Sourcemodule ValidateConfigurationRequest = Awso_appconfig.Values.ValidateConfigurationRequest

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

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

Sourcemodule UpdateExtensionAssociationRequest = Awso_appconfig.Values.UpdateExtensionAssociationRequest

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

Updates an environment.

Sourcemodule UpdateDeploymentStrategyRequest = Awso_appconfig.Values.UpdateDeploymentStrategyRequest

Updates a deployment strategy.

Sourcemodule UpdateConfigurationProfileRequest = Awso_appconfig.Values.UpdateConfigurationProfileRequest

Updates a configuration profile.

Updates an application.

Sourcemodule UpdateAccountSettingsRequest = Awso_appconfig.Values.UpdateAccountSettingsRequest

Updates the value of the DeletionProtection parameter.

Deletes a tag key and value from an AppConfig resource.

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.

Stops a deployment. This API action works only on deployments that have a status of DEPLOYING, unless an AllowRevert parameter is supplied. If the AllowRevert parameter is supplied, the status of an in-progress deployment will be ROLLED_BACK. The status of a completed deployment will be REVERTED. AppConfig only allows a revert within 72 hours of deployment completion.

Starts a deployment.

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

Sourcemodule ListTagsForResourceRequest = Awso_appconfig.Values.ListTagsForResourceRequest

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

Sourcemodule ListHostedConfigurationVersionsRequest = Awso_appconfig.Values.ListHostedConfigurationVersionsRequest

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

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.

Sourcemodule ListExtensionAssociationsRequest = Awso_appconfig.Values.ListExtensionAssociationsRequest

Lists all AppConfig extension associations in the account. For more information about extensions and associations, see Extending workflows in the AppConfig User Guide.

Lists the environments for an application.

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

Sourcemodule ListDeploymentStrategiesRequest = Awso_appconfig.Values.ListDeploymentStrategiesRequest

Lists deployment strategies.

Sourcemodule ListConfigurationProfilesRequest = Awso_appconfig.Values.ListConfigurationProfilesRequest

Lists the configuration profiles for an application.

Lists all applications in your Amazon Web Services account.

Sourcemodule HostedConfigurationVersions = Awso_appconfig.Values.HostedConfigurationVersions

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

Sourcemodule HostedConfigurationVersion = Awso_appconfig.Values.HostedConfigurationVersion

Creates a new configuration in the AppConfig hosted configuration store. If you're creating a feature flag, we recommend you familiarize yourself with the JSON schema for feature flag data. For more information, see Type reference for AWS.AppConfig.FeatureFlags in the AppConfig User Guide.

Sourcemodule GetHostedConfigurationVersionRequest = Awso_appconfig.Values.GetHostedConfigurationVersionRequest

Retrieves information about a specific configuration version.

Returns information about an AppConfig extension.

Sourcemodule GetExtensionAssociationRequest = Awso_appconfig.Values.GetExtensionAssociationRequest

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

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

Sourcemodule GetDeploymentStrategyRequest = Awso_appconfig.Values.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.

Retrieves information about a configuration deployment.

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

Sourcemodule GetConfigurationProfileRequest = Awso_appconfig.Values.GetConfigurationProfileRequest

Retrieves information about a configuration profile.

Retrieves information about an application.

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.

Lists all AppConfig extension associations in the account. For more information about extensions and associations, see Extending workflows in the AppConfig User Guide.

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.

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.

Lists the environments for an application.

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

Lists deployment strategies.

Retrieves information about a configuration deployment.

Sourcemodule DeleteHostedConfigurationVersionRequest = Awso_appconfig.Values.DeleteHostedConfigurationVersionRequest

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

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

Sourcemodule DeleteExtensionAssociationRequest = Awso_appconfig.Values.DeleteExtensionAssociationRequest

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

Deletes an environment. To prevent users from unintentionally deleting actively-used environments, enable deletion protection.

Sourcemodule DeleteDeploymentStrategyRequest = Awso_appconfig.Values.DeleteDeploymentStrategyRequest

Deletes a deployment strategy.

Sourcemodule DeleteConfigurationProfileRequest = Awso_appconfig.Values.DeleteConfigurationProfileRequest

Deletes a configuration profile. To prevent users from unintentionally deleting actively-used configuration profiles, enable deletion protection.

Deletes an application.

Sourcemodule CreateHostedConfigurationVersionRequest = Awso_appconfig.Values.CreateHostedConfigurationVersionRequest

Creates a new configuration in the AppConfig hosted configuration store. If you're creating a feature flag, we recommend you familiarize yourself with the JSON schema for feature flag data. For more information, see Type reference for AWS.AppConfig.FeatureFlags in the AppConfig User Guide.

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.

Sourcemodule CreateExtensionAssociationRequest = Awso_appconfig.Values.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.

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

Sourcemodule CreateDeploymentStrategyRequest = Awso_appconfig.Values.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.

Sourcemodule CreateConfigurationProfileRequest = Awso_appconfig.Values.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.

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.

Lists the configuration profiles for an application.

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.

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

Lists all applications in your Amazon Web Services account.

Returns information about the status of the DeletionProtection parameter.