Class: Aws::AppConfig::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::AppConfig::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/client.rb
Overview
An API client for AppConfig. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::AppConfig::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
-
#create_application(params = {}) ⇒ Types::Application
Creates an application.
-
#create_configuration_profile(params = {}) ⇒ Types::ConfigurationProfile
Creates a configuration profile, which is information that enables AppConfig to access the configuration source.
-
#create_deployment_strategy(params = {}) ⇒ Types::DeploymentStrategy
Creates a deployment strategy that defines important criteria for rolling out your configuration to the designated targets.
-
#create_environment(params = {}) ⇒ Types::Environment
Creates an environment.
-
#create_hosted_configuration_version(params = {}) ⇒ Types::HostedConfigurationVersion
Creates a new configuration in the AppConfig hosted configuration store.
-
#delete_application(params = {}) ⇒ Struct
Deletes an application.
-
#delete_configuration_profile(params = {}) ⇒ Struct
Deletes a configuration profile.
-
#delete_deployment_strategy(params = {}) ⇒ Struct
Deletes a deployment strategy.
-
#delete_environment(params = {}) ⇒ Struct
Deletes an environment.
-
#delete_hosted_configuration_version(params = {}) ⇒ Struct
Deletes a version of a configuration from the AppConfig hosted configuration store.
-
#get_application(params = {}) ⇒ Types::Application
Retrieves information about an application.
-
#get_configuration(params = {}) ⇒ Types::Configuration
Retrieves the latest deployed configuration.
-
#get_configuration_profile(params = {}) ⇒ Types::ConfigurationProfile
Retrieves information about a configuration profile.
-
#get_deployment(params = {}) ⇒ Types::Deployment
Retrieves information about a configuration deployment.
-
#get_deployment_strategy(params = {}) ⇒ Types::DeploymentStrategy
Retrieves information about a deployment strategy.
-
#get_environment(params = {}) ⇒ Types::Environment
Retrieves information about an environment.
-
#get_hosted_configuration_version(params = {}) ⇒ Types::HostedConfigurationVersion
Retrieves information about a specific configuration version.
-
#list_applications(params = {}) ⇒ Types::Applications
Lists all applications in your Amazon Web Services account.
-
#list_configuration_profiles(params = {}) ⇒ Types::ConfigurationProfiles
Lists the configuration profiles for an application.
-
#list_deployment_strategies(params = {}) ⇒ Types::DeploymentStrategies
Lists deployment strategies.
-
#list_deployments(params = {}) ⇒ Types::Deployments
Lists the deployments for an environment in descending deployment number order.
-
#list_environments(params = {}) ⇒ Types::Environments
Lists the environments for an application.
-
#list_hosted_configuration_versions(params = {}) ⇒ Types::HostedConfigurationVersions
Lists configurations stored in the AppConfig hosted configuration store by version.
-
#list_tags_for_resource(params = {}) ⇒ Types::ResourceTags
Retrieves the list of key-value tags assigned to the resource.
-
#start_deployment(params = {}) ⇒ Types::Deployment
Starts a deployment.
-
#stop_deployment(params = {}) ⇒ Types::Deployment
Stops a deployment.
-
#tag_resource(params = {}) ⇒ Struct
Assigns metadata to an AppConfig resource.
-
#untag_resource(params = {}) ⇒ Struct
Deletes a tag key and value from an AppConfig resource.
-
#update_application(params = {}) ⇒ Types::Application
Updates an application.
-
#update_configuration_profile(params = {}) ⇒ Types::ConfigurationProfile
Updates a configuration profile.
-
#update_deployment_strategy(params = {}) ⇒ Types::DeploymentStrategy
Updates a deployment strategy.
-
#update_environment(params = {}) ⇒ Types::Environment
Updates an environment.
-
#validate_configuration(params = {}) ⇒ Struct
Uses the validators in a configuration profile to validate a 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.
348 349 350 |
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/client.rb', line 348 def initialize(*args) super end |
Instance Method Details
#create_application(params = {}) ⇒ Types::Application
Creates an application. An application in AppConfig is a logical unit of code that provides capabilities for your customers. For example, an application can be a microservice that runs on Amazon EC2 instances, a mobile application installed by your users, a serverless application using Amazon API Gateway and Lambda, or any system you run on behalf of others.
415 416 417 418 |
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/client.rb', line 415 def create_application(params = {}, = {}) req = build_request(:create_application, params) req.send_request() end |
#create_configuration_profile(params = {}) ⇒ Types::ConfigurationProfile
Creates a configuration profile, which is information that enables AppConfig to access the configuration source. Valid configuration sources include the AppConfig hosted configuration store, Amazon Web Services Systems Manager (SSM) documents, SSM Parameter Store parameters, Amazon S3 objects, or any integration source action supported by CodePipeline. 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.
564 565 566 567 |
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/client.rb', line 564 def create_configuration_profile(params = {}, = {}) req = build_request(:create_configuration_profile, params) req.send_request() end |
#create_deployment_strategy(params = {}) ⇒ Types::DeploymentStrategy
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.
696 697 698 699 |
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/client.rb', line 696 def create_deployment_strategy(params = {}, = {}) req = build_request(:create_deployment_strategy, params) req.send_request() end |
#create_environment(params = {}) ⇒ Types::Environment
Creates an environment. For each application, you define one or more
environments. An environment is a logical 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.
788 789 790 791 |
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/client.rb', line 788 def create_environment(params = {}, = {}) req = build_request(:create_environment, params) req.send_request() end |
#create_hosted_configuration_version(params = {}) ⇒ Types::HostedConfigurationVersion
Creates a new configuration in the AppConfig hosted configuration store.
878 879 880 881 |
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/client.rb', line 878 def create_hosted_configuration_version(params = {}, = {}) req = build_request(:create_hosted_configuration_version, params) req.send_request() end |
#delete_application(params = {}) ⇒ Struct
Deletes an application. Deleting an application does not delete a configuration from a host.
910 911 912 913 |
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/client.rb', line 910 def delete_application(params = {}, = {}) req = build_request(:delete_application, params) req.send_request() end |
#delete_configuration_profile(params = {}) ⇒ Struct
Deletes a configuration profile. Deleting a configuration profile does not delete a configuration from a host.
948 949 950 951 |
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/client.rb', line 948 def delete_configuration_profile(params = {}, = {}) req = build_request(:delete_configuration_profile, params) req.send_request() end |
#delete_deployment_strategy(params = {}) ⇒ Struct
Deletes a deployment strategy. Deleting a deployment strategy does not delete a configuration from a host.
980 981 982 983 |
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/client.rb', line 980 def delete_deployment_strategy(params = {}, = {}) req = build_request(:delete_deployment_strategy, params) req.send_request() end |
#delete_environment(params = {}) ⇒ Struct
Deletes an environment. Deleting an environment does not delete a configuration from a host.
1018 1019 1020 1021 |
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/client.rb', line 1018 def delete_environment(params = {}, = {}) req = build_request(:delete_environment, params) req.send_request() end |
#delete_hosted_configuration_version(params = {}) ⇒ Struct
Deletes a version of a configuration from the AppConfig hosted configuration store.
1061 1062 1063 1064 |
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/client.rb', line 1061 def delete_hosted_configuration_version(params = {}, = {}) req = build_request(:delete_hosted_configuration_version, params) req.send_request() end |
#get_application(params = {}) ⇒ Types::Application
Retrieves information about an application.
1108 1109 1110 1111 |
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/client.rb', line 1108 def get_application(params = {}, = {}) req = build_request(:get_application, params) req.send_request() end |
#get_configuration(params = {}) ⇒ Types::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 and GetLatestConfiguration APIs instead.
GetConfiguration
is a priced call. For more information, see Pricing.AppConfig uses the value of the
ClientConfigurationVersion
parameter to identify the configuration version on your clients. If you don’t sendClientConfigurationVersion
with each call toGetConfiguration
, 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 and GetLatestConfiguration APIs, which track the client configuration version on your behalf. If you choose to continue using
GetConfiguration
, we recommend that you include theClientConfigurationVersion
value with every call toGetConfiguration
. The value to use forClientConfigurationVersion
comes from theConfigurationVersion
attribute returned byGetConfiguration
when there is new or updated data, and should be saved for subsequent calls toGetConfiguration
.
1237 1238 1239 1240 |
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/client.rb', line 1237 def get_configuration(params = {}, = {}) req = build_request(:get_configuration, params) req.send_request() end |
#get_configuration_profile(params = {}) ⇒ Types::ConfigurationProfile
Retrieves information about a configuration profile.
1305 1306 1307 1308 |
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/client.rb', line 1305 def get_configuration_profile(params = {}, = {}) req = build_request(:get_configuration_profile, params) req.send_request() end |
#get_deployment(params = {}) ⇒ Types::Deployment
Retrieves information about a configuration deployment.
1457 1458 1459 1460 |
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/client.rb', line 1457 def get_deployment(params = {}, = {}) req = build_request(:get_deployment, params) req.send_request() end |
#get_deployment_strategy(params = {}) ⇒ Types::DeploymentStrategy
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.
1524 1525 1526 1527 |
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/client.rb', line 1524 def get_deployment_strategy(params = {}, = {}) req = build_request(:get_deployment_strategy, params) req.send_request() end |
#get_environment(params = {}) ⇒ Types::Environment
Retrieves information about an environment. An environment is a
logical 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.
1593 1594 1595 1596 |
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/client.rb', line 1593 def get_environment(params = {}, = {}) req = build_request(:get_environment, params) req.send_request() end |
#get_hosted_configuration_version(params = {}) ⇒ Types::HostedConfigurationVersion
Retrieves information about a specific configuration version.
1659 1660 1661 1662 |
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/client.rb', line 1659 def get_hosted_configuration_version(params = {}, = {}) req = build_request(:get_hosted_configuration_version, params) req.send_request() end |
#list_applications(params = {}) ⇒ Types::Applications
Lists all applications in your Amazon Web Services account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1728 1729 1730 1731 |
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/client.rb', line 1728 def list_applications(params = {}, = {}) req = build_request(:list_applications, params) req.send_request() end |
#list_configuration_profiles(params = {}) ⇒ Types::ConfigurationProfiles
Lists the configuration profiles for an application.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1806 1807 1808 1809 |
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/client.rb', line 1806 def list_configuration_profiles(params = {}, = {}) req = build_request(:list_configuration_profiles, params) req.send_request() end |
#list_deployment_strategies(params = {}) ⇒ Types::DeploymentStrategies
Lists deployment strategies.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1876 1877 1878 1879 |
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/client.rb', line 1876 def list_deployment_strategies(params = {}, = {}) req = build_request(:list_deployment_strategies, params) req.send_request() end |
#list_deployments(params = {}) ⇒ Types::Deployments
Lists the deployments for an environment in descending deployment number order.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1967 1968 1969 1970 |
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/client.rb', line 1967 def list_deployments(params = {}, = {}) req = build_request(:list_deployments, params) req.send_request() end |
#list_environments(params = {}) ⇒ Types::Environments
Lists the environments for an application.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2040 2041 2042 2043 |
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/client.rb', line 2040 def list_environments(params = {}, = {}) req = build_request(:list_environments, params) req.send_request() end |
#list_hosted_configuration_versions(params = {}) ⇒ Types::HostedConfigurationVersions
Lists configurations stored in the AppConfig hosted configuration store by version.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2116 2117 2118 2119 |
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/client.rb', line 2116 def list_hosted_configuration_versions(params = {}, = {}) req = build_request(:list_hosted_configuration_versions, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ResourceTags
Retrieves the list of key-value tags assigned to the resource.
2161 2162 2163 2164 |
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/client.rb', line 2161 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#start_deployment(params = {}) ⇒ Types::Deployment
Starts a deployment.
2299 2300 2301 2302 |
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/client.rb', line 2299 def start_deployment(params = {}, = {}) req = build_request(:start_deployment, params) req.send_request() end |
#stop_deployment(params = {}) ⇒ Types::Deployment
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
.
2395 2396 2397 2398 |
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/client.rb', line 2395 def stop_deployment(params = {}, = {}) req = build_request(:stop_deployment, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
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.
2440 2441 2442 2443 |
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/client.rb', line 2440 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Deletes a tag key and value from an AppConfig resource.
2478 2479 2480 2481 |
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/client.rb', line 2478 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_application(params = {}) ⇒ Types::Application
Updates an application.
2536 2537 2538 2539 |
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/client.rb', line 2536 def update_application(params = {}, = {}) req = build_request(:update_application, params) req.send_request() end |
#update_configuration_profile(params = {}) ⇒ Types::ConfigurationProfile
Updates a configuration profile.
2627 2628 2629 2630 |
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/client.rb', line 2627 def update_configuration_profile(params = {}, = {}) req = build_request(:update_configuration_profile, params) req.send_request() end |
#update_deployment_strategy(params = {}) ⇒ Types::DeploymentStrategy
Updates a deployment strategy.
2740 2741 2742 2743 |
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/client.rb', line 2740 def update_deployment_strategy(params = {}, = {}) req = build_request(:update_deployment_strategy, params) req.send_request() end |
#update_environment(params = {}) ⇒ Types::Environment
Updates an environment.
2821 2822 2823 2824 |
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/client.rb', line 2821 def update_environment(params = {}, = {}) req = build_request(:update_environment, params) req.send_request() end |
#validate_configuration(params = {}) ⇒ Struct
Uses the validators in a configuration profile to validate a configuration.
2863 2864 2865 2866 |
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/client.rb', line 2863 def validate_configuration(params = {}, = {}) req = build_request(:validate_configuration, params) req.send_request() end |