aws-sdk-appconfigdata 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad8a3d182575fc622400cb50609083f2da0185a7c02048168348388d43fed06e
-  data.tar.gz: 94a7b340c302923042fa4045b80d8773a0a4c7a91f60912bd8b236829c1d0888
+  metadata.gz: f64a081925366e48f9eab4aa9d2369ebec3130f1391a8b9cb85370801d519bd5
+  data.tar.gz: efcc646acef6cd57da8580fa8b6633afb52039a57551261252bef4168289a233
 SHA512:
-  metadata.gz: 57138393331df3728bb1ca16143b184084ecc5288d9f707ecb3224a73a688e869b8bf1877e1db5fb752c30578dc364fc993104aa0c4196757910bc16e43c573b
-  data.tar.gz: f2e08065b71ab6d4fca4cc6d6d85938b298b9d2692619298ff594c69da8220fc554c666ff65fc3215b99df65ad628ebbd166952423222c30c3039111f791183a
+  metadata.gz: f76e347373986ff2bb55357aae72dcde75e390fded6b39cf2af4ff1a2c12fa50dfd36bd1f1f8a9d69469bede3d83fd7bb11b26313690067a1b0deabb0faacabe
+  data.tar.gz: 7699d208b266fc8d5a4b4a60d7975b9e167e9cb0134b16369095a53d60e3a2990e41b398d8713a15dba048e3b175edf7591ff1bdfef9ab5ad8147ded25723f91

data/CHANGELOG.md

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

data/VERSION

@@ -1 +1 @@
-1.2.0
+1.3.0

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

@@ -348,34 +348,41 @@ module Aws::AppConfigData
     # @!group API Operations
 
     # Retrieves the latest deployed configuration. This API may return empty
-    # Configuration data if the client already has the latest version. See
-    # StartConfigurationSession to obtain an InitialConfigurationToken to
-    # call this API.
+    # configuration data if the client already has the latest version. For
+    # more information about this API action and to view example CLI
+    # commands that show how to use it with the StartConfigurationSession
+    # API action, see [Receiving the configuration][1] in the *AppConfig
+    # User Guide*.
     #
-    # Each call to GetLatestConfiguration returns a new ConfigurationToken
-    # (NextPollConfigurationToken in the response). This new token MUST be
-    # provided to the next call to GetLatestConfiguration when polling for
-    # configuration updates.
+    # Note the following important information.
     #
-    #  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.
+    #  * Each configuration token is only valid for one call to
+    #   `GetLatestConfiguration`. The `GetLatestConfiguration` response
+    #   includes a `NextPollConfigurationToken` that should always replace
+    #   the token used for the just-completed call in preparation for the
+    #   next one.
+    #
+    # * `GetLatestConfiguration` is a priced call. For more information, see
+    #   [Pricing][2].
+    #
+    #
+    #
+    # [1]: http://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-retrieving-the-configuration
+    # [2]: https://aws.amazon.com/systems-manager/pricing/
     #
     # @option params [required, String] :configuration_token
     #   Token describing the current state of the configuration session. To
     #   obtain a token, first call the StartConfigurationSession API. Note
-    #   that every call to GetLatestConfiguration will return a new
-    #   ConfigurationToken (NextPollConfigurationToken in the response) and
-    #   MUST be provided to subsequent GetLatestConfiguration API calls.
+    #   that every call to `GetLatestConfiguration` will return a new
+    #   `ConfigurationToken` (`NextPollConfigurationToken` in the response)
+    #   and MUST be provided to subsequent `GetLatestConfiguration` API calls.
     #
     # @return [Types::GetLatestConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
-    #   * {Types::GetLatestConfigurationResponse#configuration #configuration} => String
-    #   * {Types::GetLatestConfigurationResponse#content_type #content_type} => String
     #   * {Types::GetLatestConfigurationResponse#next_poll_configuration_token #next_poll_configuration_token} => String
     #   * {Types::GetLatestConfigurationResponse#next_poll_interval_in_seconds #next_poll_interval_in_seconds} => Integer
+    #   * {Types::GetLatestConfigurationResponse#content_type #content_type} => String
+    #   * {Types::GetLatestConfigurationResponse#configuration #configuration} => String
     #
     # @example Request syntax with placeholder values
     #
@@ -385,10 +392,10 @@ module Aws::AppConfigData
     #
     # @example Response structure
     #
-    #   resp.configuration #=> String
-    #   resp.content_type #=> String
     #   resp.next_poll_configuration_token #=> String
     #   resp.next_poll_interval_in_seconds #=> Integer
+    #   resp.content_type #=> String
+    #   resp.configuration #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/appconfigdata-2021-11-11/GetLatestConfiguration AWS API Documentation
     #
@@ -400,22 +407,29 @@ module Aws::AppConfigData
     end
 
     # Starts a configuration session used to retrieve a deployed
-    # configuration. See the GetLatestConfiguration API for more details.
+    # configuration. For more information about this API action and to view
+    # example CLI commands that show how to use it with the
+    # GetLatestConfiguration API action, see [Receiving the
+    # configuration][1] in the *AppConfig User Guide*.
+    #
+    #
+    #
+    # [1]: http://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-retrieving-the-configuration
     #
     # @option params [required, String] :application_identifier
     #   The application ID or the application name.
     #
-    # @option params [required, String] :configuration_profile_identifier
-    #   The configuration profile ID or the configuration profile name.
-    #
     # @option params [required, String] :environment_identifier
     #   The environment ID or the environment name.
     #
+    # @option params [required, String] :configuration_profile_identifier
+    #   The configuration profile ID or the configuration profile name.
+    #
     # @option params [Integer] :required_minimum_poll_interval_in_seconds
-    #   The interval at which your client will poll for configuration. If
-    #   provided, the service will throw a BadRequestException if the client
-    #   polls before the specified poll interval. By default, client poll
-    #   intervals are not enforced.
+    #   Sets a constraint on a session. If you specify a value of, for
+    #   example, 60 seconds, then the client that established the session
+    #   can't call GetLatestConfiguration more frequently then every 60
+    #   seconds.
     #
     # @return [Types::StartConfigurationSessionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
@@ -425,8 +439,8 @@ module Aws::AppConfigData
     #
     #   resp = client.start_configuration_session({
     #     application_identifier: "Identifier", # required
-    #     configuration_profile_identifier: "Identifier", # required
     #     environment_identifier: "Identifier", # required
+    #     configuration_profile_identifier: "Identifier", # required
     #     required_minimum_poll_interval_in_seconds: 1,
     #   })
     #
@@ -456,7 +470,7 @@ module Aws::AppConfigData
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-appconfigdata'
-      context[:gem_version] = '1.2.0'
+      context[:gem_version] = '1.3.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -41,18 +41,18 @@ module Aws::AppConfigData
     BadRequestDetails.add_member_subclass(:unknown, Types::BadRequestDetails::Unknown)
     BadRequestDetails.struct_class = Types::BadRequestDetails
 
-    BadRequestException.add_member(:details, Shapes::ShapeRef.new(shape: BadRequestDetails, location_name: "Details"))
     BadRequestException.add_member(:message, Shapes::ShapeRef.new(shape: String, location_name: "Message"))
     BadRequestException.add_member(:reason, Shapes::ShapeRef.new(shape: BadRequestReason, location_name: "Reason"))
+    BadRequestException.add_member(:details, Shapes::ShapeRef.new(shape: BadRequestDetails, location_name: "Details"))
     BadRequestException.struct_class = Types::BadRequestException
 
     GetLatestConfigurationRequest.add_member(:configuration_token, Shapes::ShapeRef.new(shape: Token, required: true, location: "querystring", location_name: "configuration_token"))
     GetLatestConfigurationRequest.struct_class = Types::GetLatestConfigurationRequest
 
-    GetLatestConfigurationResponse.add_member(:configuration, Shapes::ShapeRef.new(shape: SyntheticGetLatestConfigurationResponseBlob, location_name: "Configuration"))
-    GetLatestConfigurationResponse.add_member(:content_type, Shapes::ShapeRef.new(shape: String, location: "header", location_name: "Content-Type"))
     GetLatestConfigurationResponse.add_member(:next_poll_configuration_token, Shapes::ShapeRef.new(shape: Token, location: "header", location_name: "Next-Poll-Configuration-Token"))
     GetLatestConfigurationResponse.add_member(:next_poll_interval_in_seconds, Shapes::ShapeRef.new(shape: Integer, location: "header", location_name: "Next-Poll-Interval-In-Seconds"))
+    GetLatestConfigurationResponse.add_member(:content_type, Shapes::ShapeRef.new(shape: String, location: "header", location_name: "Content-Type"))
+    GetLatestConfigurationResponse.add_member(:configuration, Shapes::ShapeRef.new(shape: SyntheticGetLatestConfigurationResponseBlob, location_name: "Configuration"))
     GetLatestConfigurationResponse.struct_class = Types::GetLatestConfigurationResponse
     GetLatestConfigurationResponse[:payload] = :configuration
     GetLatestConfigurationResponse[:payload_member] = GetLatestConfigurationResponse.member(:configuration)
@@ -67,13 +67,13 @@ module Aws::AppConfigData
     InvalidParameterMap.value = Shapes::ShapeRef.new(shape: InvalidParameterDetail)
 
     ResourceNotFoundException.add_member(:message, Shapes::ShapeRef.new(shape: String, location_name: "Message"))
-    ResourceNotFoundException.add_member(:referenced_by, Shapes::ShapeRef.new(shape: StringMap, location_name: "ReferencedBy"))
     ResourceNotFoundException.add_member(:resource_type, Shapes::ShapeRef.new(shape: ResourceType, location_name: "ResourceType"))
+    ResourceNotFoundException.add_member(:referenced_by, Shapes::ShapeRef.new(shape: StringMap, location_name: "ReferencedBy"))
     ResourceNotFoundException.struct_class = Types::ResourceNotFoundException
 
     StartConfigurationSessionRequest.add_member(:application_identifier, Shapes::ShapeRef.new(shape: Identifier, required: true, location_name: "ApplicationIdentifier"))
-    StartConfigurationSessionRequest.add_member(:configuration_profile_identifier, Shapes::ShapeRef.new(shape: Identifier, required: true, location_name: "ConfigurationProfileIdentifier"))
     StartConfigurationSessionRequest.add_member(:environment_identifier, Shapes::ShapeRef.new(shape: Identifier, required: true, location_name: "EnvironmentIdentifier"))
+    StartConfigurationSessionRequest.add_member(:configuration_profile_identifier, Shapes::ShapeRef.new(shape: Identifier, required: true, location_name: "ConfigurationProfileIdentifier"))
     StartConfigurationSessionRequest.add_member(:required_minimum_poll_interval_in_seconds, Shapes::ShapeRef.new(shape: OptionalPollSeconds, location_name: "RequiredMinimumPollIntervalInSeconds"))
     StartConfigurationSessionRequest.struct_class = Types::StartConfigurationSessionRequest
 

data/lib/aws-sdk-appconfigdata/errors.rb

@@ -47,11 +47,6 @@ module Aws::AppConfigData
         super(context, message, data)
       end
 
-      # @return [String]
-      def details
-        @data[:details]
-      end
-
       # @return [String]
       def message
         @message || @data[:message]
@@ -61,6 +56,11 @@ module Aws::AppConfigData
       def reason
         @data[:reason]
       end
+
+      # @return [String]
+      def details
+        @data[:details]
+      end
     end
 
     class InternalServerException < ServiceError
@@ -93,13 +93,13 @@ module Aws::AppConfigData
       end
 
       # @return [String]
-      def referenced_by
-        @data[:referenced_by]
+      def resource_type
+        @data[:resource_type]
       end
 
       # @return [String]
-      def resource_type
-        @data[:resource_type]
+      def referenced_by
+        @data[:referenced_by]
       end
     end
 

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

@@ -10,10 +10,11 @@
 module Aws::AppConfigData
   module Types
 
-    # Details describing why the request was invalid
+    # Detailed information about the input that failed to satisfy the
+    # constraints specified by a call.
     #
     # @!attribute [rw] invalid_parameters
-    #   Present if the Reason for the bad request was 'InvalidParameters'
+    #   One or more specified parameters are not valid for the call.
     #   @return [Hash<String,Types::InvalidParameterDetail>]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/appconfigdata-2021-11-11/BadRequestDetails AWS API Documentation
@@ -31,10 +32,6 @@ module Aws::AppConfigData
 
     # The input fails to satisfy the constraints specified by the service.
     #
-    # @!attribute [rw] details
-    #   Details describing why the request was invalid
-    #   @return [Types::BadRequestDetails]
-    #
     # @!attribute [rw] message
     #   @return [String]
     #
@@ -42,18 +39,20 @@ module Aws::AppConfigData
     #   Code indicating the reason the request was invalid.
     #   @return [String]
     #
+    # @!attribute [rw] details
+    #   Details describing why the request was invalid.
+    #   @return [Types::BadRequestDetails]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/appconfigdata-2021-11-11/BadRequestException AWS API Documentation
     #
     class BadRequestException < Struct.new(
-      :details,
       :message,
-      :reason)
+      :reason,
+      :details)
       SENSITIVE = []
       include Aws::Structure
     end
 
-    # Request parameters for the GetLatestConfiguration API
-    #
     # @note When making an API call, you may pass GetLatestConfigurationRequest
     #   data as a hash:
     #
@@ -64,9 +63,10 @@ module Aws::AppConfigData
     # @!attribute [rw] configuration_token
     #   Token describing the current state of the configuration session. To
     #   obtain a token, first call the StartConfigurationSession API. Note
-    #   that every call to GetLatestConfiguration will return a new
-    #   ConfigurationToken (NextPollConfigurationToken in the response) and
-    #   MUST be provided to subsequent GetLatestConfiguration API calls.
+    #   that every call to `GetLatestConfiguration` will return a new
+    #   `ConfigurationToken` (`NextPollConfigurationToken` in the response)
+    #   and MUST be provided to subsequent `GetLatestConfiguration` API
+    #   calls.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/appconfigdata-2021-11-11/GetLatestConfigurationRequest AWS API Documentation
@@ -77,38 +77,36 @@ module Aws::AppConfigData
       include Aws::Structure
     end
 
-    # Response parameters for the GetLatestConfiguration API
-    #
-    # @!attribute [rw] configuration
-    #   The data of the configuration. Note that this may be empty if the
-    #   client already has the latest version of configuration.
-    #   @return [String]
-    #
-    # @!attribute [rw] content_type
-    #   A standard MIME type describing the format of the configuration
-    #   content.
-    #   @return [String]
-    #
     # @!attribute [rw] next_poll_configuration_token
     #   The latest token describing the current state of the configuration
     #   session. This MUST be provided to the next call to
-    #   GetLatestConfiguration.
+    #   `GetLatestConfiguration.`
     #   @return [String]
     #
     # @!attribute [rw] next_poll_interval_in_seconds
     #   The amount of time the client should wait before polling for
-    #   configuration updates again. See
-    #   RequiredMinimumPollIntervalInSeconds to set the desired poll
+    #   configuration updates again. Use
+    #   `RequiredMinimumPollIntervalInSeconds` to set the desired poll
     #   interval.
     #   @return [Integer]
     #
+    # @!attribute [rw] content_type
+    #   A standard MIME type describing the format of the configuration
+    #   content.
+    #   @return [String]
+    #
+    # @!attribute [rw] configuration
+    #   The data of the configuration. This may be empty if the client
+    #   already has the latest version of configuration.
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/appconfigdata-2021-11-11/GetLatestConfigurationResponse AWS API Documentation
     #
     class GetLatestConfigurationResponse < Struct.new(
-      :configuration,
-      :content_type,
       :next_poll_configuration_token,
-      :next_poll_interval_in_seconds)
+      :next_poll_interval_in_seconds,
+      :content_type,
+      :configuration)
       SENSITIVE = [:configuration]
       include Aws::Structure
     end
@@ -126,11 +124,10 @@ module Aws::AppConfigData
       include Aws::Structure
     end
 
-    # Contains details about an invalid parameter.
+    # Information about an invalid parameter.
     #
     # @!attribute [rw] problem
-    #   Detail describing why an individual parameter did not satisfy the
-    #   constraints specified by the service
+    #   The reason the parameter is invalid.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/appconfigdata-2021-11-11/InvalidParameterDetail AWS API Documentation
@@ -146,34 +143,32 @@ module Aws::AppConfigData
     # @!attribute [rw] message
     #   @return [String]
     #
+    # @!attribute [rw] resource_type
+    #   The type of resource that was not found.
+    #   @return [String]
+    #
     # @!attribute [rw] referenced_by
     #   A map indicating which parameters in the request reference the
     #   resource that was not found.
     #   @return [Hash<String,String>]
     #
-    # @!attribute [rw] resource_type
-    #   The type of resource that was not found.
-    #   @return [String]
-    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/appconfigdata-2021-11-11/ResourceNotFoundException AWS API Documentation
     #
     class ResourceNotFoundException < Struct.new(
       :message,
-      :referenced_by,
-      :resource_type)
+      :resource_type,
+      :referenced_by)
       SENSITIVE = []
       include Aws::Structure
     end
 
-    # Request parameters for the StartConfigurationSession API.
-    #
     # @note When making an API call, you may pass StartConfigurationSessionRequest
     #   data as a hash:
     #
     #       {
     #         application_identifier: "Identifier", # required
-    #         configuration_profile_identifier: "Identifier", # required
     #         environment_identifier: "Identifier", # required
+    #         configuration_profile_identifier: "Identifier", # required
     #         required_minimum_poll_interval_in_seconds: 1,
     #       }
     #
@@ -181,43 +176,41 @@ module Aws::AppConfigData
     #   The application ID or the application name.
     #   @return [String]
     #
-    # @!attribute [rw] configuration_profile_identifier
-    #   The configuration profile ID or the configuration profile name.
-    #   @return [String]
-    #
     # @!attribute [rw] environment_identifier
     #   The environment ID or the environment name.
     #   @return [String]
     #
+    # @!attribute [rw] configuration_profile_identifier
+    #   The configuration profile ID or the configuration profile name.
+    #   @return [String]
+    #
     # @!attribute [rw] required_minimum_poll_interval_in_seconds
-    #   The interval at which your client will poll for configuration. If
-    #   provided, the service will throw a BadRequestException if the client
-    #   polls before the specified poll interval. By default, client poll
-    #   intervals are not enforced.
+    #   Sets a constraint on a session. If you specify a value of, for
+    #   example, 60 seconds, then the client that established the session
+    #   can't call GetLatestConfiguration more frequently then every 60
+    #   seconds.
     #   @return [Integer]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/appconfigdata-2021-11-11/StartConfigurationSessionRequest AWS API Documentation
     #
     class StartConfigurationSessionRequest < Struct.new(
       :application_identifier,
-      :configuration_profile_identifier,
       :environment_identifier,
+      :configuration_profile_identifier,
       :required_minimum_poll_interval_in_seconds)
       SENSITIVE = []
       include Aws::Structure
     end
 
-    # Response parameters for the StartConfigurationSession API.
-    #
     # @!attribute [rw] initial_configuration_token
     #   Token encapsulating state about the configuration session. Provide
-    #   this token to the GetLatestConfiguration API to retrieve
+    #   this token to the `GetLatestConfiguration` API to retrieve
     #   configuration data.
     #
     #   This token should only be used once in your first call to
-    #   GetLatestConfiguration. You MUST use the new token in the
-    #   GetConfiguration response (NextPollConfigurationToken) in each
-    #   subsequent call to GetLatestConfiguration.
+    #   `GetLatestConfiguration`. You MUST use the new token in the
+    #   `GetLatestConfiguration` response (`NextPollConfigurationToken`) in
+    #   each subsequent call to `GetLatestConfiguration`.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/appconfigdata-2021-11-11/StartConfigurationSessionResponse AWS API Documentation

data/lib/aws-sdk-appconfigdata.rb

@@ -48,6 +48,6 @@ require_relative 'aws-sdk-appconfigdata/customizations'
 # @!group service
 module Aws::AppConfigData
 
-  GEM_VERSION = '1.2.0'
+  GEM_VERSION = '1.3.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-appconfigdata
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.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