aws-sdk-appconfig 1.22.0 → 1.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: abe8d91c665d14f11f4b9ab02ef33deff92a89962582ad902b8d3f01b87142c1
-  data.tar.gz: 7c4a48c0d91c3b7a6d2703d0b7210a04c2d1924b8905eaf21de73797a915b66d
+  metadata.gz: 1dee19817e5dab21731850195fe08881cc91691e6ffe5000f91ad9a8de21fe65
+  data.tar.gz: e650e8b7c0c44d076bca1379dd1ba98219b037100b0d089224f00888fcec3796
 SHA512:
-  metadata.gz: 2eea05c4e9df205e399075d68438d96a285ba0503efc7bd549cfaf792a2e0fc9868e5548e9d1234c3ddf0bc1599b462b4e1bfe7996db0116a90a7bdb63929a7d
-  data.tar.gz: a9067eecd6331d5cdd41005e0c70f5b4325b59be9be1aee983bcf78889655dc1893822b84f3fa005e186f7fe6c712bfddccba6dcc97255a65ef5739d7fcbcea2
+  metadata.gz: 265bc5eb24bb551f5598cda7fc9f953610fc5682418b242ddd0513d9c3f929ed43ddb941fc4b3c1e6fc89502bb16296c43b3298aef5a65eadcd7fea69131a835
+  data.tar.gz: 65df196a2cccd56a90e325081b899e6e9a426f96bd9e7070d4c4f597071b71d78f09418c5419879692bbae315971903358ae8ee67ec1571847eabe51f2684475

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.23.0 (2022-01-28)
+------------------
+
+* Feature - Documentation updates for AWS AppConfig
+
 1.22.0 (2021-12-21)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.22.0
+1.23.0

data/lib/aws-sdk-appconfig/client.rb

@@ -427,7 +427,7 @@ module Aws::AppConfig
     #   to the configuration data.
     #
     # * A validator for the configuration data. Available validators include
-    #   either a JSON Schema or an Lambda function.
+    #   either a JSON Schema or an Amazon Web Services Lambda function.
     #
     # For more information, see [Create a Configuration and a Configuration
     # Profile][2] in the *AppConfig User Guide*.
@@ -476,10 +476,16 @@ module Aws::AppConfig
     #   and an optional value, both of which you define.
     #
     # @option params [String] :type
-    #   The type of configurations that the configuration profile contains. A
-    #   configuration can be a feature flag used for enabling or disabling new
-    #   features or a free-form configuration used for distributing
-    #   configurations to your application.
+    #   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`
     #
     # @return [Types::ConfigurationProfile] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
@@ -1100,19 +1106,41 @@ module Aws::AppConfig
       req.send_request(options)
     end
 
-    # Retrieves information about a configuration.
+    # Retrieves the latest deployed configuration.
+    #
+    # Note the following important information.
+    #
+    #  * This API action has been deprecated. Calls to receive configuration
+    #   data should use the [StartConfigurationSession][1] and
+    #   [GetLatestConfiguration][2] APIs instead.
+    #
+    # * `GetConfiguration` is a priced call. For more information, see
+    #   [Pricing][3].
+    #
+    # * 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.
     #
-    # 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][4] and [GetLatestConfiguration][5] 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`.
     #
-    #  To avoid excess charges, we recommend that you include the
-    # `ClientConfigurationVersion` value with every call to
-    # `GetConfiguration`. This value must be saved on your client.
-    # Subsequent calls to `GetConfiguration` must pass this value by using
-    # the `ClientConfigurationVersion` parameter.
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/appconfig/2019-10-09/APIReference/API_appconfigdata_StartConfigurationSession.html
+    # [2]: https://docs.aws.amazon.com/appconfig/2019-10-09/APIReference/API_appconfigdata_GetLatestConfiguration.html
+    # [3]: https://aws.amazon.com/systems-manager/pricing/
+    # [4]: https://docs.aws.amazon.com/appconfig/2019-10-09/APIReference/StartConfigurationSession.html
+    # [5]: https://docs.aws.amazon.com/appconfig/2019-10-09/APIReference/GetLatestConfiguration.html
     #
     # @option params [required, String] :application
     #   The application to get. Specify either the application name or the
@@ -1714,7 +1742,7 @@ module Aws::AppConfig
     #
     # @option params [String] :type
     #   A filter based on the type of configurations that the configuration
-    #   profile contains. A configuration can be a feature flag or a free-form
+    #   profile contains. A configuration can be a feature flag or a freeform
     #   configuration.
     #
     # @return [Types::ConfigurationProfiles] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
@@ -1846,7 +1874,8 @@ module Aws::AppConfig
       req.send_request(options)
     end
 
-    # Lists the deployments for an environment.
+    # Lists the deployments for an environment in descending deployment
+    # number order.
     #
     # @option params [required, String] :application_id
     #   The application ID.
@@ -1855,13 +1884,15 @@ module Aws::AppConfig
     #   The environment ID.
     #
     # @option params [Integer] :max_results
-    #   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.
+    #   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.
     #
     # @option params [String] :next_token
-    #   A token to start the list. Use this token to get the next set of
-    #   results.
+    #   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.
     #
     # @return [Types::Deployments] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
@@ -2843,7 +2874,7 @@ module Aws::AppConfig
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-appconfig'
-      context[:gem_version] = '1.22.0'
+      context[:gem_version] = '1.23.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-appconfig/client_api.rb

@@ -652,6 +652,7 @@ module Aws::AppConfig
         o.name = "GetConfiguration"
         o.http_method = "GET"
         o.http_request_uri = "/applications/{Application}/environments/{Environment}/configurations/{Configuration}"
+        o.deprecated = true
         o.input = Shapes::ShapeRef.new(shape: GetConfigurationRequest)
         o.output = Shapes::ShapeRef.new(shape: Configuration)
         o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)

data/lib/aws-sdk-appconfig/types.rb

@@ -51,7 +51,7 @@ module Aws::AppConfig
     end
 
     # Detailed information about the input that failed to satisfy the
-    # constraints specified by an AWS service.
+    # constraints specified by a call.
     #
     # @!attribute [rw] invalid_configuration
     #   Detailed information about the bad request exception error when
@@ -82,7 +82,7 @@ module Aws::AppConfig
     #
     # @!attribute [rw] details
     #   Detailed information about the input that failed to satisfy the
-    #   constraints specified by an AWS service.
+    #   constraints specified by a call.
     #   @return [Types::BadRequestDetails]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/BadRequestException AWS API Documentation
@@ -98,13 +98,11 @@ module Aws::AppConfig
     # @!attribute [rw] content
     #   The content of the configuration or the configuration data.
     #
-    #   Compare the configuration version numbers of the configuration
-    #   cached locally on your machine and the configuration number in the
-    #   the header. If the configuration numbers are the same, the content
-    #   can be ignored. The `Content` section only appears if the system
-    #   finds new or updated configuration data. If the system doesn't find
-    #   new or updated configuration data, then the `Content` section is not
-    #   returned.
+    #   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.
     #   @return [String]
     #
     # @!attribute [rw] configuration_version
@@ -160,10 +158,16 @@ module Aws::AppConfig
     #   @return [Array<Types::Validator>]
     #
     # @!attribute [rw] type
-    #   The type of configurations that the configuration profile contains.
-    #   A configuration can be a feature flag used for enabling or disabling
-    #   new features or a free-form configuration used for distributing
-    #   configurations to your application.
+    #   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`
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/ConfigurationProfile AWS API Documentation
@@ -204,10 +208,16 @@ module Aws::AppConfig
     #   @return [Array<String>]
     #
     # @!attribute [rw] type
-    #   The type of configurations that the configuration profile contains.
-    #   A configuration can be a feature flag used for enabling or disabling
-    #   new features or a free-form configuration used to introduce changes
-    #   to your application.
+    #   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`
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/ConfigurationProfileSummary AWS API Documentation
@@ -357,10 +367,16 @@ module Aws::AppConfig
     #   @return [Hash<String,String>]
     #
     # @!attribute [rw] type
-    #   The type of configurations that the configuration profile contains.
-    #   A configuration can be a feature flag used for enabling or disabling
-    #   new features or a free-form configuration used for distributing
-    #   configurations to your application.
+    #   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`
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/CreateConfigurationProfileRequest AWS API Documentation
@@ -1479,7 +1495,7 @@ module Aws::AppConfig
     # @!attribute [rw] type
     #   A filter based on the type of configurations that the configuration
     #   profile contains. A configuration can be a feature flag or a
-    #   free-form configuration.
+    #   freeform configuration.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/ListConfigurationProfilesRequest AWS API Documentation
@@ -1540,14 +1556,16 @@ module Aws::AppConfig
     #   @return [String]
     #
     # @!attribute [rw] max_results
-    #   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.
+    #   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.
     #   @return [Integer]
     #
     # @!attribute [rw] next_token
-    #   A token to start the list. Use this token to get the next set of
-    #   results.
+    #   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.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/ListDeploymentsRequest AWS API Documentation
@@ -2144,9 +2162,9 @@ module Aws::AppConfig
     # 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
-    # a Lambda function that runs against the configuration. The
-    # configuration deployment or update can only proceed when the
-    # configuration data is valid.
+    # 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.
     #
     # @note When making an API call, you may pass Validator
     #   data as a hash:

data/lib/aws-sdk-appconfig.rb

@@ -48,6 +48,6 @@ require_relative 'aws-sdk-appconfig/customizations'
 # @!group service
 module Aws::AppConfig
 
-  GEM_VERSION = '1.22.0'
+  GEM_VERSION = '1.23.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-appconfig
 version: !ruby/object:Gem::Version
-  version: 1.22.0
+  version: 1.23.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-21 00:00:00.000000000 Z
+date: 2022-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core