Class: AWS.AppConfig

/* 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"
   }
   */
 });

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  LocationUri: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  KmsKeyIdentifier: '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 following:

    • For the AppConfig hosted configuration store and for feature flags, specify hosted.

    • For an Amazon Web Services Systems Manager Parameter Store parameter, specify either the parameter name in the format ssm-parameter://<parameter name> or the ARN.

    • For an Amazon Web Services CodePipeline pipeline, specify the URI in the following format: codepipeline://<pipeline name>.

    • For an Secrets Manager secret, specify the URI in the following format: secretsmanager://<secret name>.

    • 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

    • For an SSM document, specify either the document name in the format ssm-document://<document name> or the Amazon Resource Name (ARN).

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

    • Type — required — (String)

      AppConfig supports validators of type JSON_SCHEMA and LAMBDA

      Possible values include:
      • "JSON_SCHEMA"
      • "LAMBDA"
    • Content — required — (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 contained in the profile. AppConfig supports feature flags and freeform configurations. We recommend you create feature flag configurations to enable or disable new features and freeform configurations to distribute configurations to an application. When calling this API, enter one of the following values for Type:

    AWS.AppConfig.FeatureFlags

    AWS.Freeform

  • KmsKeyIdentifier — (String)

    The identifier for an Key Management Service key to encrypt new configuration data versions in the AppConfig hosted configuration store. This attribute is only used for hosted configuration types. The identifier can be an KMS key ID, alias, or the Amazon Resource Name (ARN) of the key ID or alias. To encrypt data managed in other configuration stores, see the documentation for how to specify an KMS key for that particular service.

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.

      • Type — required — (String)

        AppConfig supports validators of type JSON_SCHEMA and LAMBDA

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

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

    • Type — (String)

      The type of configurations contained in the profile. AppConfig supports feature flags and freeform configurations. We recommend you create feature flag configurations to enable or disable new features and freeform configurations to distribute configurations to an application. When calling this API, enter one of the following values for Type:

      AWS.AppConfig.FeatureFlags

      AWS.Freeform

    • KmsKeyArn — (String)

      The Amazon Resource Name of the Key Management Service key to encrypt new configuration data versions in the AppConfig hosted configuration store. This attribute is only used for hosted configuration types. To encrypt data managed in other configuration stores, see the documentation for how to specify an KMS key for that particular service.

    • KmsKeyIdentifier — (String)

      The Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created or updated.

Returns:

• (AWS.Request) —

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

/* 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"
   }
   */
 });

var params = {
  DeploymentDurationInMinutes: 'NUMBER_VALUE', /* required */
  GrowthFactor: 'NUMBER_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  FinalBakeTimeInMinutes: 'NUMBER_VALUE',
  GrowthType: LINEAR | EXPONENTIAL,
  ReplicateTo: NONE | SSM_DOCUMENT,
  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)

    Specifies the amount of time AppConfig monitors for Amazon CloudWatch alarms after the configuration has been deployed to 100% of its targets, before considering the deployment to be complete. If an alarm is triggered during this time, AppConfig rolls back the deployment. You must configure permissions for AppConfig to roll back based on CloudWatch alarms. For more information, see Configuring permissions for rollback based on Amazon CloudWatch alarms in the AppConfig User Guide.

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

/* 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"
   }
   */
 });

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.

    • AlarmArn — required — (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.

      • AlarmArn — required — (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.

var params = {
  Actions: { /* required */
    '<ActionPoint>': [
      {
        Description: 'STRING_VALUE',
        Name: 'STRING_VALUE',
        RoleArn: 'STRING_VALUE',
        Uri: 'STRING_VALUE'
      },
      /* more items */
    ],
    /* '<ActionPoint>': ... */
  },
  Name: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  LatestVersionNumber: 'NUMBER_VALUE',
  Parameters: {
    '<ExtensionOrParameterName>': {
      Description: 'STRING_VALUE',
      Dynamic: true || false,
      Required: true || false
    },
    /* '<ExtensionOrParameterName>': ... */
  },
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
appconfig.createExtension(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 extension. Each extension name in your account must be unique. Extension versions use the same name.

  • Description — (String)

    Information about the extension.

  • Actions — (map<Array<map>>)

    The actions defined in the extension.

    • Name — (String)

      The action name.

    • Description — (String)

      Information about the action.

    • Uri — (String)

      The extension URI associated to the action point in the extension definition. The URI can be an Amazon Resource Name (ARN) for one of the following: an Lambda function, an Amazon Simple Queue Service queue, an Amazon Simple Notification Service topic, or the Amazon EventBridge default event bus.

    • RoleArn — (String)

      An Amazon Resource Name (ARN) for an Identity and Access Management assume role.

  • Parameters — (map<map>)

    The parameters accepted by the extension. You specify parameter values when you associate the extension to an AppConfig resource by using the CreateExtensionAssociation API action. For Lambda extension actions, these parameters are included in the Lambda request object.

    • Description — (String)

      Information about the parameter.

    • Required — (Boolean)

      A parameter value must be specified in the extension association.

    • Dynamic — (Boolean)

      Indicates whether this parameter's value can be supplied at the extension's action point instead of during extension association. Dynamic parameters can't be marked Required.

  • Tags — (map<String>)

    Adds one or more tags for the specified extension. Tags are metadata that help you categorize resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define.

  • LatestVersionNumber — (Integer)

    You can omit this field when you create an extension. When you create a new version, specify the most recent current version number. For example, you create version 3, enter 2 for this field.

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 system-generated ID of the extension.

    • Name — (String)

      The extension name.

    • VersionNumber — (Integer)

      The extension version number.

    • Arn — (String)

      The system-generated Amazon Resource Name (ARN) for the extension.

    • Description — (String)

      Information about the extension.

    • Actions — (map<Array<map>>)

      The actions defined in the extension.

      • Name — (String)

        The action name.

      • Description — (String)

        Information about the action.

      • Uri — (String)

        The extension URI associated to the action point in the extension definition. The URI can be an Amazon Resource Name (ARN) for one of the following: an Lambda function, an Amazon Simple Queue Service queue, an Amazon Simple Notification Service topic, or the Amazon EventBridge default event bus.

      • RoleArn — (String)

        An Amazon Resource Name (ARN) for an Identity and Access Management assume role.

    • Parameters — (map<map>)

      The parameters accepted by the extension. You specify parameter values when you associate the extension to an AppConfig resource by using the CreateExtensionAssociation API action. For Lambda extension actions, these parameters are included in the Lambda request object.

      • Description — (String)

        Information about the parameter.

      • Required — (Boolean)

        A parameter value must be specified in the extension association.

      • Dynamic — (Boolean)

        Indicates whether this parameter's value can be supplied at the extension's action point instead of during extension association. Dynamic parameters can't be marked Required.

Returns:

• (AWS.Request) —

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

var params = {
  ExtensionIdentifier: 'STRING_VALUE', /* required */
  ResourceIdentifier: 'STRING_VALUE', /* required */
  ExtensionVersionNumber: 'NUMBER_VALUE',
  Parameters: {
    '<ExtensionOrParameterName>': 'STRING_VALUE',
    /* '<ExtensionOrParameterName>': ... */
  },
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
appconfig.createExtensionAssociation(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: {}) —
  • ExtensionIdentifier — (String)

    The name, the ID, or the Amazon Resource Name (ARN) of the extension.

  • ExtensionVersionNumber — (Integer)

    The version number of the extension. If not specified, AppConfig uses the maximum version of the extension.

  • ResourceIdentifier — (String)

    The ARN of an application, configuration profile, or environment.

  • Parameters — (map<String>)

    The parameter names and values defined in the extensions. Extension parameters marked Required must be entered for this field.

  • Tags — (map<String>)

    Adds one or more tags for the specified extension association. Tags are metadata that help you categorize resources in different ways, for example, by purpose, owner, or environment. 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 system-generated ID for the association.

    • ExtensionArn — (String)

      The ARN of the extension defined in the association.

    • ResourceArn — (String)

      The ARNs of applications, configuration profiles, or environments defined in the association.

    • Arn — (String)

      The system-generated Amazon Resource Name (ARN) for the extension.

    • Parameters — (map<String>)

      The parameter names and values defined in the association.

    • ExtensionVersionNumber — (Integer)

      The version number for the extension defined in the association.

Returns:

• (AWS.Request) —

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

/* 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
   }
   */
 });

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',
  VersionLabel: 'STRING_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 configuration data, as bytes.

    Note: AppConfig accepts any type of data, including text formats like JSON or TOML, or binary formats like protocol buffers or compressed 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.

  • VersionLabel — (String)

    An optional, user-defined label for the AppConfig hosted configuration version. This value must contain at least one non-numeric character. For example, "v2.2.0".

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.

    • VersionLabel — (String)

      A user-defined label for an AppConfig hosted configuration version.

    • KmsKeyArn — (String)

      The Amazon Resource Name of the Key Management Service key that was used to encrypt this specific version of the configuration data in the AppConfig hosted configuration store.

Returns:

• (AWS.Request) —

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

/* 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
 });

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.

/* 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
 });

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  ConfigurationProfileId: 'STRING_VALUE', /* required */
  DeletionProtectionCheck: ACCOUNT_DEFAULT | APPLY | BYPASS
};
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.

  • DeletionProtectionCheck — (String)

    A parameter to configure deletion protection. If enabled, deletion protection prevents a user from deleting a configuration profile if your application has called either GetLatestConfiguration or for the configuration profile during the specified interval.

    This parameter supports the following values:

    • BYPASS: Instructs AppConfig to bypass the deletion protection check and delete a configuration profile even if deletion protection would have otherwise prevented it.

    • APPLY: Instructs the deletion protection check to run, even if deletion protection is disabled at the account level. APPLY also forces the deletion protection check to run against resources created in the past hour, which are normally excluded from deletion protection checks.

    • ACCOUNT_DEFAULT: The default setting, which instructs AppConfig to implement the deletion protection value specified in the UpdateAccountSettings API.

    Possible values include:
    • "ACCOUNT_DEFAULT"
    • "APPLY"
    • "BYPASS"

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.

/* 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
 });

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.

/* 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
 });

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  EnvironmentId: 'STRING_VALUE', /* required */
  DeletionProtectionCheck: ACCOUNT_DEFAULT | APPLY | BYPASS
};
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: {}) —
  • EnvironmentId — (String)

    The ID of the environment that you want to delete.

  • ApplicationId — (String)

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

  • DeletionProtectionCheck — (String)

    A parameter to configure deletion protection. If enabled, deletion protection prevents a user from deleting an environment if your application called either GetLatestConfiguration or in the environment during the specified interval.

    This parameter supports the following values:

    • BYPASS: Instructs AppConfig to bypass the deletion protection check and delete a configuration profile even if deletion protection would have otherwise prevented it.

    • APPLY: Instructs the deletion protection check to run, even if deletion protection is disabled at the account level. APPLY also forces the deletion protection check to run against resources created in the past hour, which are normally excluded from deletion protection checks.

    • ACCOUNT_DEFAULT: The default setting, which instructs AppConfig to implement the deletion protection value specified in the UpdateAccountSettings API.

    Possible values include:
    • "ACCOUNT_DEFAULT"
    • "APPLY"
    • "BYPASS"

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.

var params = {
  ExtensionIdentifier: 'STRING_VALUE', /* required */
  VersionNumber: 'NUMBER_VALUE'
};
appconfig.deleteExtension(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: {}) —
  • ExtensionIdentifier — (String)

    The name, ID, or Amazon Resource Name (ARN) of the extension you want to delete.

  • VersionNumber — (Integer)

    A specific version of an extension to delete. If omitted, the highest version is deleted.

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.

var params = {
  ExtensionAssociationId: 'STRING_VALUE' /* required */
};
appconfig.deleteExtensionAssociation(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: {}) —
  • ExtensionAssociationId — (String)

    The ID of the extension association 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.

/* 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
 });

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.

appconfig.getAccountSettings(function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {})

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:

    • DeletionProtection — (map)

      A parameter to configure deletion protection. If enabled, deletion protection prevents a user from deleting a configuration profile or an environment if AppConfig has called either GetLatestConfiguration or for the configuration profile or from the environment during the specified interval. Deletion protection is disabled by default. The default interval for ProtectionPeriodInMinutes is 60.

      • Enabled — (Boolean)

        A parameter that indicates if deletion protection is enabled or not.

      • ProtectionPeriodInMinutes — (Integer)

        The time interval during which AppConfig monitors for calls to GetLatestConfiguration or for a configuration profile or from an environment. AppConfig returns an error if a user calls or for the designated configuration profile or environment. To bypass the error and delete a configuration profile or an environment, specify BYPASS for the DeletionProtectionCheck parameter for either or .

Returns:

• (AWS.Request) —

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

/* 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"
   }
   */
 });

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.

/* 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"
   }
   */
 });

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 you use the StartConfigurationSession and GetLatestConfiguration APIs, which track the client configuration version on your behalf. If you choose to continue using GetConfiguration, we recommend that you include the ClientConfigurationVersion value with every call to GetConfiguration. The value to use for ClientConfigurationVersion comes from the ConfigurationVersion attribute returned by GetConfiguration when there is new or updated data, and should be saved for subsequent calls to GetConfiguration.

    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.

      The Content attribute only contains data if the system finds new or updated configuration data. If there is no new or updated data and ClientConfigurationVersion matches the version of the current configuration, AppConfig returns a 204 No Content HTTP response code and the Content value will be empty.

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

/* 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"
   }
   */
 });

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.

      • Type — required — (String)

        AppConfig supports validators of type JSON_SCHEMA and LAMBDA

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

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

    • Type — (String)

      The type of configurations contained in the profile. AppConfig supports feature flags and freeform configurations. We recommend you create feature flag configurations to enable or disable new features and freeform configurations to distribute configurations to an application. When calling this API, enter one of the following values for Type:

      AWS.AppConfig.FeatureFlags

      AWS.Freeform

    • KmsKeyArn — (String)

      The Amazon Resource Name of the Key Management Service key to encrypt new configuration data versions in the AppConfig hosted configuration store. This attribute is only used for hosted configuration types. To encrypt data managed in other configuration stores, see the documentation for how to specify an KMS key for that particular service.

    • KmsKeyIdentifier — (String)

      The Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created or updated.

Returns:

• (AWS.Request) —

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

/* 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"
   }
   */
 });

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 following:

        • The Amazon Web Services account or the Amazon CloudWatch alarm ARN that initiated a rollback.

        • The percentage of hosts that received the deployment.

        • A recommendation to attempt a new deployment (in the case of an internal error).

      • ActionInvocations — (Array<map>)

        The list of extensions that were invoked as part of the deployment.

        • ExtensionIdentifier — (String)

          The name, the ID, or the Amazon Resource Name (ARN) of the extension.

        • ActionName — (String)

          The name of the action.

        • Uri — (String)

          The extension URI associated to the action point in the extension definition. The URI can be an Amazon Resource Name (ARN) for one of the following: an Lambda function, an Amazon Simple Queue Service queue, an Amazon Simple Notification Service topic, or the Amazon EventBridge default event bus.

        • RoleArn — (String)

          An Amazon Resource Name (ARN) for an Identity and Access Management assume role.

        • ErrorMessage — (String)

          The error message when an extension invocation fails.

        • ErrorCode — (String)

          The error code when an extension invocation fails.

        • InvocationId — (String)

          A system-generated ID for this invocation.

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

    • AppliedExtensions — (Array<map>)

      A list of extensions that were processed as part of the deployment. The extensions that were previously associated to the configuration profile, environment, or the application when StartDeployment was called.

      • ExtensionId — (String)

        The system-generated ID of the extension.

      • ExtensionAssociationId — (String)

        The system-generated ID for the association.

      • VersionNumber — (Integer)

        The extension version number.

      • Parameters — (map<String>)

        One or more parameters for the actions called by the extension.

    • KmsKeyArn — (String)

      The Amazon Resource Name of the Key Management Service key used to encrypt configuration data. You can encrypt secrets stored in Secrets Manager, Amazon Simple Storage Service (Amazon S3) objects encrypted with SSE-KMS, or secure string parameters stored in Amazon Web Services Systems Manager Parameter Store.

    • KmsKeyIdentifier — (String)

      The Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created or updated.

    • VersionLabel — (String)

      A user-defined label for an AppConfig hosted configuration version.

Returns:

• (AWS.Request) —

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

/* 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"
   }
   */
 });

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.

/* 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"
   }
   */
 });

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.

      • AlarmArn — required — (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.

var params = {
  ExtensionIdentifier: 'STRING_VALUE', /* required */
  VersionNumber: 'NUMBER_VALUE'
};
appconfig.getExtension(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: {}) —
  • ExtensionIdentifier — (String)

    The name, the ID, or the Amazon Resource Name (ARN) of the extension.

  • VersionNumber — (Integer)

    The extension version number. If no version number was defined, AppConfig uses the highest 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:

    • Id — (String)

      The system-generated ID of the extension.

    • Name — (String)

      The extension name.

    • VersionNumber — (Integer)

      The extension version number.

    • Arn — (String)

      The system-generated Amazon Resource Name (ARN) for the extension.

    • Description — (String)

      Information about the extension.

    • Actions — (map<Array<map>>)

      The actions defined in the extension.

      • Name — (String)

        The action name.

      • Description — (String)

        Information about the action.

      • Uri — (String)

        The extension URI associated to the action point in the extension definition. The URI can be an Amazon Resource Name (ARN) for one of the following: an Lambda function, an Amazon Simple Queue Service queue, an Amazon Simple Notification Service topic, or the Amazon EventBridge default event bus.

      • RoleArn — (String)

        An Amazon Resource Name (ARN) for an Identity and Access Management assume role.

    • Parameters — (map<map>)

      The parameters accepted by the extension. You specify parameter values when you associate the extension to an AppConfig resource by using the CreateExtensionAssociation API action. For Lambda extension actions, these parameters are included in the Lambda request object.

      • Description — (String)

        Information about the parameter.

      • Required — (Boolean)

        A parameter value must be specified in the extension association.

      • Dynamic — (Boolean)

        Indicates whether this parameter's value can be supplied at the extension's action point instead of during extension association. Dynamic parameters can't be marked Required.

Returns:

• (AWS.Request) —

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

var params = {
  ExtensionAssociationId: 'STRING_VALUE' /* required */
};
appconfig.getExtensionAssociation(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: {}) —
  • ExtensionAssociationId — (String)

    The extension association ID 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 system-generated ID for the association.

    • ExtensionArn — (String)

      The ARN of the extension defined in the association.

    • ResourceArn — (String)

      The ARNs of applications, configuration profiles, or environments defined in the association.

    • Arn — (String)

      The system-generated Amazon Resource Name (ARN) for the extension.

    • Parameters — (map<String>)

      The parameter names and values defined in the association.

    • ExtensionVersionNumber — (Integer)

      The version number for the extension defined in the association.

Returns:

• (AWS.Request) —

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

/* 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
   }
   */
 });

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.

    • VersionLabel — (String)

      A user-defined label for an AppConfig hosted configuration version.

    • KmsKeyArn — (String)

      The Amazon Resource Name of the Key Management Service key that was used to encrypt this specific version of the configuration data in the AppConfig hosted configuration store.

Returns:

• (AWS.Request) —

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

/* 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"
     }
    ]
   }
   */
 });

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.

/* 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"
     }
    ]
   }
   */
 });

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 freeform 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 contained in the profile. AppConfig supports feature flags and freeform configurations. We recommend you create feature flag configurations to enable or disable new features and freeform configurations to distribute configurations to an application. When calling this API, enter one of the following values for Type:

        AWS.AppConfig.FeatureFlags

        AWS.Freeform

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

/* 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"
     }
    ]
   }
   */
 });

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 that may be returned for this call. If there are items that have not yet been returned, the response will include a non-null NextToken that you can provide in a subsequent call to get the next set of results.

  • NextToken — (String)

    The token returned by a prior call to this operation indicating the next set of results to be returned. If not specified, the operation will return the first 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.

      • VersionLabel — (String)

        A user-defined label for an AppConfig hosted configuration version.

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

/* 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"
     }
    ]
   }
   */
 });

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.

/* 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"
     }
    ]
   }
   */
 });

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.

        • AlarmArn — required — (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.

var params = {
  ExtensionIdentifier: 'STRING_VALUE',
  ExtensionVersionNumber: 'NUMBER_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  ResourceIdentifier: 'STRING_VALUE'
};
appconfig.listExtensionAssociations(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: {}) —
  • ResourceIdentifier — (String)

    The ARN of an application, configuration profile, or environment.

  • ExtensionIdentifier — (String)

    The name, the ID, or the Amazon Resource Name (ARN) of the extension.

  • ExtensionVersionNumber — (Integer)

    The version number for the extension defined in the association.

  • 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 or pass null to get the first 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 list of extension associations. Each item represents an extension association to an application, environment, or configuration profile.

      • Id — (String)

        The extension association ID. This ID is used to call other ExtensionAssociation API actions such as GetExtensionAssociation or DeleteExtensionAssociation.

      • ExtensionArn — (String)

        The system-generated Amazon Resource Name (ARN) for the extension.

      • ResourceArn — (String)

        The ARNs of applications, configuration profiles, or environments defined in the association.

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

var params = {
  MaxResults: 'NUMBER_VALUE',
  Name: 'STRING_VALUE',
  NextToken: 'STRING_VALUE'
};
appconfig.listExtensions(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.

  • Name — (String)

    The extension name.

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 list of available extensions. The list includes Amazon Web Services authored and user-created extensions.

      • Id — (String)

        The system-generated ID of the extension.

      • Name — (String)

        The extension name.

      • VersionNumber — (Integer)

        The extension version number.

      • Arn — (String)

        The system-generated Amazon Resource Name (ARN) for the extension.

      • Description — (String)

        Information about the extension.

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

/* 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
     }
    ]
   }
   */
 });

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  ConfigurationProfileId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  VersionLabel: '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.

  • VersionLabel — (String)

    An optional filter that can be used to specify the version label of an AppConfig hosted configuration version. This parameter supports filtering by prefix using a wildcard, for example "v2*". If you don't specify an asterisk at the end of the value, only an exact match is returned.

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.

      • VersionLabel — (String)

        A user-defined label for an AppConfig hosted configuration version.

      • KmsKeyArn — (String)

        The Amazon Resource Name of the Key Management Service key that was used to encrypt this specific version of the configuration data in the AppConfig hosted configuration store.

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

/* 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"
    }
   }
   */
 });

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.

/* 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"
   }
   */
 });

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',
  DynamicExtensionParameters: {
    '<DynamicParameterKey>': 'STRING_VALUE',
    /* '<DynamicParameterKey>': ... */
  },
  KmsKeyIdentifier: '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. If deploying an AppConfig hosted configuration version, you can specify either the version number or version label. For all other configurations, you must specify the version number.

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

  • KmsKeyIdentifier — (String)

    The KMS key identifier (key ID, key alias, or key ARN). AppConfig uses this ID to encrypt the configuration data using a customer managed key.

  • DynamicExtensionParameters — (map<String>)

    A map of dynamic extension parameter names to values to pass to associated extensions with PRE_START_DEPLOYMENT actions.

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 following:

        • The Amazon Web Services account or the Amazon CloudWatch alarm ARN that initiated a rollback.

        • The percentage of hosts that received the deployment.

        • A recommendation to attempt a new deployment (in the case of an internal error).

      • ActionInvocations — (Array<map>)

        The list of extensions that were invoked as part of the deployment.

        • ExtensionIdentifier — (String)

          The name, the ID, or the Amazon Resource Name (ARN) of the extension.

        • ActionName — (String)

          The name of the action.

        • Uri — (String)

          The extension URI associated to the action point in the extension definition. The URI can be an Amazon Resource Name (ARN) for one of the following: an Lambda function, an Amazon Simple Queue Service queue, an Amazon Simple Notification Service topic, or the Amazon EventBridge default event bus.

        • RoleArn — (String)

          An Amazon Resource Name (ARN) for an Identity and Access Management assume role.

        • ErrorMessage — (String)

          The error message when an extension invocation fails.

        • ErrorCode — (String)

          The error code when an extension invocation fails.

        • InvocationId — (String)

          A system-generated ID for this invocation.

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

    • AppliedExtensions — (Array<map>)

      A list of extensions that were processed as part of the deployment. The extensions that were previously associated to the configuration profile, environment, or the application when StartDeployment was called.

      • ExtensionId — (String)

        The system-generated ID of the extension.

      • ExtensionAssociationId — (String)

        The system-generated ID for the association.

      • VersionNumber — (Integer)

        The extension version number.

      • Parameters — (map<String>)

        One or more parameters for the actions called by the extension.

    • KmsKeyArn — (String)

      The Amazon Resource Name of the Key Management Service key used to encrypt configuration data. You can encrypt secrets stored in Secrets Manager, Amazon Simple Storage Service (Amazon S3) objects encrypted with SSE-KMS, or secure string parameters stored in Amazon Web Services Systems Manager Parameter Store.

    • KmsKeyIdentifier — (String)

      The Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created or updated.

    • VersionLabel — (String)

      A user-defined label for an AppConfig hosted configuration version.

Returns:

• (AWS.Request) —

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

/* 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
   }
   */
 });

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 following:

        • The Amazon Web Services account or the Amazon CloudWatch alarm ARN that initiated a rollback.

        • The percentage of hosts that received the deployment.

        • A recommendation to attempt a new deployment (in the case of an internal error).

      • ActionInvocations — (Array<map>)

        The list of extensions that were invoked as part of the deployment.

        • ExtensionIdentifier — (String)

          The name, the ID, or the Amazon Resource Name (ARN) of the extension.

        • ActionName — (String)

          The name of the action.

        • Uri — (String)

          The extension URI associated to the action point in the extension definition. The URI can be an Amazon Resource Name (ARN) for one of the following: an Lambda function, an Amazon Simple Queue Service queue, an Amazon Simple Notification Service topic, or the Amazon EventBridge default event bus.

        • RoleArn — (String)

          An Amazon Resource Name (ARN) for an Identity and Access Management assume role.

        • ErrorMessage — (String)

          The error message when an extension invocation fails.

        • ErrorCode — (String)

          The error code when an extension invocation fails.

        • InvocationId — (String)

          A system-generated ID for this invocation.

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

    • AppliedExtensions — (Array<map>)

      A list of extensions that were processed as part of the deployment. The extensions that were previously associated to the configuration profile, environment, or the application when StartDeployment was called.

      • ExtensionId — (String)

        The system-generated ID of the extension.

      • ExtensionAssociationId — (String)

        The system-generated ID for the association.

      • VersionNumber — (Integer)

        The extension version number.

      • Parameters — (map<String>)

        One or more parameters for the actions called by the extension.

    • KmsKeyArn — (String)

      The Amazon Resource Name of the Key Management Service key used to encrypt configuration data. You can encrypt secrets stored in Secrets Manager, Amazon Simple Storage Service (Amazon S3) objects encrypted with SSE-KMS, or secure string parameters stored in Amazon Web Services Systems Manager Parameter Store.

    • KmsKeyIdentifier — (String)

      The Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created or updated.

    • VersionLabel — (String)

      A user-defined label for an AppConfig hosted configuration version.

Returns:

• (AWS.Request) —

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

/* 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
 });

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.

/* 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
 });

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.

var params = {
  DeletionProtection: {
    Enabled: true || false,
    ProtectionPeriodInMinutes: 'NUMBER_VALUE'
  }
};
appconfig.updateAccountSettings(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: {}) —
  • DeletionProtection — (map)

    A parameter to configure deletion protection. If enabled, deletion protection prevents a user from deleting a configuration profile or an environment if AppConfig has called either GetLatestConfiguration or for the configuration profile or from the environment during the specified interval. Deletion protection is disabled by default. The default interval for ProtectionPeriodInMinutes is 60.

    • Enabled — (Boolean)

      A parameter that indicates if deletion protection is enabled or not.

    • ProtectionPeriodInMinutes — (Integer)

      The time interval during which AppConfig monitors for calls to GetLatestConfiguration or for a configuration profile or from an environment. AppConfig returns an error if a user calls or for the designated configuration profile or environment. To bypass the error and delete a configuration profile or an environment, specify BYPASS for the DeletionProtectionCheck parameter for either or .

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:

    • DeletionProtection — (map)

      A parameter to configure deletion protection. If enabled, deletion protection prevents a user from deleting a configuration profile or an environment if AppConfig has called either GetLatestConfiguration or for the configuration profile or from the environment during the specified interval. Deletion protection is disabled by default. The default interval for ProtectionPeriodInMinutes is 60.

      • Enabled — (Boolean)

        A parameter that indicates if deletion protection is enabled or not.

      • ProtectionPeriodInMinutes — (Integer)

        The time interval during which AppConfig monitors for calls to GetLatestConfiguration or for a configuration profile or from an environment. AppConfig returns an error if a user calls or for the designated configuration profile or environment. To bypass the error and delete a configuration profile or an environment, specify BYPASS for the DeletionProtectionCheck parameter for either or .

Returns:

• (AWS.Request) —

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

/* 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"
   }
   */
 });

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.

/* 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"
   }
   */
 });

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  ConfigurationProfileId: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  KmsKeyIdentifier: '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.

    • Type — required — (String)

      AppConfig supports validators of type JSON_SCHEMA and LAMBDA

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

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

  • KmsKeyIdentifier — (String)

    The identifier for a Key Management Service key to encrypt new configuration data versions in the AppConfig hosted configuration store. This attribute is only used for hosted configuration types. The identifier can be an KMS key ID, alias, or the Amazon Resource Name (ARN) of the key ID or alias. To encrypt data managed in other configuration stores, see the documentation for how to specify an KMS key for that particular service.

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.

      • Type — required — (String)

        AppConfig supports validators of type JSON_SCHEMA and LAMBDA

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

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

    • Type — (String)

      The type of configurations contained in the profile. AppConfig supports feature flags and freeform configurations. We recommend you create feature flag configurations to enable or disable new features and freeform configurations to distribute configurations to an application. When calling this API, enter one of the following values for Type:

      AWS.AppConfig.FeatureFlags

      AWS.Freeform

    • KmsKeyArn — (String)

      The Amazon Resource Name of the Key Management Service key to encrypt new configuration data versions in the AppConfig hosted configuration store. This attribute is only used for hosted configuration types. To encrypt data managed in other configuration stores, see the documentation for how to specify an KMS key for that particular service.

    • KmsKeyIdentifier — (String)

      The Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created or updated.

Returns:

• (AWS.Request) —

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

/* 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"
   }
   */
 });

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.

/* 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"
   }
   */
 });

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.

    • AlarmArn — required — (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.

      • AlarmArn — required — (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.

var params = {
  ExtensionIdentifier: 'STRING_VALUE', /* required */
  Actions: {
    '<ActionPoint>': [
      {
        Description: 'STRING_VALUE',
        Name: 'STRING_VALUE',
        RoleArn: 'STRING_VALUE',
        Uri: 'STRING_VALUE'
      },
      /* more items */
    ],
    /* '<ActionPoint>': ... */
  },
  Description: 'STRING_VALUE',
  Parameters: {
    '<ExtensionOrParameterName>': {
      Description: 'STRING_VALUE',
      Dynamic: true || false,
      Required: true || false
    },
    /* '<ExtensionOrParameterName>': ... */
  },
  VersionNumber: 'NUMBER_VALUE'
};
appconfig.updateExtension(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: {}) —
  • ExtensionIdentifier — (String)

    The name, the ID, or the Amazon Resource Name (ARN) of the extension.

  • Description — (String)

    Information about the extension.

  • Actions — (map<Array<map>>)

    The actions defined in the extension.

    • Name — (String)

      The action name.

    • Description — (String)

      Information about the action.

    • Uri — (String)

      The extension URI associated to the action point in the extension definition. The URI can be an Amazon Resource Name (ARN) for one of the following: an Lambda function, an Amazon Simple Queue Service queue, an Amazon Simple Notification Service topic, or the Amazon EventBridge default event bus.

    • RoleArn — (String)

      An Amazon Resource Name (ARN) for an Identity and Access Management assume role.

  • Parameters — (map<map>)

    One or more parameters for the actions called by the extension.

    • Description — (String)

      Information about the parameter.

    • Required — (Boolean)

      A parameter value must be specified in the extension association.

    • Dynamic — (Boolean)

      Indicates whether this parameter's value can be supplied at the extension's action point instead of during extension association. Dynamic parameters can't be marked Required.

  • VersionNumber — (Integer)

    The extension version number.

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 system-generated ID of the extension.

    • Name — (String)

      The extension name.

    • VersionNumber — (Integer)

      The extension version number.

    • Arn — (String)

      The system-generated Amazon Resource Name (ARN) for the extension.

    • Description — (String)

      Information about the extension.

    • Actions — (map<Array<map>>)

      The actions defined in the extension.

      • Name — (String)

        The action name.

      • Description — (String)

        Information about the action.

      • Uri — (String)

        The extension URI associated to the action point in the extension definition. The URI can be an Amazon Resource Name (ARN) for one of the following: an Lambda function, an Amazon Simple Queue Service queue, an Amazon Simple Notification Service topic, or the Amazon EventBridge default event bus.

      • RoleArn — (String)

        An Amazon Resource Name (ARN) for an Identity and Access Management assume role.

    • Parameters — (map<map>)

      The parameters accepted by the extension. You specify parameter values when you associate the extension to an AppConfig resource by using the CreateExtensionAssociation API action. For Lambda extension actions, these parameters are included in the Lambda request object.

      • Description — (String)

        Information about the parameter.

      • Required — (Boolean)

        A parameter value must be specified in the extension association.

      • Dynamic — (Boolean)

        Indicates whether this parameter's value can be supplied at the extension's action point instead of during extension association. Dynamic parameters can't be marked Required.

Returns:

• (AWS.Request) —

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

var params = {
  ExtensionAssociationId: 'STRING_VALUE', /* required */
  Parameters: {
    '<ExtensionOrParameterName>': 'STRING_VALUE',
    /* '<ExtensionOrParameterName>': ... */
  }
};
appconfig.updateExtensionAssociation(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: {}) —
  • ExtensionAssociationId — (String)

    The system-generated ID for the association.

  • Parameters — (map<String>)

    The parameter names and values defined in the extension.

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 system-generated ID for the association.

    • ExtensionArn — (String)

      The ARN of the extension defined in the association.

    • ResourceArn — (String)

      The ARNs of applications, configuration profiles, or environments defined in the association.

    • Arn — (String)

      The system-generated Amazon Resource Name (ARN) for the extension.

    • Parameters — (map<String>)

      The parameter names and values defined in the association.

    • ExtensionVersionNumber — (Integer)

      The version number for the extension defined in the association.

Returns:

• (AWS.Request) —

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

/* 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
 });

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.