Class: Aws::AppConfigData::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::AppConfigData::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-appconfigdata/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.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
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.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
385 386 387 |
# File 'gems/aws-sdk-appconfigdata/lib/aws-sdk-appconfigdata/client.rb', line 385 def initialize(*args) super end |
Instance Method Details
#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
. TheGetLatestConfiguration
response includes aNextPollConfigurationToken
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.
452 453 454 455 |
# File 'gems/aws-sdk-appconfigdata/lib/aws-sdk-appconfigdata/client.rb', line 452 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.
503 504 505 506 |
# File 'gems/aws-sdk-appconfigdata/lib/aws-sdk-appconfigdata/client.rb', line 503 def start_configuration_session(params = {}, = {}) req = build_request(:start_configuration_session, params) req.send_request() end |