aws-sdk-apigateway 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e7d6736c0f8c18dd8d172920a3a2b64ddc617218
-  data.tar.gz: 9a945bb603f64c516cac7b24e017d12214fd59ca
+  metadata.gz: 32dd66a417cb0ffcb831d383c6d74ea9f563aab9
+  data.tar.gz: 13f1c58992c5a9ec442c733c9f68dc827266251a
 SHA512:
-  metadata.gz: c49946be1031463707f13c454a43d549253699550d5a93f8546261697c05234356cdf7180fb2af7c38e7ec4661ad68d68140ae26b6c5a266194b56ba10bfba4e
-  data.tar.gz: aaab9c69a4ba897585b6002005fe44b537fe8bac088a37cafc34e1026291e47d4c75cba4e9d3f84fad8febb828f833625982d1527d1ac5c61684ced6e52f50ba
+  metadata.gz: 4c9c4fae6b7847ac07765a475dead9bb944fb95b5e0600602e6e44a15790c577b6ad4eb7a5b4042f098f88abc6fbe070e31f77e4ac9a788c0c239865dac03aae
+  data.tar.gz: a042b9c8786959e803536f51868a7e74b6f3f5e0a0e784e537417a4372667ffbf635d06599a35546a2349a1e9095634ab5d347b6afc2e9b9d3e0d8839c3b9ac5

data/lib/aws-sdk-apigateway.rb

@@ -42,6 +42,6 @@ require_relative 'aws-sdk-apigateway/customizations'
 # @service
 module Aws::APIGateway
 
-  GEM_VERSION = '1.5.0'
+  GEM_VERSION = '1.6.0'
 
 end

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

@@ -446,6 +446,10 @@ module Aws::APIGateway
     #   alphanumeric and underscore characters, and the values must match
     #   `[A-Za-z0-9-._~:/?#&=,]+`.
     #
+    # @option params [Types::DeploymentCanarySettings] :canary_settings
+    #   The input configuration for the canary deployment when the deployment
+    #   is a canary release deployment.
+    #
     # @return [Types::Deployment] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::Deployment#id #id} => String
@@ -465,6 +469,13 @@ module Aws::APIGateway
     #     variables: {
     #       "String" => "String",
     #     },
+    #     canary_settings: {
+    #       percent_traffic: 1.0,
+    #       stage_variable_overrides: {
+    #         "String" => "String",
+    #       },
+    #       use_stage_cache: false,
+    #     },
     #   })
     #
     # @example Response structure
@@ -927,10 +938,11 @@ module Aws::APIGateway
     #   The string identifier of the associated RestApi.
     #
     # @option params [required, String] :stage_name
-    #   The name for the Stage resource.
+    #   \\\{Required\] The name for the Stage resource.
     #
     # @option params [required, String] :deployment_id
-    #   The identifier of the Deployment resource for the Stage resource.
+    #   \[Required\] The identifier of the Deployment resource for the Stage
+    #   resource.
     #
     # @option params [String] :description
     #   The description of the Stage resource.
@@ -949,6 +961,9 @@ module Aws::APIGateway
     # @option params [String] :documentation_version
     #   The version of the associated API documentation.
     #
+    # @option params [Types::CanarySettings] :canary_settings
+    #   The canary deployment settings of this stage.
+    #
     # @return [Types::Stage] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::Stage#deployment_id #deployment_id} => String
@@ -962,6 +977,7 @@ module Aws::APIGateway
     #   * {Types::Stage#variables #variables} => Hash<String,String>
     #   * {Types::Stage#documentation_version #documentation_version} => String
     #   * {Types::Stage#access_log_settings #access_log_settings} => Types::AccessLogSettings
+    #   * {Types::Stage#canary_settings #canary_settings} => Types::CanarySettings
     #   * {Types::Stage#created_date #created_date} => Time
     #   * {Types::Stage#last_updated_date #last_updated_date} => Time
     #
@@ -978,6 +994,14 @@ module Aws::APIGateway
     #       "String" => "String",
     #     },
     #     documentation_version: "String",
+    #     canary_settings: {
+    #       percent_traffic: 1.0,
+    #       deployment_id: "String",
+    #       stage_variable_overrides: {
+    #         "String" => "String",
+    #       },
+    #       use_stage_cache: false,
+    #     },
     #   })
     #
     # @example Response structure
@@ -1005,6 +1029,11 @@ module Aws::APIGateway
     #   resp.documentation_version #=> String
     #   resp.access_log_settings.format #=> String
     #   resp.access_log_settings.destination_arn #=> String
+    #   resp.canary_settings.percent_traffic #=> Float
+    #   resp.canary_settings.deployment_id #=> String
+    #   resp.canary_settings.stage_variable_overrides #=> Hash
+    #   resp.canary_settings.stage_variable_overrides["String"] #=> String
+    #   resp.canary_settings.use_stage_cache #=> Boolean
     #   resp.created_date #=> Time
     #   resp.last_updated_date #=> Time
     #
@@ -3486,6 +3515,7 @@ module Aws::APIGateway
     #   * {Types::Stage#variables #variables} => Hash<String,String>
     #   * {Types::Stage#documentation_version #documentation_version} => String
     #   * {Types::Stage#access_log_settings #access_log_settings} => Types::AccessLogSettings
+    #   * {Types::Stage#canary_settings #canary_settings} => Types::CanarySettings
     #   * {Types::Stage#created_date #created_date} => Time
     #   * {Types::Stage#last_updated_date #last_updated_date} => Time
     #
@@ -3521,6 +3551,11 @@ module Aws::APIGateway
     #   resp.documentation_version #=> String
     #   resp.access_log_settings.format #=> String
     #   resp.access_log_settings.destination_arn #=> String
+    #   resp.canary_settings.percent_traffic #=> Float
+    #   resp.canary_settings.deployment_id #=> String
+    #   resp.canary_settings.stage_variable_overrides #=> Hash
+    #   resp.canary_settings.stage_variable_overrides["String"] #=> String
+    #   resp.canary_settings.use_stage_cache #=> Boolean
     #   resp.created_date #=> Time
     #   resp.last_updated_date #=> Time
     #
@@ -3576,6 +3611,11 @@ module Aws::APIGateway
     #   resp.item[0].documentation_version #=> String
     #   resp.item[0].access_log_settings.format #=> String
     #   resp.item[0].access_log_settings.destination_arn #=> String
+    #   resp.item[0].canary_settings.percent_traffic #=> Float
+    #   resp.item[0].canary_settings.deployment_id #=> String
+    #   resp.item[0].canary_settings.stage_variable_overrides #=> Hash
+    #   resp.item[0].canary_settings.stage_variable_overrides["String"] #=> String
+    #   resp.item[0].canary_settings.use_stage_cache #=> Boolean
     #   resp.item[0].created_date #=> Time
     #   resp.item[0].last_updated_date #=> Time
     #
@@ -5858,6 +5898,7 @@ module Aws::APIGateway
     #   * {Types::Stage#variables #variables} => Hash<String,String>
     #   * {Types::Stage#documentation_version #documentation_version} => String
     #   * {Types::Stage#access_log_settings #access_log_settings} => Types::AccessLogSettings
+    #   * {Types::Stage#canary_settings #canary_settings} => Types::CanarySettings
     #   * {Types::Stage#created_date #created_date} => Time
     #   * {Types::Stage#last_updated_date #last_updated_date} => Time
     #
@@ -5901,6 +5942,11 @@ module Aws::APIGateway
     #   resp.documentation_version #=> String
     #   resp.access_log_settings.format #=> String
     #   resp.access_log_settings.destination_arn #=> String
+    #   resp.canary_settings.percent_traffic #=> Float
+    #   resp.canary_settings.deployment_id #=> String
+    #   resp.canary_settings.stage_variable_overrides #=> Hash
+    #   resp.canary_settings.stage_variable_overrides["String"] #=> String
+    #   resp.canary_settings.use_stage_cache #=> Boolean
     #   resp.created_date #=> Time
     #   resp.last_updated_date #=> Time
     #
@@ -6034,7 +6080,7 @@ module Aws::APIGateway
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-apigateway'
-      context[:gem_version] = '1.5.0'
+      context[:gem_version] = '1.6.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -28,6 +28,7 @@ module Aws::APIGateway
     Boolean = Shapes::BooleanShape.new(name: 'Boolean')
     CacheClusterSize = Shapes::StringShape.new(name: 'CacheClusterSize')
     CacheClusterStatus = Shapes::StringShape.new(name: 'CacheClusterStatus')
+    CanarySettings = Shapes::StructureShape.new(name: 'CanarySettings')
     ClientCertificate = Shapes::StructureShape.new(name: 'ClientCertificate')
     ClientCertificates = Shapes::StructureShape.new(name: 'ClientCertificates')
     ConflictException = Shapes::StructureShape.new(name: 'ConflictException')
@@ -67,6 +68,7 @@ module Aws::APIGateway
     DeleteUsagePlanKeyRequest = Shapes::StructureShape.new(name: 'DeleteUsagePlanKeyRequest')
     DeleteUsagePlanRequest = Shapes::StructureShape.new(name: 'DeleteUsagePlanRequest')
     Deployment = Shapes::StructureShape.new(name: 'Deployment')
+    DeploymentCanarySettings = Shapes::StructureShape.new(name: 'DeploymentCanarySettings')
     Deployments = Shapes::StructureShape.new(name: 'Deployments')
     DocumentationPart = Shapes::StructureShape.new(name: 'DocumentationPart')
     DocumentationPartIds = Shapes::StructureShape.new(name: 'DocumentationPartIds')
@@ -311,6 +313,12 @@ module Aws::APIGateway
     BasePathMappings.add_member(:items, Shapes::ShapeRef.new(shape: ListOfBasePathMapping, location_name: "item"))
     BasePathMappings.struct_class = Types::BasePathMappings
 
+    CanarySettings.add_member(:percent_traffic, Shapes::ShapeRef.new(shape: Double, location_name: "percentTraffic"))
+    CanarySettings.add_member(:deployment_id, Shapes::ShapeRef.new(shape: String, location_name: "deploymentId"))
+    CanarySettings.add_member(:stage_variable_overrides, Shapes::ShapeRef.new(shape: MapOfStringToString, location_name: "stageVariableOverrides"))
+    CanarySettings.add_member(:use_stage_cache, Shapes::ShapeRef.new(shape: Boolean, location_name: "useStageCache"))
+    CanarySettings.struct_class = Types::CanarySettings
+
     ClientCertificate.add_member(:client_certificate_id, Shapes::ShapeRef.new(shape: String, location_name: "clientCertificateId"))
     ClientCertificate.add_member(:description, Shapes::ShapeRef.new(shape: String, location_name: "description"))
     ClientCertificate.add_member(:pem_encoded_certificate, Shapes::ShapeRef.new(shape: String, location_name: "pemEncodedCertificate"))
@@ -356,6 +364,7 @@ module Aws::APIGateway
     CreateDeploymentRequest.add_member(:cache_cluster_enabled, Shapes::ShapeRef.new(shape: NullableBoolean, location_name: "cacheClusterEnabled"))
     CreateDeploymentRequest.add_member(:cache_cluster_size, Shapes::ShapeRef.new(shape: CacheClusterSize, location_name: "cacheClusterSize"))
     CreateDeploymentRequest.add_member(:variables, Shapes::ShapeRef.new(shape: MapOfStringToString, location_name: "variables"))
+    CreateDeploymentRequest.add_member(:canary_settings, Shapes::ShapeRef.new(shape: DeploymentCanarySettings, location_name: "canarySettings"))
     CreateDeploymentRequest.struct_class = Types::CreateDeploymentRequest
 
     CreateDocumentationPartRequest.add_member(:rest_api_id, Shapes::ShapeRef.new(shape: String, required: true, location: "uri", location_name: "restapi_id"))
@@ -414,6 +423,7 @@ module Aws::APIGateway
     CreateStageRequest.add_member(:cache_cluster_size, Shapes::ShapeRef.new(shape: CacheClusterSize, location_name: "cacheClusterSize"))
     CreateStageRequest.add_member(:variables, Shapes::ShapeRef.new(shape: MapOfStringToString, location_name: "variables"))
     CreateStageRequest.add_member(:documentation_version, Shapes::ShapeRef.new(shape: String, location_name: "documentationVersion"))
+    CreateStageRequest.add_member(:canary_settings, Shapes::ShapeRef.new(shape: CanarySettings, location_name: "canarySettings"))
     CreateStageRequest.struct_class = Types::CreateStageRequest
 
     CreateUsagePlanKeyRequest.add_member(:usage_plan_id, Shapes::ShapeRef.new(shape: String, required: true, location: "uri", location_name: "usageplanId"))
@@ -515,6 +525,11 @@ module Aws::APIGateway
     Deployment.add_member(:api_summary, Shapes::ShapeRef.new(shape: PathToMapOfMethodSnapshot, location_name: "apiSummary"))
     Deployment.struct_class = Types::Deployment
 
+    DeploymentCanarySettings.add_member(:percent_traffic, Shapes::ShapeRef.new(shape: Double, location_name: "percentTraffic"))
+    DeploymentCanarySettings.add_member(:stage_variable_overrides, Shapes::ShapeRef.new(shape: MapOfStringToString, location_name: "stageVariableOverrides"))
+    DeploymentCanarySettings.add_member(:use_stage_cache, Shapes::ShapeRef.new(shape: Boolean, location_name: "useStageCache"))
+    DeploymentCanarySettings.struct_class = Types::DeploymentCanarySettings
+
     Deployments.add_member(:position, Shapes::ShapeRef.new(shape: String, location_name: "position"))
     Deployments.add_member(:items, Shapes::ShapeRef.new(shape: ListOfDeployment, location_name: "item"))
     Deployments.struct_class = Types::Deployments
@@ -1115,6 +1130,7 @@ module Aws::APIGateway
     Stage.add_member(:variables, Shapes::ShapeRef.new(shape: MapOfStringToString, location_name: "variables"))
     Stage.add_member(:documentation_version, Shapes::ShapeRef.new(shape: String, location_name: "documentationVersion"))
     Stage.add_member(:access_log_settings, Shapes::ShapeRef.new(shape: AccessLogSettings, location_name: "accessLogSettings"))
+    Stage.add_member(:canary_settings, Shapes::ShapeRef.new(shape: CanarySettings, location_name: "canarySettings"))
     Stage.add_member(:created_date, Shapes::ShapeRef.new(shape: Timestamp, location_name: "createdDate"))
     Stage.add_member(:last_updated_date, Shapes::ShapeRef.new(shape: Timestamp, location_name: "lastUpdatedDate"))
     Stage.struct_class = Types::Stage

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

@@ -435,6 +435,48 @@ module Aws::APIGateway
       include Aws::Structure
     end
 
+    # Configuration settings of a canary deployment.
+    #
+    # @note When making an API call, you may pass CanarySettings
+    #   data as a hash:
+    #
+    #       {
+    #         percent_traffic: 1.0,
+    #         deployment_id: "String",
+    #         stage_variable_overrides: {
+    #           "String" => "String",
+    #         },
+    #         use_stage_cache: false,
+    #       }
+    #
+    # @!attribute [rw] percent_traffic
+    #   The percent (0-100) of traffic diverted to a canary deployment.
+    #   @return [Float]
+    #
+    # @!attribute [rw] deployment_id
+    #   The ID of the canary deployment.
+    #   @return [String]
+    #
+    # @!attribute [rw] stage_variable_overrides
+    #   Stage variables overridden for a canary release deployment,
+    #   including new stage variables introduced in the canary. These stage
+    #   variables are represented as a string-to-string map between stage
+    #   variable names and their values.
+    #   @return [Hash<String,String>]
+    #
+    # @!attribute [rw] use_stage_cache
+    #   A Boolean flag to indicate whether the canary deployment uses the
+    #   stage cache or not.
+    #   @return [Boolean]
+    #
+    class CanarySettings < Struct.new(
+      :percent_traffic,
+      :deployment_id,
+      :stage_variable_overrides,
+      :use_stage_cache)
+      include Aws::Structure
+    end
+
     # Represents a client certificate used to configure client-side SSL
     # authentication while sending requests to the integration endpoint.
     #
@@ -748,6 +790,13 @@ module Aws::APIGateway
     #         variables: {
     #           "String" => "String",
     #         },
+    #         canary_settings: {
+    #           percent_traffic: 1.0,
+    #           stage_variable_overrides: {
+    #             "String" => "String",
+    #           },
+    #           use_stage_cache: false,
+    #         },
     #       }
     #
     # @!attribute [rw] rest_api_id
@@ -785,6 +834,11 @@ module Aws::APIGateway
     #   `[A-Za-z0-9-._~:/?#&=,]+`.
     #   @return [Hash<String,String>]
     #
+    # @!attribute [rw] canary_settings
+    #   The input configuration for the canary deployment when the
+    #   deployment is a canary release deployment.
+    #   @return [Types::DeploymentCanarySettings]
+    #
     class CreateDeploymentRequest < Struct.new(
       :rest_api_id,
       :stage_name,
@@ -792,7 +846,8 @@ module Aws::APIGateway
       :description,
       :cache_cluster_enabled,
       :cache_cluster_size,
-      :variables)
+      :variables,
+      :canary_settings)
       include Aws::Structure
     end
 
@@ -1141,6 +1196,14 @@ module Aws::APIGateway
     #           "String" => "String",
     #         },
     #         documentation_version: "String",
+    #         canary_settings: {
+    #           percent_traffic: 1.0,
+    #           deployment_id: "String",
+    #           stage_variable_overrides: {
+    #             "String" => "String",
+    #           },
+    #           use_stage_cache: false,
+    #         },
     #       }
     #
     # @!attribute [rw] rest_api_id
@@ -1148,11 +1211,12 @@ module Aws::APIGateway
     #   @return [String]
     #
     # @!attribute [rw] stage_name
-    #   The name for the Stage resource.
+    #   \\\{Required\] The name for the Stage resource.
     #   @return [String]
     #
     # @!attribute [rw] deployment_id
-    #   The identifier of the Deployment resource for the Stage resource.
+    #   \[Required\] The identifier of the Deployment resource for the Stage
+    #   resource.
     #   @return [String]
     #
     # @!attribute [rw] description
@@ -1177,6 +1241,10 @@ module Aws::APIGateway
     #   The version of the associated API documentation.
     #   @return [String]
     #
+    # @!attribute [rw] canary_settings
+    #   The canary deployment settings of this stage.
+    #   @return [Types::CanarySettings]
+    #
     class CreateStageRequest < Struct.new(
       :rest_api_id,
       :stage_name,
@@ -1185,7 +1253,8 @@ module Aws::APIGateway
       :cache_cluster_enabled,
       :cache_cluster_size,
       :variables,
-      :documentation_version)
+      :documentation_version,
+      :canary_settings)
       include Aws::Structure
     end
 
@@ -1835,6 +1904,44 @@ module Aws::APIGateway
       include Aws::Structure
     end
 
+    # The input configuration for a canary deployment.
+    #
+    # @note When making an API call, you may pass DeploymentCanarySettings
+    #   data as a hash:
+    #
+    #       {
+    #         percent_traffic: 1.0,
+    #         stage_variable_overrides: {
+    #           "String" => "String",
+    #         },
+    #         use_stage_cache: false,
+    #       }
+    #
+    # @!attribute [rw] percent_traffic
+    #   The percentage (0.0-100.0) of traffic routed to the canary
+    #   deployment.
+    #   @return [Float]
+    #
+    # @!attribute [rw] stage_variable_overrides
+    #   A stage variable overrides used for the canary release deployment.
+    #   They can override existing stage variables or add new stage
+    #   variables for the canary release deployment. These stage variables
+    #   are represented as a string-to-string map between stage variable
+    #   names and their values.
+    #   @return [Hash<String,String>]
+    #
+    # @!attribute [rw] use_stage_cache
+    #   A Boolean flag to indicate whether the canary release deployment
+    #   uses the stage cache or not.
+    #   @return [Boolean]
+    #
+    class DeploymentCanarySettings < Struct.new(
+      :percent_traffic,
+      :stage_variable_overrides,
+      :use_stage_cache)
+      include Aws::Structure
+    end
+
     # Represents a collection resource that contains zero or more references
     # to your existing deployments, and links that guide you on how to
     # interact with your collection. The collection offers a paginated view
@@ -4718,7 +4825,7 @@ module Aws::APIGateway
     #
     # @!attribute [rw] op
     #   An update operation to be performed with this PATCH request. The
-    #   valid value can be "add", "remove", or "replace". Not all
+    #   valid value can be `add`, `remove`, `replace` or `copy`. Not all
     #   valid operations are supported for a given resource. Support of the
     #   operations depends on specific operational contexts. Attempts to
     #   apply an unsupported operation on a resource will return an error
@@ -4743,10 +4850,11 @@ module Aws::APIGateway
     #   @return [String]
     #
     # @!attribute [rw] value
-    #   The new target value of the update operation. When using AWS CLI to
-    #   update a property of a JSON value, enclose the JSON object with a
-    #   pair of single quotes in a Linux shell, e.g., '\\\{"a": ...\\}'.
-    #   In a Windows shell, see [Using JSON for Parameters][1].
+    #   The new target value of the update operation. It is applicable for
+    #   the `add` or `replace` operation. When using AWS CLI to update a
+    #   property of a JSON value, enclose the JSON object with a pair of
+    #   single quotes in a Linux shell, e.g., '\\\{"a": ...\\}'. In a
+    #   Windows shell, see [Using JSON for Parameters][1].
     #
     #
     #
@@ -4754,7 +4862,13 @@ module Aws::APIGateway
     #   @return [String]
     #
     # @!attribute [rw] from
-    #   Not supported.
+    #   The `copy` update operation's source as identified by a
+    #   `JSON-Pointer` value referencing the location within the targeted
+    #   resource to copy the value from. For example, to promote a canary
+    #   deployment, you copy the canary deployment ID to the affiliated
+    #   deployment ID by calling a PATCH request on a Stage resource with
+    #   `"op":"copy"`, `"from":"/canarySettings/deploymentId"` and
+    #   `"path":"/deploymentId"`.
     #   @return [String]
     #
     class PatchOperation < Struct.new(
@@ -5734,9 +5848,13 @@ module Aws::APIGateway
     #   @return [String]
     #
     # @!attribute [rw] access_log_settings
-    #   The access log settings in this stage.
+    #   Settings for logging access in this stage.
     #   @return [Types::AccessLogSettings]
     #
+    # @!attribute [rw] canary_settings
+    #   Settings for the canary deployment in this stage.
+    #   @return [Types::CanarySettings]
+    #
     # @!attribute [rw] created_date
     #   The timestamp when the stage was created.
     #   @return [Time]
@@ -5757,6 +5875,7 @@ module Aws::APIGateway
       :variables,
       :documentation_version,
       :access_log_settings,
+      :canary_settings,
       :created_date,
       :last_updated_date)
       include Aws::Structure

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-apigateway
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-22 00:00:00.000000000 Z
+date: 2017-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core