@aws-sdk/client-appconfig 3.295.0 → 3.297.0

package/dist-types/models/models_0.d.ts

@@ -1,6 +1,7 @@
 import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
 import { AppConfigServiceException as __BaseException } from "./AppConfigServiceException";
 /**
+ * @public
  * <p>An action defines the tasks that the extension performs during the AppConfig
  *          workflow. Each action includes an action point such as
  *             <code>ON_CREATE_HOSTED_CONFIGURATION</code>, <code>PRE_DEPLOYMENT</code>, or
@@ -66,6 +67,7 @@ export interface Action {
     RoleArn?: string;
 }
 /**
+ * @public
  * <p>An extension that was invoked as part of a deployment event.</p>
  */
 export interface ActionInvocation {
@@ -100,6 +102,9 @@ export interface ActionInvocation {
      */
     InvocationId?: string;
 }
+/**
+ * @public
+ */
 export declare enum ActionPoint {
     ON_DEPLOYMENT_BAKING = "ON_DEPLOYMENT_BAKING",
     ON_DEPLOYMENT_COMPLETE = "ON_DEPLOYMENT_COMPLETE",
@@ -109,6 +114,9 @@ export declare enum ActionPoint {
     PRE_CREATE_HOSTED_CONFIGURATION_VERSION = "PRE_CREATE_HOSTED_CONFIGURATION_VERSION",
     PRE_START_DEPLOYMENT = "PRE_START_DEPLOYMENT"
 }
+/**
+ * @public
+ */
 export interface Application {
     /**
      * <p>The application ID.</p>
@@ -124,6 +132,7 @@ export interface Application {
     Description?: string;
 }
 /**
+ * @public
  * <p>Detailed information about the bad request exception error when creating a hosted
  *          configuration version.</p>
  */
@@ -153,10 +162,14 @@ export interface InvalidConfigurationDetail {
     Value?: string;
 }
 /**
+ * @public
  * <p>Detailed information about the input that failed to satisfy the constraints specified by
  *          a call.</p>
  */
 export type BadRequestDetails = BadRequestDetails.InvalidConfigurationMember | BadRequestDetails.$UnknownMember;
+/**
+ * @public
+ */
 export declare namespace BadRequestDetails {
     /**
      * <p>Detailed information about the bad request exception error when creating a hosted
@@ -176,10 +189,14 @@ export declare namespace BadRequestDetails {
     }
     const visit: <T>(value: BadRequestDetails, visitor: Visitor<T>) => T;
 }
+/**
+ * @public
+ */
 export declare enum BadRequestReason {
     INVALID_CONFIGURATION = "InvalidConfiguration"
 }
 /**
+ * @public
  * <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
  */
 export declare class BadRequestException extends __BaseException {
@@ -197,6 +214,9 @@ export declare class BadRequestException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<BadRequestException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface CreateApplicationRequest {
     /**
      * <p>A name for the application.</p>
@@ -213,6 +233,7 @@ export interface CreateApplicationRequest {
     Tags?: Record<string, string>;
 }
 /**
+ * @public
  * <p>There was an internal failure in the AppConfig service.</p>
  */
 export declare class InternalServerException extends __BaseException {
@@ -224,11 +245,15 @@ export declare class InternalServerException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
 }
+/**
+ * @public
+ */
 export declare enum ValidatorType {
     JSON_SCHEMA = "JSON_SCHEMA",
     LAMBDA = "LAMBDA"
 }
 /**
+ * @public
  * <p>A validator provides a syntactic or semantic check to ensure the configuration that you
  *          want to deploy functions as intended. To validate your application configuration data, you
  *          provide a schema or an Amazon Web Services Lambda function that runs against the configuration. The
@@ -248,6 +273,9 @@ export interface Validator {
      */
     Content: string | undefined;
 }
+/**
+ * @public
+ */
 export interface ConfigurationProfile {
     /**
      * <p>The application ID.</p>
@@ -293,6 +321,9 @@ export interface ConfigurationProfile {
      */
     Type?: string;
 }
+/**
+ * @public
+ */
 export interface CreateConfigurationProfileRequest {
     /**
      * <p>The application ID.</p>
@@ -370,6 +401,7 @@ export interface CreateConfigurationProfileRequest {
     Type?: string;
 }
 /**
+ * @public
  * <p>The requested resource could not be found.</p>
  */
 export declare class ResourceNotFoundException extends __BaseException {
@@ -382,14 +414,23 @@ export declare class ResourceNotFoundException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
 }
+/**
+ * @public
+ */
 export declare enum GrowthType {
     EXPONENTIAL = "EXPONENTIAL",
     LINEAR = "LINEAR"
 }
+/**
+ * @public
+ */
 export declare enum ReplicateTo {
     NONE = "NONE",
     SSM_DOCUMENT = "SSM_DOCUMENT"
 }
+/**
+ * @public
+ */
 export interface CreateDeploymentStrategyRequest {
     /**
      * <p>A name for the deployment strategy.</p>
@@ -460,6 +501,9 @@ export interface CreateDeploymentStrategyRequest {
      */
     Tags?: Record<string, string>;
 }
+/**
+ * @public
+ */
 export interface DeploymentStrategy {
     /**
      * <p>The deployment strategy ID.</p>
@@ -497,6 +541,7 @@ export interface DeploymentStrategy {
     ReplicateTo?: ReplicateTo | string;
 }
 /**
+ * @public
  * <p>Amazon CloudWatch alarms to monitor during the deployment process.</p>
  */
 export interface Monitor {
@@ -510,6 +555,9 @@ export interface Monitor {
      */
     AlarmRoleArn?: string;
 }
+/**
+ * @public
+ */
 export interface CreateEnvironmentRequest {
     /**
      * <p>The application ID.</p>
@@ -533,12 +581,18 @@ export interface CreateEnvironmentRequest {
      */
     Tags?: Record<string, string>;
 }
+/**
+ * @public
+ */
 export declare enum EnvironmentState {
     DEPLOYING = "DEPLOYING",
     READY_FOR_DEPLOYMENT = "READY_FOR_DEPLOYMENT",
     ROLLED_BACK = "ROLLED_BACK",
     ROLLING_BACK = "ROLLING_BACK"
 }
+/**
+ * @public
+ */
 export interface Environment {
     /**
      * <p>The application ID.</p>
@@ -569,6 +623,7 @@ export interface Environment {
     Monitors?: Monitor[];
 }
 /**
+ * @public
  * <p>The request could not be processed because of conflict in the current state of the
  *          resource.</p>
  */
@@ -582,6 +637,7 @@ export declare class ConflictException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
 }
 /**
+ * @public
  * <p>A value such as an Amazon Resource Name (ARN) or an Amazon Simple Notification Service topic entered
  *          in an extension when invoked. Parameter values are specified in an extension association.
  *          For more information about extensions, see <a href="https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html">Working with
@@ -598,6 +654,9 @@ export interface Parameter {
      */
     Required?: boolean;
 }
+/**
+ * @public
+ */
 export interface CreateExtensionRequest {
     /**
      * <p>A name for the extension. Each extension name in your account must be unique. Extension
@@ -632,6 +691,9 @@ export interface CreateExtensionRequest {
      */
     LatestVersionNumber?: number;
 }
+/**
+ * @public
+ */
 export interface Extension {
     /**
      * <p>The system-generated ID of the extension.</p>
@@ -666,6 +728,7 @@ export interface Extension {
     Parameters?: Record<string, Parameter>;
 }
 /**
+ * @public
  * <p>The number of hosted configuration versions exceeds the limit for the AppConfig hosted configuration store. Delete one or more versions and try again.</p>
  */
 export declare class ServiceQuotaExceededException extends __BaseException {
@@ -677,6 +740,9 @@ export declare class ServiceQuotaExceededException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface CreateExtensionAssociationRequest {
     /**
      * <p>The name, the ID, or the Amazon Resource Name (ARN) of the extension.</p>
@@ -704,6 +770,9 @@ export interface CreateExtensionAssociationRequest {
      */
     Tags?: Record<string, string>;
 }
+/**
+ * @public
+ */
 export interface ExtensionAssociation {
     /**
      * <p>The system-generated ID for the association.</p>
@@ -731,6 +800,9 @@ export interface ExtensionAssociation {
      */
     ExtensionVersionNumber?: number;
 }
+/**
+ * @public
+ */
 export interface CreateHostedConfigurationVersionRequest {
     /**
      * <p>The application ID.</p>
@@ -765,6 +837,9 @@ export interface CreateHostedConfigurationVersionRequest {
      */
     VersionLabel?: string;
 }
+/**
+ * @public
+ */
 export interface HostedConfigurationVersion {
     /**
      * <p>The application ID.</p>
@@ -796,10 +871,14 @@ export interface HostedConfigurationVersion {
      */
     VersionLabel?: string;
 }
+/**
+ * @public
+ */
 export declare enum BytesMeasure {
     KILOBYTES = "KILOBYTES"
 }
 /**
+ * @public
  * <p>The configuration size is too large.</p>
  */
 export declare class PayloadTooLargeException extends __BaseException {
@@ -814,12 +893,18 @@ export declare class PayloadTooLargeException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<PayloadTooLargeException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface DeleteApplicationRequest {
     /**
      * <p>The ID of the application to delete.</p>
      */
     ApplicationId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DeleteConfigurationProfileRequest {
     /**
      * <p>The application ID that includes the configuration profile you want to delete.</p>
@@ -830,12 +915,18 @@ export interface DeleteConfigurationProfileRequest {
      */
     ConfigurationProfileId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DeleteDeploymentStrategyRequest {
     /**
      * <p>The ID of the deployment strategy you want to delete.</p>
      */
     DeploymentStrategyId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DeleteEnvironmentRequest {
     /**
      * <p>The application ID that includes the environment that you want to delete.</p>
@@ -846,6 +937,9 @@ export interface DeleteEnvironmentRequest {
      */
     EnvironmentId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DeleteExtensionRequest {
     /**
      * <p>The name, ID, or Amazon Resource Name (ARN) of the extension you want to delete.</p>
@@ -857,12 +951,18 @@ export interface DeleteExtensionRequest {
      */
     VersionNumber?: number;
 }
+/**
+ * @public
+ */
 export interface DeleteExtensionAssociationRequest {
     /**
      * <p>The ID of the extension association to delete.</p>
      */
     ExtensionAssociationId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DeleteHostedConfigurationVersionRequest {
     /**
      * <p>The application ID.</p>
@@ -877,12 +977,18 @@ export interface DeleteHostedConfigurationVersionRequest {
      */
     VersionNumber: number | undefined;
 }
+/**
+ * @public
+ */
 export interface GetApplicationRequest {
     /**
      * <p>The ID of the application you want to get.</p>
      */
     ApplicationId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface Configuration {
     /**
      * <p>The content of the configuration or the configuration data.</p>
@@ -905,6 +1011,9 @@ export interface Configuration {
      */
     ContentType?: string;
 }
+/**
+ * @public
+ */
 export interface GetConfigurationRequest {
     /**
      * <p>The application to get. Specify either the application name or the application
@@ -950,6 +1059,9 @@ export interface GetConfigurationRequest {
      */
     ClientConfigurationVersion?: string;
 }
+/**
+ * @public
+ */
 export interface GetConfigurationProfileRequest {
     /**
      * <p>The ID of the application that includes the configuration profile you want to
@@ -962,6 +1074,7 @@ export interface GetConfigurationProfileRequest {
     ConfigurationProfileId: string | undefined;
 }
 /**
+ * @public
  * <p>An extension that was invoked during a deployment.</p>
  */
 export interface AppliedExtension {
@@ -982,6 +1095,9 @@ export interface AppliedExtension {
      */
     Parameters?: Record<string, string>;
 }
+/**
+ * @public
+ */
 export declare enum DeploymentEventType {
     BAKE_TIME_STARTED = "BAKE_TIME_STARTED",
     DEPLOYMENT_COMPLETED = "DEPLOYMENT_COMPLETED",
@@ -990,6 +1106,9 @@ export declare enum DeploymentEventType {
     ROLLBACK_COMPLETED = "ROLLBACK_COMPLETED",
     ROLLBACK_STARTED = "ROLLBACK_STARTED"
 }
+/**
+ * @public
+ */
 export declare enum TriggeredBy {
     APPCONFIG = "APPCONFIG",
     CLOUDWATCH_ALARM = "CLOUDWATCH_ALARM",
@@ -997,6 +1116,7 @@ export declare enum TriggeredBy {
     USER = "USER"
 }
 /**
+ * @public
  * <p>An object that describes a deployment event.</p>
  */
 export interface DeploymentEvent {
@@ -1027,6 +1147,9 @@ export interface DeploymentEvent {
      */
     OccurredAt?: Date;
 }
+/**
+ * @public
+ */
 export declare enum DeploymentState {
     BAKING = "BAKING",
     COMPLETE = "COMPLETE",
@@ -1035,6 +1158,9 @@ export declare enum DeploymentState {
     ROLLING_BACK = "ROLLING_BACK",
     VALIDATING = "VALIDATING"
 }
+/**
+ * @public
+ */
 export interface Deployment {
     /**
      * <p>The ID of the application that was deployed.</p>
@@ -1129,6 +1255,9 @@ export interface Deployment {
      */
     KmsKeyIdentifier?: string;
 }
+/**
+ * @public
+ */
 export interface GetDeploymentRequest {
     /**
      * <p>The ID of the application that includes the deployment you want to get. </p>
@@ -1143,12 +1272,18 @@ export interface GetDeploymentRequest {
      */
     DeploymentNumber: number | undefined;
 }
+/**
+ * @public
+ */
 export interface GetDeploymentStrategyRequest {
     /**
      * <p>The ID of the deployment strategy to get.</p>
      */
     DeploymentStrategyId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface GetEnvironmentRequest {
     /**
      * <p>The ID of the application that includes the environment you want to get.</p>
@@ -1159,6 +1294,9 @@ export interface GetEnvironmentRequest {
      */
     EnvironmentId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface GetExtensionRequest {
     /**
      * <p>The name, the ID, or the Amazon Resource Name (ARN) of the extension.</p>
@@ -1170,12 +1308,18 @@ export interface GetExtensionRequest {
      */
     VersionNumber?: number;
 }
+/**
+ * @public
+ */
 export interface GetExtensionAssociationRequest {
     /**
      * <p>The extension association ID to get.</p>
      */
     ExtensionAssociationId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface GetHostedConfigurationVersionRequest {
     /**
      * <p>The application ID.</p>
@@ -1190,6 +1334,9 @@ export interface GetHostedConfigurationVersionRequest {
      */
     VersionNumber: number | undefined;
 }
+/**
+ * @public
+ */
 export interface Applications {
     /**
      * <p>The elements from this collection.</p>
@@ -1201,6 +1348,9 @@ export interface Applications {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export interface ListApplicationsRequest {
     /**
      * <p>The maximum number of items to return for this call. The call also returns a token that
@@ -1216,6 +1366,7 @@ export interface ListApplicationsRequest {
     NextToken?: string;
 }
 /**
+ * @public
  * <p>A summary of a configuration profile.</p>
  */
 export interface ConfigurationProfileSummary {
@@ -1254,6 +1405,9 @@ export interface ConfigurationProfileSummary {
      */
     Type?: string;
 }
+/**
+ * @public
+ */
 export interface ConfigurationProfiles {
     /**
      * <p>The elements from this collection.</p>
@@ -1265,6 +1419,9 @@ export interface ConfigurationProfiles {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export interface ListConfigurationProfilesRequest {
     /**
      * <p>The application ID.</p>
@@ -1286,6 +1443,7 @@ export interface ListConfigurationProfilesRequest {
     Type?: string;
 }
 /**
+ * @public
  * <p>Information about the deployment.</p>
  */
 export interface DeploymentSummary {
@@ -1336,6 +1494,9 @@ export interface DeploymentSummary {
      */
     CompletedAt?: Date;
 }
+/**
+ * @public
+ */
 export interface Deployments {
     /**
      * <p>The elements from this collection.</p>
@@ -1347,6 +1508,9 @@ export interface Deployments {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export interface ListDeploymentsRequest {
     /**
      * <p>The application ID.</p>
@@ -1369,6 +1533,9 @@ export interface ListDeploymentsRequest {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export interface DeploymentStrategies {
     /**
      * <p>The elements from this collection.</p>
@@ -1380,6 +1547,9 @@ export interface DeploymentStrategies {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export interface ListDeploymentStrategiesRequest {
     /**
      * <p>The maximum number of items to return for this call. The call also returns a token that
@@ -1391,6 +1561,9 @@ export interface ListDeploymentStrategiesRequest {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export interface Environments {
     /**
      * <p>The elements from this collection.</p>
@@ -1402,6 +1575,9 @@ export interface Environments {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export interface ListEnvironmentsRequest {
     /**
      * <p>The application ID.</p>
@@ -1418,6 +1594,7 @@ export interface ListEnvironmentsRequest {
     NextToken?: string;
 }
 /**
+ * @public
  * <p>Information about an association between an extension and an AppConfig
  *          resource such as an application, environment, or configuration profile. Call
  *             <code>GetExtensionAssociation</code> to get more information about an
@@ -1440,6 +1617,9 @@ export interface ExtensionAssociationSummary {
      */
     ResourceArn?: string;
 }
+/**
+ * @public
+ */
 export interface ExtensionAssociations {
     /**
      * <p>The list of extension associations. Each item represents an extension association to an
@@ -1452,6 +1632,9 @@ export interface ExtensionAssociations {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export interface ListExtensionAssociationsRequest {
     /**
      * <p>The ARN of an application, configuration profile, or environment.</p>
@@ -1477,6 +1660,7 @@ export interface ListExtensionAssociationsRequest {
     NextToken?: string;
 }
 /**
+ * @public
  * <p>Information about an extension. Call <code>GetExtension</code> to get more information
  *          about an extension.</p>
  */
@@ -1502,6 +1686,9 @@ export interface ExtensionSummary {
      */
     Description?: string;
 }
+/**
+ * @public
+ */
 export interface Extensions {
     /**
      * <p>The list of available extensions. The list includes Amazon Web Services authored and
@@ -1514,6 +1701,9 @@ export interface Extensions {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export interface ListExtensionsRequest {
     /**
      * <p>The maximum number of items to return for this call. The call also returns a token that
@@ -1530,6 +1720,7 @@ export interface ListExtensionsRequest {
     Name?: string;
 }
 /**
+ * @public
  * <p>Information about the configuration.</p>
  */
 export interface HostedConfigurationVersionSummary {
@@ -1559,6 +1750,9 @@ export interface HostedConfigurationVersionSummary {
      */
     VersionLabel?: string;
 }
+/**
+ * @public
+ */
 export interface HostedConfigurationVersions {
     /**
      * <p>The elements from this collection.</p>
@@ -1570,6 +1764,9 @@ export interface HostedConfigurationVersions {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export interface ListHostedConfigurationVersionsRequest {
     /**
      * <p>The application ID.</p>
@@ -1593,12 +1790,18 @@ export interface ListHostedConfigurationVersionsRequest {
      */
     VersionLabel?: string;
 }
+/**
+ * @public
+ */
 export interface ListTagsForResourceRequest {
     /**
      * <p>The resource ARN.</p>
      */
     ResourceArn: string | undefined;
 }
+/**
+ * @public
+ */
 export interface ResourceTags {
     /**
      * <p>Metadata to assign to AppConfig resources. Tags help organize and categorize
@@ -1607,6 +1810,9 @@ export interface ResourceTags {
      */
     Tags?: Record<string, string>;
 }
+/**
+ * @public
+ */
 export interface StartDeploymentRequest {
     /**
      * <p>The application ID.</p>
@@ -1642,6 +1848,9 @@ export interface StartDeploymentRequest {
      */
     KmsKeyIdentifier?: string;
 }
+/**
+ * @public
+ */
 export interface StopDeploymentRequest {
     /**
      * <p>The application ID.</p>
@@ -1656,6 +1865,9 @@ export interface StopDeploymentRequest {
      */
     DeploymentNumber: number | undefined;
 }
+/**
+ * @public
+ */
 export interface TagResourceRequest {
     /**
      * <p>The ARN of the resource for which to retrieve tags.</p>
@@ -1668,6 +1880,9 @@ export interface TagResourceRequest {
      */
     Tags: Record<string, string> | undefined;
 }
+/**
+ * @public
+ */
 export interface UntagResourceRequest {
     /**
      * <p>The ARN of the resource for which to remove tags.</p>
@@ -1678,6 +1893,9 @@ export interface UntagResourceRequest {
      */
     TagKeys: string[] | undefined;
 }
+/**
+ * @public
+ */
 export interface UpdateApplicationRequest {
     /**
      * <p>The application ID.</p>
@@ -1692,6 +1910,9 @@ export interface UpdateApplicationRequest {
      */
     Description?: string;
 }
+/**
+ * @public
+ */
 export interface UpdateConfigurationProfileRequest {
     /**
      * <p>The application ID.</p>
@@ -1719,6 +1940,9 @@ export interface UpdateConfigurationProfileRequest {
      */
     Validators?: Validator[];
 }
+/**
+ * @public
+ */
 export interface UpdateDeploymentStrategyRequest {
     /**
      * <p>The deployment strategy ID.</p>
@@ -1774,6 +1998,9 @@ export interface UpdateDeploymentStrategyRequest {
      */
     GrowthType?: GrowthType | string;
 }
+/**
+ * @public
+ */
 export interface UpdateEnvironmentRequest {
     /**
      * <p>The application ID.</p>
@@ -1796,6 +2023,9 @@ export interface UpdateEnvironmentRequest {
      */
     Monitors?: Monitor[];
 }
+/**
+ * @public
+ */
 export interface UpdateExtensionRequest {
     /**
      * <p>The name, the ID, or the Amazon Resource Name (ARN) of the extension.</p>
@@ -1818,6 +2048,9 @@ export interface UpdateExtensionRequest {
      */
     VersionNumber?: number;
 }
+/**
+ * @public
+ */
 export interface UpdateExtensionAssociationRequest {
     /**
      * <p>The system-generated ID for the association.</p>
@@ -1828,6 +2061,9 @@ export interface UpdateExtensionAssociationRequest {
      */
     Parameters?: Record<string, string>;
 }
+/**
+ * @public
+ */
 export interface ValidateConfigurationRequest {
     /**
      * <p>The application ID.</p>