Class: Aws::AppConfig::Client

Inherits:
Seahorse::Client::Base show all
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

#config, #handlers

API Operations collapse

Instance Method Summary collapse

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.

Parameters:

  • options (Hash)

Options Hash (options):

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials. This can be an instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.
  • :region (required, String) —

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :client_side_monitoring (Boolean) — default: false —

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :disable_request_compression (Boolean) — default: false —

    When set to 'true' the request body will not be compressed for supported operations.

  • :endpoint (String) —

    The client endpoint is normally constructed from the :region option. You should only configure an :endpoint when connecting to test or custom endpoints. This should be a valid HTTP(S) URI.

  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to true, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the :logger at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/. It should have a maximum length of 50.

  • :secret_access_key (String)
  • :session_token (String)
  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :token_provider (Aws::TokenProvider) —

    A Bearer Token Provider. This can be an instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

    • Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from aws login.

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::AppConfig::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::AppConfig::EndpointParameters

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_open_timeout (Float) — default: 15 —

    The number of seconds to wait when opening a HTTP session before raising a Timeout::Error.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :ssl_timeout (Float) — default: nil —

    Sets the SSL timeout in seconds.

  • :http_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.



385
386
387
 
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/client.rb', line 385

def initialize(*args)
  super
end

Instance Method Details

#create_application(params = {}) ⇒ Types::Application

Creates an application. In AppConfig, an application is simply an organizational construct like a folder. This organizational construct has a relationship with some unit of executable code. For example, you could create an application called MyMobileApp to organize and manage configuration data for a mobile application installed by your users.

Examples:

Example: To create an application


# The following create-application example creates an application in AWS AppConfig.

resp = client.create_application({
  description: "An application used for creating an example.", 
  name: "example-application", 
})

resp.to_h outputs the following:
{
  description: "An application used for creating an example.", 
  id: "339ohji", 
  name: "example-application", 
}

Request syntax with placeholder values


resp = client.create_application({
  name: "Name", # required
  description: "Description",
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.id #=> String
resp.name #=> String
resp.description #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    A name for the application.

  • :description (String) —

    A description of the application.

  • :tags (Hash<String,String>) —

    Metadata to assign to the application. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define.

Returns:

See Also:



451
452
453
454
 
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/client.rb', line 451

def create_application(params = {}, options = {})
  req = build_request(:create_application, params)
  req.send_request(options)
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 following:

  • Configuration data in YAML, JSON, and other formats stored in the AppConfig hosted configuration store

  • Configuration data stored as objects in an Amazon Simple Storage Service (Amazon S3) bucket

  • Pipelines stored in CodePipeline

  • Secrets stored in Secrets Manager

  • Standard and secure string parameters stored in Amazon Web Services Systems Manager Parameter Store

  • Configuration data in SSM documents stored in the Systems Manager document store

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.

Examples:

Example: To create a configuration profile


# The following create-configuration-profile example creates a configuration profile using a configuration stored in
# Parameter Store, a capability of Systems Manager.

resp = client.create_configuration_profile({
  application_id: "339ohji", 
  location_uri: "ssm-parameter://Example-Parameter", 
  name: "Example-Configuration-Profile", 
  retrieval_role_arn: "arn:aws:iam::111122223333:role/Example-App-Config-Role", 
})

resp.to_h outputs the following:
{
  application_id: "339ohji", 
  id: "ur8hx2f", 
  location_uri: "ssm-parameter://Example-Parameter", 
  name: "Example-Configuration-Profile", 
  retrieval_role_arn: "arn:aws:iam::111122223333:role/Example-App-Config-Role", 
}

Request syntax with placeholder values


resp = client.create_configuration_profile({
  application_id: "Id", # required
  name: "LongName", # required
  description: "Description",
  location_uri: "Uri", # required
  retrieval_role_arn: "RoleArn",
  validators: [
    {
      type: "JSON_SCHEMA", # required, accepts JSON_SCHEMA, LAMBDA
      content: "StringWithLengthBetween0And32768", # required
    },
  ],
  tags: {
    "TagKey" => "TagValue",
  },
  type: "ConfigurationProfileType",
})

Response structure


resp.application_id #=> String
resp.id #=> String
resp.name #=> String
resp.description #=> String
resp.location_uri #=> String
resp.retrieval_role_arn #=> String
resp.validators #=> Array
resp.validators[0].type #=> String, one of "JSON_SCHEMA", "LAMBDA"
resp.validators[0].content #=> String
resp.type #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :application_id (required, String) —

    The application ID.

  • :name (required, String) —

    A name for the configuration profile.

  • :description (String) —

    A description of the configuration profile.

  • :location_uri (required, String) —

    A URI to locate the configuration. You can specify the following:

    • For the AppConfig hosted configuration store and for feature flags, specify hosted.

    • For an Amazon Web Services Systems Manager Parameter Store parameter, specify either the parameter name in the format ssm-parameter://<parameter name> or the ARN.

    • For an Amazon Web Services CodePipeline pipeline, specify the URI in the following format: codepipeline://<pipeline name>.

    • For an Secrets Manager secret, specify the URI in the following format: secretsmanager://<secret name>.

    • For an Amazon S3 object, specify the URI in the following format: s3://<bucket>/<objectKey>. Here is an example: s3://my-bucket/my-app/us-east-1/my-config.json

    • For an SSM document, specify either the document name in the format ssm-document://<document name> or the Amazon Resource Name (ARN).

  • :retrieval_role_arn (String) —

    The ARN of an IAM role with permission to access the configuration at the specified LocationUri.

    A retrieval role ARN is not required for configurations stored in the AppConfig hosted configuration store. It is required for all other sources that store your configuration.

  • :validators (Array<Types::Validator>) —

    A list of methods for validating the configuration.

  • :tags (Hash<String,String>) —

    Metadata to assign to the configuration profile. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define.

  • :type (String) —

    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

Returns:

See Also:



623
624
625
626
 
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/client.rb', line 623

def create_configuration_profile(params = {}, options = {})
  req = build_request(:create_configuration_profile, params)
  req.send_request(options)
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.

Examples:

Example: To create a deployment strategy


# The following create-deployment-strategy example creates a deployment strategy called Example-Deployment that takes 15
# minutes and deploys the configuration to 25% of the application at a time. The strategy is also copied to an SSM
# Document.

resp = client.create_deployment_strategy({
  deployment_duration_in_minutes: 15, 
  growth_factor: 25, 
  name: "Example-Deployment", 
  replicate_to: "SSM_DOCUMENT", 
})

resp.to_h outputs the following:
{
  deployment_duration_in_minutes: 15, 
  final_bake_time_in_minutes: 0, 
  growth_factor: 25, 
  growth_type: "LINEAR", 
  id: "1225qzk", 
  name: "Example-Deployment", 
  replicate_to: "SSM_DOCUMENT", 
}

Request syntax with placeholder values


resp = client.create_deployment_strategy({
  name: "Name", # required
  description: "Description",
  deployment_duration_in_minutes: 1, # required
  final_bake_time_in_minutes: 1,
  growth_factor: 1.0, # required
  growth_type: "LINEAR", # accepts LINEAR, EXPONENTIAL
  replicate_to: "NONE", # accepts NONE, SSM_DOCUMENT
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.id #=> String
resp.name #=> String
resp.description #=> String
resp.deployment_duration_in_minutes #=> Integer
resp.growth_type #=> String, one of "LINEAR", "EXPONENTIAL"
resp.growth_factor #=> Float
resp.final_bake_time_in_minutes #=> Integer
resp.replicate_to #=> String, one of "NONE", "SSM_DOCUMENT"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    A name for the deployment strategy.

  • :description (String) —

    A description of the deployment strategy.

  • :deployment_duration_in_minutes (required, Integer) —

    Total amount of time for a deployment to last.

  • :final_bake_time_in_minutes (Integer) —

    Specifies the amount of time AppConfig monitors for Amazon CloudWatch alarms after the configuration has been deployed to 100% of its targets, before considering the deployment to be complete. If an alarm is triggered during this time, AppConfig rolls back the deployment. You must configure permissions for AppConfig to roll back based on CloudWatch alarms. For more information, see Configuring permissions for rollback based on Amazon CloudWatch alarms in the AppConfig User Guide.

  • :growth_factor (required, Float) —

    The percentage of targets to receive a deployed configuration during each interval.

  • :growth_type (String) —

    The algorithm used to define how percentage grows over time. AppConfig supports the following growth types:

    Linear: For this type, AppConfig processes the deployment by dividing the total number of targets by the value specified for Step percentage. For example, a linear deployment that uses a Step percentage of 10 deploys the configuration to 10 percent of the hosts. After those deployments are complete, the system deploys the configuration to the next 10 percent. This continues until 100% of the targets have successfully received the configuration.

    Exponential: For this type, AppConfig processes the deployment exponentially using the following formula: G*(2^N). In this formula, G is the growth factor specified by the user and N is the number of steps until the configuration is deployed to all targets. For example, if you specify a growth factor of 2, then the system rolls out the configuration as follows:

    2*(2^0)

    2*(2^1)

    2*(2^2)

    Expressed numerically, the deployment rolls out as follows: 2% of the targets, 4% of the targets, 8% of the targets, and continues until the configuration has been deployed to all targets.

  • :replicate_to (String) —

    Save the deployment strategy to a Systems Manager (SSM) document.

  • :tags (Hash<String,String>) —

    Metadata to assign to the deployment strategy. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define.

Returns:

See Also:



764
765
766
767
 
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/client.rb', line 764

def create_deployment_strategy(params = {}, options = {})
  req = build_request(:create_deployment_strategy, params)
  req.send_request(options)
end

#create_environment(params = {}) ⇒ Types::Environment

Creates an environment. For each application, you define one or more environments. An environment is a 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.

Examples:

Example: To create an environment


# The following create-environment example creates an AWS AppConfig environment named Example-Environment using the
# application you created using create-application

resp = client.create_environment({
  application_id: "339ohji", 
  name: "Example-Environment", 
})

resp.to_h outputs the following:
{
  application_id: "339ohji", 
  id: "54j1r29", 
  name: "Example-Environment", 
  state: "READY_FOR_DEPLOYMENT", 
}

Request syntax with placeholder values


resp = client.create_environment({
  application_id: "Id", # required
  name: "Name", # required
  description: "Description",
  monitors: [
    {
      alarm_arn: "StringWithLengthBetween1And2048", # required
      alarm_role_arn: "RoleArn",
    },
  ],
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.application_id #=> String
resp.id #=> String
resp.name #=> String
resp.description #=> String
resp.state #=> String, one of "READY_FOR_DEPLOYMENT", "DEPLOYING", "ROLLING_BACK", "ROLLED_BACK"
resp.monitors #=> Array
resp.monitors[0].alarm_arn #=> String
resp.monitors[0].alarm_role_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :application_id (required, String) —

    The application ID.

  • :name (required, String) —

    A name for the environment.

  • :description (String) —

    A description of the environment.

  • :monitors (Array<Types::Monitor>) —

    Amazon CloudWatch alarms to monitor during the deployment process.

  • :tags (Hash<String,String>) —

    Metadata to assign to the environment. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define.

Returns:

See Also:



855
856
857
858
 
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/client.rb', line 855

def create_environment(params = {}, options = {})
  req = build_request(:create_environment, params)
  req.send_request(options)
end

#create_extension(params = {}) ⇒ Types::Extension

Creates an AppConfig extension. An extension augments your ability to inject logic or behavior at different points during the AppConfig workflow of creating or deploying a configuration.

You can create your own extensions or use the Amazon Web Services authored extensions provided by AppConfig. For an AppConfig extension that uses Lambda, you must create a Lambda function to perform any computation and processing defined in the extension. If you plan to create custom versions of the Amazon Web Services authored notification extensions, you only need to specify an Amazon Resource Name (ARN) in the Uri field for the new extension version.

  • For a custom EventBridge notification extension, enter the ARN of the EventBridge default events in the Uri field.

  • For a custom Amazon SNS notification extension, enter the ARN of an Amazon SNS topic in the Uri field.

  • For a custom Amazon SQS notification extension, enter the ARN of an Amazon SQS message queue in the Uri field.

For more information about extensions, see Working with AppConfig extensions in the AppConfig User Guide.

Examples:

Request syntax with placeholder values


resp = client.create_extension({
  name: "Name", # required
  description: "Description",
  actions: { # required
    "PRE_CREATE_HOSTED_CONFIGURATION_VERSION" => [
      {
        name: "Name",
        description: "Description",
        uri: "Uri",
        role_arn: "Arn",
      },
    ],
  },
  parameters: {
    "Name" => {
      description: "Description",
      required: false,
    },
  },
  tags: {
    "TagKey" => "TagValue",
  },
  latest_version_number: 1,
})

Response structure


resp.id #=> String
resp.name #=> String
resp.version_number #=> Integer
resp.arn #=> String
resp.description #=> String
resp.actions #=> Hash
resp.actions["ActionPoint"] #=> Array
resp.actions["ActionPoint"][0].name #=> String
resp.actions["ActionPoint"][0].description #=> String
resp.actions["ActionPoint"][0].uri #=> String
resp.actions["ActionPoint"][0].role_arn #=> String
resp.parameters #=> Hash
resp.parameters["Name"].description #=> String
resp.parameters["Name"].required #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    A name for the extension. Each extension name in your account must be unique. Extension versions use the same name.

  • :description (String) —

    Information about the extension.

  • :actions (required, Hash<String,Array>) —

    The actions defined in the extension.

  • :parameters (Hash<String,Types::Parameter>) —

    The parameters accepted by the extension. You specify parameter values when you associate the extension to an AppConfig resource by using the CreateExtensionAssociation API action. For Lambda extension actions, these parameters are included in the Lambda request object.

  • :tags (Hash<String,String>) —

    Adds one or more tags for the specified extension. Tags are metadata that help you categorize resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define.

  • :latest_version_number (Integer) —

    You can omit this field when you create an extension. When you create a new version, specify the most recent current version number. For example, you create version 3, enter 2 for this field.

Returns:

See Also:



973
974
975
976
 
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/client.rb', line 973

def create_extension(params = {}, options = {})
  req = build_request(:create_extension, params)
  req.send_request(options)
end

#create_extension_association(params = {}) ⇒ Types::ExtensionAssociation

When you create an extension or configure an Amazon Web Services authored extension, you associate the extension with an AppConfig application, environment, or configuration profile. For example, you can choose to run the AppConfig deployment events to Amazon SNS Amazon Web Services authored extension and receive notifications on an Amazon SNS topic anytime a configuration deployment is started for a specific application. Defining which extension to associate with an AppConfig resource is called an extension association. An extension association is a specified relationship between an extension and an AppConfig resource, such as an application or a configuration profile. For more information about extensions and associations, see Working with AppConfig extensions in the AppConfig User Guide.

Examples:

Request syntax with placeholder values


resp = client.create_extension_association({
  extension_identifier: "Identifier", # required
  extension_version_number: 1,
  resource_identifier: "Identifier", # required
  parameters: {
    "Name" => "StringWithLengthBetween1And2048",
  },
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.id #=> String
resp.extension_arn #=> String
resp.resource_arn #=> String
resp.arn #=> String
resp.parameters #=> Hash
resp.parameters["Name"] #=> String
resp.extension_version_number #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :extension_identifier (required, String) —

    The name, the ID, or the Amazon Resource Name (ARN) of the extension.

  • :extension_version_number (Integer) —

    The version number of the extension. If not specified, AppConfig uses the maximum version of the extension.

  • :resource_identifier (required, String) —

    The ARN of an application, configuration profile, or environment.

  • :parameters (Hash<String,String>) —

    The parameter names and values defined in the extensions. Extension parameters marked Required must be entered for this field.

  • :tags (Hash<String,String>) —

    Adds one or more tags for the specified extension association. Tags are metadata that help you categorize resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define.

Returns:

See Also:



1052
1053
1054
1055
 
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/client.rb', line 1052

def create_extension_association(params = {}, options = {})
  req = build_request(:create_extension_association, params)
  req.send_request(options)
end

#create_hosted_configuration_version(params = {}) ⇒ Types::HostedConfigurationVersion

Creates a new configuration in the AppConfig hosted configuration store.

Examples:

Example: To create a hosted configuration version


# The following create-hosted-configuration-version example creates a new configuration in the AWS AppConfig configuration
# store.

resp = client.create_hosted_configuration_version({
  application_id: "339ohji", 
  configuration_profile_id: "ur8hx2f", 
  content: "eyAiTmFtZSI6ICJFeGFtcGxlQXBwbGljYXRpb24iLCAiSWQiOiBFeGFtcGxlSUQsICJSYW5rIjogNyB9", 
  content_type: "text", 
  latest_version_number: 1, 
})

resp.to_h outputs the following:
{
  application_id: "339ohji", 
  configuration_profile_id: "ur8hx2f", 
  content_type: "text", 
  version_number: 1, 
}

Request syntax with placeholder values


resp = client.create_hosted_configuration_version({
  application_id: "Id", # required
  configuration_profile_id: "Id", # required
  description: "Description",
  content: "data", # required
  content_type: "StringWithLengthBetween1And255", # required
  latest_version_number: 1,
  version_label: "VersionLabel",
})

Response structure


resp.application_id #=> String
resp.configuration_profile_id #=> String
resp.version_number #=> Integer
resp.description #=> String
resp.content #=> String
resp.content_type #=> String
resp.version_label #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :application_id (required, String) —

    The application ID.

  • :configuration_profile_id (required, String) —

    The configuration profile ID.

  • :description (String) —

    A description of the configuration.

  • :content (required, String, StringIO, File) —

    The content of the configuration or the configuration data.

  • :content_type (required, String) —

    A standard MIME type describing the format of the configuration content. For more information, see Content-Type.

  • :latest_version_number (Integer) —

    An optional locking token used to prevent race conditions from overwriting configuration updates when creating a new version. To ensure your data is not overwritten when creating multiple hosted configuration versions in rapid succession, specify the version number of the latest hosted configuration version.

  • :version_label (String) —

    An optional, user-defined label for the AppConfig hosted configuration version. This value must contain at least one non-numeric character. For example, "v2.2.0".

Returns:

See Also:



1150
1151
1152
1153
 
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/client.rb', line 1150

def create_hosted_configuration_version(params = {}, options = {})
  req = build_request(:create_hosted_configuration_version, params)
  req.send_request(options)
end

#delete_application(params = {}) ⇒ Struct

Deletes an application. Deleting an application does not delete a configuration from a host.

Examples:

Example: To delete an application


# The following delete-application example deletes the specified application. 

resp = client.delete_application({
  application_id: "339ohji", 
})

Request syntax with placeholder values


resp = client.delete_application({
  application_id: "Id", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :application_id (required, String) —

    The ID of the application to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1182
1183
1184
1185
 
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/client.rb', line 1182

def delete_application(params = {}, options = {})
  req = build_request(:delete_application, params)
  req.send_request(options)
end

#delete_configuration_profile(params = {}) ⇒ Struct

Deletes a configuration profile. Deleting a configuration profile does not delete a configuration from a host.

Examples:

Example: To delete a configuration profile


# The following delete-configuration-profile example deletes the specified configuration profile.

resp = client.delete_configuration_profile({
  application_id: "339ohji", 
  configuration_profile_id: "ur8hx2f", 
})

Request syntax with placeholder values


resp = client.delete_configuration_profile({
  application_id: "Id", # required
  configuration_profile_id: "Id", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :application_id (required, String) —

    The application ID that includes the configuration profile you want to delete.

  • :configuration_profile_id (required, String) —

    The ID of the configuration profile you want to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1220
1221
1222
1223
 
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/client.rb', line 1220

def delete_configuration_profile(params = {}, options = {})
  req = build_request(:delete_configuration_profile, params)
  req.send_request(options)
end

#delete_deployment_strategy(params = {}) ⇒ Struct

Deletes a deployment strategy. Deleting a deployment strategy does not delete a configuration from a host.

Examples:

Example: To delete a deployment strategy


# The following delete-deployment-strategy example deletes the specified deployment strategy.

resp = client.delete_deployment_strategy({
  deployment_strategy_id: "1225qzk", 
})

Request syntax with placeholder values


resp = client.delete_deployment_strategy({
  deployment_strategy_id: "DeploymentStrategyId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :deployment_strategy_id (required, String) —

    The ID of the deployment strategy you want to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1252
1253
1254
1255
 
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/client.rb', line 1252

def delete_deployment_strategy(params = {}, options = {})
  req = build_request(:delete_deployment_strategy, params)
  req.send_request(options)
end

#delete_environment(params = {}) ⇒ Struct

Deletes an environment. Deleting an environment does not delete a configuration from a host.

Examples:

Example: To delete an environment


# The following delete-environment example deletes the specified application environment.

resp = client.delete_environment({
  application_id: "339ohji", 
  environment_id: "54j1r29", 
})

Request syntax with placeholder values


resp = client.delete_environment({
  application_id: "Id", # required
  environment_id: "Id", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :application_id (required, String) —

    The application ID that includes the environment that you want to delete.

  • :environment_id (required, String) —

    The ID of the environment that you want to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1290
1291
1292
1293
 
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/client.rb', line 1290

def delete_environment(params = {}, options = {})
  req = build_request(:delete_environment, params)
  req.send_request(options)
end

#delete_extension(params = {}) ⇒ Struct

Deletes an AppConfig extension. You must delete all associations to an extension before you delete the extension.

Examples:

Request syntax with placeholder values


resp = client.delete_extension({
  extension_identifier: "Identifier", # required
  version_number: 1,
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :extension_identifier (required, String) —

    The name, ID, or Amazon Resource Name (ARN) of the extension you want to delete.

  • :version_number (Integer) —

    A specific version of an extension to delete. If omitted, the highest version is deleted.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1319
1320
1321
1322
 
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/client.rb', line 1319

def delete_extension(params = {}, options = {})
  req = build_request(:delete_extension, params)
  req.send_request(options)
end

#delete_extension_association(params = {}) ⇒ Struct

Deletes an extension association. This action doesn't delete extensions defined in the association.

Examples:

Request syntax with placeholder values


resp = client.delete_extension_association({
  extension_association_id: "Id", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :extension_association_id (required, String) —

    The ID of the extension association to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1342
1343
1344
1345
 
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/client.rb', line 1342

def delete_extension_association(params = {}, options = {})
  req = build_request(:delete_extension_association, params)
  req.send_request(options)
end

#delete_hosted_configuration_version(params = {}) ⇒ Struct

Deletes a version of a configuration from the AppConfig hosted configuration store.

Examples:

Example: To delete a hosted configuration version


# The following delete-hosted-configuration-version example deletes a configuration version hosted in the AWS AppConfig
# configuration store.

resp = client.delete_hosted_configuration_version({
  application_id: "339ohji", 
  configuration_profile_id: "ur8hx2f", 
  version_number: 1, 
})

Request syntax with placeholder values


resp = client.delete_hosted_configuration_version({
  application_id: "Id", # required
  configuration_profile_id: "Id", # required
  version_number: 1, # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :application_id (required, String) —

    The application ID.

  • :configuration_profile_id (required, String) —

    The configuration profile ID.

  • :version_number (required, Integer) —

    The versions number to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1385
1386
1387
1388
 
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/client.rb', line 1385

def delete_hosted_configuration_version(params = {}, options = {})
  req = build_request(:delete_hosted_configuration_version, params)
  req.send_request(options)
end

#get_application(params = {}) ⇒ Types::Application

Retrieves information about an application.

Examples:

Example: To list details of an application


# The following get-application example lists the details of the specified application.

resp = client.get_application({
  application_id: "339ohji", 
})

resp.to_h outputs the following:
{
  id: "339ohji", 
  name: "example-application", 
}

Request syntax with placeholder values


resp = client.get_application({
  application_id: "Id", # required
})

Response structure


resp.id #=> String
resp.name #=> String
resp.description #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :application_id (required, String) —

    The ID of the application you want to get.

Returns:

See Also:



1432
1433
1434
1435
 
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/client.rb', line 1432

def get_application(params = {}, options = {})
  req = build_request(:get_application, params)
  req.send_request(options)
end

#get_configuration(params = {}) ⇒ Types::Configuration

(Deprecated) Retrieves the latest deployed configuration.

Note the following important information.

Examples:

Example: To retrieve configuration details


# The following get-configuration example returns the configuration details of the example application. On subsequent
# calls to get-configuration, use the client-configuration-version parameter to only update the configuration of your
# application if the version has changed. Only updating the configuration when the version has changed avoids excess
# charges incurred by calling get-configuration.

resp = client.get_configuration({
  application: "example-application", 
  client_id: "example-id", 
  configuration: "Example-Configuration-Profile", 
  environment: "Example-Environment", 
})

resp.to_h outputs the following:
{
  configuration_version: "1", 
  content_type: "application/octet-stream", 
}

Request syntax with placeholder values


resp = client.get_configuration({
  application: "StringWithLengthBetween1And64", # required
  environment: "StringWithLengthBetween1And64", # required
  configuration: "StringWithLengthBetween1And64", # required
  client_id: "StringWithLengthBetween1And64", # required
  client_configuration_version: "Version",
})

Response structure


resp.content #=> String
resp.configuration_version #=> String
resp.content_type #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :application (required, String) —

    The application to get. Specify either the application name or the application ID.

  • :environment (required, String) —

    The environment to get. Specify either the environment name or the environment ID.

  • :configuration (required, String) —

    The configuration to get. Specify either the configuration name or the configuration ID.

  • :client_id (required, String) —

    The clientId parameter in the following command is a unique, user-specified ID to identify the client for the configuration. This ID enables AppConfig to deploy the configuration in intervals, as defined in the deployment strategy.

  • :client_configuration_version (String) —

    The configuration version returned in the most recent GetConfiguration response.

    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 and GetLatestConfiguration 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.

    For more information about working with configurations, see Retrieving the Configuration in the AppConfig User Guide.

Returns:

See Also:



1548
1549
1550
1551
 
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/client.rb', line 1548

def get_configuration(params = {}, options = {})
  req = build_request(:get_configuration, params)
  req.send_request(options)
end

#get_configuration_profile(params = {}) ⇒ Types::ConfigurationProfile

Retrieves information about a configuration profile.

Examples:

Example: To retrieve configuration profile details


# The following get-configuration-profile example returns the details of the specified configuration profile.

resp = client.get_configuration_profile({
  application_id: "339ohji", 
  configuration_profile_id: "ur8hx2f", 
})

resp.to_h outputs the following:
{
  application_id: "339ohji", 
  id: "ur8hx2f", 
  location_uri: "ssm-parameter://Example-Parameter", 
  name: "Example-Configuration-Profile", 
  retrieval_role_arn: "arn:aws:iam::111122223333:role/Example-App-Config-Role", 
}

Request syntax with placeholder values


resp = client.get_configuration_profile({
  application_id: "Id", # required
  configuration_profile_id: "Id", # required
})

Response structure


resp.application_id #=> String
resp.id #=> String
resp.name #=> String
resp.description #=> String
resp.location_uri #=> String
resp.retrieval_role_arn #=> String
resp.validators #=> Array
resp.validators[0].type #=> String, one of "JSON_SCHEMA", "LAMBDA"
resp.validators[0].content #=> String
resp.type #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :application_id (required, String) —

    The ID of the application that includes the configuration profile you want to get.

  • :configuration_profile_id (required, String) —

    The ID of the configuration profile that you want to get.

Returns:

See Also:



1616
1617
1618
1619
 
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/client.rb', line 1616

def get_configuration_profile(params = {}, options = {})
  req = build_request(:get_configuration_profile, params)
  req.send_request(options)
end

#get_deployment(params = {}) ⇒ Types::Deployment

Retrieves information about a configuration deployment.

Examples:

Example: To retrieve deployment details


# The following get-deployment example lists details of the deployment to the application in the specified environment and
# deployment.

resp = client.get_deployment({
  application_id: "339ohji", 
  deployment_number: 1, 
  environment_id: "54j1r29", 
})

resp.to_h outputs the following:
{
  application_id: "339ohji", 
  completed_at: Time.parse("2021-09-17T21:59:03.888000+00:00"), 
  configuration_location_uri: "ssm-parameter://Example-Parameter", 
  configuration_name: "Example-Configuration-Profile", 
  configuration_profile_id: "ur8hx2f", 
  configuration_version: "1", 
  deployment_duration_in_minutes: 15, 
  deployment_number: 1, 
  deployment_strategy_id: "1225qzk", 
  environment_id: "54j1r29", 
  event_log: [
    {
      description: "Deployment completed", 
      event_type: "DEPLOYMENT_COMPLETED", 
      occurred_at: Time.parse("2021-09-17T21:59:03.888000+00:00"), 
      triggered_by: "APPCONFIG", 
    }, 
    {
      description: "Deployment bake time started", 
      event_type: "BAKE_TIME_STARTED", 
      occurred_at: Time.parse("2021-09-17T21:58:57.722000+00:00"), 
      triggered_by: "APPCONFIG", 
    }, 
    {
      description: "Configuration available to 100.00% of clients", 
      event_type: "PERCENTAGE_UPDATED", 
      occurred_at: Time.parse("2021-09-17T21:55:56.816000+00:00"), 
      triggered_by: "APPCONFIG", 
    }, 
    {
      description: "Configuration available to 75.00% of clients", 
      event_type: "PERCENTAGE_UPDATED", 
      occurred_at: Time.parse("2021-09-17T21:52:56.567000+00:00"), 
      triggered_by: "APPCONFIG", 
    }, 
    {
      description: "Configuration available to 50.00% of clients", 
      event_type: "PERCENTAGE_UPDATED", 
      occurred_at: Time.parse("2021-09-17T21:49:55.737000+00:00"), 
      triggered_by: "APPCONFIG", 
    }, 
    {
      description: "Configuration available to 25.00% of clients", 
      event_type: "PERCENTAGE_UPDATED", 
      occurred_at: Time.parse("2021-09-17T21:46:55.187000+00:00"), 
      triggered_by: "APPCONFIG", 
    }, 
    {
      description: "Deployment started", 
      event_type: "DEPLOYMENT_STARTED", 
      occurred_at: Time.parse("2021-09-17T21:43:54.205000+00:00"), 
      triggered_by: "USER", 
    }, 
  ], 
  final_bake_time_in_minutes: 0, 
  growth_factor: 25, 
  growth_type: "LINEAR", 
  percentage_complete: 100, 
  started_at: Time.parse("2021-09-17T21:43:54.205000+00:00"), 
  state: "COMPLETE", 
}

Request syntax with placeholder values


resp = client.get_deployment({
  application_id: "Id", # required
  environment_id: "Id", # required
  deployment_number: 1, # required
})

Response structure


resp.application_id #=> String
resp.environment_id #=> String
resp.deployment_strategy_id #=> String
resp.configuration_profile_id #=> String
resp.deployment_number #=> Integer
resp.configuration_name #=> String
resp.configuration_location_uri #=> String
resp.configuration_version #=> String
resp.description #=> String
resp.deployment_duration_in_minutes #=> Integer
resp.growth_type #=> String, one of "LINEAR", "EXPONENTIAL"
resp.growth_factor #=> Float
resp.final_bake_time_in_minutes #=> Integer
resp.state #=> String, one of "BAKING", "VALIDATING", "DEPLOYING", "COMPLETE", "ROLLING_BACK", "ROLLED_BACK"
resp.event_log #=> Array
resp.event_log[0].event_type #=> String, one of "PERCENTAGE_UPDATED", "ROLLBACK_STARTED", "ROLLBACK_COMPLETED", "BAKE_TIME_STARTED", "DEPLOYMENT_STARTED", "DEPLOYMENT_COMPLETED"
resp.event_log[0].triggered_by #=> String, one of "USER", "APPCONFIG", "CLOUDWATCH_ALARM", "INTERNAL_ERROR"
resp.event_log[0].description #=> String
resp.event_log[0].action_invocations #=> Array
resp.event_log[0].action_invocations[0].extension_identifier #=> String
resp.event_log[0].action_invocations[0].action_name #=> String
resp.event_log[0].action_invocations[0].uri #=> String
resp.event_log[0].action_invocations[0].role_arn #=> String
resp.event_log[0].action_invocations[0].error_message #=> String
resp.event_log[0].action_invocations[0].error_code #=> String
resp.event_log[0].action_invocations[0].invocation_id #=> String
resp.event_log[0].occurred_at #=> Time
resp.percentage_complete #=> Float
resp.started_at #=> Time
resp.completed_at #=> Time
resp.applied_extensions #=> Array
resp.applied_extensions[0].extension_id #=> String
resp.applied_extensions[0].extension_association_id #=> String
resp.applied_extensions[0].version_number #=> Integer
resp.applied_extensions[0].parameters #=> Hash
resp.applied_extensions[0].parameters["Name"] #=> String
resp.kms_key_arn #=> String
resp.kms_key_identifier #=> String
resp.version_label #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :application_id (required, String) —

    The ID of the application that includes the deployment you want to get.

  • :environment_id (required, String) —

    The ID of the environment that includes the deployment you want to get.

  • :deployment_number (required, Integer) —

    The sequence number of the deployment.

Returns:

See Also:



1789
1790
1791
1792
 
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/client.rb', line 1789

def get_deployment(params = {}, options = {})
  req = build_request(:get_deployment, params)
  req.send_request(options)
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.

Examples:

Example: To retrieve details of a deployment strategy


# The following get-deployment-strategy example lists the details of the specified deployment strategy.

resp = client.get_deployment_strategy({
  deployment_strategy_id: "1225qzk", 
})

resp.to_h outputs the following:
{
  deployment_duration_in_minutes: 15, 
  final_bake_time_in_minutes: 0, 
  growth_factor: 25, 
  growth_type: "LINEAR", 
  id: "1225qzk", 
  name: "Example-Deployment", 
  replicate_to: "SSM_DOCUMENT", 
}

Request syntax with placeholder values


resp = client.get_deployment_strategy({
  deployment_strategy_id: "DeploymentStrategyId", # required
})

Response structure


resp.id #=> String
resp.name #=> String
resp.description #=> String
resp.deployment_duration_in_minutes #=> Integer
resp.growth_type #=> String, one of "LINEAR", "EXPONENTIAL"
resp.growth_factor #=> Float
resp.final_bake_time_in_minutes #=> Integer
resp.replicate_to #=> String, one of "NONE", "SSM_DOCUMENT"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :deployment_strategy_id (required, String) —

    The ID of the deployment strategy to get.

Returns:

See Also:



1856
1857
1858
1859
 
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/client.rb', line 1856

def get_deployment_strategy(params = {}, options = {})
  req = build_request(:get_deployment_strategy, params)
  req.send_request(options)
end

#get_environment(params = {}) ⇒ Types::Environment

Retrieves information about an environment. An environment is a 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.

Examples:

Example: To retrieve environment details


# The following get-environment example returns the details and state of the specified environment.

resp = client.get_environment({
  application_id: "339ohji", 
  environment_id: "54j1r29", 
})

resp.to_h outputs the following:
{
  application_id: "339ohji", 
  id: "54j1r29", 
  name: "Example-Environment", 
  state: "READY_FOR_DEPLOYMENT", 
}

Request syntax with placeholder values


resp = client.get_environment({
  application_id: "Id", # required
  environment_id: "Id", # required
})

Response structure


resp.application_id #=> String
resp.id #=> String
resp.name #=> String
resp.description #=> String
resp.state #=> String, one of "READY_FOR_DEPLOYMENT", "DEPLOYING", "ROLLING_BACK", "ROLLED_BACK"
resp.monitors #=> Array
resp.monitors[0].alarm_arn #=> String
resp.monitors[0].alarm_role_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :application_id (required, String) —

    The ID of the application that includes the environment you want to get.

  • :environment_id (required, String) —

    The ID of the environment that you want to get.

Returns:

See Also:



1924
1925
1926
1927
 
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/client.rb', line 1924

def get_environment(params = {}, options = {})
  req = build_request(:get_environment, params)
  req.send_request(options)
end

#get_extension(params = {}) ⇒ Types::Extension

Returns information about an AppConfig extension.

Examples:

Request syntax with placeholder values


resp = client.get_extension({
  extension_identifier: "Identifier", # required
  version_number: 1,
})

Response structure


resp.id #=> String
resp.name #=> String
resp.version_number #=> Integer
resp.arn #=> String
resp.description #=> String
resp.actions #=> Hash
resp.actions["ActionPoint"] #=> Array
resp.actions["ActionPoint"][0].name #=> String
resp.actions["ActionPoint"][0].description #=> String
resp.actions["ActionPoint"][0].uri #=> String
resp.actions["ActionPoint"][0].role_arn #=> String
resp.parameters #=> Hash
resp.parameters["Name"].description #=> String
resp.parameters["Name"].required #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :extension_identifier (required, String) —

    The name, the ID, or the Amazon Resource Name (ARN) of the extension.

  • :version_number (Integer) —

    The extension version number. If no version number was defined, AppConfig uses the highest version.

Returns:

See Also:



1976
1977
1978
1979
 
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/client.rb', line 1976

def get_extension(params = {}, options = {})
  req = build_request(:get_extension, params)
  req.send_request(options)
end

#get_extension_association(params = {}) ⇒ Types::ExtensionAssociation

Returns information about an AppConfig extension association. For more information about extensions and associations, see Working with AppConfig extensions in the AppConfig User Guide.

Examples:

Request syntax with placeholder values


resp = client.get_extension_association({
  extension_association_id: "Id", # required
})

Response structure


resp.id #=> String
resp.extension_arn #=> String
resp.resource_arn #=> String
resp.arn #=> String
resp.parameters #=> Hash
resp.parameters["Name"] #=> String
resp.extension_version_number #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :extension_association_id (required, String) —

    The extension association ID to get.

Returns:

See Also:



2021
2022
2023
2024
 
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/client.rb', line 2021

def get_extension_association(params = {}, options = {})
  req = build_request(:get_extension_association, params)
  req.send_request(options)
end

#get_hosted_configuration_version(params = {}) ⇒ Types::HostedConfigurationVersion

Retrieves information about a specific configuration version.

Examples:

Example: To retrieve hosted configuration details


# The following get-hosted-configuration-version example retrieves the configuration details of the AWS AppConfig hosted
# configuration.

resp = client.get_hosted_configuration_version({
  application_id: "339ohji", 
  configuration_profile_id: "ur8hx2f", 
  version_number: 1, 
})

resp.to_h outputs the following:
{
  application_id: "339ohji", 
  configuration_profile_id: "ur8hx2f", 
  content_type: "application/json", 
  version_number: 1, 
}

Request syntax with placeholder values


resp = client.get_hosted_configuration_version({
  application_id: "Id", # required
  configuration_profile_id: "Id", # required
  version_number: 1, # required
})

Response structure


resp.application_id #=> String
resp.configuration_profile_id #=> String
resp.version_number #=> Integer
resp.description #=> String
resp.content #=> String
resp.content_type #=> String
resp.version_label #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :application_id (required, String) —

    The application ID.

  • :configuration_profile_id (required, String) —

    The configuration profile ID.

  • :version_number (required, Integer) —

    The version.

Returns:

See Also:



2089
2090
2091
2092
 
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/client.rb', line 2089

def get_hosted_configuration_version(params = {}, options = {})
  req = build_request(:get_hosted_configuration_version, params)
  req.send_request(options)
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.

Examples:

Example: To list the available applications


# The following list-applications example lists the available applications in your AWS account.

resp = client.list_applications({
})

resp.to_h outputs the following:
{
  items: [
    {
      description: "An application used for creating an example.", 
      id: "339ohji", 
      name: "test-application", 
    }, 
    {
      id: "rwalwu7", 
      name: "Test-Application", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.list_applications({
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.items #=> Array
resp.items[0].id #=> String
resp.items[0].name #=> String
resp.items[0].description #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    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.

  • :next_token (String) —

    A token to start the list. Next token is a pagination token generated by AppConfig to describe what page the previous List call ended on. For the first List request, the nextToken should not be set. On subsequent calls, the nextToken parameter should be set to the previous responses nextToken value. Use this token to get the next set of results.

Returns:

See Also:



2158
2159
2160
2161
 
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/client.rb', line 2158

def list_applications(params = {}, options = {})
  req = build_request(:list_applications, params)
  req.send_request(options)
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.

Examples:

Example: To list the available configuration profiles


# The following list-configuration-profiles example lists the available configuration profiles for the specified
# application.

resp = client.list_configuration_profiles({
  application_id: "339ohji", 
})

resp.to_h outputs the following:
{
  items: [
    {
      application_id: "339ohji", 
      id: "ur8hx2f", 
      location_uri: "ssm-parameter://Example-Parameter", 
      name: "Example-Configuration-Profile", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.list_configuration_profiles({
  application_id: "Id", # required
  max_results: 1,
  next_token: "NextToken",
  type: "ConfigurationProfileType",
})

Response structure


resp.items #=> Array
resp.items[0].application_id #=> String
resp.items[0].id #=> String
resp.items[0].name #=> String
resp.items[0].location_uri #=> String
resp.items[0].validator_types #=> Array
resp.items[0].validator_types[0] #=> String, one of "JSON_SCHEMA", "LAMBDA"
resp.items[0].type #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :application_id (required, String) —

    The application ID.

  • :max_results (Integer) —

    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.

  • :next_token (String) —

    A token to start the list. Use this token to get the next set of results.

  • :type (String) —

    A filter based on the type of configurations that the configuration profile contains. A configuration can be a feature flag or a freeform configuration.

Returns:

See Also:



2236
2237
2238
2239
 
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/client.rb', line 2236

def list_configuration_profiles(params = {}, options = {})
  req = build_request(:list_configuration_profiles, params)
  req.send_request(options)
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.

Examples:

Example: To list the available deployment strategies


# The following list-deployment-strategies example lists the available deployment strategies in your AWS account.

resp = client.list_deployment_strategies({
})

resp.to_h outputs the following:
{
  items: [
    {
      deployment_duration_in_minutes: 15, 
      final_bake_time_in_minutes: 0, 
      growth_factor: 25, 
      growth_type: "LINEAR", 
      id: "1225qzk", 
      name: "Example-Deployment", 
      replicate_to: "SSM_DOCUMENT", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.list_deployment_strategies({
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.items #=> Array
resp.items[0].id #=> String
resp.items[0].name #=> String
resp.items[0].description #=> String
resp.items[0].deployment_duration_in_minutes #=> Integer
resp.items[0].growth_type #=> String, one of "LINEAR", "EXPONENTIAL"
resp.items[0].growth_factor #=> Float
resp.items[0].final_bake_time_in_minutes #=> Integer
resp.items[0].replicate_to #=> String, one of "NONE", "SSM_DOCUMENT"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    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.

  • :next_token (String) —

    A token to start the list. Use this token to get the next set of results.

Returns:

See Also:



2306
2307
2308
2309
 
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/client.rb', line 2306

def list_deployment_strategies(params = {}, options = {})
  req = build_request(:list_deployment_strategies, params)
  req.send_request(options)
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.

Examples:

Example: To list the available deployments


# The following list-deployments example lists the available deployments in your AWS account for the specified application
# and environment.

resp = client.list_deployments({
  application_id: "339ohji", 
  environment_id: "54j1r29", 
})

resp.to_h outputs the following:
{
  items: [
    {
      completed_at: Time.parse("2021-09-17T21:59:03.888000+00:00"), 
      configuration_name: "Example-Configuration-Profile", 
      configuration_version: "1", 
      deployment_duration_in_minutes: 15, 
      deployment_number: 1, 
      final_bake_time_in_minutes: 0, 
      growth_factor: 25, 
      growth_type: "LINEAR", 
      percentage_complete: 100, 
      started_at: Time.parse("2021-09-17T21:43:54.205000+00:00"), 
      state: "COMPLETE", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.list_deployments({
  application_id: "Id", # required
  environment_id: "Id", # required
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.items #=> Array
resp.items[0].deployment_number #=> Integer
resp.items[0].configuration_name #=> String
resp.items[0].configuration_version #=> String
resp.items[0].deployment_duration_in_minutes #=> Integer
resp.items[0].growth_type #=> String, one of "LINEAR", "EXPONENTIAL"
resp.items[0].growth_factor #=> Float
resp.items[0].final_bake_time_in_minutes #=> Integer
resp.items[0].state #=> String, one of "BAKING", "VALIDATING", "DEPLOYING", "COMPLETE", "ROLLING_BACK", "ROLLED_BACK"
resp.items[0].percentage_complete #=> Float
resp.items[0].started_at #=> Time
resp.items[0].completed_at #=> Time
resp.items[0].version_label #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :application_id (required, String) —

    The application ID.

  • :environment_id (required, String) —

    The environment ID.

  • :max_results (Integer) —

    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.

  • :next_token (String) —

    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.

Returns:

See Also:



2398
2399
2400
2401
 
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/client.rb', line 2398

def list_deployments(params = {}, options = {})
  req = build_request(:list_deployments, params)
  req.send_request(options)
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.

Examples:

Example: To list the available environments


# The following list-environments example lists the available environments in your AWS account for the specified
# application.

resp = client.list_environments({
  application_id: "339ohji", 
})

resp.to_h outputs the following:
{
  items: [
    {
      application_id: "339ohji", 
      id: "54j1r29", 
      name: "Example-Environment", 
      state: "READY_FOR_DEPLOYMENT", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.list_environments({
  application_id: "Id", # required
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.items #=> Array
resp.items[0].application_id #=> String
resp.items[0].id #=> String
resp.items[0].name #=> String
resp.items[0].description #=> String
resp.items[0].state #=> String, one of "READY_FOR_DEPLOYMENT", "DEPLOYING", "ROLLING_BACK", "ROLLED_BACK"
resp.items[0].monitors #=> Array
resp.items[0].monitors[0].alarm_arn #=> String
resp.items[0].monitors[0].alarm_role_arn #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :application_id (required, String) —

    The application ID.

  • :max_results (Integer) —

    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.

  • :next_token (String) —

    A token to start the list. Use this token to get the next set of results.

Returns:

See Also:



2471
2472
2473
2474
 
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/client.rb', line 2471

def list_environments(params = {}, options = {})
  req = build_request(:list_environments, params)
  req.send_request(options)
end

#list_extension_associations(params = {}) ⇒ Types::ExtensionAssociations

Lists all AppConfig extension associations in the account. For more information about extensions and associations, see Working with AppConfig extensions in the AppConfig User Guide.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_extension_associations({
  resource_identifier: "Arn",
  extension_identifier: "Identifier",
  extension_version_number: 1,
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.items #=> Array
resp.items[0].id #=> String
resp.items[0].extension_arn #=> String
resp.items[0].resource_arn #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_identifier (String) —

    The ARN of an application, configuration profile, or environment.

  • :extension_identifier (String) —

    The name, the ID, or the Amazon Resource Name (ARN) of the extension.

  • :extension_version_number (Integer) —

    The version number for the extension defined in the association.

  • :max_results (Integer) —

    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.

  • :next_token (String) —

    A token to start the list. Use this token to get the next set of results or pass null to get the first set of results.

Returns:

See Also:



2531
2532
2533
2534
 
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/client.rb', line 2531

def list_extension_associations(params = {}, options = {})
  req = build_request(:list_extension_associations, params)
  req.send_request(options)
end

#list_extensions(params = {}) ⇒ Types::Extensions

Lists all custom and Amazon Web Services authored AppConfig extensions in the account. For more information about extensions, see Working with AppConfig extensions in the AppConfig User Guide.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_extensions({
  max_results: 1,
  next_token: "NextToken",
  name: "QueryName",
})

Response structure


resp.items #=> Array
resp.items[0].id #=> String
resp.items[0].name #=> String
resp.items[0].version_number #=> Integer
resp.items[0].arn #=> String
resp.items[0].description #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    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.

  • :next_token (String) —

    A token to start the list. Use this token to get the next set of results.

  • :name (String) —

    The extension name.

Returns:

See Also:



2585
2586
2587
2588
 
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/client.rb', line 2585

def list_extensions(params = {}, options = {})
  req = build_request(:list_extensions, params)
  req.send_request(options)
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.

Examples:

Example: To list the available hosted configuration versions


# The following list-hosted-configuration-versions example lists the configurations versions hosted in the AWS AppConfig
# hosted configuration store for the specified application and configuration profile.

resp = client.list_hosted_configuration_versions({
  application_id: "339ohji", 
  configuration_profile_id: "ur8hx2f", 
})

resp.to_h outputs the following:
{
  items: [
    {
      application_id: "339ohji", 
      configuration_profile_id: "ur8hx2f", 
      content_type: "application/json", 
      version_number: 1, 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.list_hosted_configuration_versions({
  application_id: "Id", # required
  configuration_profile_id: "Id", # required
  max_results: 1,
  next_token: "NextToken",
  version_label: "QueryName",
})

Response structure


resp.items #=> Array
resp.items[0].application_id #=> String
resp.items[0].configuration_profile_id #=> String
resp.items[0].version_number #=> Integer
resp.items[0].description #=> String
resp.items[0].content_type #=> String
resp.items[0].version_label #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :application_id (required, String) —

    The application ID.

  • :configuration_profile_id (required, String) —

    The configuration profile ID.

  • :max_results (Integer) —

    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.

  • :next_token (String) —

    A token to start the list. Use this token to get the next set of results.

  • :version_label (String) —

    An optional filter that can be used to specify the version label of an AppConfig hosted configuration version. This parameter supports filtering by prefix using a wildcard, for example "v2*". If you don't specify an asterisk at the end of the value, only an exact match is returned.

Returns:

See Also:



2670
2671
2672
2673
 
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/client.rb', line 2670

def list_hosted_configuration_versions(params = {}, options = {})
  req = build_request(:list_hosted_configuration_versions, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ Types::ResourceTags

Retrieves the list of key-value tags assigned to the resource.

Examples:

Example: To list the tags of an application


# The following list-tags-for-resource example lists the tags of a specified application.

resp = client.list_tags_for_resource({
  resource_arn: "arn:aws:appconfig:us-east-1:111122223333:application/339ohji", 
})

resp.to_h outputs the following:
{
  tags: {
    "group1" => "1", 
  }, 
}

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "Arn", # required
})

Response structure


resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The resource ARN.

Returns:

See Also:



2715
2716
2717
2718
 
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/client.rb', line 2715

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#start_deployment(params = {}) ⇒ Types::Deployment

Starts a deployment.

Examples:

Example: To start a configuration deployment


# The following start-deployment example starts a deployment to the application using the specified environment,
# deployment strategy, and configuration profile.

resp = client.start_deployment({
  application_id: "339ohji", 
  configuration_profile_id: "ur8hx2f", 
  configuration_version: "1", 
  deployment_strategy_id: "1225qzk", 
  description: "", 
  environment_id: "54j1r29", 
  tags: {
  }, 
})

resp.to_h outputs the following:
{
  application_id: "339ohji", 
  configuration_location_uri: "ssm-parameter://Example-Parameter", 
  configuration_name: "Example-Configuration-Profile", 
  configuration_profile_id: "ur8hx2f", 
  configuration_version: "1", 
  deployment_duration_in_minutes: 15, 
  deployment_number: 1, 
  deployment_strategy_id: "1225qzk", 
  environment_id: "54j1r29", 
  event_log: [
    {
      description: "Deployment started", 
      event_type: "DEPLOYMENT_STARTED", 
      occurred_at: Time.parse("2021-09-17T21:43:54.205000+00:00"), 
      triggered_by: "USER", 
    }, 
  ], 
  final_bake_time_in_minutes: 0, 
  growth_factor: 25, 
  growth_type: "LINEAR", 
  percentage_complete: 1.0, 
  started_at: Time.parse("2021-09-17T21:43:54.205000+00:00"), 
  state: "DEPLOYING", 
}

Request syntax with placeholder values


resp = client.start_deployment({
  application_id: "Id", # required
  environment_id: "Id", # required
  deployment_strategy_id: "DeploymentStrategyId", # required
  configuration_profile_id: "Id", # required
  configuration_version: "Version", # required
  description: "Description",
  tags: {
    "TagKey" => "TagValue",
  },
  kms_key_identifier: "Identifier",
})

Response structure


resp.application_id #=> String
resp.environment_id #=> String
resp.deployment_strategy_id #=> String
resp.configuration_profile_id #=> String
resp.deployment_number #=> Integer
resp.configuration_name #=> String
resp.configuration_location_uri #=> String
resp.configuration_version #=> String
resp.description #=> String
resp.deployment_duration_in_minutes #=> Integer
resp.growth_type #=> String, one of "LINEAR", "EXPONENTIAL"
resp.growth_factor #=> Float
resp.final_bake_time_in_minutes #=> Integer
resp.state #=> String, one of "BAKING", "VALIDATING", "DEPLOYING", "COMPLETE", "ROLLING_BACK", "ROLLED_BACK"
resp.event_log #=> Array
resp.event_log[0].event_type #=> String, one of "PERCENTAGE_UPDATED", "ROLLBACK_STARTED", "ROLLBACK_COMPLETED", "BAKE_TIME_STARTED", "DEPLOYMENT_STARTED", "DEPLOYMENT_COMPLETED"
resp.event_log[0].triggered_by #=> String, one of "USER", "APPCONFIG", "CLOUDWATCH_ALARM", "INTERNAL_ERROR"
resp.event_log[0].description #=> String
resp.event_log[0].action_invocations #=> Array
resp.event_log[0].action_invocations[0].extension_identifier #=> String
resp.event_log[0].action_invocations[0].action_name #=> String
resp.event_log[0].action_invocations[0].uri #=> String
resp.event_log[0].action_invocations[0].role_arn #=> String
resp.event_log[0].action_invocations[0].error_message #=> String
resp.event_log[0].action_invocations[0].error_code #=> String
resp.event_log[0].action_invocations[0].invocation_id #=> String
resp.event_log[0].occurred_at #=> Time
resp.percentage_complete #=> Float
resp.started_at #=> Time
resp.completed_at #=> Time
resp.applied_extensions #=> Array
resp.applied_extensions[0].extension_id #=> String
resp.applied_extensions[0].extension_association_id #=> String
resp.applied_extensions[0].version_number #=> Integer
resp.applied_extensions[0].parameters #=> Hash
resp.applied_extensions[0].parameters["Name"] #=> String
resp.kms_key_arn #=> String
resp.kms_key_identifier #=> String
resp.version_label #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :application_id (required, String) —

    The application ID.

  • :environment_id (required, String) —

    The environment ID.

  • :deployment_strategy_id (required, String) —

    The deployment strategy ID.

  • :configuration_profile_id (required, String) —

    The configuration profile ID.

  • :configuration_version (required, String) —

    The configuration version to deploy. If deploying an AppConfig hosted configuration version, you can specify either the version number or version label. For all other configurations, you must specify the version number.

  • :description (String) —

    A description of the deployment.

  • :tags (Hash<String,String>) —

    Metadata to assign to the deployment. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define.

  • :kms_key_identifier (String) —

    The KMS key identifier (key ID, key alias, or key ARN). AppConfig uses this ID to encrypt the configuration data using a customer managed key.

Returns:

See Also:



2883
2884
2885
2886
 
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/client.rb', line 2883

def start_deployment(params = {}, options = {})
  req = build_request(:start_deployment, params)
  req.send_request(options)
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.

Examples:

Example: To stop configuration deployment


# The following stop-deployment example stops the deployment of an application configuration to the specified environment.

resp = client.stop_deployment({
  application_id: "339ohji", 
  deployment_number: 2, 
  environment_id: "54j1r29", 
})

resp.to_h outputs the following:
{
  deployment_duration_in_minutes: 15, 
  deployment_number: 2, 
  final_bake_time_in_minutes: 0, 
  growth_factor: 25.0, 
  percentage_complete: 1.0, 
}

Request syntax with placeholder values


resp = client.stop_deployment({
  application_id: "Id", # required
  environment_id: "Id", # required
  deployment_number: 1, # required
})

Response structure


resp.application_id #=> String
resp.environment_id #=> String
resp.deployment_strategy_id #=> String
resp.configuration_profile_id #=> String
resp.deployment_number #=> Integer
resp.configuration_name #=> String
resp.configuration_location_uri #=> String
resp.configuration_version #=> String
resp.description #=> String
resp.deployment_duration_in_minutes #=> Integer
resp.growth_type #=> String, one of "LINEAR", "EXPONENTIAL"
resp.growth_factor #=> Float
resp.final_bake_time_in_minutes #=> Integer
resp.state #=> String, one of "BAKING", "VALIDATING", "DEPLOYING", "COMPLETE", "ROLLING_BACK", "ROLLED_BACK"
resp.event_log #=> Array
resp.event_log[0].event_type #=> String, one of "PERCENTAGE_UPDATED", "ROLLBACK_STARTED", "ROLLBACK_COMPLETED", "BAKE_TIME_STARTED", "DEPLOYMENT_STARTED", "DEPLOYMENT_COMPLETED"
resp.event_log[0].triggered_by #=> String, one of "USER", "APPCONFIG", "CLOUDWATCH_ALARM", "INTERNAL_ERROR"
resp.event_log[0].description #=> String
resp.event_log[0].action_invocations #=> Array
resp.event_log[0].action_invocations[0].extension_identifier #=> String
resp.event_log[0].action_invocations[0].action_name #=> String
resp.event_log[0].action_invocations[0].uri #=> String
resp.event_log[0].action_invocations[0].role_arn #=> String
resp.event_log[0].action_invocations[0].error_message #=> String
resp.event_log[0].action_invocations[0].error_code #=> String
resp.event_log[0].action_invocations[0].invocation_id #=> String
resp.event_log[0].occurred_at #=> Time
resp.percentage_complete #=> Float
resp.started_at #=> Time
resp.completed_at #=> Time
resp.applied_extensions #=> Array
resp.applied_extensions[0].extension_id #=> String
resp.applied_extensions[0].extension_association_id #=> String
resp.applied_extensions[0].version_number #=> Integer
resp.applied_extensions[0].parameters #=> Hash
resp.applied_extensions[0].parameters["Name"] #=> String
resp.kms_key_arn #=> String
resp.kms_key_identifier #=> String
resp.version_label #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :application_id (required, String) —

    The application ID.

  • :environment_id (required, String) —

    The environment ID.

  • :deployment_number (required, Integer) —

    The sequence number of the deployment.

Returns:

See Also:



3000
3001
3002
3003
 
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/client.rb', line 3000

def stop_deployment(params = {}, options = {})
  req = build_request(:stop_deployment, params)
  req.send_request(options)
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.

Examples:

Example: To tag an application


# The following tag-resource example tags an application resource.

resp = client.tag_resource({
  resource_arn: "arn:aws:appconfig:us-east-1:111122223333:application/339ohji", 
  tags: {
    "group1" => "1", 
  }, 
})

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "Arn", # required
  tags: { # required
    "TagKey" => "TagValue",
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ARN of the resource for which to retrieve tags.

  • :tags (required, Hash<String,String>) —

    The key-value string map. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3045
3046
3047
3048
 
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/client.rb', line 3045

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

Deletes a tag key and value from an AppConfig resource.

Examples:

Example: To remove a tag from an application


# The following untag-resource example removes the group1 tag from the specified application.

resp = client.untag_resource({
  resource_arn: "arn:aws:appconfig:us-east-1:111122223333:application/339ohji", 
  tag_keys: [
    "group1", 
  ], 
})

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "Arn", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ARN of the resource for which to remove tags.

  • :tag_keys (required, Array<String>) —

    The tag keys to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3083
3084
3085
3086
 
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/client.rb', line 3083

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_application(params = {}) ⇒ Types::Application

Updates an application.

Examples:

Example: To update an application


# The following update-application example updates the name of the specified application.

resp = client.update_application({
  application_id: "339ohji", 
  description: "", 
  name: "Example-Application", 
})

resp.to_h outputs the following:
{
  description: "An application used for creating an example.", 
  id: "339ohji", 
  name: "Example-Application", 
}

Request syntax with placeholder values


resp = client.update_application({
  application_id: "Id", # required
  name: "Name",
  description: "Description",
})

Response structure


resp.id #=> String
resp.name #=> String
resp.description #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :application_id (required, String) —

    The application ID.

  • :name (String) —

    The name of the application.

  • :description (String) —

    A description of the application.

Returns:

See Also:



3141
3142
3143
3144
 
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/client.rb', line 3141

def update_application(params = {}, options = {})
  req = build_request(:update_application, params)
  req.send_request(options)
end

#update_configuration_profile(params = {}) ⇒ Types::ConfigurationProfile

Updates a configuration profile.

Examples:

Example: To update a configuration profile


# The following update-configuration-profile example updates the description of the specified configuration profile.

resp = client.update_configuration_profile({
  application_id: "339ohji", 
  configuration_profile_id: "ur8hx2f", 
  description: "Configuration profile used for examples.", 
})

resp.to_h outputs the following:
{
  application_id: "339ohji", 
  description: "Configuration profile used for examples.", 
  id: "ur8hx2f", 
  location_uri: "ssm-parameter://Example-Parameter", 
  name: "Example-Configuration-Profile", 
  retrieval_role_arn: "arn:aws:iam::111122223333:role/Example-App-Config-Role", 
}

Request syntax with placeholder values


resp = client.update_configuration_profile({
  application_id: "Id", # required
  configuration_profile_id: "Id", # required
  name: "Name",
  description: "Description",
  retrieval_role_arn: "RoleArn",
  validators: [
    {
      type: "JSON_SCHEMA", # required, accepts JSON_SCHEMA, LAMBDA
      content: "StringWithLengthBetween0And32768", # required
    },
  ],
})

Response structure


resp.application_id #=> String
resp.id #=> String
resp.name #=> String
resp.description #=> String
resp.location_uri #=> String
resp.retrieval_role_arn #=> String
resp.validators #=> Array
resp.validators[0].type #=> String, one of "JSON_SCHEMA", "LAMBDA"
resp.validators[0].content #=> String
resp.type #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :application_id (required, String) —

    The application ID.

  • :configuration_profile_id (required, String) —

    The ID of the configuration profile.

  • :name (String) —

    The name of the configuration profile.

  • :description (String) —

    A description of the configuration profile.

  • :retrieval_role_arn (String) —

    The ARN of an IAM role with permission to access the configuration at the specified LocationUri.

  • :validators (Array<Types::Validator>) —

    A list of methods for validating the configuration.

Returns:

See Also:



3232
3233
3234
3235
 
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/client.rb', line 3232

def update_configuration_profile(params = {}, options = {})
  req = build_request(:update_configuration_profile, params)
  req.send_request(options)
end

#update_deployment_strategy(params = {}) ⇒ Types::DeploymentStrategy

Updates a deployment strategy.

Examples:

Example: To update a deployment strategy


# The following update-deployment-strategy example updates final bake time to 20 minutes in the specified deployment
# strategy. ::

resp = client.update_deployment_strategy({
  deployment_strategy_id: "1225qzk", 
  final_bake_time_in_minutes: 20, 
})

resp.to_h outputs the following:
{
  deployment_duration_in_minutes: 15, 
  final_bake_time_in_minutes: 20, 
  growth_factor: 25, 
  growth_type: "LINEAR", 
  id: "1225qzk", 
  name: "Example-Deployment", 
  replicate_to: "SSM_DOCUMENT", 
}

Request syntax with placeholder values


resp = client.update_deployment_strategy({
  deployment_strategy_id: "DeploymentStrategyId", # required
  description: "Description",
  deployment_duration_in_minutes: 1,
  final_bake_time_in_minutes: 1,
  growth_factor: 1.0,
  growth_type: "LINEAR", # accepts LINEAR, EXPONENTIAL
})

Response structure


resp.id #=> String
resp.name #=> String
resp.description #=> String
resp.deployment_duration_in_minutes #=> Integer
resp.growth_type #=> String, one of "LINEAR", "EXPONENTIAL"
resp.growth_factor #=> Float
resp.final_bake_time_in_minutes #=> Integer
resp.replicate_to #=> String, one of "NONE", "SSM_DOCUMENT"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :deployment_strategy_id (required, String) —

    The deployment strategy ID.

  • :description (String) —

    A description of the deployment strategy.

  • :deployment_duration_in_minutes (Integer) —

    Total amount of time for a deployment to last.

  • :final_bake_time_in_minutes (Integer) —

    The amount of time that AppConfig monitors for alarms before considering the deployment to be complete and no longer eligible for automatic rollback.

  • :growth_factor (Float) —

    The percentage of targets to receive a deployed configuration during each interval.

  • :growth_type (String) —

    The algorithm used to define how percentage grows over time. AppConfig supports the following growth types:

    Linear: For this type, AppConfig processes the deployment by increments of the growth factor evenly distributed over the deployment time. For example, a linear deployment that uses a growth factor of 20 initially makes the configuration available to 20 percent of the targets. After 1/5th of the deployment time has passed, the system updates the percentage to 40 percent. This continues until 100% of the targets are set to receive the deployed configuration.

    Exponential: For this type, AppConfig processes the deployment exponentially using the following formula: G*(2^N). In this formula, G is the growth factor specified by the user and N is the number of steps until the configuration is deployed to all targets. For example, if you specify a growth factor of 2, then the system rolls out the configuration as follows:

    2*(2^0)

    2*(2^1)

    2*(2^2)

    Expressed numerically, the deployment rolls out as follows: 2% of the targets, 4% of the targets, 8% of the targets, and continues until the configuration has been deployed to all targets.

Returns:

See Also:



3345
3346
3347
3348
 
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/client.rb', line 3345

def update_deployment_strategy(params = {}, options = {})
  req = build_request(:update_deployment_strategy, params)
  req.send_request(options)
end

#update_environment(params = {}) ⇒ Types::Environment

Updates an environment.

Examples:

Example: To update an environment


# The following update-environment example updates an environment's description.

resp = client.update_environment({
  application_id: "339ohji", 
  description: "An environment for examples.", 
  environment_id: "54j1r29", 
})

resp.to_h outputs the following:
{
  application_id: "339ohji", 
  description: "An environment for examples.", 
  id: "54j1r29", 
  name: "Example-Environment", 
  state: "ROLLED_BACK", 
}

Request syntax with placeholder values


resp = client.update_environment({
  application_id: "Id", # required
  environment_id: "Id", # required
  name: "Name",
  description: "Description",
  monitors: [
    {
      alarm_arn: "StringWithLengthBetween1And2048", # required
      alarm_role_arn: "RoleArn",
    },
  ],
})

Response structure


resp.application_id #=> String
resp.id #=> String
resp.name #=> String
resp.description #=> String
resp.state #=> String, one of "READY_FOR_DEPLOYMENT", "DEPLOYING", "ROLLING_BACK", "ROLLED_BACK"
resp.monitors #=> Array
resp.monitors[0].alarm_arn #=> String
resp.monitors[0].alarm_role_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :application_id (required, String) —

    The application ID.

  • :environment_id (required, String) —

    The environment ID.

  • :name (String) —

    The name of the environment.

  • :description (String) —

    A description of the environment.

  • :monitors (Array<Types::Monitor>) —

    Amazon CloudWatch alarms to monitor during the deployment process.

Returns:

See Also:



3426
3427
3428
3429
 
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/client.rb', line 3426

def update_environment(params = {}, options = {})
  req = build_request(:update_environment, params)
  req.send_request(options)
end

#update_extension(params = {}) ⇒ Types::Extension

Updates an AppConfig extension. For more information about extensions, see Working with AppConfig extensions in the AppConfig User Guide.

Examples:

Request syntax with placeholder values


resp = client.update_extension({
  extension_identifier: "Identifier", # required
  description: "Description",
  actions: {
    "PRE_CREATE_HOSTED_CONFIGURATION_VERSION" => [
      {
        name: "Name",
        description: "Description",
        uri: "Uri",
        role_arn: "Arn",
      },
    ],
  },
  parameters: {
    "Name" => {
      description: "Description",
      required: false,
    },
  },
  version_number: 1,
})

Response structure


resp.id #=> String
resp.name #=> String
resp.version_number #=> Integer
resp.arn #=> String
resp.description #=> String
resp.actions #=> Hash
resp.actions["ActionPoint"] #=> Array
resp.actions["ActionPoint"][0].name #=> String
resp.actions["ActionPoint"][0].description #=> String
resp.actions["ActionPoint"][0].uri #=> String
resp.actions["ActionPoint"][0].role_arn #=> String
resp.parameters #=> Hash
resp.parameters["Name"].description #=> String
resp.parameters["Name"].required #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :extension_identifier (required, String) —

    The name, the ID, or the Amazon Resource Name (ARN) of the extension.

  • :description (String) —

    Information about the extension.

  • :actions (Hash<String,Array>) —

    The actions defined in the extension.

  • :parameters (Hash<String,Types::Parameter>) —

    One or more parameters for the actions called by the extension.

  • :version_number (Integer) —

    The extension version number.

Returns:

See Also:



3509
3510
3511
3512
 
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/client.rb', line 3509

def update_extension(params = {}, options = {})
  req = build_request(:update_extension, params)
  req.send_request(options)
end

#update_extension_association(params = {}) ⇒ Types::ExtensionAssociation

Updates an association. For more information about extensions and associations, see Working with AppConfig extensions in the AppConfig User Guide.

Examples:

Request syntax with placeholder values


resp = client.update_extension_association({
  extension_association_id: "Id", # required
  parameters: {
    "Name" => "StringWithLengthBetween1And2048",
  },
})

Response structure


resp.id #=> String
resp.extension_arn #=> String
resp.resource_arn #=> String
resp.arn #=> String
resp.parameters #=> Hash
resp.parameters["Name"] #=> String
resp.extension_version_number #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :extension_association_id (required, String) —

    The system-generated ID for the association.

  • :parameters (Hash<String,String>) —

    The parameter names and values defined in the extension.

Returns:

See Also:



3560
3561
3562
3563
 
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/client.rb', line 3560

def update_extension_association(params = {}, options = {})
  req = build_request(:update_extension_association, params)
  req.send_request(options)
end

#validate_configuration(params = {}) ⇒ Struct

Uses the validators in a configuration profile to validate a configuration.

Examples:

Example: To validate a configuration


# The following validate-configuration example uses the validators in a configuration profile to validate a configuration.

resp = client.validate_configuration({
  application_id: "abc1234", 
  configuration_profile_id: "ur8hx2f", 
  configuration_version: "1", 
})

Request syntax with placeholder values


resp = client.validate_configuration({
  application_id: "Id", # required
  configuration_profile_id: "Id", # required
  configuration_version: "Version", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :application_id (required, String) —

    The application ID.

  • :configuration_profile_id (required, String) —

    The configuration profile ID.

  • :configuration_version (required, String) —

    The version of the configuration to validate.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3602
3603
3604
3605
 
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/client.rb', line 3602

def validate_configuration(params = {}, options = {})
  req = build_request(:validate_configuration, params)
  req.send_request(options)
end