AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Classes

NameDescription
Class Action

An action defines the tasks that the extension performs during the AppConfig workflow. Each action includes an action point such as ON_CREATE_HOSTED_CONFIGURATION, PRE_DEPLOYMENT, or ON_DEPLOYMENT. Each action also includes a name, a URI to an Lambda function, and an Amazon Resource Name (ARN) for an Identity and Access Management assume role. You specify the name, URI, and ARN for each action point defined in the extension. You can specify the following actions for an extension:

  • PRE_CREATE_HOSTED_CONFIGURATION_VERSION

  • PRE_START_DEPLOYMENT

  • ON_DEPLOYMENT_START

  • ON_DEPLOYMENT_STEP

  • ON_DEPLOYMENT_BAKING

  • ON_DEPLOYMENT_COMPLETE

  • ON_DEPLOYMENT_ROLLED_BACK
Class ActionInvocation

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

Class AppConfigPaginatorFactory

Paginators for the AppConfig service

Class Application

Class AppliedExtension

An extension that was invoked during a deployment.

Class BadRequestDetails

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

Class BadRequestException

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

Class ConfigurationProfileSummary

A summary of a configuration profile.

Class ConflictException

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

Class CreateApplicationRequest

Container for the parameters to the CreateApplication operation. Creates an application. In AppConfig, an application is simply an organizational construct like a folder. This organizational construct has a relationship with some unit of executable code. For example, you could create an application called MyMobileApp to organize and manage configuration data for a mobile application installed by your users.

Class CreateApplicationResponse

This is the response object from the CreateApplication operation.

Class CreateConfigurationProfileRequest

Container for the parameters to the CreateConfigurationProfile operation. Creates a configuration profile, which is information that enables AppConfig to access the configuration source. Valid configuration sources include the following:

  • Configuration data in YAML, JSON, and other formats stored in the AppConfig hosted configuration store

  • Configuration data stored as objects in an Amazon Simple Storage Service (Amazon S3) bucket

  • Pipelines stored in CodePipeline

  • Secrets stored in Secrets Manager

  • Standard and secure string parameters stored in Amazon Web Services Systems Manager Parameter Store

  • Configuration data in SSM documents stored in the Systems Manager document store

A configuration profile includes the following information:

  • The URI location of the configuration data.

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

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

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

Class CreateConfigurationProfileResponse

This is the response object from the CreateConfigurationProfile operation.

Class CreateDeploymentStrategyRequest

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

Class CreateDeploymentStrategyResponse

This is the response object from the CreateDeploymentStrategy operation.

Class CreateEnvironmentRequest

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

Class CreateEnvironmentResponse

This is the response object from the CreateEnvironment operation.

Class CreateExtensionAssociationRequest

Container for the parameters to the CreateExtensionAssociation operation. When you create an extension or configure an Amazon Web Services authored extension, you associate the extension with an AppConfig application, environment, or configuration profile. For example, you can choose to run the AppConfig deployment events to Amazon SNS Amazon Web Services authored extension and receive notifications on an Amazon SNS topic anytime a configuration deployment is started for a specific application. Defining which extension to associate with an AppConfig resource is called an extension association. An extension association is a specified relationship between an extension and an AppConfig resource, such as an application or a configuration profile. For more information about extensions and associations, see Extending workflows in the AppConfig User Guide.

Class CreateExtensionAssociationResponse

This is the response object from the CreateExtensionAssociation operation.

Class CreateExtensionRequest

Container for the parameters to the CreateExtension operation. Creates an AppConfig extension. An extension augments your ability to inject logic or behavior at different points during the AppConfig workflow of creating or deploying a configuration.

You can create your own extensions or use the Amazon Web Services authored extensions provided by AppConfig. For an AppConfig extension that uses Lambda, you must create a Lambda function to perform any computation and processing defined in the extension. If you plan to create custom versions of the Amazon Web Services authored notification extensions, you only need to specify an Amazon Resource Name (ARN) in the Uri field for the new extension version.

  • For a custom EventBridge notification extension, enter the ARN of the EventBridge default events in the Uri field.

  • For a custom Amazon SNS notification extension, enter the ARN of an Amazon SNS topic in the Uri field.

  • For a custom Amazon SQS notification extension, enter the ARN of an Amazon SQS message queue in the Uri field.

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

Class CreateExtensionResponse

This is the response object from the CreateExtension operation.

Class CreateHostedConfigurationVersionRequest

Container for the parameters to the CreateHostedConfigurationVersion operation. Creates a new configuration in the AppConfig hosted configuration store.

Class CreateHostedConfigurationVersionResponse

This is the response object from the CreateHostedConfigurationVersion operation.

Class DeleteApplicationRequest

Container for the parameters to the DeleteApplication operation. Deletes an application. Deleting an application does not delete a configuration from a host.

Class DeleteApplicationResponse

This is the response object from the DeleteApplication operation.

Class DeleteConfigurationProfileRequest

Container for the parameters to the DeleteConfigurationProfile operation. Deletes a configuration profile. Deleting a configuration profile does not delete a configuration from a host.

Class DeleteConfigurationProfileResponse

This is the response object from the DeleteConfigurationProfile operation.

Class DeleteDeploymentStrategyRequest

Container for the parameters to the DeleteDeploymentStrategy operation. Deletes a deployment strategy. Deleting a deployment strategy does not delete a configuration from a host.

Class DeleteDeploymentStrategyResponse

This is the response object from the DeleteDeploymentStrategy operation.

Class DeleteEnvironmentRequest

Container for the parameters to the DeleteEnvironment operation. Deletes an environment. Deleting an environment does not delete a configuration from a host.

Class DeleteEnvironmentResponse

This is the response object from the DeleteEnvironment operation.

Class DeleteExtensionAssociationRequest

Container for the parameters to the DeleteExtensionAssociation operation. Deletes an extension association. This action doesn't delete extensions defined in the association.

Class DeleteExtensionAssociationResponse

This is the response object from the DeleteExtensionAssociation operation.

Class DeleteExtensionRequest

Container for the parameters to the DeleteExtension operation. Deletes an AppConfig extension. You must delete all associations to an extension before you delete the extension.

Class DeleteExtensionResponse

This is the response object from the DeleteExtension operation.

Class DeleteHostedConfigurationVersionRequest

Container for the parameters to the DeleteHostedConfigurationVersion operation. Deletes a version of a configuration from the AppConfig hosted configuration store.

Class DeleteHostedConfigurationVersionResponse

This is the response object from the DeleteHostedConfigurationVersion operation.

Class DeploymentEvent

An object that describes a deployment event.

Class DeploymentStrategy

Class DeploymentSummary

Information about the deployment.

Class Environment

Class ExtensionAssociationSummary

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

Class ExtensionSummary

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

Class GetApplicationRequest

Container for the parameters to the GetApplication operation. Retrieves information about an application.

Class GetApplicationResponse

This is the response object from the GetApplication operation.

Class GetConfigurationProfileRequest

Container for the parameters to the GetConfigurationProfile operation. Retrieves information about a configuration profile.

Class GetConfigurationProfileResponse

This is the response object from the GetConfigurationProfile operation.

Class GetConfigurationRequest

Container for the parameters to the GetConfiguration operation. (Deprecated) Retrieves the latest deployed configuration.

Note the following important information.

Class GetConfigurationResponse

This is the response object from the GetConfiguration operation.

Class GetDeploymentRequest

Container for the parameters to the GetDeployment operation. Retrieves information about a configuration deployment.

Class GetDeploymentResponse

This is the response object from the GetDeployment operation.

Class GetDeploymentStrategyRequest

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

Class GetDeploymentStrategyResponse

This is the response object from the GetDeploymentStrategy operation.

Class GetEnvironmentRequest

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

Class GetEnvironmentResponse

This is the response object from the GetEnvironment operation.

Class GetExtensionAssociationRequest

Container for the parameters to the GetExtensionAssociation operation. Returns information about an AppConfig extension association. For more information about extensions and associations, see Extending workflows in the AppConfig User Guide.

Class GetExtensionAssociationResponse

This is the response object from the GetExtensionAssociation operation.

Class GetExtensionRequest

Container for the parameters to the GetExtension operation. Returns information about an AppConfig extension.

Class GetExtensionResponse

This is the response object from the GetExtension operation.

Class GetHostedConfigurationVersionRequest

Container for the parameters to the GetHostedConfigurationVersion operation. Retrieves information about a specific configuration version.

Class GetHostedConfigurationVersionResponse

This is the response object from the GetHostedConfigurationVersion operation.

Class HostedConfigurationVersionSummary

Information about the configuration.

Class InternalServerException

There was an internal failure in the AppConfig service.

Class InvalidConfigurationDetail

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

Class ListApplicationsRequest

Container for the parameters to the ListApplications operation. Lists all applications in your Amazon Web Services account.

Class ListApplicationsResponse

This is the response object from the ListApplications operation.

Class ListConfigurationProfilesRequest

Container for the parameters to the ListConfigurationProfiles operation. Lists the configuration profiles for an application.

Class ListConfigurationProfilesResponse

This is the response object from the ListConfigurationProfiles operation.

Class ListDeploymentsRequest

Container for the parameters to the ListDeployments operation. Lists the deployments for an environment in descending deployment number order.

Class ListDeploymentsResponse

This is the response object from the ListDeployments operation.

Class ListDeploymentStrategiesRequest

Container for the parameters to the ListDeploymentStrategies operation. Lists deployment strategies.

Class ListDeploymentStrategiesResponse

This is the response object from the ListDeploymentStrategies operation.

Class ListEnvironmentsRequest

Container for the parameters to the ListEnvironments operation. Lists the environments for an application.

Class ListEnvironmentsResponse

This is the response object from the ListEnvironments operation.

Class ListExtensionAssociationsRequest

Container for the parameters to the ListExtensionAssociations operation. Lists all AppConfig extension associations in the account. For more information about extensions and associations, see Extending workflows in the AppConfig User Guide.

Class ListExtensionAssociationsResponse

This is the response object from the ListExtensionAssociations operation.

Class ListExtensionsRequest

Container for the parameters to the ListExtensions operation. Lists all custom and Amazon Web Services authored AppConfig extensions in the account. For more information about extensions, see Extending workflows in the AppConfig User Guide.

Class ListExtensionsResponse

This is the response object from the ListExtensions operation.

Class ListHostedConfigurationVersionsRequest

Container for the parameters to the ListHostedConfigurationVersions operation. Lists configurations stored in the AppConfig hosted configuration store by version.

Class ListHostedConfigurationVersionsResponse

This is the response object from the ListHostedConfigurationVersions operation.

Class ListTagsForResourceRequest

Container for the parameters to the ListTagsForResource operation. Retrieves the list of key-value tags assigned to the resource.

Class ListTagsForResourceResponse

This is the response object from the ListTagsForResource operation.

Class Monitor

Amazon CloudWatch alarms to monitor during the deployment process.

Class Parameter

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

Class PayloadTooLargeException

The configuration size is too large.

Class ResourceNotFoundException

The requested resource could not be found.

Class ServiceQuotaExceededException

The number of one more AppConfig resources exceeds the maximum allowed. Verify that your environment doesn't exceed the following service quotas:

Applications: 100 max

Deployment strategies: 20 max

Configuration profiles: 100 max per application

Environments: 20 max per application

To resolve this issue, you can delete one or more resources and try again. Or, you can request a quota increase. For more information about quotas and to request an increase, see Service quotas for AppConfig in the Amazon Web Services General Reference.

Class StartDeploymentRequest

Container for the parameters to the StartDeployment operation. Starts a deployment.

Class StartDeploymentResponse

This is the response object from the StartDeployment operation.

Class StopDeploymentRequest

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

Class StopDeploymentResponse

This is the response object from the StopDeployment operation.

Class TagResourceRequest

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

Class TagResourceResponse

This is the response object from the TagResource operation.

Class UntagResourceRequest

Container for the parameters to the UntagResource operation. Deletes a tag key and value from an AppConfig resource.

Class UntagResourceResponse

This is the response object from the UntagResource operation.

Class UpdateApplicationRequest

Container for the parameters to the UpdateApplication operation. Updates an application.

Class UpdateApplicationResponse

This is the response object from the UpdateApplication operation.

Class UpdateConfigurationProfileRequest

Container for the parameters to the UpdateConfigurationProfile operation. Updates a configuration profile.

Class UpdateConfigurationProfileResponse

This is the response object from the UpdateConfigurationProfile operation.

Class UpdateDeploymentStrategyRequest

Container for the parameters to the UpdateDeploymentStrategy operation. Updates a deployment strategy.

Class UpdateDeploymentStrategyResponse

This is the response object from the UpdateDeploymentStrategy operation.

Class UpdateEnvironmentRequest

Container for the parameters to the UpdateEnvironment operation. Updates an environment.

Class UpdateEnvironmentResponse

This is the response object from the UpdateEnvironment operation.

Class UpdateExtensionAssociationRequest

Container for the parameters to the UpdateExtensionAssociation operation. Updates an association. For more information about extensions and associations, see Extending workflows in the AppConfig User Guide.

Class UpdateExtensionAssociationResponse

This is the response object from the UpdateExtensionAssociation operation.

Class UpdateExtensionRequest

Container for the parameters to the UpdateExtension operation. Updates an AppConfig extension. For more information about extensions, see Extending workflows in the AppConfig User Guide.

Class UpdateExtensionResponse

This is the response object from the UpdateExtension operation.

Class ValidateConfigurationRequest

Container for the parameters to the ValidateConfiguration operation. Uses the validators in a configuration profile to validate a configuration.

Class ValidateConfigurationResponse

This is the response object from the ValidateConfiguration operation.

Class Validator

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

Interfaces

NameDescription
Interface IAppConfigPaginatorFactory

Paginators for the AppConfig service

Interface IListApplicationsPaginator

Paginator for the ListApplications operation

Interface IListConfigurationProfilesPaginator

Paginator for the ListConfigurationProfiles operation

Interface IListDeploymentsPaginator

Paginator for the ListDeployments operation

Interface IListDeploymentStrategiesPaginator

Paginator for the ListDeploymentStrategies operation

Interface IListEnvironmentsPaginator

Paginator for the ListEnvironments operation

Interface IListExtensionAssociationsPaginator

Paginator for the ListExtensionAssociations operation

Interface IListExtensionsPaginator

Paginator for the ListExtensions operation

Interface IListHostedConfigurationVersionsPaginator

Paginator for the ListHostedConfigurationVersions operation