/ cloudformation-templates / node_modules / aws-cdk / node_modules / aws-sdk / clients / appconfig.d.ts
appconfig.d.ts
1 import {Request} from '../lib/request'; 2 import {Response} from '../lib/response'; 3 import {AWSError} from '../lib/error'; 4 import {Service} from '../lib/service'; 5 import {ServiceConfigurationOptions} from '../lib/service'; 6 import {ConfigBase as Config} from '../lib/config-base'; 7 interface Blob {} 8 declare class AppConfig extends Service { 9 /** 10 * Constructs a service object. This object has one method for each API operation. 11 */ 12 constructor(options?: AppConfig.Types.ClientConfiguration) 13 config: Config & AppConfig.Types.ClientConfiguration; 14 /** 15 * 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. 16 */ 17 createApplication(params: AppConfig.Types.CreateApplicationRequest, callback?: (err: AWSError, data: AppConfig.Types.Application) => void): Request<AppConfig.Types.Application, AWSError>; 18 /** 19 * 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. 20 */ 21 createApplication(callback?: (err: AWSError, data: AppConfig.Types.Application) => void): Request<AppConfig.Types.Application, AWSError>; 22 /** 23 * 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. 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. 24 */ 25 createConfigurationProfile(params: AppConfig.Types.CreateConfigurationProfileRequest, callback?: (err: AWSError, data: AppConfig.Types.ConfigurationProfile) => void): Request<AppConfig.Types.ConfigurationProfile, AWSError>; 26 /** 27 * 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. 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. 28 */ 29 createConfigurationProfile(callback?: (err: AWSError, data: AppConfig.Types.ConfigurationProfile) => void): Request<AppConfig.Types.ConfigurationProfile, AWSError>; 30 /** 31 * 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. 32 */ 33 createDeploymentStrategy(params: AppConfig.Types.CreateDeploymentStrategyRequest, callback?: (err: AWSError, data: AppConfig.Types.DeploymentStrategy) => void): Request<AppConfig.Types.DeploymentStrategy, AWSError>; 34 /** 35 * 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. 36 */ 37 createDeploymentStrategy(callback?: (err: AWSError, data: AppConfig.Types.DeploymentStrategy) => void): Request<AppConfig.Types.DeploymentStrategy, AWSError>; 38 /** 39 * 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. 40 */ 41 createEnvironment(params: AppConfig.Types.CreateEnvironmentRequest, callback?: (err: AWSError, data: AppConfig.Types.Environment) => void): Request<AppConfig.Types.Environment, AWSError>; 42 /** 43 * 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. 44 */ 45 createEnvironment(callback?: (err: AWSError, data: AppConfig.Types.Environment) => void): Request<AppConfig.Types.Environment, AWSError>; 46 /** 47 * Create a new configuration in the AppConfig configuration store. 48 */ 49 createHostedConfigurationVersion(params: AppConfig.Types.CreateHostedConfigurationVersionRequest, callback?: (err: AWSError, data: AppConfig.Types.HostedConfigurationVersion) => void): Request<AppConfig.Types.HostedConfigurationVersion, AWSError>; 50 /** 51 * Create a new configuration in the AppConfig configuration store. 52 */ 53 createHostedConfigurationVersion(callback?: (err: AWSError, data: AppConfig.Types.HostedConfigurationVersion) => void): Request<AppConfig.Types.HostedConfigurationVersion, AWSError>; 54 /** 55 * Delete an application. Deleting an application does not delete a configuration from a host. 56 */ 57 deleteApplication(params: AppConfig.Types.DeleteApplicationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 58 /** 59 * Delete an application. Deleting an application does not delete a configuration from a host. 60 */ 61 deleteApplication(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 62 /** 63 * Delete a configuration profile. Deleting a configuration profile does not delete a configuration from a host. 64 */ 65 deleteConfigurationProfile(params: AppConfig.Types.DeleteConfigurationProfileRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 66 /** 67 * Delete a configuration profile. Deleting a configuration profile does not delete a configuration from a host. 68 */ 69 deleteConfigurationProfile(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 70 /** 71 * Delete a deployment strategy. Deleting a deployment strategy does not delete a configuration from a host. 72 */ 73 deleteDeploymentStrategy(params: AppConfig.Types.DeleteDeploymentStrategyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 74 /** 75 * Delete a deployment strategy. Deleting a deployment strategy does not delete a configuration from a host. 76 */ 77 deleteDeploymentStrategy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 78 /** 79 * Delete an environment. Deleting an environment does not delete a configuration from a host. 80 */ 81 deleteEnvironment(params: AppConfig.Types.DeleteEnvironmentRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 82 /** 83 * Delete an environment. Deleting an environment does not delete a configuration from a host. 84 */ 85 deleteEnvironment(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 86 /** 87 * Delete a version of a configuration from the AppConfig configuration store. 88 */ 89 deleteHostedConfigurationVersion(params: AppConfig.Types.DeleteHostedConfigurationVersionRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 90 /** 91 * Delete a version of a configuration from the AppConfig configuration store. 92 */ 93 deleteHostedConfigurationVersion(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 94 /** 95 * Retrieve information about an application. 96 */ 97 getApplication(params: AppConfig.Types.GetApplicationRequest, callback?: (err: AWSError, data: AppConfig.Types.Application) => void): Request<AppConfig.Types.Application, AWSError>; 98 /** 99 * Retrieve information about an application. 100 */ 101 getApplication(callback?: (err: AWSError, data: AppConfig.Types.Application) => void): Request<AppConfig.Types.Application, AWSError>; 102 /** 103 * 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. 104 */ 105 getConfiguration(params: AppConfig.Types.GetConfigurationRequest, callback?: (err: AWSError, data: AppConfig.Types.Configuration) => void): Request<AppConfig.Types.Configuration, AWSError>; 106 /** 107 * 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. 108 */ 109 getConfiguration(callback?: (err: AWSError, data: AppConfig.Types.Configuration) => void): Request<AppConfig.Types.Configuration, AWSError>; 110 /** 111 * Retrieve information about a configuration profile. 112 */ 113 getConfigurationProfile(params: AppConfig.Types.GetConfigurationProfileRequest, callback?: (err: AWSError, data: AppConfig.Types.ConfigurationProfile) => void): Request<AppConfig.Types.ConfigurationProfile, AWSError>; 114 /** 115 * Retrieve information about a configuration profile. 116 */ 117 getConfigurationProfile(callback?: (err: AWSError, data: AppConfig.Types.ConfigurationProfile) => void): Request<AppConfig.Types.ConfigurationProfile, AWSError>; 118 /** 119 * Retrieve information about a configuration deployment. 120 */ 121 getDeployment(params: AppConfig.Types.GetDeploymentRequest, callback?: (err: AWSError, data: AppConfig.Types.Deployment) => void): Request<AppConfig.Types.Deployment, AWSError>; 122 /** 123 * Retrieve information about a configuration deployment. 124 */ 125 getDeployment(callback?: (err: AWSError, data: AppConfig.Types.Deployment) => void): Request<AppConfig.Types.Deployment, AWSError>; 126 /** 127 * 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. 128 */ 129 getDeploymentStrategy(params: AppConfig.Types.GetDeploymentStrategyRequest, callback?: (err: AWSError, data: AppConfig.Types.DeploymentStrategy) => void): Request<AppConfig.Types.DeploymentStrategy, AWSError>; 130 /** 131 * 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. 132 */ 133 getDeploymentStrategy(callback?: (err: AWSError, data: AppConfig.Types.DeploymentStrategy) => void): Request<AppConfig.Types.DeploymentStrategy, AWSError>; 134 /** 135 * 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. 136 */ 137 getEnvironment(params: AppConfig.Types.GetEnvironmentRequest, callback?: (err: AWSError, data: AppConfig.Types.Environment) => void): Request<AppConfig.Types.Environment, AWSError>; 138 /** 139 * 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. 140 */ 141 getEnvironment(callback?: (err: AWSError, data: AppConfig.Types.Environment) => void): Request<AppConfig.Types.Environment, AWSError>; 142 /** 143 * Get information about a specific configuration version. 144 */ 145 getHostedConfigurationVersion(params: AppConfig.Types.GetHostedConfigurationVersionRequest, callback?: (err: AWSError, data: AppConfig.Types.HostedConfigurationVersion) => void): Request<AppConfig.Types.HostedConfigurationVersion, AWSError>; 146 /** 147 * Get information about a specific configuration version. 148 */ 149 getHostedConfigurationVersion(callback?: (err: AWSError, data: AppConfig.Types.HostedConfigurationVersion) => void): Request<AppConfig.Types.HostedConfigurationVersion, AWSError>; 150 /** 151 * List all applications in your AWS account. 152 */ 153 listApplications(params: AppConfig.Types.ListApplicationsRequest, callback?: (err: AWSError, data: AppConfig.Types.Applications) => void): Request<AppConfig.Types.Applications, AWSError>; 154 /** 155 * List all applications in your AWS account. 156 */ 157 listApplications(callback?: (err: AWSError, data: AppConfig.Types.Applications) => void): Request<AppConfig.Types.Applications, AWSError>; 158 /** 159 * Lists the configuration profiles for an application. 160 */ 161 listConfigurationProfiles(params: AppConfig.Types.ListConfigurationProfilesRequest, callback?: (err: AWSError, data: AppConfig.Types.ConfigurationProfiles) => void): Request<AppConfig.Types.ConfigurationProfiles, AWSError>; 162 /** 163 * Lists the configuration profiles for an application. 164 */ 165 listConfigurationProfiles(callback?: (err: AWSError, data: AppConfig.Types.ConfigurationProfiles) => void): Request<AppConfig.Types.ConfigurationProfiles, AWSError>; 166 /** 167 * List deployment strategies. 168 */ 169 listDeploymentStrategies(params: AppConfig.Types.ListDeploymentStrategiesRequest, callback?: (err: AWSError, data: AppConfig.Types.DeploymentStrategies) => void): Request<AppConfig.Types.DeploymentStrategies, AWSError>; 170 /** 171 * List deployment strategies. 172 */ 173 listDeploymentStrategies(callback?: (err: AWSError, data: AppConfig.Types.DeploymentStrategies) => void): Request<AppConfig.Types.DeploymentStrategies, AWSError>; 174 /** 175 * Lists the deployments for an environment. 176 */ 177 listDeployments(params: AppConfig.Types.ListDeploymentsRequest, callback?: (err: AWSError, data: AppConfig.Types.Deployments) => void): Request<AppConfig.Types.Deployments, AWSError>; 178 /** 179 * Lists the deployments for an environment. 180 */ 181 listDeployments(callback?: (err: AWSError, data: AppConfig.Types.Deployments) => void): Request<AppConfig.Types.Deployments, AWSError>; 182 /** 183 * List the environments for an application. 184 */ 185 listEnvironments(params: AppConfig.Types.ListEnvironmentsRequest, callback?: (err: AWSError, data: AppConfig.Types.Environments) => void): Request<AppConfig.Types.Environments, AWSError>; 186 /** 187 * List the environments for an application. 188 */ 189 listEnvironments(callback?: (err: AWSError, data: AppConfig.Types.Environments) => void): Request<AppConfig.Types.Environments, AWSError>; 190 /** 191 * View a list of configurations stored in the AppConfig configuration store by version. 192 */ 193 listHostedConfigurationVersions(params: AppConfig.Types.ListHostedConfigurationVersionsRequest, callback?: (err: AWSError, data: AppConfig.Types.HostedConfigurationVersions) => void): Request<AppConfig.Types.HostedConfigurationVersions, AWSError>; 194 /** 195 * View a list of configurations stored in the AppConfig configuration store by version. 196 */ 197 listHostedConfigurationVersions(callback?: (err: AWSError, data: AppConfig.Types.HostedConfigurationVersions) => void): Request<AppConfig.Types.HostedConfigurationVersions, AWSError>; 198 /** 199 * Retrieves the list of key-value tags assigned to the resource. 200 */ 201 listTagsForResource(params: AppConfig.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: AppConfig.Types.ResourceTags) => void): Request<AppConfig.Types.ResourceTags, AWSError>; 202 /** 203 * Retrieves the list of key-value tags assigned to the resource. 204 */ 205 listTagsForResource(callback?: (err: AWSError, data: AppConfig.Types.ResourceTags) => void): Request<AppConfig.Types.ResourceTags, AWSError>; 206 /** 207 * Starts a deployment. 208 */ 209 startDeployment(params: AppConfig.Types.StartDeploymentRequest, callback?: (err: AWSError, data: AppConfig.Types.Deployment) => void): Request<AppConfig.Types.Deployment, AWSError>; 210 /** 211 * Starts a deployment. 212 */ 213 startDeployment(callback?: (err: AWSError, data: AppConfig.Types.Deployment) => void): Request<AppConfig.Types.Deployment, AWSError>; 214 /** 215 * 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. 216 */ 217 stopDeployment(params: AppConfig.Types.StopDeploymentRequest, callback?: (err: AWSError, data: AppConfig.Types.Deployment) => void): Request<AppConfig.Types.Deployment, AWSError>; 218 /** 219 * 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. 220 */ 221 stopDeployment(callback?: (err: AWSError, data: AppConfig.Types.Deployment) => void): Request<AppConfig.Types.Deployment, AWSError>; 222 /** 223 * 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. 224 */ 225 tagResource(params: AppConfig.Types.TagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 226 /** 227 * 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. 228 */ 229 tagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 230 /** 231 * Deletes a tag key and value from an AppConfig resource. 232 */ 233 untagResource(params: AppConfig.Types.UntagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 234 /** 235 * Deletes a tag key and value from an AppConfig resource. 236 */ 237 untagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 238 /** 239 * Updates an application. 240 */ 241 updateApplication(params: AppConfig.Types.UpdateApplicationRequest, callback?: (err: AWSError, data: AppConfig.Types.Application) => void): Request<AppConfig.Types.Application, AWSError>; 242 /** 243 * Updates an application. 244 */ 245 updateApplication(callback?: (err: AWSError, data: AppConfig.Types.Application) => void): Request<AppConfig.Types.Application, AWSError>; 246 /** 247 * Updates a configuration profile. 248 */ 249 updateConfigurationProfile(params: AppConfig.Types.UpdateConfigurationProfileRequest, callback?: (err: AWSError, data: AppConfig.Types.ConfigurationProfile) => void): Request<AppConfig.Types.ConfigurationProfile, AWSError>; 250 /** 251 * Updates a configuration profile. 252 */ 253 updateConfigurationProfile(callback?: (err: AWSError, data: AppConfig.Types.ConfigurationProfile) => void): Request<AppConfig.Types.ConfigurationProfile, AWSError>; 254 /** 255 * Updates a deployment strategy. 256 */ 257 updateDeploymentStrategy(params: AppConfig.Types.UpdateDeploymentStrategyRequest, callback?: (err: AWSError, data: AppConfig.Types.DeploymentStrategy) => void): Request<AppConfig.Types.DeploymentStrategy, AWSError>; 258 /** 259 * Updates a deployment strategy. 260 */ 261 updateDeploymentStrategy(callback?: (err: AWSError, data: AppConfig.Types.DeploymentStrategy) => void): Request<AppConfig.Types.DeploymentStrategy, AWSError>; 262 /** 263 * Updates an environment. 264 */ 265 updateEnvironment(params: AppConfig.Types.UpdateEnvironmentRequest, callback?: (err: AWSError, data: AppConfig.Types.Environment) => void): Request<AppConfig.Types.Environment, AWSError>; 266 /** 267 * Updates an environment. 268 */ 269 updateEnvironment(callback?: (err: AWSError, data: AppConfig.Types.Environment) => void): Request<AppConfig.Types.Environment, AWSError>; 270 /** 271 * Uses the validators in a configuration profile to validate a configuration. 272 */ 273 validateConfiguration(params: AppConfig.Types.ValidateConfigurationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 274 /** 275 * Uses the validators in a configuration profile to validate a configuration. 276 */ 277 validateConfiguration(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 278 } 279 declare namespace AppConfig { 280 export interface Application { 281 /** 282 * The application ID. 283 */ 284 Id?: Id; 285 /** 286 * The application name. 287 */ 288 Name?: Name; 289 /** 290 * The description of the application. 291 */ 292 Description?: Description; 293 } 294 export type ApplicationList = Application[]; 295 export interface Applications { 296 /** 297 * The elements from this collection. 298 */ 299 Items?: ApplicationList; 300 /** 301 * The token for the next set of items to return. Use this token to get the next set of results. 302 */ 303 NextToken?: NextToken; 304 } 305 export type Arn = string; 306 export type _Blob = Buffer|Uint8Array|Blob|string; 307 export interface Configuration { 308 /** 309 * The content of the configuration or the configuration data. 310 */ 311 Content?: _Blob; 312 /** 313 * The configuration version. 314 */ 315 ConfigurationVersion?: Version; 316 /** 317 * A standard MIME type describing the format of the configuration content. For more information, see Content-Type. 318 */ 319 ContentType?: String; 320 } 321 export interface ConfigurationProfile { 322 /** 323 * The application ID. 324 */ 325 ApplicationId?: Id; 326 /** 327 * The configuration profile ID. 328 */ 329 Id?: Id; 330 /** 331 * The name of the configuration profile. 332 */ 333 Name?: Name; 334 /** 335 * The configuration profile description. 336 */ 337 Description?: Description; 338 /** 339 * The URI location of the configuration. 340 */ 341 LocationUri?: Uri; 342 /** 343 * The ARN of an IAM role with permission to access the configuration at the specified LocationUri. 344 */ 345 RetrievalRoleArn?: RoleArn; 346 /** 347 * A list of methods for validating the configuration. 348 */ 349 Validators?: ValidatorList; 350 } 351 export interface ConfigurationProfileSummary { 352 /** 353 * The application ID. 354 */ 355 ApplicationId?: Id; 356 /** 357 * The ID of the configuration profile. 358 */ 359 Id?: Id; 360 /** 361 * The name of the configuration profile. 362 */ 363 Name?: Name; 364 /** 365 * The URI location of the configuration. 366 */ 367 LocationUri?: Uri; 368 /** 369 * The types of validators in the configuration profile. 370 */ 371 ValidatorTypes?: ValidatorTypeList; 372 } 373 export type ConfigurationProfileSummaryList = ConfigurationProfileSummary[]; 374 export interface ConfigurationProfiles { 375 /** 376 * The elements from this collection. 377 */ 378 Items?: ConfigurationProfileSummaryList; 379 /** 380 * The token for the next set of items to return. Use this token to get the next set of results. 381 */ 382 NextToken?: NextToken; 383 } 384 export interface CreateApplicationRequest { 385 /** 386 * A name for the application. 387 */ 388 Name: Name; 389 /** 390 * A description of the application. 391 */ 392 Description?: Description; 393 /** 394 * Metadata to assign to the application. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define. 395 */ 396 Tags?: TagMap; 397 } 398 export interface CreateConfigurationProfileRequest { 399 /** 400 * The application ID. 401 */ 402 ApplicationId: Id; 403 /** 404 * A name for the configuration profile. 405 */ 406 Name: Name; 407 /** 408 * A description of the configuration profile. 409 */ 410 Description?: Description; 411 /** 412 * A URI to locate the configuration. You can specify a Systems Manager (SSM) document, an SSM Parameter Store parameter, or an Amazon S3 object. For an SSM document, specify either the document name in the format ssm-document://<Document_name> or the Amazon Resource Name (ARN). For a parameter, specify either the parameter name in the format ssm-parameter://<Parameter_name> or the ARN. For an Amazon S3 object, specify the URI in the following format: s3://<bucket>/<objectKey> . Here is an example: s3://my-bucket/my-app/us-east-1/my-config.json 413 */ 414 LocationUri: Uri; 415 /** 416 * The ARN of an IAM role with permission to access the configuration at the specified LocationUri. 417 */ 418 RetrievalRoleArn?: RoleArn; 419 /** 420 * A list of methods for validating the configuration. 421 */ 422 Validators?: ValidatorList; 423 /** 424 * Metadata to assign to the configuration profile. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define. 425 */ 426 Tags?: TagMap; 427 } 428 export interface CreateDeploymentStrategyRequest { 429 /** 430 * A name for the deployment strategy. 431 */ 432 Name: Name; 433 /** 434 * A description of the deployment strategy. 435 */ 436 Description?: Description; 437 /** 438 * Total amount of time for a deployment to last. 439 */ 440 DeploymentDurationInMinutes: MinutesBetween0And24Hours; 441 /** 442 * The amount of time AppConfig monitors for alarms before considering the deployment to be complete and no longer eligible for automatic roll back. 443 */ 444 FinalBakeTimeInMinutes?: MinutesBetween0And24Hours; 445 /** 446 * The percentage of targets to receive a deployed configuration during each interval. 447 */ 448 GrowthFactor: GrowthFactor; 449 /** 450 * The algorithm used to define how percentage grows over time. AWS AppConfig supports the following growth types: Linear: For this type, AppConfig processes the deployment by dividing the total number of targets by the value specified for Step percentage. For example, a linear deployment that uses a Step percentage of 10 deploys the configuration to 10 percent of the hosts. After those deployments are complete, the system deploys the configuration to the next 10 percent. This continues until 100% of the targets have successfully received the configuration. Exponential: For this type, AppConfig processes the deployment exponentially using the following formula: G*(2^N). In this formula, G is the growth factor specified by the user and N is the number of steps until the configuration is deployed to all targets. For example, if you specify a growth factor of 2, then the system rolls out the configuration as follows: 2*(2^0) 2*(2^1) 2*(2^2) Expressed numerically, the deployment rolls out as follows: 2% of the targets, 4% of the targets, 8% of the targets, and continues until the configuration has been deployed to all targets. 451 */ 452 GrowthType?: GrowthType; 453 /** 454 * Save the deployment strategy to a Systems Manager (SSM) document. 455 */ 456 ReplicateTo: ReplicateTo; 457 /** 458 * Metadata to assign to the deployment strategy. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define. 459 */ 460 Tags?: TagMap; 461 } 462 export interface CreateEnvironmentRequest { 463 /** 464 * The application ID. 465 */ 466 ApplicationId: Id; 467 /** 468 * A name for the environment. 469 */ 470 Name: Name; 471 /** 472 * A description of the environment. 473 */ 474 Description?: Description; 475 /** 476 * Amazon CloudWatch alarms to monitor during the deployment process. 477 */ 478 Monitors?: MonitorList; 479 /** 480 * Metadata to assign to the environment. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define. 481 */ 482 Tags?: TagMap; 483 } 484 export interface CreateHostedConfigurationVersionRequest { 485 /** 486 * The application ID. 487 */ 488 ApplicationId: Id; 489 /** 490 * The configuration profile ID. 491 */ 492 ConfigurationProfileId: Id; 493 /** 494 * A description of the configuration. 495 */ 496 Description?: Description; 497 /** 498 * The content of the configuration or the configuration data. 499 */ 500 Content: _Blob; 501 /** 502 * A standard MIME type describing the format of the configuration content. For more information, see Content-Type. 503 */ 504 ContentType: StringWithLengthBetween1And255; 505 /** 506 * An optional locking token used to prevent race conditions from overwriting configuration updates when creating a new version. To ensure your data is not overwritten when creating multiple hosted configuration versions in rapid succession, specify the version of the latest hosted configuration version. 507 */ 508 LatestVersionNumber?: Integer; 509 } 510 export interface DeleteApplicationRequest { 511 /** 512 * The ID of the application to delete. 513 */ 514 ApplicationId: Id; 515 } 516 export interface DeleteConfigurationProfileRequest { 517 /** 518 * The application ID that includes the configuration profile you want to delete. 519 */ 520 ApplicationId: Id; 521 /** 522 * The ID of the configuration profile you want to delete. 523 */ 524 ConfigurationProfileId: Id; 525 } 526 export interface DeleteDeploymentStrategyRequest { 527 /** 528 * The ID of the deployment strategy you want to delete. 529 */ 530 DeploymentStrategyId: DeploymentStrategyId; 531 } 532 export interface DeleteEnvironmentRequest { 533 /** 534 * The application ID that includes the environment you want to delete. 535 */ 536 ApplicationId: Id; 537 /** 538 * The ID of the environment you want to delete. 539 */ 540 EnvironmentId: Id; 541 } 542 export interface DeleteHostedConfigurationVersionRequest { 543 /** 544 * The application ID. 545 */ 546 ApplicationId: Id; 547 /** 548 * The configuration profile ID. 549 */ 550 ConfigurationProfileId: Id; 551 /** 552 * The versions number to delete. 553 */ 554 VersionNumber: Integer; 555 } 556 export interface Deployment { 557 /** 558 * The ID of the application that was deployed. 559 */ 560 ApplicationId?: Id; 561 /** 562 * The ID of the environment that was deployed. 563 */ 564 EnvironmentId?: Id; 565 /** 566 * The ID of the deployment strategy that was deployed. 567 */ 568 DeploymentStrategyId?: Id; 569 /** 570 * The ID of the configuration profile that was deployed. 571 */ 572 ConfigurationProfileId?: Id; 573 /** 574 * The sequence number of the deployment. 575 */ 576 DeploymentNumber?: Integer; 577 /** 578 * The name of the configuration. 579 */ 580 ConfigurationName?: Name; 581 /** 582 * Information about the source location of the configuration. 583 */ 584 ConfigurationLocationUri?: Uri; 585 /** 586 * The configuration version that was deployed. 587 */ 588 ConfigurationVersion?: Version; 589 /** 590 * The description of the deployment. 591 */ 592 Description?: Description; 593 /** 594 * Total amount of time the deployment lasted. 595 */ 596 DeploymentDurationInMinutes?: MinutesBetween0And24Hours; 597 /** 598 * The algorithm used to define how percentage grew over time. 599 */ 600 GrowthType?: GrowthType; 601 /** 602 * The percentage of targets to receive a deployed configuration during each interval. 603 */ 604 GrowthFactor?: Percentage; 605 /** 606 * The amount of time AppConfig monitored for alarms before considering the deployment to be complete and no longer eligible for automatic roll back. 607 */ 608 FinalBakeTimeInMinutes?: MinutesBetween0And24Hours; 609 /** 610 * The state of the deployment. 611 */ 612 State?: DeploymentState; 613 /** 614 * A list containing all events related to a deployment. The most recent events are displayed first. 615 */ 616 EventLog?: DeploymentEvents; 617 /** 618 * The percentage of targets for which the deployment is available. 619 */ 620 PercentageComplete?: Percentage; 621 /** 622 * The time the deployment started. 623 */ 624 StartedAt?: Iso8601DateTime; 625 /** 626 * The time the deployment completed. 627 */ 628 CompletedAt?: Iso8601DateTime; 629 } 630 export interface DeploymentEvent { 631 /** 632 * The type of deployment event. Deployment event types include the start, stop, or completion of a deployment; a percentage update; the start or stop of a bake period; the start or completion of a rollback. 633 */ 634 EventType?: DeploymentEventType; 635 /** 636 * The entity that triggered the deployment event. Events can be triggered by a user, AWS AppConfig, an Amazon CloudWatch alarm, or an internal error. 637 */ 638 TriggeredBy?: TriggeredBy; 639 /** 640 * A description of the deployment event. Descriptions include, but are not limited to, the user account or the CloudWatch alarm ARN that initiated a rollback, the percentage of hosts that received the deployment, or in the case of an internal error, a recommendation to attempt a new deployment. 641 */ 642 Description?: Description; 643 /** 644 * The date and time the event occurred. 645 */ 646 OccurredAt?: Iso8601DateTime; 647 } 648 export type DeploymentEventType = "PERCENTAGE_UPDATED"|"ROLLBACK_STARTED"|"ROLLBACK_COMPLETED"|"BAKE_TIME_STARTED"|"DEPLOYMENT_STARTED"|"DEPLOYMENT_COMPLETED"|string; 649 export type DeploymentEvents = DeploymentEvent[]; 650 export type DeploymentList = DeploymentSummary[]; 651 export type DeploymentState = "BAKING"|"VALIDATING"|"DEPLOYING"|"COMPLETE"|"ROLLING_BACK"|"ROLLED_BACK"|string; 652 export interface DeploymentStrategies { 653 /** 654 * The elements from this collection. 655 */ 656 Items?: DeploymentStrategyList; 657 /** 658 * The token for the next set of items to return. Use this token to get the next set of results. 659 */ 660 NextToken?: NextToken; 661 } 662 export interface DeploymentStrategy { 663 /** 664 * The deployment strategy ID. 665 */ 666 Id?: Id; 667 /** 668 * The name of the deployment strategy. 669 */ 670 Name?: Name; 671 /** 672 * The description of the deployment strategy. 673 */ 674 Description?: Description; 675 /** 676 * Total amount of time the deployment lasted. 677 */ 678 DeploymentDurationInMinutes?: MinutesBetween0And24Hours; 679 /** 680 * The algorithm used to define how percentage grew over time. 681 */ 682 GrowthType?: GrowthType; 683 /** 684 * The percentage of targets that received a deployed configuration during each interval. 685 */ 686 GrowthFactor?: Percentage; 687 /** 688 * The amount of time AppConfig monitored for alarms before considering the deployment to be complete and no longer eligible for automatic roll back. 689 */ 690 FinalBakeTimeInMinutes?: MinutesBetween0And24Hours; 691 /** 692 * Save the deployment strategy to a Systems Manager (SSM) document. 693 */ 694 ReplicateTo?: ReplicateTo; 695 } 696 export type DeploymentStrategyId = string; 697 export type DeploymentStrategyList = DeploymentStrategy[]; 698 export interface DeploymentSummary { 699 /** 700 * The sequence number of the deployment. 701 */ 702 DeploymentNumber?: Integer; 703 /** 704 * The name of the configuration. 705 */ 706 ConfigurationName?: Name; 707 /** 708 * The version of the configuration. 709 */ 710 ConfigurationVersion?: Version; 711 /** 712 * Total amount of time the deployment lasted. 713 */ 714 DeploymentDurationInMinutes?: MinutesBetween0And24Hours; 715 /** 716 * The algorithm used to define how percentage grows over time. 717 */ 718 GrowthType?: GrowthType; 719 /** 720 * The percentage of targets to receive a deployed configuration during each interval. 721 */ 722 GrowthFactor?: Percentage; 723 /** 724 * The amount of time AppConfig monitors for alarms before considering the deployment to be complete and no longer eligible for automatic roll back. 725 */ 726 FinalBakeTimeInMinutes?: MinutesBetween0And24Hours; 727 /** 728 * The state of the deployment. 729 */ 730 State?: DeploymentState; 731 /** 732 * The percentage of targets for which the deployment is available. 733 */ 734 PercentageComplete?: Percentage; 735 /** 736 * Time the deployment started. 737 */ 738 StartedAt?: Iso8601DateTime; 739 /** 740 * Time the deployment completed. 741 */ 742 CompletedAt?: Iso8601DateTime; 743 } 744 export interface Deployments { 745 /** 746 * The elements from this collection. 747 */ 748 Items?: DeploymentList; 749 /** 750 * The token for the next set of items to return. Use this token to get the next set of results. 751 */ 752 NextToken?: NextToken; 753 } 754 export type Description = string; 755 export interface Environment { 756 /** 757 * The application ID. 758 */ 759 ApplicationId?: Id; 760 /** 761 * The environment ID. 762 */ 763 Id?: Id; 764 /** 765 * The name of the environment. 766 */ 767 Name?: Name; 768 /** 769 * The description of the environment. 770 */ 771 Description?: Description; 772 /** 773 * The state of the environment. An environment can be in one of the following states: READY_FOR_DEPLOYMENT, DEPLOYING, ROLLING_BACK, or ROLLED_BACK 774 */ 775 State?: EnvironmentState; 776 /** 777 * Amazon CloudWatch alarms monitored during the deployment. 778 */ 779 Monitors?: MonitorList; 780 } 781 export type EnvironmentList = Environment[]; 782 export type EnvironmentState = "READY_FOR_DEPLOYMENT"|"DEPLOYING"|"ROLLING_BACK"|"ROLLED_BACK"|string; 783 export interface Environments { 784 /** 785 * The elements from this collection. 786 */ 787 Items?: EnvironmentList; 788 /** 789 * The token for the next set of items to return. Use this token to get the next set of results. 790 */ 791 NextToken?: NextToken; 792 } 793 export interface GetApplicationRequest { 794 /** 795 * The ID of the application you want to get. 796 */ 797 ApplicationId: Id; 798 } 799 export interface GetConfigurationProfileRequest { 800 /** 801 * The ID of the application that includes the configuration profile you want to get. 802 */ 803 ApplicationId: Id; 804 /** 805 * The ID of the configuration profile you want to get. 806 */ 807 ConfigurationProfileId: Id; 808 } 809 export interface GetConfigurationRequest { 810 /** 811 * The application to get. Specify either the application name or the application ID. 812 */ 813 Application: StringWithLengthBetween1And64; 814 /** 815 * The environment to get. Specify either the environment name or the environment ID. 816 */ 817 Environment: StringWithLengthBetween1And64; 818 /** 819 * The configuration to get. Specify either the configuration name or the configuration ID. 820 */ 821 Configuration: StringWithLengthBetween1And64; 822 /** 823 * A unique ID to identify the client for the configuration. This ID enables AppConfig to deploy the configuration in intervals, as defined in the deployment strategy. 824 */ 825 ClientId: StringWithLengthBetween1And64; 826 /** 827 * The configuration version returned in the most recent GetConfiguration response. 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. For more information about working with configurations, see Retrieving the Configuration in the AWS AppConfig User Guide. 828 */ 829 ClientConfigurationVersion?: Version; 830 } 831 export interface GetDeploymentRequest { 832 /** 833 * The ID of the application that includes the deployment you want to get. 834 */ 835 ApplicationId: Id; 836 /** 837 * The ID of the environment that includes the deployment you want to get. 838 */ 839 EnvironmentId: Id; 840 /** 841 * The sequence number of the deployment. 842 */ 843 DeploymentNumber: Integer; 844 } 845 export interface GetDeploymentStrategyRequest { 846 /** 847 * The ID of the deployment strategy to get. 848 */ 849 DeploymentStrategyId: DeploymentStrategyId; 850 } 851 export interface GetEnvironmentRequest { 852 /** 853 * The ID of the application that includes the environment you want to get. 854 */ 855 ApplicationId: Id; 856 /** 857 * The ID of the environment you wnat to get. 858 */ 859 EnvironmentId: Id; 860 } 861 export interface GetHostedConfigurationVersionRequest { 862 /** 863 * The application ID. 864 */ 865 ApplicationId: Id; 866 /** 867 * The configuration profile ID. 868 */ 869 ConfigurationProfileId: Id; 870 /** 871 * The version. 872 */ 873 VersionNumber: Integer; 874 } 875 export type GrowthFactor = number; 876 export type GrowthType = "LINEAR"|"EXPONENTIAL"|string; 877 export interface HostedConfigurationVersion { 878 /** 879 * The application ID. 880 */ 881 ApplicationId?: Id; 882 /** 883 * The configuration profile ID. 884 */ 885 ConfigurationProfileId?: Id; 886 /** 887 * The configuration version. 888 */ 889 VersionNumber?: Integer; 890 /** 891 * A description of the configuration. 892 */ 893 Description?: Description; 894 /** 895 * The content of the configuration or the configuration data. 896 */ 897 Content?: _Blob; 898 /** 899 * A standard MIME type describing the format of the configuration content. For more information, see Content-Type. 900 */ 901 ContentType?: StringWithLengthBetween1And255; 902 } 903 export interface HostedConfigurationVersionSummary { 904 /** 905 * The application ID. 906 */ 907 ApplicationId?: Id; 908 /** 909 * The configuration profile ID. 910 */ 911 ConfigurationProfileId?: Id; 912 /** 913 * The configuration version. 914 */ 915 VersionNumber?: Integer; 916 /** 917 * A description of the configuration. 918 */ 919 Description?: Description; 920 /** 921 * A standard MIME type describing the format of the configuration content. For more information, see Content-Type. 922 */ 923 ContentType?: StringWithLengthBetween1And255; 924 } 925 export type HostedConfigurationVersionSummaryList = HostedConfigurationVersionSummary[]; 926 export interface HostedConfigurationVersions { 927 /** 928 * The elements from this collection. 929 */ 930 Items?: HostedConfigurationVersionSummaryList; 931 /** 932 * The token for the next set of items to return. Use this token to get the next set of results. 933 */ 934 NextToken?: NextToken; 935 } 936 export type Id = string; 937 export type Integer = number; 938 export type Iso8601DateTime = Date; 939 export interface ListApplicationsRequest { 940 /** 941 * The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. 942 */ 943 MaxResults?: MaxResults; 944 /** 945 * A token to start the list. Use this token to get the next set of results. 946 */ 947 NextToken?: NextToken; 948 } 949 export interface ListConfigurationProfilesRequest { 950 /** 951 * The application ID. 952 */ 953 ApplicationId: Id; 954 /** 955 * The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. 956 */ 957 MaxResults?: MaxResults; 958 /** 959 * A token to start the list. Use this token to get the next set of results. 960 */ 961 NextToken?: NextToken; 962 } 963 export interface ListDeploymentStrategiesRequest { 964 /** 965 * The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. 966 */ 967 MaxResults?: MaxResults; 968 /** 969 * A token to start the list. Use this token to get the next set of results. 970 */ 971 NextToken?: NextToken; 972 } 973 export interface ListDeploymentsRequest { 974 /** 975 * The application ID. 976 */ 977 ApplicationId: Id; 978 /** 979 * The environment ID. 980 */ 981 EnvironmentId: Id; 982 /** 983 * The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. 984 */ 985 MaxResults?: MaxResults; 986 /** 987 * A token to start the list. Use this token to get the next set of results. 988 */ 989 NextToken?: NextToken; 990 } 991 export interface ListEnvironmentsRequest { 992 /** 993 * The application ID. 994 */ 995 ApplicationId: Id; 996 /** 997 * The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. 998 */ 999 MaxResults?: MaxResults; 1000 /** 1001 * A token to start the list. Use this token to get the next set of results. 1002 */ 1003 NextToken?: NextToken; 1004 } 1005 export interface ListHostedConfigurationVersionsRequest { 1006 /** 1007 * The application ID. 1008 */ 1009 ApplicationId: Id; 1010 /** 1011 * The configuration profile ID. 1012 */ 1013 ConfigurationProfileId: Id; 1014 /** 1015 * The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. 1016 */ 1017 MaxResults?: MaxResults; 1018 /** 1019 * A token to start the list. Use this token to get the next set of results. 1020 */ 1021 NextToken?: NextToken; 1022 } 1023 export interface ListTagsForResourceRequest { 1024 /** 1025 * The resource ARN. 1026 */ 1027 ResourceArn: Arn; 1028 } 1029 export type MaxResults = number; 1030 export type MinutesBetween0And24Hours = number; 1031 export interface Monitor { 1032 /** 1033 * ARN of the Amazon CloudWatch alarm. 1034 */ 1035 AlarmArn?: Arn; 1036 /** 1037 * ARN of an IAM role for AppConfig to monitor AlarmArn. 1038 */ 1039 AlarmRoleArn?: RoleArn; 1040 } 1041 export type MonitorList = Monitor[]; 1042 export type Name = string; 1043 export type NextToken = string; 1044 export type Percentage = number; 1045 export type ReplicateTo = "NONE"|"SSM_DOCUMENT"|string; 1046 export interface ResourceTags { 1047 /** 1048 * Metadata to assign to AppConfig resources. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define. 1049 */ 1050 Tags?: TagMap; 1051 } 1052 export type RoleArn = string; 1053 export interface StartDeploymentRequest { 1054 /** 1055 * The application ID. 1056 */ 1057 ApplicationId: Id; 1058 /** 1059 * The environment ID. 1060 */ 1061 EnvironmentId: Id; 1062 /** 1063 * The deployment strategy ID. 1064 */ 1065 DeploymentStrategyId: DeploymentStrategyId; 1066 /** 1067 * The configuration profile ID. 1068 */ 1069 ConfigurationProfileId: Id; 1070 /** 1071 * The configuration version to deploy. 1072 */ 1073 ConfigurationVersion: Version; 1074 /** 1075 * A description of the deployment. 1076 */ 1077 Description?: Description; 1078 /** 1079 * Metadata to assign to the deployment. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define. 1080 */ 1081 Tags?: TagMap; 1082 } 1083 export interface StopDeploymentRequest { 1084 /** 1085 * The application ID. 1086 */ 1087 ApplicationId: Id; 1088 /** 1089 * The environment ID. 1090 */ 1091 EnvironmentId: Id; 1092 /** 1093 * The sequence number of the deployment. 1094 */ 1095 DeploymentNumber: Integer; 1096 } 1097 export type String = string; 1098 export type StringWithLengthBetween0And32768 = string; 1099 export type StringWithLengthBetween1And255 = string; 1100 export type StringWithLengthBetween1And64 = string; 1101 export type TagKey = string; 1102 export type TagKeyList = TagKey[]; 1103 export type TagMap = {[key: string]: TagValue}; 1104 export interface TagResourceRequest { 1105 /** 1106 * The ARN of the resource for which to retrieve tags. 1107 */ 1108 ResourceArn: Arn; 1109 /** 1110 * The key-value string map. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters. 1111 */ 1112 Tags: TagMap; 1113 } 1114 export type TagValue = string; 1115 export type TriggeredBy = "USER"|"APPCONFIG"|"CLOUDWATCH_ALARM"|"INTERNAL_ERROR"|string; 1116 export interface UntagResourceRequest { 1117 /** 1118 * The ARN of the resource for which to remove tags. 1119 */ 1120 ResourceArn: Arn; 1121 /** 1122 * The tag keys to delete. 1123 */ 1124 TagKeys: TagKeyList; 1125 } 1126 export interface UpdateApplicationRequest { 1127 /** 1128 * The application ID. 1129 */ 1130 ApplicationId: Id; 1131 /** 1132 * The name of the application. 1133 */ 1134 Name?: Name; 1135 /** 1136 * A description of the application. 1137 */ 1138 Description?: Description; 1139 } 1140 export interface UpdateConfigurationProfileRequest { 1141 /** 1142 * The application ID. 1143 */ 1144 ApplicationId: Id; 1145 /** 1146 * The ID of the configuration profile. 1147 */ 1148 ConfigurationProfileId: Id; 1149 /** 1150 * The name of the configuration profile. 1151 */ 1152 Name?: Name; 1153 /** 1154 * A description of the configuration profile. 1155 */ 1156 Description?: Description; 1157 /** 1158 * The ARN of an IAM role with permission to access the configuration at the specified LocationUri. 1159 */ 1160 RetrievalRoleArn?: RoleArn; 1161 /** 1162 * A list of methods for validating the configuration. 1163 */ 1164 Validators?: ValidatorList; 1165 } 1166 export interface UpdateDeploymentStrategyRequest { 1167 /** 1168 * The deployment strategy ID. 1169 */ 1170 DeploymentStrategyId: DeploymentStrategyId; 1171 /** 1172 * A description of the deployment strategy. 1173 */ 1174 Description?: Description; 1175 /** 1176 * Total amount of time for a deployment to last. 1177 */ 1178 DeploymentDurationInMinutes?: MinutesBetween0And24Hours; 1179 /** 1180 * The amount of time AppConfig monitors for alarms before considering the deployment to be complete and no longer eligible for automatic roll back. 1181 */ 1182 FinalBakeTimeInMinutes?: MinutesBetween0And24Hours; 1183 /** 1184 * The percentage of targets to receive a deployed configuration during each interval. 1185 */ 1186 GrowthFactor?: GrowthFactor; 1187 /** 1188 * The algorithm used to define how percentage grows over time. AWS AppConfig supports the following growth types: Linear: For this type, AppConfig processes the deployment by increments of the growth factor evenly distributed over the deployment time. For example, a linear deployment that uses a growth factor of 20 initially makes the configuration available to 20 percent of the targets. After 1/5th of the deployment time has passed, the system updates the percentage to 40 percent. This continues until 100% of the targets are set to receive the deployed configuration. Exponential: For this type, AppConfig processes the deployment exponentially using the following formula: G*(2^N). In this formula, G is the growth factor specified by the user and N is the number of steps until the configuration is deployed to all targets. For example, if you specify a growth factor of 2, then the system rolls out the configuration as follows: 2*(2^0) 2*(2^1) 2*(2^2) Expressed numerically, the deployment rolls out as follows: 2% of the targets, 4% of the targets, 8% of the targets, and continues until the configuration has been deployed to all targets. 1189 */ 1190 GrowthType?: GrowthType; 1191 } 1192 export interface UpdateEnvironmentRequest { 1193 /** 1194 * The application ID. 1195 */ 1196 ApplicationId: Id; 1197 /** 1198 * The environment ID. 1199 */ 1200 EnvironmentId: Id; 1201 /** 1202 * The name of the environment. 1203 */ 1204 Name?: Name; 1205 /** 1206 * A description of the environment. 1207 */ 1208 Description?: Description; 1209 /** 1210 * Amazon CloudWatch alarms to monitor during the deployment process. 1211 */ 1212 Monitors?: MonitorList; 1213 } 1214 export type Uri = string; 1215 export interface ValidateConfigurationRequest { 1216 /** 1217 * The application ID. 1218 */ 1219 ApplicationId: Id; 1220 /** 1221 * The configuration profile ID. 1222 */ 1223 ConfigurationProfileId: Id; 1224 /** 1225 * The version of the configuration to validate. 1226 */ 1227 ConfigurationVersion: Version; 1228 } 1229 export interface Validator { 1230 /** 1231 * AppConfig supports validators of type JSON_SCHEMA and LAMBDA 1232 */ 1233 Type: ValidatorType; 1234 /** 1235 * Either the JSON Schema content or the Amazon Resource Name (ARN) of an AWS Lambda function. 1236 */ 1237 Content: StringWithLengthBetween0And32768; 1238 } 1239 export type ValidatorList = Validator[]; 1240 export type ValidatorType = "JSON_SCHEMA"|"LAMBDA"|string; 1241 export type ValidatorTypeList = ValidatorType[]; 1242 export type Version = string; 1243 /** 1244 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. 1245 */ 1246 export type apiVersion = "2019-10-09"|"latest"|string; 1247 export interface ClientApiVersions { 1248 /** 1249 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. 1250 */ 1251 apiVersion?: apiVersion; 1252 } 1253 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; 1254 /** 1255 * Contains interfaces for use with the AppConfig client. 1256 */ 1257 export import Types = AppConfig; 1258 } 1259 export = AppConfig;