You are viewing the documentation for an older major version of the AWS SDK for JavaScript.
The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

Class: AWS.AppConfig

Inherits:
AWS.Service show all
Identifier:
appconfig
API Version:
2019-10-09
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

Use AppConfig, a capability of Amazon Web Services Systems Manager, to create, manage, and quickly deploy application configurations. AppConfig supports controlled deployments to applications of any size and includes built-in validation checks and monitoring. You can use AppConfig with applications hosted on Amazon EC2 instances, Lambda, containers, mobile applications, or IoT devices.

To prevent errors when deploying application configurations, especially for production systems where a simple typo could cause an unexpected outage, AppConfig includes validators. A validator provides a syntactic or semantic check to ensure that the configuration you want to deploy works as intended. To validate your application configuration data, you provide a schema or a Lambda function that runs against the configuration. The configuration deployment or update can only proceed when the configuration data is valid.

During a configuration deployment, AppConfig monitors the application to ensure that the deployment is successful. If the system encounters an error, AppConfig rolls back the change to minimize impact for your application users. You can configure a deployment strategy for each application or environment that includes deployment criteria, including velocity, bake time, and alarms to monitor. Similar to error monitoring, if a deployment triggers an alarm, AppConfig automatically rolls back to the previous version.

AppConfig supports multiple use cases. Here are some examples:

  • Application tuning: Use AppConfig to carefully introduce changes to your application that can only be tested with production traffic.

  • Feature toggle: Use AppConfig to turn on new features that require a timely deployment, such as a product launch or announcement.

  • Allow list: Use AppConfig to allow premium subscribers to access paid content.

  • Operational issues: Use AppConfig to reduce stress on your application when a dependency or other external factor impacts the system.

This reference is intended to be used with the AppConfig User Guide.

Sending a Request Using AppConfig

var appconfig = new AWS.AppConfig();
appconfig.createApplication(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the AppConfig object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var appconfig = new AWS.AppConfig({apiVersion: '2019-10-09'});

You can also set the API version globally in AWS.config.apiVersions using the appconfig service identifier:

AWS.config.apiVersions = {
  appconfig: '2019-10-09',
  // other service API versions
};

var appconfig = new AWS.AppConfig();

Version:

  • 2019-10-09

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.AppConfig(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a AppConfig object

var appconfig = new AWS.AppConfig({apiVersion: '2019-10-09'});

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.AppConfig.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.AppConfig.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.AppConfig.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional')

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean)

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean)

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean)

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined)

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number)

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean)

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional')

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

  • useFipsEndpoint (Boolean)

    Enables FIPS compatible endpoints. Defaults to false.

  • useDualstackEndpoint (Boolean)

    Enables IPv6 dualstack endpoint. Defaults to false.

Property Details

endpointAWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

createApplication(params = {}, callback) ⇒ AWS.Request

Creates an application. 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 Lambda, or any system you run on behalf of others.

Service Reference:

Examples:

To create an application


/* The following create-application example creates an application in AWS AppConfig. */

 var params = {
  Description: "An application used for creating an example.", 
  Name: "example-application"
 };
 appconfig.createApplication(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Description: "An application used for creating an example.", 
    Id: "339ohji", 
    Name: "example-application"
   }
   */
 });

Calling the createApplication operation

var params = {
  Name: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
appconfig.createApplication(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Name — (String)

      A name for the application.

    • Description — (String)

      A description of the application.

    • Tags — (map<String>)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Id — (String)

        The application ID.

      • Name — (String)

        The application name.

      • Description — (String)

        The description of the application.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createConfigurationProfile(params = {}, callback) ⇒ AWS.Request

Creates a configuration profile, which is information that enables AppConfig to access the configuration source. Valid configuration sources include the AppConfig hosted configuration store, Amazon Web Services Systems Manager (SSM) documents, SSM Parameter Store parameters, Amazon S3 objects, or any integration source action supported by CodePipeline. A configuration profile includes the following information:

  • The URI location of the configuration data.

  • The Identity and Access Management (IAM) role that provides access to the configuration data.

  • A validator for the configuration data. Available validators include either a JSON Schema or an Lambda function.

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

Service Reference:

Examples:

To create a configuration profile


/* The following create-configuration-profile example creates a configuration profile using a configuration stored in Parameter Store, a capability of Systems Manager. */

 var params = {
  ApplicationId: "339ohji", 
  LocationUri: "ssm-parameter://Example-Parameter", 
  Name: "Example-Configuration-Profile", 
  RetrievalRoleArn: "arn:aws:iam::111122223333:role/Example-App-Config-Role"
 };
 appconfig.createConfigurationProfile(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ApplicationId: "339ohji", 
    Id: "ur8hx2f", 
    LocationUri: "ssm-parameter://Example-Parameter", 
    Name: "Example-Configuration-Profile", 
    RetrievalRoleArn: "arn:aws:iam::111122223333:role/Example-App-Config-Role"
   }
   */
 });

Calling the createConfigurationProfile operation

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  LocationUri: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  RetrievalRoleArn: 'STRING_VALUE',
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  },
  Type: 'STRING_VALUE',
  Validators: [
    {
      Content: 'STRING_VALUE', /* required */
      Type: JSON_SCHEMA | LAMBDA /* required */
    },
    /* more items */
  ]
};
appconfig.createConfigurationProfile(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ApplicationId — (String)

      The application ID.

    • Name — (String)

      A name for the configuration profile.

    • Description — (String)

      A description of the configuration profile.

    • LocationUri — (String)

      A URI to locate the configuration. You can specify the AppConfig hosted configuration store, Systems Manager (SSM) document, an SSM Parameter Store parameter, or an Amazon S3 object. For the hosted configuration store and for feature flags, specify hosted. 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

    • RetrievalRoleArn — (String)

      The ARN of an IAM role with permission to access the configuration at the specified LocationUri.

      A retrieval role ARN is not required for configurations stored in the AppConfig hosted configuration store. It is required for all other sources that store your configuration.

    • Validators — (Array<map>)

      A list of methods for validating the configuration.

      • Typerequired — (String)

        AppConfig supports validators of type JSON_SCHEMA and LAMBDA

        Possible values include:
        • "JSON_SCHEMA"
        • "LAMBDA"
      • Contentrequired — (String)

        Either the JSON Schema content or the Amazon Resource Name (ARN) of an Lambda function.

    • Tags — (map<String>)

      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.

    • Type — (String)

      The type of configurations that the configuration profile contains. A configuration can be a feature flag used for enabling or disabling new features or a free-form configuration used for distributing configurations to your application.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ApplicationId — (String)

        The application ID.

      • Id — (String)

        The configuration profile ID.

      • Name — (String)

        The name of the configuration profile.

      • Description — (String)

        The configuration profile description.

      • LocationUri — (String)

        The URI location of the configuration.

      • RetrievalRoleArn — (String)

        The ARN of an IAM role with permission to access the configuration at the specified LocationUri.

      • Validators — (Array<map>)

        A list of methods for validating the configuration.

        • Typerequired — (String)

          AppConfig supports validators of type JSON_SCHEMA and LAMBDA

          Possible values include:
          • "JSON_SCHEMA"
          • "LAMBDA"
        • Contentrequired — (String)

          Either the JSON Schema content or the Amazon Resource Name (ARN) of an Lambda function.

      • Type — (String)

        The type of configurations that the configuration profile contains. A configuration can be a feature flag used for enabling or disabling new features or a free-form configuration used for distributing configurations to your application.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createDeploymentStrategy(params = {}, callback) ⇒ AWS.Request

Creates a deployment strategy that defines important criteria for rolling out your configuration to the designated targets. A deployment strategy includes the overall duration required, a percentage of targets to receive the deployment during each interval, an algorithm that defines how percentage grows, and bake time.

Service Reference:

Examples:

To create a deployment strategy


/* The following create-deployment-strategy example creates a deployment strategy called Example-Deployment that takes 15 minutes and deploys the configuration to 25% of the application at a time. The strategy is also copied to an SSM Document. */

 var params = {
  DeploymentDurationInMinutes: 15, 
  GrowthFactor: 25, 
  Name: "Example-Deployment", 
  ReplicateTo: "SSM_DOCUMENT"
 };
 appconfig.createDeploymentStrategy(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    DeploymentDurationInMinutes: 15, 
    FinalBakeTimeInMinutes: 0, 
    GrowthFactor: 25, 
    GrowthType: "LINEAR", 
    Id: "1225qzk", 
    Name: "Example-Deployment", 
    ReplicateTo: "SSM_DOCUMENT"
   }
   */
 });

Calling the createDeploymentStrategy operation

var params = {
  DeploymentDurationInMinutes: 'NUMBER_VALUE', /* required */
  GrowthFactor: 'NUMBER_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  ReplicateTo: NONE | SSM_DOCUMENT, /* required */
  Description: 'STRING_VALUE',
  FinalBakeTimeInMinutes: 'NUMBER_VALUE',
  GrowthType: LINEAR | EXPONENTIAL,
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
appconfig.createDeploymentStrategy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Name — (String)

      A name for the deployment strategy.

    • Description — (String)

      A description of the deployment strategy.

    • DeploymentDurationInMinutes — (Integer)

      Total amount of time for a deployment to last.

    • FinalBakeTimeInMinutes — (Integer)

      The amount of time AppConfig monitors for alarms before considering the deployment to be complete and no longer eligible for automatic roll back.

    • GrowthFactor — (Float)

      The percentage of targets to receive a deployed configuration during each interval.

    • GrowthType — (String)

      The algorithm used to define how percentage grows over time. 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*(2N). 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*(20)

      2*(21)

      2*(22)

      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.

      Possible values include:
      • "LINEAR"
      • "EXPONENTIAL"
    • ReplicateTo — (String)

      Save the deployment strategy to a Systems Manager (SSM) document.

      Possible values include:
      • "NONE"
      • "SSM_DOCUMENT"
    • Tags — (map<String>)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Id — (String)

        The deployment strategy ID.

      • Name — (String)

        The name of the deployment strategy.

      • Description — (String)

        The description of the deployment strategy.

      • DeploymentDurationInMinutes — (Integer)

        Total amount of time the deployment lasted.

      • GrowthType — (String)

        The algorithm used to define how percentage grew over time.

        Possible values include:
        • "LINEAR"
        • "EXPONENTIAL"
      • GrowthFactor — (Float)

        The percentage of targets that received a deployed configuration during each interval.

      • FinalBakeTimeInMinutes — (Integer)

        The amount of time that AppConfig monitored for alarms before considering the deployment to be complete and no longer eligible for automatic rollback.

      • ReplicateTo — (String)

        Save the deployment strategy to a Systems Manager (SSM) document.

        Possible values include:
        • "NONE"
        • "SSM_DOCUMENT"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createEnvironment(params = {}, callback) ⇒ AWS.Request

Creates an environment. 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.

Service Reference:

Examples:

To create an environment


/* The following create-environment example creates an AWS AppConfig environment named Example-Environment using the application you created using create-application */

 var params = {
  ApplicationId: "339ohji", 
  Name: "Example-Environment"
 };
 appconfig.createEnvironment(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ApplicationId: "339ohji", 
    Id: "54j1r29", 
    Name: "Example-Environment", 
    State: "READY_FOR_DEPLOYMENT"
   }
   */
 });

Calling the createEnvironment operation

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  Monitors: [
    {
      AlarmArn: 'STRING_VALUE', /* required */
      AlarmRoleArn: 'STRING_VALUE'
    },
    /* more items */
  ],
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
appconfig.createEnvironment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ApplicationId — (String)

      The application ID.

    • Name — (String)

      A name for the environment.

    • Description — (String)

      A description of the environment.

    • Monitors — (Array<map>)

      Amazon CloudWatch alarms to monitor during the deployment process.

      • AlarmArnrequired — (String)

        Amazon Resource Name (ARN) of the Amazon CloudWatch alarm.

      • AlarmRoleArn — (String)

        ARN of an Identity and Access Management (IAM) role for AppConfig to monitor AlarmArn.

    • Tags — (map<String>)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ApplicationId — (String)

        The application ID.

      • Id — (String)

        The environment ID.

      • Name — (String)

        The name of the environment.

      • Description — (String)

        The description of the environment.

      • State — (String)

        The state of the environment. An environment can be in one of the following states: READY_FOR_DEPLOYMENT, DEPLOYING, ROLLING_BACK, or ROLLED_BACK

        Possible values include:
        • "READY_FOR_DEPLOYMENT"
        • "DEPLOYING"
        • "ROLLING_BACK"
        • "ROLLED_BACK"
      • Monitors — (Array<map>)

        Amazon CloudWatch alarms monitored during the deployment.

        • AlarmArnrequired — (String)

          Amazon Resource Name (ARN) of the Amazon CloudWatch alarm.

        • AlarmRoleArn — (String)

          ARN of an Identity and Access Management (IAM) role for AppConfig to monitor AlarmArn.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createHostedConfigurationVersion(params = {}, callback) ⇒ AWS.Request

Creates a new configuration in the AppConfig hosted configuration store.

Examples:

To create a hosted configuration version


/* The following create-hosted-configuration-version example creates a new configuration in the AWS AppConfig configuration store. */

 var params = {
  ApplicationId: "339ohji", 
  ConfigurationProfileId: "ur8hx2f", 
  Content: <Binary String>, 
  ContentType: "text", 
  LatestVersionNumber: 1
 };
 appconfig.createHostedConfigurationVersion(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ApplicationId: "339ohji", 
    ConfigurationProfileId: "ur8hx2f", 
    ContentType: "text", 
    VersionNumber: 1
   }
   */
 });

Calling the createHostedConfigurationVersion operation

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  ConfigurationProfileId: 'STRING_VALUE', /* required */
  Content: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */, /* required */
  ContentType: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  LatestVersionNumber: 'NUMBER_VALUE'
};
appconfig.createHostedConfigurationVersion(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ApplicationId — (String)

      The application ID.

    • ConfigurationProfileId — (String)

      The configuration profile ID.

    • Description — (String)

      A description of the configuration.

    • Content — (Buffer, Typed Array, Blob, String)

      The content of the configuration or the configuration data.

    • ContentType — (String)

      A standard MIME type describing the format of the configuration content. For more information, see Content-Type.

    • LatestVersionNumber — (Integer)

      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 number of the latest hosted configuration version.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ApplicationId — (String)

        The application ID.

      • ConfigurationProfileId — (String)

        The configuration profile ID.

      • VersionNumber — (Integer)

        The configuration version.

      • Description — (String)

        A description of the configuration.

      • Content — (Buffer(Node.js), Typed Array(Browser))

        The content of the configuration or the configuration data.

      • ContentType — (String)

        A standard MIME type describing the format of the configuration content. For more information, see Content-Type.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteApplication(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

To delete an application


/* The following delete-application example deletes the specified application. 
*/

 var params = {
  ApplicationId: "339ohji"
 };
 appconfig.deleteApplication(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the deleteApplication operation

var params = {
  ApplicationId: 'STRING_VALUE' /* required */
};
appconfig.deleteApplication(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ApplicationId — (String)

      The ID of the application to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteConfigurationProfile(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

To delete a configuration profile


/* The following delete-configuration-profile example deletes the specified configuration profile. */

 var params = {
  ApplicationId: "339ohji", 
  ConfigurationProfileId: "ur8hx2f"
 };
 appconfig.deleteConfigurationProfile(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the deleteConfigurationProfile operation

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  ConfigurationProfileId: 'STRING_VALUE' /* required */
};
appconfig.deleteConfigurationProfile(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ApplicationId — (String)

      The application ID that includes the configuration profile you want to delete.

    • ConfigurationProfileId — (String)

      The ID of the configuration profile you want to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteDeploymentStrategy(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

To delete a deployment strategy


/* The following delete-deployment-strategy example deletes the specified deployment strategy. */

 var params = {
  DeploymentStrategyId: "1225qzk"
 };
 appconfig.deleteDeploymentStrategy(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the deleteDeploymentStrategy operation

var params = {
  DeploymentStrategyId: 'STRING_VALUE' /* required */
};
appconfig.deleteDeploymentStrategy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • DeploymentStrategyId — (String)

      The ID of the deployment strategy you want to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteEnvironment(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

To delete an environment


/* The following delete-environment example deletes the specified application environment. */

 var params = {
  ApplicationId: "339ohji", 
  EnvironmentId: "54j1r29"
 };
 appconfig.deleteEnvironment(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the deleteEnvironment operation

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  EnvironmentId: 'STRING_VALUE' /* required */
};
appconfig.deleteEnvironment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ApplicationId — (String)

      The application ID that includes the environment that you want to delete.

    • EnvironmentId — (String)

      The ID of the environment that you want to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteHostedConfigurationVersion(params = {}, callback) ⇒ AWS.Request

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

Examples:

To delete a hosted configuration version


/* The following delete-hosted-configuration-version example deletes a configuration version hosted in the AWS AppConfig configuration store. */

 var params = {
  ApplicationId: "339ohji", 
  ConfigurationProfileId: "ur8hx2f", 
  VersionNumber: 1
 };
 appconfig.deleteHostedConfigurationVersion(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the deleteHostedConfigurationVersion operation

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  ConfigurationProfileId: 'STRING_VALUE', /* required */
  VersionNumber: 'NUMBER_VALUE' /* required */
};
appconfig.deleteHostedConfigurationVersion(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ApplicationId — (String)

      The application ID.

    • ConfigurationProfileId — (String)

      The configuration profile ID.

    • VersionNumber — (Integer)

      The versions number to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getApplication(params = {}, callback) ⇒ AWS.Request

Retrieves information about an application.

Service Reference:

Examples:

To list details of an application


/* The following get-application example lists the details of the specified application. */

 var params = {
  ApplicationId: "339ohji"
 };
 appconfig.getApplication(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Id: "339ohji", 
    Name: "example-application"
   }
   */
 });

Calling the getApplication operation

var params = {
  ApplicationId: 'STRING_VALUE' /* required */
};
appconfig.getApplication(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ApplicationId — (String)

      The ID of the application you want to get.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Id — (String)

        The application ID.

      • Name — (String)

        The application name.

      • Description — (String)

        The description of the application.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getConfiguration(params = {}, callback) ⇒ AWS.Request

Retrieves information about a configuration.

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.

Service Reference:

Examples:

To retrieve configuration details


/* The following get-configuration example returns the configuration details of the example application. On subsequent calls to get-configuration, use the client-configuration-version parameter to only update the configuration of your application if the version has changed. Only updating the configuration when the version has changed avoids excess charges incurred by calling get-configuration. */

 var params = {
  Application: "example-application", 
  ClientId: "example-id", 
  Configuration: "Example-Configuration-Profile", 
  Environment: "Example-Environment"
 };
 appconfig.getConfiguration(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ConfigurationVersion: "1", 
    ContentType: "application/octet-stream"
   }
   */
 });

Calling the getConfiguration operation

var params = {
  Application: 'STRING_VALUE', /* required */
  ClientId: 'STRING_VALUE', /* required */
  Configuration: 'STRING_VALUE', /* required */
  Environment: 'STRING_VALUE', /* required */
  ClientConfigurationVersion: 'STRING_VALUE'
};
appconfig.getConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Application — (String)

      The application to get. Specify either the application name or the application ID.

    • Environment — (String)

      The environment to get. Specify either the environment name or the environment ID.

    • Configuration — (String)

      The configuration to get. Specify either the configuration name or the configuration ID.

    • ClientId — (String)

      The clientId parameter in the following command is a unique, user-specified ID to identify the client for the configuration. This ID enables AppConfig to deploy the configuration in intervals, as defined in the deployment strategy.

    • ClientConfigurationVersion — (String)

      The configuration version returned in the most recent GetConfiguration response.

      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 AppConfig User Guide.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Content — (Buffer(Node.js), Typed Array(Browser))

        The content of the configuration or the configuration data.

        Compare the configuration version numbers of the configuration cached locally on your machine and the configuration number in the the header. If the configuration numbers are the same, the content can be ignored. The Content section only appears if the system finds new or updated configuration data. If the system doesn't find new or updated configuration data, then the Content section is not returned.

      • ConfigurationVersion — (String)

        The configuration version.

      • ContentType — (String)

        A standard MIME type describing the format of the configuration content. For more information, see Content-Type.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getConfigurationProfile(params = {}, callback) ⇒ AWS.Request

Retrieves information about a configuration profile.

Service Reference:

Examples:

To retrieve configuration profile details


/* The following get-configuration-profile example returns the details of the specified configuration profile. */

 var params = {
  ApplicationId: "339ohji", 
  ConfigurationProfileId: "ur8hx2f"
 };
 appconfig.getConfigurationProfile(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ApplicationId: "339ohji", 
    Id: "ur8hx2f", 
    LocationUri: "ssm-parameter://Example-Parameter", 
    Name: "Example-Configuration-Profile", 
    RetrievalRoleArn: "arn:aws:iam::111122223333:role/Example-App-Config-Role"
   }
   */
 });

Calling the getConfigurationProfile operation

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  ConfigurationProfileId: 'STRING_VALUE' /* required */
};
appconfig.getConfigurationProfile(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ApplicationId — (String)

      The ID of the application that includes the configuration profile you want to get.

    • ConfigurationProfileId — (String)

      The ID of the configuration profile that you want to get.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ApplicationId — (String)

        The application ID.

      • Id — (String)

        The configuration profile ID.

      • Name — (String)

        The name of the configuration profile.

      • Description — (String)

        The configuration profile description.

      • LocationUri — (String)

        The URI location of the configuration.

      • RetrievalRoleArn — (String)

        The ARN of an IAM role with permission to access the configuration at the specified LocationUri.

      • Validators — (Array<map>)

        A list of methods for validating the configuration.

        • Typerequired — (String)

          AppConfig supports validators of type JSON_SCHEMA and LAMBDA

          Possible values include:
          • "JSON_SCHEMA"
          • "LAMBDA"
        • Contentrequired — (String)

          Either the JSON Schema content or the Amazon Resource Name (ARN) of an Lambda function.

      • Type — (String)

        The type of configurations that the configuration profile contains. A configuration can be a feature flag used for enabling or disabling new features or a free-form configuration used for distributing configurations to your application.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getDeployment(params = {}, callback) ⇒ AWS.Request

Retrieves information about a configuration deployment.

Service Reference:

Examples:

To retrieve deployment details


/* The following get-deployment example lists details of the deployment to the application in the specified environment and deployment. */

 var params = {
  ApplicationId: "339ohji", 
  DeploymentNumber: 1, 
  EnvironmentId: "54j1r29"
 };
 appconfig.getDeployment(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ApplicationId: "339ohji", 
    CompletedAt: <Date Representation>, 
    ConfigurationLocationUri: "ssm-parameter://Example-Parameter", 
    ConfigurationName: "Example-Configuration-Profile", 
    ConfigurationProfileId: "ur8hx2f", 
    ConfigurationVersion: "1", 
    DeploymentDurationInMinutes: 15, 
    DeploymentNumber: 1, 
    DeploymentStrategyId: "1225qzk", 
    EnvironmentId: "54j1r29", 
    EventLog: [
       {
      Description: "Deployment completed", 
      EventType: "DEPLOYMENT_COMPLETED", 
      OccurredAt: <Date Representation>, 
      TriggeredBy: "APPCONFIG"
     }, 
       {
      Description: "Deployment bake time started", 
      EventType: "BAKE_TIME_STARTED", 
      OccurredAt: <Date Representation>, 
      TriggeredBy: "APPCONFIG"
     }, 
       {
      Description: "Configuration available to 100.00% of clients", 
      EventType: "PERCENTAGE_UPDATED", 
      OccurredAt: <Date Representation>, 
      TriggeredBy: "APPCONFIG"
     }, 
       {
      Description: "Configuration available to 75.00% of clients", 
      EventType: "PERCENTAGE_UPDATED", 
      OccurredAt: <Date Representation>, 
      TriggeredBy: "APPCONFIG"
     }, 
       {
      Description: "Configuration available to 50.00% of clients", 
      EventType: "PERCENTAGE_UPDATED", 
      OccurredAt: <Date Representation>, 
      TriggeredBy: "APPCONFIG"
     }, 
       {
      Description: "Configuration available to 25.00% of clients", 
      EventType: "PERCENTAGE_UPDATED", 
      OccurredAt: <Date Representation>, 
      TriggeredBy: "APPCONFIG"
     }, 
       {
      Description: "Deployment started", 
      EventType: "DEPLOYMENT_STARTED", 
      OccurredAt: <Date Representation>, 
      TriggeredBy: "USER"
     }
    ], 
    FinalBakeTimeInMinutes: 0, 
    GrowthFactor: 25, 
    GrowthType: "LINEAR", 
    PercentageComplete: 100, 
    StartedAt: <Date Representation>, 
    State: "COMPLETE"
   }
   */
 });

Calling the getDeployment operation

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  DeploymentNumber: 'NUMBER_VALUE', /* required */
  EnvironmentId: 'STRING_VALUE' /* required */
};
appconfig.getDeployment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ApplicationId — (String)

      The ID of the application that includes the deployment you want to get.

    • EnvironmentId — (String)

      The ID of the environment that includes the deployment you want to get.

    • DeploymentNumber — (Integer)

      The sequence number of the deployment.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ApplicationId — (String)

        The ID of the application that was deployed.

      • EnvironmentId — (String)

        The ID of the environment that was deployed.

      • DeploymentStrategyId — (String)

        The ID of the deployment strategy that was deployed.

      • ConfigurationProfileId — (String)

        The ID of the configuration profile that was deployed.

      • DeploymentNumber — (Integer)

        The sequence number of the deployment.

      • ConfigurationName — (String)

        The name of the configuration.

      • ConfigurationLocationUri — (String)

        Information about the source location of the configuration.

      • ConfigurationVersion — (String)

        The configuration version that was deployed.

      • Description — (String)

        The description of the deployment.

      • DeploymentDurationInMinutes — (Integer)

        Total amount of time the deployment lasted.

      • GrowthType — (String)

        The algorithm used to define how percentage grew over time.

        Possible values include:
        • "LINEAR"
        • "EXPONENTIAL"
      • GrowthFactor — (Float)

        The percentage of targets to receive a deployed configuration during each interval.

      • FinalBakeTimeInMinutes — (Integer)

        The amount of time that AppConfig monitored for alarms before considering the deployment to be complete and no longer eligible for automatic rollback.

      • State — (String)

        The state of the deployment.

        Possible values include:
        • "BAKING"
        • "VALIDATING"
        • "DEPLOYING"
        • "COMPLETE"
        • "ROLLING_BACK"
        • "ROLLED_BACK"
      • EventLog — (Array<map>)

        A list containing all events related to a deployment. The most recent events are displayed first.

        • EventType — (String)

          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; and the start or completion of a rollback.

          Possible values include:
          • "PERCENTAGE_UPDATED"
          • "ROLLBACK_STARTED"
          • "ROLLBACK_COMPLETED"
          • "BAKE_TIME_STARTED"
          • "DEPLOYMENT_STARTED"
          • "DEPLOYMENT_COMPLETED"
        • TriggeredBy — (String)

          The entity that triggered the deployment event. Events can be triggered by a user, AppConfig, an Amazon CloudWatch alarm, or an internal error.

          Possible values include:
          • "USER"
          • "APPCONFIG"
          • "CLOUDWATCH_ALARM"
          • "INTERNAL_ERROR"
        • Description — (String)

          A description of the deployment event. Descriptions include, but are not limited to, the user account or the Amazon 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.

        • OccurredAt — (Date)

          The date and time the event occurred.

      • PercentageComplete — (Float)

        The percentage of targets for which the deployment is available.

      • StartedAt — (Date)

        The time the deployment started.

      • CompletedAt — (Date)

        The time the deployment completed.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getDeploymentStrategy(params = {}, callback) ⇒ AWS.Request

Retrieves information about a deployment strategy. A deployment strategy defines important criteria for rolling out your configuration to the designated targets. A deployment strategy includes the overall duration required, a percentage of targets to receive the deployment during each interval, an algorithm that defines how percentage grows, and bake time.

Service Reference:

Examples:

To retrieve details of a deployment strategy


/* The following get-deployment-strategy example lists the details of the specified deployment strategy. */

 var params = {
  DeploymentStrategyId: "1225qzk"
 };
 appconfig.getDeploymentStrategy(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    DeploymentDurationInMinutes: 15, 
    FinalBakeTimeInMinutes: 0, 
    GrowthFactor: 25, 
    GrowthType: "LINEAR", 
    Id: "1225qzk", 
    Name: "Example-Deployment", 
    ReplicateTo: "SSM_DOCUMENT"
   }
   */
 });

Calling the getDeploymentStrategy operation

var params = {
  DeploymentStrategyId: 'STRING_VALUE' /* required */
};
appconfig.getDeploymentStrategy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • DeploymentStrategyId — (String)

      The ID of the deployment strategy to get.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Id — (String)

        The deployment strategy ID.

      • Name — (String)

        The name of the deployment strategy.

      • Description — (String)

        The description of the deployment strategy.

      • DeploymentDurationInMinutes — (Integer)

        Total amount of time the deployment lasted.

      • GrowthType — (String)

        The algorithm used to define how percentage grew over time.

        Possible values include:
        • "LINEAR"
        • "EXPONENTIAL"
      • GrowthFactor — (Float)

        The percentage of targets that received a deployed configuration during each interval.

      • FinalBakeTimeInMinutes — (Integer)

        The amount of time that AppConfig monitored for alarms before considering the deployment to be complete and no longer eligible for automatic rollback.

      • ReplicateTo — (String)

        Save the deployment strategy to a Systems Manager (SSM) document.

        Possible values include:
        • "NONE"
        • "SSM_DOCUMENT"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getEnvironment(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

To retrieve environment details


/* The following get-environment example returns the details and state of the specified environment. */

 var params = {
  ApplicationId: "339ohji", 
  EnvironmentId: "54j1r29"
 };
 appconfig.getEnvironment(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ApplicationId: "339ohji", 
    Id: "54j1r29", 
    Name: "Example-Environment", 
    State: "READY_FOR_DEPLOYMENT"
   }
   */
 });

Calling the getEnvironment operation

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  EnvironmentId: 'STRING_VALUE' /* required */
};
appconfig.getEnvironment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ApplicationId — (String)

      The ID of the application that includes the environment you want to get.

    • EnvironmentId — (String)

      The ID of the environment that you want to get.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ApplicationId — (String)

        The application ID.

      • Id — (String)

        The environment ID.

      • Name — (String)

        The name of the environment.

      • Description — (String)

        The description of the environment.

      • State — (String)

        The state of the environment. An environment can be in one of the following states: READY_FOR_DEPLOYMENT, DEPLOYING, ROLLING_BACK, or ROLLED_BACK

        Possible values include:
        • "READY_FOR_DEPLOYMENT"
        • "DEPLOYING"
        • "ROLLING_BACK"
        • "ROLLED_BACK"
      • Monitors — (Array<map>)

        Amazon CloudWatch alarms monitored during the deployment.

        • AlarmArnrequired — (String)

          Amazon Resource Name (ARN) of the Amazon CloudWatch alarm.

        • AlarmRoleArn — (String)

          ARN of an Identity and Access Management (IAM) role for AppConfig to monitor AlarmArn.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getHostedConfigurationVersion(params = {}, callback) ⇒ AWS.Request

Retrieves information about a specific configuration version.

Service Reference:

Examples:

To retrieve hosted configuration details


/* The following get-hosted-configuration-version example retrieves the configuration details of the AWS AppConfig hosted configuration. */

 var params = {
  ApplicationId: "339ohji", 
  ConfigurationProfileId: "ur8hx2f", 
  VersionNumber: 1
 };
 appconfig.getHostedConfigurationVersion(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ApplicationId: "339ohji", 
    ConfigurationProfileId: "ur8hx2f", 
    ContentType: "application/json", 
    VersionNumber: 1
   }
   */
 });

Calling the getHostedConfigurationVersion operation

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  ConfigurationProfileId: 'STRING_VALUE', /* required */
  VersionNumber: 'NUMBER_VALUE' /* required */
};
appconfig.getHostedConfigurationVersion(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ApplicationId — (String)

      The application ID.

    • ConfigurationProfileId — (String)

      The configuration profile ID.

    • VersionNumber — (Integer)

      The version.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ApplicationId — (String)

        The application ID.

      • ConfigurationProfileId — (String)

        The configuration profile ID.

      • VersionNumber — (Integer)

        The configuration version.

      • Description — (String)

        A description of the configuration.

      • Content — (Buffer(Node.js), Typed Array(Browser))

        The content of the configuration or the configuration data.

      • ContentType — (String)

        A standard MIME type describing the format of the configuration content. For more information, see Content-Type.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listApplications(params = {}, callback) ⇒ AWS.Request

Lists all applications in your Amazon Web Services account.

Service Reference:

Examples:

To list the available applications


/* The following list-applications example lists the available applications in your AWS account. */

 var params = {
 };
 appconfig.listApplications(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Items: [
       {
      Description: "An application used for creating an example.", 
      Id: "339ohji", 
      Name: "test-application"
     }, 
       {
      Id: "rwalwu7", 
      Name: "Test-Application"
     }
    ]
   }
   */
 });

Calling the listApplications operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
appconfig.listApplications(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • MaxResults — (Integer)

      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.

    • NextToken — (String)

      A token to start the list. Next token is a pagination token generated by AppConfig to describe what page the previous List call ended on. For the first List request, the nextToken should not be set. On subsequent calls, the nextToken parameter should be set to the previous responses nextToken value. Use this token to get the next set of results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Items — (Array<map>)

        The elements from this collection.

        • Id — (String)

          The application ID.

        • Name — (String)

          The application name.

        • Description — (String)

          The description of the application.

      • NextToken — (String)

        The token for the next set of items to return. Use this token to get the next set of results.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listConfigurationProfiles(params = {}, callback) ⇒ AWS.Request

Lists the configuration profiles for an application.

Service Reference:

Examples:

To list the available configuration profiles


/* The following list-configuration-profiles example lists the available configuration profiles for the specified application. */

 var params = {
  ApplicationId: "339ohji"
 };
 appconfig.listConfigurationProfiles(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Items: [
       {
      ApplicationId: "339ohji", 
      Id: "ur8hx2f", 
      LocationUri: "ssm-parameter://Example-Parameter", 
      Name: "Example-Configuration-Profile"
     }
    ]
   }
   */
 });

Calling the listConfigurationProfiles operation

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  Type: 'STRING_VALUE'
};
appconfig.listConfigurationProfiles(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ApplicationId — (String)

      The application ID.

    • MaxResults — (Integer)

      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.

    • NextToken — (String)

      A token to start the list. Use this token to get the next set of results.

    • Type — (String)

      A filter based on the type of configurations that the configuration profile contains. A configuration can be a feature flag or a free-form configuration.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Items — (Array<map>)

        The elements from this collection.

        • ApplicationId — (String)

          The application ID.

        • Id — (String)

          The ID of the configuration profile.

        • Name — (String)

          The name of the configuration profile.

        • LocationUri — (String)

          The URI location of the configuration.

        • ValidatorTypes — (Array<String>)

          The types of validators in the configuration profile.

        • Type — (String)

          The type of configurations that the configuration profile contains. A configuration can be a feature flag used for enabling or disabling new features or a free-form configuration used to introduce changes to your application.

      • NextToken — (String)

        The token for the next set of items to return. Use this token to get the next set of results.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listDeployments(params = {}, callback) ⇒ AWS.Request

Lists the deployments for an environment.

Service Reference:

Examples:

To list the available deployments


/* The following list-deployments example lists the available deployments in your AWS account for the specified application and environment. */

 var params = {
  ApplicationId: "339ohji", 
  EnvironmentId: "54j1r29"
 };
 appconfig.listDeployments(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Items: [
       {
      CompletedAt: <Date Representation>, 
      ConfigurationName: "Example-Configuration-Profile", 
      ConfigurationVersion: "1", 
      DeploymentDurationInMinutes: 15, 
      DeploymentNumber: 1, 
      FinalBakeTimeInMinutes: 0, 
      GrowthFactor: 25, 
      GrowthType: "LINEAR", 
      PercentageComplete: 100, 
      StartedAt: <Date Representation>, 
      State: "COMPLETE"
     }
    ]
   }
   */
 });

Calling the listDeployments operation

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  EnvironmentId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
appconfig.listDeployments(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ApplicationId — (String)

      The application ID.

    • EnvironmentId — (String)

      The environment ID.

    • MaxResults — (Integer)

      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.

    • NextToken — (String)

      A token to start the list. Use this token to get the next set of results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Items — (Array<map>)

        The elements from this collection.

        • DeploymentNumber — (Integer)

          The sequence number of the deployment.

        • ConfigurationName — (String)

          The name of the configuration.

        • ConfigurationVersion — (String)

          The version of the configuration.

        • DeploymentDurationInMinutes — (Integer)

          Total amount of time the deployment lasted.

        • GrowthType — (String)

          The algorithm used to define how percentage grows over time.

          Possible values include:
          • "LINEAR"
          • "EXPONENTIAL"
        • GrowthFactor — (Float)

          The percentage of targets to receive a deployed configuration during each interval.

        • FinalBakeTimeInMinutes — (Integer)

          The amount of time that AppConfig monitors for alarms before considering the deployment to be complete and no longer eligible for automatic rollback.

        • State — (String)

          The state of the deployment.

          Possible values include:
          • "BAKING"
          • "VALIDATING"
          • "DEPLOYING"
          • "COMPLETE"
          • "ROLLING_BACK"
          • "ROLLED_BACK"
        • PercentageComplete — (Float)

          The percentage of targets for which the deployment is available.

        • StartedAt — (Date)

          Time the deployment started.

        • CompletedAt — (Date)

          Time the deployment completed.

      • NextToken — (String)

        The token for the next set of items to return. Use this token to get the next set of results.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listDeploymentStrategies(params = {}, callback) ⇒ AWS.Request

Lists deployment strategies.

Service Reference:

Examples:

To list the available deployment strategies


/* The following list-deployment-strategies example lists the available deployment strategies in your AWS account. */

 var params = {
 };
 appconfig.listDeploymentStrategies(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Items: [
       {
      DeploymentDurationInMinutes: 15, 
      FinalBakeTimeInMinutes: 0, 
      GrowthFactor: 25, 
      GrowthType: "LINEAR", 
      Id: "1225qzk", 
      Name: "Example-Deployment", 
      ReplicateTo: "SSM_DOCUMENT"
     }
    ]
   }
   */
 });

Calling the listDeploymentStrategies operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
appconfig.listDeploymentStrategies(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • MaxResults — (Integer)

      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.

    • NextToken — (String)

      A token to start the list. Use this token to get the next set of results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Items — (Array<map>)

        The elements from this collection.

        • Id — (String)

          The deployment strategy ID.

        • Name — (String)

          The name of the deployment strategy.

        • Description — (String)

          The description of the deployment strategy.

        • DeploymentDurationInMinutes — (Integer)

          Total amount of time the deployment lasted.

        • GrowthType — (String)

          The algorithm used to define how percentage grew over time.

          Possible values include:
          • "LINEAR"
          • "EXPONENTIAL"
        • GrowthFactor — (Float)

          The percentage of targets that received a deployed configuration during each interval.

        • FinalBakeTimeInMinutes — (Integer)

          The amount of time that AppConfig monitored for alarms before considering the deployment to be complete and no longer eligible for automatic rollback.

        • ReplicateTo — (String)

          Save the deployment strategy to a Systems Manager (SSM) document.

          Possible values include:
          • "NONE"
          • "SSM_DOCUMENT"
      • NextToken — (String)

        The token for the next set of items to return. Use this token to get the next set of results.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listEnvironments(params = {}, callback) ⇒ AWS.Request

Lists the environments for an application.

Service Reference:

Examples:

To list the available environments


/* The following list-environments example lists the available environments in your AWS account for the specified application. */

 var params = {
  ApplicationId: "339ohji"
 };
 appconfig.listEnvironments(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Items: [
       {
      ApplicationId: "339ohji", 
      Id: "54j1r29", 
      Name: "Example-Environment", 
      State: "READY_FOR_DEPLOYMENT"
     }
    ]
   }
   */
 });

Calling the listEnvironments operation

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
appconfig.listEnvironments(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ApplicationId — (String)

      The application ID.

    • MaxResults — (Integer)

      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.

    • NextToken — (String)

      A token to start the list. Use this token to get the next set of results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Items — (Array<map>)

        The elements from this collection.

        • ApplicationId — (String)

          The application ID.

        • Id — (String)

          The environment ID.

        • Name — (String)

          The name of the environment.

        • Description — (String)

          The description of the environment.

        • State — (String)

          The state of the environment. An environment can be in one of the following states: READY_FOR_DEPLOYMENT, DEPLOYING, ROLLING_BACK, or ROLLED_BACK

          Possible values include:
          • "READY_FOR_DEPLOYMENT"
          • "DEPLOYING"
          • "ROLLING_BACK"
          • "ROLLED_BACK"
        • Monitors — (Array<map>)

          Amazon CloudWatch alarms monitored during the deployment.

          • AlarmArnrequired — (String)

            Amazon Resource Name (ARN) of the Amazon CloudWatch alarm.

          • AlarmRoleArn — (String)

            ARN of an Identity and Access Management (IAM) role for AppConfig to monitor AlarmArn.

      • NextToken — (String)

        The token for the next set of items to return. Use this token to get the next set of results.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listHostedConfigurationVersions(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

To list the available hosted configuration versions


/* The following list-hosted-configuration-versions example lists the configurations versions hosted in the AWS AppConfig hosted configuration store for the specified application and configuration profile. */

 var params = {
  ApplicationId: "339ohji", 
  ConfigurationProfileId: "ur8hx2f"
 };
 appconfig.listHostedConfigurationVersions(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Items: [
       {
      ApplicationId: "339ohji", 
      ConfigurationProfileId: "ur8hx2f", 
      ContentType: "application/json", 
      VersionNumber: 1
     }
    ]
   }
   */
 });

Calling the listHostedConfigurationVersions operation

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  ConfigurationProfileId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
appconfig.listHostedConfigurationVersions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ApplicationId — (String)

      The application ID.

    • ConfigurationProfileId — (String)

      The configuration profile ID.

    • MaxResults — (Integer)

      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.

    • NextToken — (String)

      A token to start the list. Use this token to get the next set of results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Items — (Array<map>)

        The elements from this collection.

        • ApplicationId — (String)

          The application ID.

        • ConfigurationProfileId — (String)

          The configuration profile ID.

        • VersionNumber — (Integer)

          The configuration version.

        • Description — (String)

          A description of the configuration.

        • ContentType — (String)

          A standard MIME type describing the format of the configuration content. For more information, see Content-Type.

      • NextToken — (String)

        The token for the next set of items to return. Use this token to get the next set of results.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

To list the tags of an application


/* The following list-tags-for-resource example lists the tags of a specified application. */

 var params = {
  ResourceArn: "arn:aws:appconfig:us-east-1:111122223333:application/339ohji"
 };
 appconfig.listTagsForResource(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Tags: {
     "group1": "1"
    }
   }
   */
 });

Calling the listTagsForResource operation

var params = {
  ResourceArn: 'STRING_VALUE' /* required */
};
appconfig.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceArn — (String)

      The resource ARN.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Tags — (map<String>)

        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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

startDeployment(params = {}, callback) ⇒ AWS.Request

Starts a deployment.

Service Reference:

Examples:

To start a configuration deployment


/* The following start-deployment example starts a deployment to the application using the specified environment, deployment strategy, and configuration profile. */

 var params = {
  ApplicationId: "339ohji", 
  ConfigurationProfileId: "ur8hx2f", 
  ConfigurationVersion: "1", 
  DeploymentStrategyId: "1225qzk", 
  Description: "", 
  EnvironmentId: "54j1r29", 
  Tags: {
  }
 };
 appconfig.startDeployment(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ApplicationId: "339ohji", 
    ConfigurationLocationUri: "ssm-parameter://Example-Parameter", 
    ConfigurationName: "Example-Configuration-Profile", 
    ConfigurationProfileId: "ur8hx2f", 
    ConfigurationVersion: "1", 
    DeploymentDurationInMinutes: 15, 
    DeploymentNumber: 1, 
    DeploymentStrategyId: "1225qzk", 
    EnvironmentId: "54j1r29", 
    EventLog: [
       {
      Description: "Deployment started", 
      EventType: "DEPLOYMENT_STARTED", 
      OccurredAt: <Date Representation>, 
      TriggeredBy: "USER"
     }
    ], 
    FinalBakeTimeInMinutes: 0, 
    GrowthFactor: 25, 
    GrowthType: "LINEAR", 
    PercentageComplete: 1.0, 
    StartedAt: <Date Representation>, 
    State: "DEPLOYING"
   }
   */
 });

Calling the startDeployment operation

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  ConfigurationProfileId: 'STRING_VALUE', /* required */
  ConfigurationVersion: 'STRING_VALUE', /* required */
  DeploymentStrategyId: 'STRING_VALUE', /* required */
  EnvironmentId: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
appconfig.startDeployment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ApplicationId — (String)

      The application ID.

    • EnvironmentId — (String)

      The environment ID.

    • DeploymentStrategyId — (String)

      The deployment strategy ID.

    • ConfigurationProfileId — (String)

      The configuration profile ID.

    • ConfigurationVersion — (String)

      The configuration version to deploy.

    • Description — (String)

      A description of the deployment.

    • Tags — (map<String>)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ApplicationId — (String)

        The ID of the application that was deployed.

      • EnvironmentId — (String)

        The ID of the environment that was deployed.

      • DeploymentStrategyId — (String)

        The ID of the deployment strategy that was deployed.

      • ConfigurationProfileId — (String)

        The ID of the configuration profile that was deployed.

      • DeploymentNumber — (Integer)

        The sequence number of the deployment.

      • ConfigurationName — (String)

        The name of the configuration.

      • ConfigurationLocationUri — (String)

        Information about the source location of the configuration.

      • ConfigurationVersion — (String)

        The configuration version that was deployed.

      • Description — (String)

        The description of the deployment.

      • DeploymentDurationInMinutes — (Integer)

        Total amount of time the deployment lasted.

      • GrowthType — (String)

        The algorithm used to define how percentage grew over time.

        Possible values include:
        • "LINEAR"
        • "EXPONENTIAL"
      • GrowthFactor — (Float)

        The percentage of targets to receive a deployed configuration during each interval.

      • FinalBakeTimeInMinutes — (Integer)

        The amount of time that AppConfig monitored for alarms before considering the deployment to be complete and no longer eligible for automatic rollback.

      • State — (String)

        The state of the deployment.

        Possible values include:
        • "BAKING"
        • "VALIDATING"
        • "DEPLOYING"
        • "COMPLETE"
        • "ROLLING_BACK"
        • "ROLLED_BACK"
      • EventLog — (Array<map>)

        A list containing all events related to a deployment. The most recent events are displayed first.

        • EventType — (String)

          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; and the start or completion of a rollback.

          Possible values include:
          • "PERCENTAGE_UPDATED"
          • "ROLLBACK_STARTED"
          • "ROLLBACK_COMPLETED"
          • "BAKE_TIME_STARTED"
          • "DEPLOYMENT_STARTED"
          • "DEPLOYMENT_COMPLETED"
        • TriggeredBy — (String)

          The entity that triggered the deployment event. Events can be triggered by a user, AppConfig, an Amazon CloudWatch alarm, or an internal error.

          Possible values include:
          • "USER"
          • "APPCONFIG"
          • "CLOUDWATCH_ALARM"
          • "INTERNAL_ERROR"
        • Description — (String)

          A description of the deployment event. Descriptions include, but are not limited to, the user account or the Amazon 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.

        • OccurredAt — (Date)

          The date and time the event occurred.

      • PercentageComplete — (Float)

        The percentage of targets for which the deployment is available.

      • StartedAt — (Date)

        The time the deployment started.

      • CompletedAt — (Date)

        The time the deployment completed.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

stopDeployment(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

To stop configuration deployment


/* The following stop-deployment example stops the deployment of an application configuration to the specified environment. */

 var params = {
  ApplicationId: "339ohji", 
  DeploymentNumber: 2, 
  EnvironmentId: "54j1r29"
 };
 appconfig.stopDeployment(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    DeploymentDurationInMinutes: 15, 
    DeploymentNumber: 2, 
    FinalBakeTimeInMinutes: 0, 
    GrowthFactor: 25.0, 
    PercentageComplete: 1.0
   }
   */
 });

Calling the stopDeployment operation

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  DeploymentNumber: 'NUMBER_VALUE', /* required */
  EnvironmentId: 'STRING_VALUE' /* required */
};
appconfig.stopDeployment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ApplicationId — (String)

      The application ID.

    • EnvironmentId — (String)

      The environment ID.

    • DeploymentNumber — (Integer)

      The sequence number of the deployment.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ApplicationId — (String)

        The ID of the application that was deployed.

      • EnvironmentId — (String)

        The ID of the environment that was deployed.

      • DeploymentStrategyId — (String)

        The ID of the deployment strategy that was deployed.

      • ConfigurationProfileId — (String)

        The ID of the configuration profile that was deployed.

      • DeploymentNumber — (Integer)

        The sequence number of the deployment.

      • ConfigurationName — (String)

        The name of the configuration.

      • ConfigurationLocationUri — (String)

        Information about the source location of the configuration.

      • ConfigurationVersion — (String)

        The configuration version that was deployed.

      • Description — (String)

        The description of the deployment.

      • DeploymentDurationInMinutes — (Integer)

        Total amount of time the deployment lasted.

      • GrowthType — (String)

        The algorithm used to define how percentage grew over time.

        Possible values include:
        • "LINEAR"
        • "EXPONENTIAL"
      • GrowthFactor — (Float)

        The percentage of targets to receive a deployed configuration during each interval.

      • FinalBakeTimeInMinutes — (Integer)

        The amount of time that AppConfig monitored for alarms before considering the deployment to be complete and no longer eligible for automatic rollback.

      • State — (String)

        The state of the deployment.

        Possible values include:
        • "BAKING"
        • "VALIDATING"
        • "DEPLOYING"
        • "COMPLETE"
        • "ROLLING_BACK"
        • "ROLLED_BACK"
      • EventLog — (Array<map>)

        A list containing all events related to a deployment. The most recent events are displayed first.

        • EventType — (String)

          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; and the start or completion of a rollback.

          Possible values include:
          • "PERCENTAGE_UPDATED"
          • "ROLLBACK_STARTED"
          • "ROLLBACK_COMPLETED"
          • "BAKE_TIME_STARTED"
          • "DEPLOYMENT_STARTED"
          • "DEPLOYMENT_COMPLETED"
        • TriggeredBy — (String)

          The entity that triggered the deployment event. Events can be triggered by a user, AppConfig, an Amazon CloudWatch alarm, or an internal error.

          Possible values include:
          • "USER"
          • "APPCONFIG"
          • "CLOUDWATCH_ALARM"
          • "INTERNAL_ERROR"
        • Description — (String)

          A description of the deployment event. Descriptions include, but are not limited to, the user account or the Amazon 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.

        • OccurredAt — (Date)

          The date and time the event occurred.

      • PercentageComplete — (Float)

        The percentage of targets for which the deployment is available.

      • StartedAt — (Date)

        The time the deployment started.

      • CompletedAt — (Date)

        The time the deployment completed.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

tagResource(params = {}, callback) ⇒ AWS.Request

Assigns metadata to an AppConfig resource. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define. You can specify a maximum of 50 tags for a resource.

Service Reference:

Examples:

To tag an application


/* The following tag-resource example tags an application resource. */

 var params = {
  ResourceArn: "arn:aws:appconfig:us-east-1:111122223333:application/339ohji", 
  Tags: {
   "group1": "1"
  }
 };
 appconfig.tagResource(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the tagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  Tags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
appconfig.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceArn — (String)

      The ARN of the resource for which to retrieve tags.

    • Tags — (map<String>)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

untagResource(params = {}, callback) ⇒ AWS.Request

Deletes a tag key and value from an AppConfig resource.

Service Reference:

Examples:

To remove a tag from an application


/* The following untag-resource example removes the group1 tag from the specified application. */

 var params = {
  ResourceArn: "arn:aws:appconfig:us-east-1:111122223333:application/339ohji", 
  TagKeys: [
     "group1"
  ]
 };
 appconfig.untagResource(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the untagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
appconfig.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceArn — (String)

      The ARN of the resource for which to remove tags.

    • TagKeys — (Array<String>)

      The tag keys to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateApplication(params = {}, callback) ⇒ AWS.Request

Updates an application.

Service Reference:

Examples:

To update an application


/* The following update-application example updates the name of the specified application. */

 var params = {
  ApplicationId: "339ohji", 
  Description: "", 
  Name: "Example-Application"
 };
 appconfig.updateApplication(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Description: "An application used for creating an example.", 
    Id: "339ohji", 
    Name: "Example-Application"
   }
   */
 });

Calling the updateApplication operation

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  Name: 'STRING_VALUE'
};
appconfig.updateApplication(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ApplicationId — (String)

      The application ID.

    • Name — (String)

      The name of the application.

    • Description — (String)

      A description of the application.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Id — (String)

        The application ID.

      • Name — (String)

        The application name.

      • Description — (String)

        The description of the application.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateConfigurationProfile(params = {}, callback) ⇒ AWS.Request

Updates a configuration profile.

Service Reference:

Examples:

To update a configuration profile


/* The following update-configuration-profile example updates the description of the specified configuration profile. */

 var params = {
  ApplicationId: "339ohji", 
  ConfigurationProfileId: "ur8hx2f", 
  Description: "Configuration profile used for examples."
 };
 appconfig.updateConfigurationProfile(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ApplicationId: "339ohji", 
    Description: "Configuration profile used for examples.", 
    Id: "ur8hx2f", 
    LocationUri: "ssm-parameter://Example-Parameter", 
    Name: "Example-Configuration-Profile", 
    RetrievalRoleArn: "arn:aws:iam::111122223333:role/Example-App-Config-Role"
   }
   */
 });

Calling the updateConfigurationProfile operation

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  ConfigurationProfileId: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  Name: 'STRING_VALUE',
  RetrievalRoleArn: 'STRING_VALUE',
  Validators: [
    {
      Content: 'STRING_VALUE', /* required */
      Type: JSON_SCHEMA | LAMBDA /* required */
    },
    /* more items */
  ]
};
appconfig.updateConfigurationProfile(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ApplicationId — (String)

      The application ID.

    • ConfigurationProfileId — (String)

      The ID of the configuration profile.

    • Name — (String)

      The name of the configuration profile.

    • Description — (String)

      A description of the configuration profile.

    • RetrievalRoleArn — (String)

      The ARN of an IAM role with permission to access the configuration at the specified LocationUri.

    • Validators — (Array<map>)

      A list of methods for validating the configuration.

      • Typerequired — (String)

        AppConfig supports validators of type JSON_SCHEMA and LAMBDA

        Possible values include:
        • "JSON_SCHEMA"
        • "LAMBDA"
      • Contentrequired — (String)

        Either the JSON Schema content or the Amazon Resource Name (ARN) of an Lambda function.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ApplicationId — (String)

        The application ID.

      • Id — (String)

        The configuration profile ID.

      • Name — (String)

        The name of the configuration profile.

      • Description — (String)

        The configuration profile description.

      • LocationUri — (String)

        The URI location of the configuration.

      • RetrievalRoleArn — (String)

        The ARN of an IAM role with permission to access the configuration at the specified LocationUri.

      • Validators — (Array<map>)

        A list of methods for validating the configuration.

        • Typerequired — (String)

          AppConfig supports validators of type JSON_SCHEMA and LAMBDA

          Possible values include:
          • "JSON_SCHEMA"
          • "LAMBDA"
        • Contentrequired — (String)

          Either the JSON Schema content or the Amazon Resource Name (ARN) of an Lambda function.

      • Type — (String)

        The type of configurations that the configuration profile contains. A configuration can be a feature flag used for enabling or disabling new features or a free-form configuration used for distributing configurations to your application.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateDeploymentStrategy(params = {}, callback) ⇒ AWS.Request

Updates a deployment strategy.

Service Reference:

Examples:

To update a deployment strategy


/* The following update-deployment-strategy example updates final bake time to 20 minutes in the specified deployment strategy. ::
*/

 var params = {
  DeploymentStrategyId: "1225qzk", 
  FinalBakeTimeInMinutes: 20
 };
 appconfig.updateDeploymentStrategy(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    DeploymentDurationInMinutes: 15, 
    FinalBakeTimeInMinutes: 20, 
    GrowthFactor: 25, 
    GrowthType: "LINEAR", 
    Id: "1225qzk", 
    Name: "Example-Deployment", 
    ReplicateTo: "SSM_DOCUMENT"
   }
   */
 });

Calling the updateDeploymentStrategy operation

var params = {
  DeploymentStrategyId: 'STRING_VALUE', /* required */
  DeploymentDurationInMinutes: 'NUMBER_VALUE',
  Description: 'STRING_VALUE',
  FinalBakeTimeInMinutes: 'NUMBER_VALUE',
  GrowthFactor: 'NUMBER_VALUE',
  GrowthType: LINEAR | EXPONENTIAL
};
appconfig.updateDeploymentStrategy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • DeploymentStrategyId — (String)

      The deployment strategy ID.

    • Description — (String)

      A description of the deployment strategy.

    • DeploymentDurationInMinutes — (Integer)

      Total amount of time for a deployment to last.

    • FinalBakeTimeInMinutes — (Integer)

      The amount of time that AppConfig monitors for alarms before considering the deployment to be complete and no longer eligible for automatic rollback.

    • GrowthFactor — (Float)

      The percentage of targets to receive a deployed configuration during each interval.

    • GrowthType — (String)

      The algorithm used to define how percentage grows over time. 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*(2N). 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*(20)

      2*(21)

      2*(22)

      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.

      Possible values include:
      • "LINEAR"
      • "EXPONENTIAL"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Id — (String)

        The deployment strategy ID.

      • Name — (String)

        The name of the deployment strategy.

      • Description — (String)

        The description of the deployment strategy.

      • DeploymentDurationInMinutes — (Integer)

        Total amount of time the deployment lasted.

      • GrowthType — (String)

        The algorithm used to define how percentage grew over time.

        Possible values include:
        • "LINEAR"
        • "EXPONENTIAL"
      • GrowthFactor — (Float)

        The percentage of targets that received a deployed configuration during each interval.

      • FinalBakeTimeInMinutes — (Integer)

        The amount of time that AppConfig monitored for alarms before considering the deployment to be complete and no longer eligible for automatic rollback.

      • ReplicateTo — (String)

        Save the deployment strategy to a Systems Manager (SSM) document.

        Possible values include:
        • "NONE"
        • "SSM_DOCUMENT"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateEnvironment(params = {}, callback) ⇒ AWS.Request

Updates an environment.

Service Reference:

Examples:

To update an environment


/* The following update-environment example updates an environment's description. */

 var params = {
  ApplicationId: "339ohji", 
  Description: "An environment for examples.", 
  EnvironmentId: "54j1r29"
 };
 appconfig.updateEnvironment(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ApplicationId: "339ohji", 
    Description: "An environment for examples.", 
    Id: "54j1r29", 
    Name: "Example-Environment", 
    State: "ROLLED_BACK"
   }
   */
 });

Calling the updateEnvironment operation

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  EnvironmentId: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  Monitors: [
    {
      AlarmArn: 'STRING_VALUE', /* required */
      AlarmRoleArn: 'STRING_VALUE'
    },
    /* more items */
  ],
  Name: 'STRING_VALUE'
};
appconfig.updateEnvironment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ApplicationId — (String)

      The application ID.

    • EnvironmentId — (String)

      The environment ID.

    • Name — (String)

      The name of the environment.

    • Description — (String)

      A description of the environment.

    • Monitors — (Array<map>)

      Amazon CloudWatch alarms to monitor during the deployment process.

      • AlarmArnrequired — (String)

        Amazon Resource Name (ARN) of the Amazon CloudWatch alarm.

      • AlarmRoleArn — (String)

        ARN of an Identity and Access Management (IAM) role for AppConfig to monitor AlarmArn.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ApplicationId — (String)

        The application ID.

      • Id — (String)

        The environment ID.

      • Name — (String)

        The name of the environment.

      • Description — (String)

        The description of the environment.

      • State — (String)

        The state of the environment. An environment can be in one of the following states: READY_FOR_DEPLOYMENT, DEPLOYING, ROLLING_BACK, or ROLLED_BACK

        Possible values include:
        • "READY_FOR_DEPLOYMENT"
        • "DEPLOYING"
        • "ROLLING_BACK"
        • "ROLLED_BACK"
      • Monitors — (Array<map>)

        Amazon CloudWatch alarms monitored during the deployment.

        • AlarmArnrequired — (String)

          Amazon Resource Name (ARN) of the Amazon CloudWatch alarm.

        • AlarmRoleArn — (String)

          ARN of an Identity and Access Management (IAM) role for AppConfig to monitor AlarmArn.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

validateConfiguration(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

To validate a configuration


/* The following validate-configuration example uses the validators in a configuration profile to validate a configuration. */

 var params = {
  ApplicationId: "abc1234", 
  ConfigurationProfileId: "ur8hx2f", 
  ConfigurationVersion: "1"
 };
 appconfig.validateConfiguration(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the validateConfiguration operation

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  ConfigurationProfileId: 'STRING_VALUE', /* required */
  ConfigurationVersion: 'STRING_VALUE' /* required */
};
appconfig.validateConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ApplicationId — (String)

      The application ID.

    • ConfigurationProfileId — (String)

      The configuration profile ID.

    • ConfigurationVersion — (String)

      The version of the configuration to validate.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.