Class: Aws::AppConfigData::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::AppConfigData::Client
- Includes:
- ClientStubs
- Defined in:
- lib/aws-sdk-appconfigdata/client.rb
Overview
An API client for AppConfigData. To construct a client, you need to configure a ‘:region` and `:credentials`.
client = Aws::AppConfigData::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
See #initialize for a full list of supported configuration options.
Class Attribute Summary collapse
- .identifier ⇒ Object readonly private
API Operations collapse
-
#get_latest_configuration(params = {}) ⇒ Types::GetLatestConfigurationResponse
Retrieves the latest deployed configuration.
-
#start_configuration_session(params = {}) ⇒ Types::StartConfigurationSessionResponse
Starts a configuration session used to retrieve a deployed configuration.
Class Method Summary collapse
- .errors_module ⇒ Object private
Instance Method Summary collapse
- #build_request(operation_name, params = {}) ⇒ Object private
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
- #waiter_names ⇒ Object deprecated private Deprecated.
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
410 411 412 |
# File 'lib/aws-sdk-appconfigdata/client.rb', line 410 def initialize(*args) super end |
Class Attribute Details
.identifier ⇒ Object (readonly)
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
559 560 561 |
# File 'lib/aws-sdk-appconfigdata/client.rb', line 559 def identifier @identifier end |
Class Method Details
.errors_module ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
562 563 564 |
# File 'lib/aws-sdk-appconfigdata/client.rb', line 562 def errors_module Errors end |
Instance Method Details
#build_request(operation_name, params = {}) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
537 538 539 540 541 542 543 544 545 546 547 548 |
# File 'lib/aws-sdk-appconfigdata/client.rb', line 537 def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-appconfigdata' context[:gem_version] = '1.21.0' Seahorse::Client::Request.new(handlers, context) end |
#get_latest_configuration(params = {}) ⇒ Types::GetLatestConfigurationResponse
Retrieves the latest deployed configuration. This API may return empty 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 [Retrieving the configuration] in the *AppConfig User Guide*.
Note the following important information.
* 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].
[1]: docs.aws.amazon.com/appconfig/latest/userguide/appconfig-retrieving-the-configuration [2]: aws.amazon.com/systems-manager/pricing/
477 478 479 480 |
# File 'lib/aws-sdk-appconfigdata/client.rb', line 477 def get_latest_configuration(params = {}, = {}) req = build_request(:get_latest_configuration, params) req.send_request() end |
#start_configuration_session(params = {}) ⇒ Types::StartConfigurationSessionResponse
Starts a configuration session used to retrieve a deployed 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 [Retrieving the configuration] in the *AppConfig User Guide*.
[1]: docs.aws.amazon.com/appconfig/latest/userguide/appconfig-retrieving-the-configuration
528 529 530 531 |
# File 'lib/aws-sdk-appconfigdata/client.rb', line 528 def start_configuration_session(params = {}, = {}) req = build_request(:start_configuration_session, params) req.send_request() end |
#waiter_names ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
552 553 554 |
# File 'lib/aws-sdk-appconfigdata/client.rb', line 552 def waiter_names [] end |