] :tags
# \[Required\] The key-value map of strings. 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.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
# resp = client.tag_resource({
# resource_arn: "String", # required
# tags: { # required
# "String" => "String",
# },
# })
#
# @overload tag_resource(params = {})
# @param [Hash] params ({})
def tag_resource(params = {}, options = {})
req = build_request(:tag_resource, params)
req.send_request(options)
end
# Simulate the execution of an Authorizer in your RestApi with headers,
# parameters, and an incoming request body.
#
#
# [Use Lambda Function as Authorizer][1] [Use Cognito User Pool as
# Authorizer][2]
#
#
#
#
# [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-use-lambda-authorizer.html
# [2]: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-integrate-with-cognito.html
#
# @option params [required, String] :rest_api_id
# \[Required\] The string identifier of the associated RestApi.
#
# @option params [required, String] :authorizer_id
# \[Required\] Specifies a test invoke authorizer request's Authorizer
# ID.
#
# @option params [Hash] :headers
# \[Required\] A key-value map of headers to simulate an incoming
# invocation request. This is where the incoming authorization token, or
# identity source, should be specified.
#
# @option params [Hash] :multi_value_headers
# \[Optional\] The headers as a map from string to list of values to
# simulate an incoming invocation request. This is where the incoming
# authorization token, or identity source, may be specified.
#
# @option params [String] :path_with_query_string
# \[Optional\] The URI path, including query string, of the simulated
# invocation request. Use this to specify path parameters and query
# string parameters.
#
# @option params [String] :body
# \[Optional\] The simulated request body of an incoming invocation
# request.
#
# @option params [Hash] :stage_variables
# A key-value map of stage variables to simulate an invocation on a
# deployed Stage.
#
# @option params [Hash] :additional_context
# \[Optional\] A key-value map of additional context variables.
#
# @return [Types::TestInvokeAuthorizerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::TestInvokeAuthorizerResponse#client_status #client_status} => Integer
# * {Types::TestInvokeAuthorizerResponse#log #log} => String
# * {Types::TestInvokeAuthorizerResponse#latency #latency} => Integer
# * {Types::TestInvokeAuthorizerResponse#principal_id #principal_id} => String
# * {Types::TestInvokeAuthorizerResponse#policy #policy} => String
# * {Types::TestInvokeAuthorizerResponse#authorization #authorization} => Hash<String,Array<String>>
# * {Types::TestInvokeAuthorizerResponse#claims #claims} => Hash<String,String>
#
# @example Request syntax with placeholder values
#
# resp = client.test_invoke_authorizer({
# rest_api_id: "String", # required
# authorizer_id: "String", # required
# headers: {
# "String" => "String",
# },
# multi_value_headers: {
# "String" => ["String"],
# },
# path_with_query_string: "String",
# body: "String",
# stage_variables: {
# "String" => "String",
# },
# additional_context: {
# "String" => "String",
# },
# })
#
# @example Response structure
#
# resp.client_status #=> Integer
# resp.log #=> String
# resp.latency #=> Integer
# resp.principal_id #=> String
# resp.policy #=> String
# resp.authorization #=> Hash
# resp.authorization["String"] #=> Array
# resp.authorization["String"][0] #=> String
# resp.claims #=> Hash
# resp.claims["String"] #=> String
#
# @overload test_invoke_authorizer(params = {})
# @param [Hash] params ({})
def test_invoke_authorizer(params = {}, options = {})
req = build_request(:test_invoke_authorizer, params)
req.send_request(options)
end
# Simulate the execution of a Method in your RestApi with headers,
# parameters, and an incoming request body.
#
# @option params [required, String] :rest_api_id
# \[Required\] The string identifier of the associated RestApi.
#
# @option params [required, String] :resource_id
# \[Required\] Specifies a test invoke method request's resource ID.
#
# @option params [required, String] :http_method
# \[Required\] Specifies a test invoke method request's HTTP method.
#
# @option params [String] :path_with_query_string
# The URI path, including query string, of the simulated invocation
# request. Use this to specify path parameters and query string
# parameters.
#
# @option params [String] :body
# The simulated request body of an incoming invocation request.
#
# @option params [Hash] :headers
# A key-value map of headers to simulate an incoming invocation request.
#
# @option params [Hash] :multi_value_headers
# The headers as a map from string to list of values to simulate an
# incoming invocation request.
#
# @option params [String] :client_certificate_id
# A ClientCertificate identifier to use in the test invocation. API
# Gateway will use the certificate when making the HTTPS request to the
# defined back-end endpoint.
#
# @option params [Hash] :stage_variables
# A key-value map of stage variables to simulate an invocation on a
# deployed Stage.
#
# @return [Types::TestInvokeMethodResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::TestInvokeMethodResponse#status #status} => Integer
# * {Types::TestInvokeMethodResponse#body #body} => String
# * {Types::TestInvokeMethodResponse#headers #headers} => Hash<String,String>
# * {Types::TestInvokeMethodResponse#multi_value_headers #multi_value_headers} => Hash<String,Array<String>>
# * {Types::TestInvokeMethodResponse#log #log} => String
# * {Types::TestInvokeMethodResponse#latency #latency} => Integer
#
# @example Request syntax with placeholder values
#
# resp = client.test_invoke_method({
# rest_api_id: "String", # required
# resource_id: "String", # required
# http_method: "String", # required
# path_with_query_string: "String",
# body: "String",
# headers: {
# "String" => "String",
# },
# multi_value_headers: {
# "String" => ["String"],
# },
# client_certificate_id: "String",
# stage_variables: {
# "String" => "String",
# },
# })
#
# @example Response structure
#
# resp.status #=> Integer
# resp.body #=> String
# resp.headers #=> Hash
# resp.headers["String"] #=> String
# resp.multi_value_headers #=> Hash
# resp.multi_value_headers["String"] #=> Array
# resp.multi_value_headers["String"][0] #=> String
# resp.log #=> String
# resp.latency #=> Integer
#
# @overload test_invoke_method(params = {})
# @param [Hash] params ({})
def test_invoke_method(params = {}, options = {})
req = build_request(:test_invoke_method, params)
req.send_request(options)
end
# Removes a tag from a given resource.
#
# @option params [required, String] :resource_arn
# \[Required\] The ARN of a resource that can be tagged.
#
# @option params [required, Array] :tag_keys
# \[Required\] The Tag keys to delete.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
# resp = client.untag_resource({
# resource_arn: "String", # required
# tag_keys: ["String"], # required
# })
#
# @overload untag_resource(params = {})
# @param [Hash] params ({})
def untag_resource(params = {}, options = {})
req = build_request(:untag_resource, params)
req.send_request(options)
end
# Changes information about the current Account resource.
#
# @option params [Array] :patch_operations
# A list of update operations to be applied to the specified resource
# and in the order specified in this list.
#
# @return [Types::Account] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::Account#cloudwatch_role_arn #cloudwatch_role_arn} => String
# * {Types::Account#throttle_settings #throttle_settings} => Types::ThrottleSettings
# * {Types::Account#features #features} => Array<String>
# * {Types::Account#api_key_version #api_key_version} => String
#
# @example Request syntax with placeholder values
#
# resp = client.update_account({
# patch_operations: [
# {
# op: "add", # accepts add, remove, replace, move, copy, test
# path: "String",
# value: "String",
# from: "String",
# },
# ],
# })
#
# @example Response structure
#
# resp.cloudwatch_role_arn #=> String
# resp.throttle_settings.burst_limit #=> Integer
# resp.throttle_settings.rate_limit #=> Float
# resp.features #=> Array
# resp.features[0] #=> String
# resp.api_key_version #=> String
#
# @overload update_account(params = {})
# @param [Hash] params ({})
def update_account(params = {}, options = {})
req = build_request(:update_account, params)
req.send_request(options)
end
# Changes information about an ApiKey resource.
#
# @option params [required, String] :api_key
# \[Required\] The identifier of the ApiKey resource to be updated.
#
# @option params [Array] :patch_operations
# A list of update operations to be applied to the specified resource
# and in the order specified in this list.
#
# @return [Types::ApiKey] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::ApiKey#id #id} => String
# * {Types::ApiKey#value #value} => String
# * {Types::ApiKey#name #name} => String
# * {Types::ApiKey#customer_id #customer_id} => String
# * {Types::ApiKey#description #description} => String
# * {Types::ApiKey#enabled #enabled} => Boolean
# * {Types::ApiKey#created_date #created_date} => Time
# * {Types::ApiKey#last_updated_date #last_updated_date} => Time
# * {Types::ApiKey#stage_keys #stage_keys} => Array<String>
# * {Types::ApiKey#tags #tags} => Hash<String,String>
#
# @example Request syntax with placeholder values
#
# resp = client.update_api_key({
# api_key: "String", # required
# patch_operations: [
# {
# op: "add", # accepts add, remove, replace, move, copy, test
# path: "String",
# value: "String",
# from: "String",
# },
# ],
# })
#
# @example Response structure
#
# resp.id #=> String
# resp.value #=> String
# resp.name #=> String
# resp.customer_id #=> String
# resp.description #=> String
# resp.enabled #=> Boolean
# resp.created_date #=> Time
# resp.last_updated_date #=> Time
# resp.stage_keys #=> Array
# resp.stage_keys[0] #=> String
# resp.tags #=> Hash
# resp.tags["String"] #=> String
#
# @overload update_api_key(params = {})
# @param [Hash] params ({})
def update_api_key(params = {}, options = {})
req = build_request(:update_api_key, params)
req.send_request(options)
end
# Updates an existing Authorizer resource.
#
#
# [AWS CLI][1]
#
#
#
#
# [1]: https://docs.aws.amazon.com/cli/latest/reference/apigateway/update-authorizer.html
#
# @option params [required, String] :rest_api_id
# \[Required\] The string identifier of the associated RestApi.
#
# @option params [required, String] :authorizer_id
# \[Required\] The identifier of the Authorizer resource.
#
# @option params [Array] :patch_operations
# A list of update operations to be applied to the specified resource
# and in the order specified in this list.
#
# @return [Types::Authorizer] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::Authorizer#id #id} => String
# * {Types::Authorizer#name #name} => String
# * {Types::Authorizer#type #type} => String
# * {Types::Authorizer#provider_arns #provider_arns} => Array<String>
# * {Types::Authorizer#auth_type #auth_type} => String
# * {Types::Authorizer#authorizer_uri #authorizer_uri} => String
# * {Types::Authorizer#authorizer_credentials #authorizer_credentials} => String
# * {Types::Authorizer#identity_source #identity_source} => String
# * {Types::Authorizer#identity_validation_expression #identity_validation_expression} => String
# * {Types::Authorizer#authorizer_result_ttl_in_seconds #authorizer_result_ttl_in_seconds} => Integer
#
# @example Request syntax with placeholder values
#
# resp = client.update_authorizer({
# rest_api_id: "String", # required
# authorizer_id: "String", # required
# patch_operations: [
# {
# op: "add", # accepts add, remove, replace, move, copy, test
# path: "String",
# value: "String",
# from: "String",
# },
# ],
# })
#
# @example Response structure
#
# resp.id #=> String
# resp.name #=> String
# resp.type #=> String, one of "TOKEN", "REQUEST", "COGNITO_USER_POOLS"
# resp.provider_arns #=> Array
# resp.provider_arns[0] #=> String
# resp.auth_type #=> String
# resp.authorizer_uri #=> String
# resp.authorizer_credentials #=> String
# resp.identity_source #=> String
# resp.identity_validation_expression #=> String
# resp.authorizer_result_ttl_in_seconds #=> Integer
#
# @overload update_authorizer(params = {})
# @param [Hash] params ({})
def update_authorizer(params = {}, options = {})
req = build_request(:update_authorizer, params)
req.send_request(options)
end
# Changes information about the BasePathMapping resource.
#
# @option params [required, String] :domain_name
# \[Required\] The domain name of the BasePathMapping resource to
# change.
#
# @option params [required, String] :base_path
# \[Required\] The base path of the BasePathMapping resource to change.
#
# To specify an empty base path, set this parameter to `'(none)'`.
#
# @option params [Array] :patch_operations
# A list of update operations to be applied to the specified resource
# and in the order specified in this list.
#
# @return [Types::BasePathMapping] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::BasePathMapping#base_path #base_path} => String
# * {Types::BasePathMapping#rest_api_id #rest_api_id} => String
# * {Types::BasePathMapping#stage #stage} => String
#
# @example Request syntax with placeholder values
#
# resp = client.update_base_path_mapping({
# domain_name: "String", # required
# base_path: "String", # required
# patch_operations: [
# {
# op: "add", # accepts add, remove, replace, move, copy, test
# path: "String",
# value: "String",
# from: "String",
# },
# ],
# })
#
# @example Response structure
#
# resp.base_path #=> String
# resp.rest_api_id #=> String
# resp.stage #=> String
#
# @overload update_base_path_mapping(params = {})
# @param [Hash] params ({})
def update_base_path_mapping(params = {}, options = {})
req = build_request(:update_base_path_mapping, params)
req.send_request(options)
end
# Changes information about an ClientCertificate resource.
#
# @option params [required, String] :client_certificate_id
# \[Required\] The identifier of the ClientCertificate resource to be
# updated.
#
# @option params [Array] :patch_operations
# A list of update operations to be applied to the specified resource
# and in the order specified in this list.
#
# @return [Types::ClientCertificate] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::ClientCertificate#client_certificate_id #client_certificate_id} => String
# * {Types::ClientCertificate#description #description} => String
# * {Types::ClientCertificate#pem_encoded_certificate #pem_encoded_certificate} => String
# * {Types::ClientCertificate#created_date #created_date} => Time
# * {Types::ClientCertificate#expiration_date #expiration_date} => Time
# * {Types::ClientCertificate#tags #tags} => Hash<String,String>
#
# @example Request syntax with placeholder values
#
# resp = client.update_client_certificate({
# client_certificate_id: "String", # required
# patch_operations: [
# {
# op: "add", # accepts add, remove, replace, move, copy, test
# path: "String",
# value: "String",
# from: "String",
# },
# ],
# })
#
# @example Response structure
#
# resp.client_certificate_id #=> String
# resp.description #=> String
# resp.pem_encoded_certificate #=> String
# resp.created_date #=> Time
# resp.expiration_date #=> Time
# resp.tags #=> Hash
# resp.tags["String"] #=> String
#
# @overload update_client_certificate(params = {})
# @param [Hash] params ({})
def update_client_certificate(params = {}, options = {})
req = build_request(:update_client_certificate, params)
req.send_request(options)
end
# Changes information about a Deployment resource.
#
# @option params [required, String] :rest_api_id
# \[Required\] The string identifier of the associated RestApi.
#
# @option params [required, String] :deployment_id
# The replacement identifier for the Deployment resource to change
# information about.
#
# @option params [Array] :patch_operations
# A list of update operations to be applied to the specified resource
# and in the order specified in this list.
#
# @return [Types::Deployment] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::Deployment#id #id} => String
# * {Types::Deployment#description #description} => String
# * {Types::Deployment#created_date #created_date} => Time
# * {Types::Deployment#api_summary #api_summary} => Hash<String,Hash<String,Types::MethodSnapshot>>
#
# @example Request syntax with placeholder values
#
# resp = client.update_deployment({
# rest_api_id: "String", # required
# deployment_id: "String", # required
# patch_operations: [
# {
# op: "add", # accepts add, remove, replace, move, copy, test
# path: "String",
# value: "String",
# from: "String",
# },
# ],
# })
#
# @example Response structure
#
# resp.id #=> String
# resp.description #=> String
# resp.created_date #=> Time
# resp.api_summary #=> Hash
# resp.api_summary["String"] #=> Hash
# resp.api_summary["String"]["String"].authorization_type #=> String
# resp.api_summary["String"]["String"].api_key_required #=> Boolean
#
# @overload update_deployment(params = {})
# @param [Hash] params ({})
def update_deployment(params = {}, options = {})
req = build_request(:update_deployment, params)
req.send_request(options)
end
# @option params [required, String] :rest_api_id
# \[Required\] The string identifier of the associated RestApi.
#
# @option params [required, String] :documentation_part_id
# \[Required\] The identifier of the to-be-updated documentation part.
#
# @option params [Array] :patch_operations
# A list of update operations to be applied to the specified resource
# and in the order specified in this list.
#
# @return [Types::DocumentationPart] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::DocumentationPart#id #id} => String
# * {Types::DocumentationPart#location #location} => Types::DocumentationPartLocation
# * {Types::DocumentationPart#properties #properties} => String
#
# @example Request syntax with placeholder values
#
# resp = client.update_documentation_part({
# rest_api_id: "String", # required
# documentation_part_id: "String", # required
# patch_operations: [
# {
# op: "add", # accepts add, remove, replace, move, copy, test
# path: "String",
# value: "String",
# from: "String",
# },
# ],
# })
#
# @example Response structure
#
# resp.id #=> String
# resp.location.type #=> String, one of "API", "AUTHORIZER", "MODEL", "RESOURCE", "METHOD", "PATH_PARAMETER", "QUERY_PARAMETER", "REQUEST_HEADER", "REQUEST_BODY", "RESPONSE", "RESPONSE_HEADER", "RESPONSE_BODY"
# resp.location.path #=> String
# resp.location.method #=> String
# resp.location.status_code #=> String
# resp.location.name #=> String
# resp.properties #=> String
#
# @overload update_documentation_part(params = {})
# @param [Hash] params ({})
def update_documentation_part(params = {}, options = {})
req = build_request(:update_documentation_part, params)
req.send_request(options)
end
# @option params [required, String] :rest_api_id
# \[Required\] The string identifier of the associated RestApi..
#
# @option params [required, String] :documentation_version
# \[Required\] The version identifier of the to-be-updated documentation
# version.
#
# @option params [Array] :patch_operations
# A list of update operations to be applied to the specified resource
# and in the order specified in this list.
#
# @return [Types::DocumentationVersion] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::DocumentationVersion#version #version} => String
# * {Types::DocumentationVersion#created_date #created_date} => Time
# * {Types::DocumentationVersion#description #description} => String
#
# @example Request syntax with placeholder values
#
# resp = client.update_documentation_version({
# rest_api_id: "String", # required
# documentation_version: "String", # required
# patch_operations: [
# {
# op: "add", # accepts add, remove, replace, move, copy, test
# path: "String",
# value: "String",
# from: "String",
# },
# ],
# })
#
# @example Response structure
#
# resp.version #=> String
# resp.created_date #=> Time
# resp.description #=> String
#
# @overload update_documentation_version(params = {})
# @param [Hash] params ({})
def update_documentation_version(params = {}, options = {})
req = build_request(:update_documentation_version, params)
req.send_request(options)
end
# Changes information about the DomainName resource.
#
# @option params [required, String] :domain_name
# \[Required\] The name of the DomainName resource to be changed.
#
# @option params [Array] :patch_operations
# A list of update operations to be applied to the specified resource
# and in the order specified in this list.
#
# @return [Types::DomainName] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::DomainName#domain_name #domain_name} => String
# * {Types::DomainName#certificate_name #certificate_name} => String
# * {Types::DomainName#certificate_arn #certificate_arn} => String
# * {Types::DomainName#certificate_upload_date #certificate_upload_date} => Time
# * {Types::DomainName#regional_domain_name #regional_domain_name} => String
# * {Types::DomainName#regional_hosted_zone_id #regional_hosted_zone_id} => String
# * {Types::DomainName#regional_certificate_name #regional_certificate_name} => String
# * {Types::DomainName#regional_certificate_arn #regional_certificate_arn} => String
# * {Types::DomainName#distribution_domain_name #distribution_domain_name} => String
# * {Types::DomainName#distribution_hosted_zone_id #distribution_hosted_zone_id} => String
# * {Types::DomainName#endpoint_configuration #endpoint_configuration} => Types::EndpointConfiguration
# * {Types::DomainName#domain_name_status #domain_name_status} => String
# * {Types::DomainName#domain_name_status_message #domain_name_status_message} => String
# * {Types::DomainName#security_policy #security_policy} => String
# * {Types::DomainName#tags #tags} => Hash<String,String>
#
# @example Request syntax with placeholder values
#
# resp = client.update_domain_name({
# domain_name: "String", # required
# patch_operations: [
# {
# op: "add", # accepts add, remove, replace, move, copy, test
# path: "String",
# value: "String",
# from: "String",
# },
# ],
# })
#
# @example Response structure
#
# resp.domain_name #=> String
# resp.certificate_name #=> String
# resp.certificate_arn #=> String
# resp.certificate_upload_date #=> Time
# resp.regional_domain_name #=> String
# resp.regional_hosted_zone_id #=> String
# resp.regional_certificate_name #=> String
# resp.regional_certificate_arn #=> String
# resp.distribution_domain_name #=> String
# resp.distribution_hosted_zone_id #=> String
# resp.endpoint_configuration.types #=> Array
# resp.endpoint_configuration.types[0] #=> String, one of "REGIONAL", "EDGE", "PRIVATE"
# resp.endpoint_configuration.vpc_endpoint_ids #=> Array
# resp.endpoint_configuration.vpc_endpoint_ids[0] #=> String
# resp.domain_name_status #=> String, one of "AVAILABLE", "UPDATING", "PENDING"
# resp.domain_name_status_message #=> String
# resp.security_policy #=> String, one of "TLS_1_0", "TLS_1_2"
# resp.tags #=> Hash
# resp.tags["String"] #=> String
#
# @overload update_domain_name(params = {})
# @param [Hash] params ({})
def update_domain_name(params = {}, options = {})
req = build_request(:update_domain_name, params)
req.send_request(options)
end
# Updates a GatewayResponse of a specified response type on the given
# RestApi.
#
# @option params [required, String] :rest_api_id
# \[Required\] The string identifier of the associated RestApi.
#
# @option params [required, String] :response_type
# \[Required\] The response type of the associated GatewayResponse.
# Valid values are
# * ACCESS\_DENIED
# * API\_CONFIGURATION\_ERROR
# * AUTHORIZER\_FAILURE
# * AUTHORIZER\_CONFIGURATION\_ERROR
# * BAD\_REQUEST\_PARAMETERS
# * BAD\_REQUEST\_BODY
# * DEFAULT\_4XX
# * DEFAULT\_5XX
# * EXPIRED\_TOKEN
# * INVALID\_SIGNATURE
# * INTEGRATION\_FAILURE
# * INTEGRATION\_TIMEOUT
# * INVALID\_API\_KEY
# * MISSING\_AUTHENTICATION\_TOKEN
# * QUOTA\_EXCEEDED
# * REQUEST\_TOO\_LARGE
# * RESOURCE\_NOT\_FOUND
# * THROTTLED
# * UNAUTHORIZED
# * UNSUPPORTED\_MEDIA\_TYPE
#
# @option params [Array] :patch_operations
# A list of update operations to be applied to the specified resource
# and in the order specified in this list.
#
# @return [Types::GatewayResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GatewayResponse#response_type #response_type} => String
# * {Types::GatewayResponse#status_code #status_code} => String
# * {Types::GatewayResponse#response_parameters #response_parameters} => Hash<String,String>
# * {Types::GatewayResponse#response_templates #response_templates} => Hash<String,String>
# * {Types::GatewayResponse#default_response #default_response} => Boolean
#
# @example Request syntax with placeholder values
#
# resp = client.update_gateway_response({
# rest_api_id: "String", # required
# response_type: "DEFAULT_4XX", # required, accepts DEFAULT_4XX, DEFAULT_5XX, RESOURCE_NOT_FOUND, UNAUTHORIZED, INVALID_API_KEY, ACCESS_DENIED, AUTHORIZER_FAILURE, AUTHORIZER_CONFIGURATION_ERROR, INVALID_SIGNATURE, EXPIRED_TOKEN, MISSING_AUTHENTICATION_TOKEN, INTEGRATION_FAILURE, INTEGRATION_TIMEOUT, API_CONFIGURATION_ERROR, UNSUPPORTED_MEDIA_TYPE, BAD_REQUEST_PARAMETERS, BAD_REQUEST_BODY, REQUEST_TOO_LARGE, THROTTLED, QUOTA_EXCEEDED
# patch_operations: [
# {
# op: "add", # accepts add, remove, replace, move, copy, test
# path: "String",
# value: "String",
# from: "String",
# },
# ],
# })
#
# @example Response structure
#
# resp.response_type #=> String, one of "DEFAULT_4XX", "DEFAULT_5XX", "RESOURCE_NOT_FOUND", "UNAUTHORIZED", "INVALID_API_KEY", "ACCESS_DENIED", "AUTHORIZER_FAILURE", "AUTHORIZER_CONFIGURATION_ERROR", "INVALID_SIGNATURE", "EXPIRED_TOKEN", "MISSING_AUTHENTICATION_TOKEN", "INTEGRATION_FAILURE", "INTEGRATION_TIMEOUT", "API_CONFIGURATION_ERROR", "UNSUPPORTED_MEDIA_TYPE", "BAD_REQUEST_PARAMETERS", "BAD_REQUEST_BODY", "REQUEST_TOO_LARGE", "THROTTLED", "QUOTA_EXCEEDED"
# resp.status_code #=> String
# resp.response_parameters #=> Hash
# resp.response_parameters["String"] #=> String
# resp.response_templates #=> Hash
# resp.response_templates["String"] #=> String
# resp.default_response #=> Boolean
#
# @overload update_gateway_response(params = {})
# @param [Hash] params ({})
def update_gateway_response(params = {}, options = {})
req = build_request(:update_gateway_response, params)
req.send_request(options)
end
# Represents an update integration.
#
# @option params [required, String] :rest_api_id
# \[Required\] The string identifier of the associated RestApi.
#
# @option params [required, String] :resource_id
# \[Required\] Represents an update integration request's resource
# identifier.
#
# @option params [required, String] :http_method
# \[Required\] Represents an update integration request's HTTP method.
#
# @option params [Array] :patch_operations
# A list of update operations to be applied to the specified resource
# and in the order specified in this list.
#
# @return [Types::Integration] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::Integration#type #type} => String
# * {Types::Integration#http_method #http_method} => String
# * {Types::Integration#uri #uri} => String
# * {Types::Integration#connection_type #connection_type} => String
# * {Types::Integration#connection_id #connection_id} => String
# * {Types::Integration#credentials #credentials} => String
# * {Types::Integration#request_parameters #request_parameters} => Hash<String,String>
# * {Types::Integration#request_templates #request_templates} => Hash<String,String>
# * {Types::Integration#passthrough_behavior #passthrough_behavior} => String
# * {Types::Integration#content_handling #content_handling} => String
# * {Types::Integration#timeout_in_millis #timeout_in_millis} => Integer
# * {Types::Integration#cache_namespace #cache_namespace} => String
# * {Types::Integration#cache_key_parameters #cache_key_parameters} => Array<String>
# * {Types::Integration#integration_responses #integration_responses} => Hash<String,Types::IntegrationResponse>
# * {Types::Integration#tls_config #tls_config} => Types::TlsConfig
#
# @example Request syntax with placeholder values
#
# resp = client.update_integration({
# rest_api_id: "String", # required
# resource_id: "String", # required
# http_method: "String", # required
# patch_operations: [
# {
# op: "add", # accepts add, remove, replace, move, copy, test
# path: "String",
# value: "String",
# from: "String",
# },
# ],
# })
#
# @example Response structure
#
# resp.type #=> String, one of "HTTP", "AWS", "MOCK", "HTTP_PROXY", "AWS_PROXY"
# resp.http_method #=> String
# resp.uri #=> String
# resp.connection_type #=> String, one of "INTERNET", "VPC_LINK"
# resp.connection_id #=> String
# resp.credentials #=> String
# resp.request_parameters #=> Hash
# resp.request_parameters["String"] #=> String
# resp.request_templates #=> Hash
# resp.request_templates["String"] #=> String
# resp.passthrough_behavior #=> String
# resp.content_handling #=> String, one of "CONVERT_TO_BINARY", "CONVERT_TO_TEXT"
# resp.timeout_in_millis #=> Integer
# resp.cache_namespace #=> String
# resp.cache_key_parameters #=> Array
# resp.cache_key_parameters[0] #=> String
# resp.integration_responses #=> Hash
# resp.integration_responses["String"].status_code #=> String
# resp.integration_responses["String"].selection_pattern #=> String
# resp.integration_responses["String"].response_parameters #=> Hash
# resp.integration_responses["String"].response_parameters["String"] #=> String
# resp.integration_responses["String"].response_templates #=> Hash
# resp.integration_responses["String"].response_templates["String"] #=> String
# resp.integration_responses["String"].content_handling #=> String, one of "CONVERT_TO_BINARY", "CONVERT_TO_TEXT"
# resp.tls_config.insecure_skip_verification #=> Boolean
#
# @overload update_integration(params = {})
# @param [Hash] params ({})
def update_integration(params = {}, options = {})
req = build_request(:update_integration, params)
req.send_request(options)
end
# Represents an update integration response.
#
# @option params [required, String] :rest_api_id
# \[Required\] The string identifier of the associated RestApi.
#
# @option params [required, String] :resource_id
# \[Required\] Specifies an update integration response request's
# resource identifier.
#
# @option params [required, String] :http_method
# \[Required\] Specifies an update integration response request's HTTP
# method.
#
# @option params [required, String] :status_code
# \[Required\] Specifies an update integration response request's
# status code.
#
# @option params [Array] :patch_operations
# A list of update operations to be applied to the specified resource
# and in the order specified in this list.
#
# @return [Types::IntegrationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::IntegrationResponse#status_code #status_code} => String
# * {Types::IntegrationResponse#selection_pattern #selection_pattern} => String
# * {Types::IntegrationResponse#response_parameters #response_parameters} => Hash<String,String>
# * {Types::IntegrationResponse#response_templates #response_templates} => Hash<String,String>
# * {Types::IntegrationResponse#content_handling #content_handling} => String
#
# @example Request syntax with placeholder values
#
# resp = client.update_integration_response({
# rest_api_id: "String", # required
# resource_id: "String", # required
# http_method: "String", # required
# status_code: "StatusCode", # required
# patch_operations: [
# {
# op: "add", # accepts add, remove, replace, move, copy, test
# path: "String",
# value: "String",
# from: "String",
# },
# ],
# })
#
# @example Response structure
#
# resp.status_code #=> String
# resp.selection_pattern #=> String
# resp.response_parameters #=> Hash
# resp.response_parameters["String"] #=> String
# resp.response_templates #=> Hash
# resp.response_templates["String"] #=> String
# resp.content_handling #=> String, one of "CONVERT_TO_BINARY", "CONVERT_TO_TEXT"
#
# @overload update_integration_response(params = {})
# @param [Hash] params ({})
def update_integration_response(params = {}, options = {})
req = build_request(:update_integration_response, params)
req.send_request(options)
end
# Updates an existing Method resource.
#
# @option params [required, String] :rest_api_id
# \[Required\] The string identifier of the associated RestApi.
#
# @option params [required, String] :resource_id
# \[Required\] The Resource identifier for the Method resource.
#
# @option params [required, String] :http_method
# \[Required\] The HTTP verb of the Method resource.
#
# @option params [Array] :patch_operations
# A list of update operations to be applied to the specified resource
# and in the order specified in this list.
#
# @return [Types::Method] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::Method#http_method #http_method} => String
# * {Types::Method#authorization_type #authorization_type} => String
# * {Types::Method#authorizer_id #authorizer_id} => String
# * {Types::Method#api_key_required #api_key_required} => Boolean
# * {Types::Method#request_validator_id #request_validator_id} => String
# * {Types::Method#operation_name #operation_name} => String
# * {Types::Method#request_parameters #request_parameters} => Hash<String,Boolean>
# * {Types::Method#request_models #request_models} => Hash<String,String>
# * {Types::Method#method_responses #method_responses} => Hash<String,Types::MethodResponse>
# * {Types::Method#method_integration #method_integration} => Types::Integration
# * {Types::Method#authorization_scopes #authorization_scopes} => Array<String>
#
# @example Request syntax with placeholder values
#
# resp = client.update_method({
# rest_api_id: "String", # required
# resource_id: "String", # required
# http_method: "String", # required
# patch_operations: [
# {
# op: "add", # accepts add, remove, replace, move, copy, test
# path: "String",
# value: "String",
# from: "String",
# },
# ],
# })
#
# @example Response structure
#
# resp.http_method #=> String
# resp.authorization_type #=> String
# resp.authorizer_id #=> String
# resp.api_key_required #=> Boolean
# resp.request_validator_id #=> String
# resp.operation_name #=> String
# resp.request_parameters #=> Hash
# resp.request_parameters["String"] #=> Boolean
# resp.request_models #=> Hash
# resp.request_models["String"] #=> String
# resp.method_responses #=> Hash
# resp.method_responses["String"].status_code #=> String
# resp.method_responses["String"].response_parameters #=> Hash
# resp.method_responses["String"].response_parameters["String"] #=> Boolean
# resp.method_responses["String"].response_models #=> Hash
# resp.method_responses["String"].response_models["String"] #=> String
# resp.method_integration.type #=> String, one of "HTTP", "AWS", "MOCK", "HTTP_PROXY", "AWS_PROXY"
# resp.method_integration.http_method #=> String
# resp.method_integration.uri #=> String
# resp.method_integration.connection_type #=> String, one of "INTERNET", "VPC_LINK"
# resp.method_integration.connection_id #=> String
# resp.method_integration.credentials #=> String
# resp.method_integration.request_parameters #=> Hash
# resp.method_integration.request_parameters["String"] #=> String
# resp.method_integration.request_templates #=> Hash
# resp.method_integration.request_templates["String"] #=> String
# resp.method_integration.passthrough_behavior #=> String
# resp.method_integration.content_handling #=> String, one of "CONVERT_TO_BINARY", "CONVERT_TO_TEXT"
# resp.method_integration.timeout_in_millis #=> Integer
# resp.method_integration.cache_namespace #=> String
# resp.method_integration.cache_key_parameters #=> Array
# resp.method_integration.cache_key_parameters[0] #=> String
# resp.method_integration.integration_responses #=> Hash
# resp.method_integration.integration_responses["String"].status_code #=> String
# resp.method_integration.integration_responses["String"].selection_pattern #=> String
# resp.method_integration.integration_responses["String"].response_parameters #=> Hash
# resp.method_integration.integration_responses["String"].response_parameters["String"] #=> String
# resp.method_integration.integration_responses["String"].response_templates #=> Hash
# resp.method_integration.integration_responses["String"].response_templates["String"] #=> String
# resp.method_integration.integration_responses["String"].content_handling #=> String, one of "CONVERT_TO_BINARY", "CONVERT_TO_TEXT"
# resp.method_integration.tls_config.insecure_skip_verification #=> Boolean
# resp.authorization_scopes #=> Array
# resp.authorization_scopes[0] #=> String
#
# @overload update_method(params = {})
# @param [Hash] params ({})
def update_method(params = {}, options = {})
req = build_request(:update_method, params)
req.send_request(options)
end
# Updates an existing MethodResponse resource.
#
# @option params [required, String] :rest_api_id
# \[Required\] The string identifier of the associated RestApi.
#
# @option params [required, String] :resource_id
# \[Required\] The Resource identifier for the MethodResponse resource.
#
# @option params [required, String] :http_method
# \[Required\] The HTTP verb of the Method resource.
#
# @option params [required, String] :status_code
# \[Required\] The status code for the MethodResponse resource.
#
# @option params [Array] :patch_operations
# A list of update operations to be applied to the specified resource
# and in the order specified in this list.
#
# @return [Types::MethodResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::MethodResponse#status_code #status_code} => String
# * {Types::MethodResponse#response_parameters #response_parameters} => Hash<String,Boolean>
# * {Types::MethodResponse#response_models #response_models} => Hash<String,String>
#
# @example Request syntax with placeholder values
#
# resp = client.update_method_response({
# rest_api_id: "String", # required
# resource_id: "String", # required
# http_method: "String", # required
# status_code: "StatusCode", # required
# patch_operations: [
# {
# op: "add", # accepts add, remove, replace, move, copy, test
# path: "String",
# value: "String",
# from: "String",
# },
# ],
# })
#
# @example Response structure
#
# resp.status_code #=> String
# resp.response_parameters #=> Hash
# resp.response_parameters["String"] #=> Boolean
# resp.response_models #=> Hash
# resp.response_models["String"] #=> String
#
# @overload update_method_response(params = {})
# @param [Hash] params ({})
def update_method_response(params = {}, options = {})
req = build_request(:update_method_response, params)
req.send_request(options)
end
# Changes information about a model.
#
# @option params [required, String] :rest_api_id
# \[Required\] The string identifier of the associated RestApi.
#
# @option params [required, String] :model_name
# \[Required\] The name of the model to update.
#
# @option params [Array] :patch_operations
# A list of update operations to be applied to the specified resource
# and in the order specified in this list.
#
# @return [Types::Model] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::Model#id #id} => String
# * {Types::Model#name #name} => String
# * {Types::Model#description #description} => String
# * {Types::Model#schema #schema} => String
# * {Types::Model#content_type #content_type} => String
#
# @example Request syntax with placeholder values
#
# resp = client.update_model({
# rest_api_id: "String", # required
# model_name: "String", # required
# patch_operations: [
# {
# op: "add", # accepts add, remove, replace, move, copy, test
# path: "String",
# value: "String",
# from: "String",
# },
# ],
# })
#
# @example Response structure
#
# resp.id #=> String
# resp.name #=> String
# resp.description #=> String
# resp.schema #=> String
# resp.content_type #=> String
#
# @overload update_model(params = {})
# @param [Hash] params ({})
def update_model(params = {}, options = {})
req = build_request(:update_model, params)
req.send_request(options)
end
# Updates a RequestValidator of a given RestApi.
#
# @option params [required, String] :rest_api_id
# \[Required\] The string identifier of the associated RestApi.
#
# @option params [required, String] :request_validator_id
# \[Required\] The identifier of RequestValidator to be updated.
#
# @option params [Array] :patch_operations
# A list of update operations to be applied to the specified resource
# and in the order specified in this list.
#
# @return [Types::RequestValidator] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::RequestValidator#id #id} => String
# * {Types::RequestValidator#name #name} => String
# * {Types::RequestValidator#validate_request_body #validate_request_body} => Boolean
# * {Types::RequestValidator#validate_request_parameters #validate_request_parameters} => Boolean
#
# @example Request syntax with placeholder values
#
# resp = client.update_request_validator({
# rest_api_id: "String", # required
# request_validator_id: "String", # required
# patch_operations: [
# {
# op: "add", # accepts add, remove, replace, move, copy, test
# path: "String",
# value: "String",
# from: "String",
# },
# ],
# })
#
# @example Response structure
#
# resp.id #=> String
# resp.name #=> String
# resp.validate_request_body #=> Boolean
# resp.validate_request_parameters #=> Boolean
#
# @overload update_request_validator(params = {})
# @param [Hash] params ({})
def update_request_validator(params = {}, options = {})
req = build_request(:update_request_validator, params)
req.send_request(options)
end
# Changes information about a Resource resource.
#
# @option params [required, String] :rest_api_id
# \[Required\] The string identifier of the associated RestApi.
#
# @option params [required, String] :resource_id
# \[Required\] The identifier of the Resource resource.
#
# @option params [Array] :patch_operations
# A list of update operations to be applied to the specified resource
# and in the order specified in this list.
#
# @return [Types::Resource] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::Resource#id #id} => String
# * {Types::Resource#parent_id #parent_id} => String
# * {Types::Resource#path_part #path_part} => String
# * {Types::Resource#path #path} => String
# * {Types::Resource#resource_methods #resource_methods} => Hash<String,Types::Method>
#
# @example Request syntax with placeholder values
#
# resp = client.update_resource({
# rest_api_id: "String", # required
# resource_id: "String", # required
# patch_operations: [
# {
# op: "add", # accepts add, remove, replace, move, copy, test
# path: "String",
# value: "String",
# from: "String",
# },
# ],
# })
#
# @example Response structure
#
# resp.id #=> String
# resp.parent_id #=> String
# resp.path_part #=> String
# resp.path #=> String
# resp.resource_methods #=> Hash
# resp.resource_methods["String"].http_method #=> String
# resp.resource_methods["String"].authorization_type #=> String
# resp.resource_methods["String"].authorizer_id #=> String
# resp.resource_methods["String"].api_key_required #=> Boolean
# resp.resource_methods["String"].request_validator_id #=> String
# resp.resource_methods["String"].operation_name #=> String
# resp.resource_methods["String"].request_parameters #=> Hash
# resp.resource_methods["String"].request_parameters["String"] #=> Boolean
# resp.resource_methods["String"].request_models #=> Hash
# resp.resource_methods["String"].request_models["String"] #=> String
# resp.resource_methods["String"].method_responses #=> Hash
# resp.resource_methods["String"].method_responses["String"].status_code #=> String
# resp.resource_methods["String"].method_responses["String"].response_parameters #=> Hash
# resp.resource_methods["String"].method_responses["String"].response_parameters["String"] #=> Boolean
# resp.resource_methods["String"].method_responses["String"].response_models #=> Hash
# resp.resource_methods["String"].method_responses["String"].response_models["String"] #=> String
# resp.resource_methods["String"].method_integration.type #=> String, one of "HTTP", "AWS", "MOCK", "HTTP_PROXY", "AWS_PROXY"
# resp.resource_methods["String"].method_integration.http_method #=> String
# resp.resource_methods["String"].method_integration.uri #=> String
# resp.resource_methods["String"].method_integration.connection_type #=> String, one of "INTERNET", "VPC_LINK"
# resp.resource_methods["String"].method_integration.connection_id #=> String
# resp.resource_methods["String"].method_integration.credentials #=> String
# resp.resource_methods["String"].method_integration.request_parameters #=> Hash
# resp.resource_methods["String"].method_integration.request_parameters["String"] #=> String
# resp.resource_methods["String"].method_integration.request_templates #=> Hash
# resp.resource_methods["String"].method_integration.request_templates["String"] #=> String
# resp.resource_methods["String"].method_integration.passthrough_behavior #=> String
# resp.resource_methods["String"].method_integration.content_handling #=> String, one of "CONVERT_TO_BINARY", "CONVERT_TO_TEXT"
# resp.resource_methods["String"].method_integration.timeout_in_millis #=> Integer
# resp.resource_methods["String"].method_integration.cache_namespace #=> String
# resp.resource_methods["String"].method_integration.cache_key_parameters #=> Array
# resp.resource_methods["String"].method_integration.cache_key_parameters[0] #=> String
# resp.resource_methods["String"].method_integration.integration_responses #=> Hash
# resp.resource_methods["String"].method_integration.integration_responses["String"].status_code #=> String
# resp.resource_methods["String"].method_integration.integration_responses["String"].selection_pattern #=> String
# resp.resource_methods["String"].method_integration.integration_responses["String"].response_parameters #=> Hash
# resp.resource_methods["String"].method_integration.integration_responses["String"].response_parameters["String"] #=> String
# resp.resource_methods["String"].method_integration.integration_responses["String"].response_templates #=> Hash
# resp.resource_methods["String"].method_integration.integration_responses["String"].response_templates["String"] #=> String
# resp.resource_methods["String"].method_integration.integration_responses["String"].content_handling #=> String, one of "CONVERT_TO_BINARY", "CONVERT_TO_TEXT"
# resp.resource_methods["String"].method_integration.tls_config.insecure_skip_verification #=> Boolean
# resp.resource_methods["String"].authorization_scopes #=> Array
# resp.resource_methods["String"].authorization_scopes[0] #=> String
#
# @overload update_resource(params = {})
# @param [Hash] params ({})
def update_resource(params = {}, options = {})
req = build_request(:update_resource, params)
req.send_request(options)
end
# Changes information about the specified API.
#
# @option params [required, String] :rest_api_id
# \[Required\] The string identifier of the associated RestApi.
#
# @option params [Array] :patch_operations
# A list of update operations to be applied to the specified resource
# and in the order specified in this list.
#
# @return [Types::RestApi] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::RestApi#id #id} => String
# * {Types::RestApi#name #name} => String
# * {Types::RestApi#description #description} => String
# * {Types::RestApi#created_date #created_date} => Time
# * {Types::RestApi#version #version} => String
# * {Types::RestApi#warnings #warnings} => Array<String>
# * {Types::RestApi#binary_media_types #binary_media_types} => Array<String>
# * {Types::RestApi#minimum_compression_size #minimum_compression_size} => Integer
# * {Types::RestApi#api_key_source #api_key_source} => String
# * {Types::RestApi#endpoint_configuration #endpoint_configuration} => Types::EndpointConfiguration
# * {Types::RestApi#policy #policy} => String
# * {Types::RestApi#tags #tags} => Hash<String,String>
#
# @example Request syntax with placeholder values
#
# resp = client.update_rest_api({
# rest_api_id: "String", # required
# patch_operations: [
# {
# op: "add", # accepts add, remove, replace, move, copy, test
# path: "String",
# value: "String",
# from: "String",
# },
# ],
# })
#
# @example Response structure
#
# resp.id #=> String
# resp.name #=> String
# resp.description #=> String
# resp.created_date #=> Time
# resp.version #=> String
# resp.warnings #=> Array
# resp.warnings[0] #=> String
# resp.binary_media_types #=> Array
# resp.binary_media_types[0] #=> String
# resp.minimum_compression_size #=> Integer
# resp.api_key_source #=> String, one of "HEADER", "AUTHORIZER"
# resp.endpoint_configuration.types #=> Array
# resp.endpoint_configuration.types[0] #=> String, one of "REGIONAL", "EDGE", "PRIVATE"
# resp.endpoint_configuration.vpc_endpoint_ids #=> Array
# resp.endpoint_configuration.vpc_endpoint_ids[0] #=> String
# resp.policy #=> String
# resp.tags #=> Hash
# resp.tags["String"] #=> String
#
# @overload update_rest_api(params = {})
# @param [Hash] params ({})
def update_rest_api(params = {}, options = {})
req = build_request(:update_rest_api, params)
req.send_request(options)
end
# Changes information about a Stage resource.
#
# @option params [required, String] :rest_api_id
# \[Required\] The string identifier of the associated RestApi.
#
# @option params [required, String] :stage_name
# \[Required\] The name of the Stage resource to change information
# about.
#
# @option params [Array] :patch_operations
# A list of update operations to be applied to the specified resource
# and in the order specified in this list.
#
# @return [Types::Stage] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::Stage#deployment_id #deployment_id} => String
# * {Types::Stage#client_certificate_id #client_certificate_id} => String
# * {Types::Stage#stage_name #stage_name} => String
# * {Types::Stage#description #description} => String
# * {Types::Stage#cache_cluster_enabled #cache_cluster_enabled} => Boolean
# * {Types::Stage#cache_cluster_size #cache_cluster_size} => String
# * {Types::Stage#cache_cluster_status #cache_cluster_status} => String
# * {Types::Stage#method_settings #method_settings} => Hash<String,Types::MethodSetting>
# * {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#tracing_enabled #tracing_enabled} => Boolean
# * {Types::Stage#web_acl_arn #web_acl_arn} => String
# * {Types::Stage#tags #tags} => Hash<String,String>
# * {Types::Stage#created_date #created_date} => Time
# * {Types::Stage#last_updated_date #last_updated_date} => Time
#
# @example Request syntax with placeholder values
#
# resp = client.update_stage({
# rest_api_id: "String", # required
# stage_name: "String", # required
# patch_operations: [
# {
# op: "add", # accepts add, remove, replace, move, copy, test
# path: "String",
# value: "String",
# from: "String",
# },
# ],
# })
#
# @example Response structure
#
# resp.deployment_id #=> String
# resp.client_certificate_id #=> String
# resp.stage_name #=> String
# resp.description #=> String
# resp.cache_cluster_enabled #=> Boolean
# resp.cache_cluster_size #=> String, one of "0.5", "1.6", "6.1", "13.5", "28.4", "58.2", "118", "237"
# resp.cache_cluster_status #=> String, one of "CREATE_IN_PROGRESS", "AVAILABLE", "DELETE_IN_PROGRESS", "NOT_AVAILABLE", "FLUSH_IN_PROGRESS"
# resp.method_settings #=> Hash
# resp.method_settings["String"].metrics_enabled #=> Boolean
# resp.method_settings["String"].logging_level #=> String
# resp.method_settings["String"].data_trace_enabled #=> Boolean
# resp.method_settings["String"].throttling_burst_limit #=> Integer
# resp.method_settings["String"].throttling_rate_limit #=> Float
# resp.method_settings["String"].caching_enabled #=> Boolean
# resp.method_settings["String"].cache_ttl_in_seconds #=> Integer
# resp.method_settings["String"].cache_data_encrypted #=> Boolean
# resp.method_settings["String"].require_authorization_for_cache_control #=> Boolean
# resp.method_settings["String"].unauthorized_cache_control_header_strategy #=> String, one of "FAIL_WITH_403", "SUCCEED_WITH_RESPONSE_HEADER", "SUCCEED_WITHOUT_RESPONSE_HEADER"
# resp.variables #=> Hash
# resp.variables["String"] #=> String
# 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.tracing_enabled #=> Boolean
# resp.web_acl_arn #=> String
# resp.tags #=> Hash
# resp.tags["String"] #=> String
# resp.created_date #=> Time
# resp.last_updated_date #=> Time
#
# @overload update_stage(params = {})
# @param [Hash] params ({})
def update_stage(params = {}, options = {})
req = build_request(:update_stage, params)
req.send_request(options)
end
# Grants a temporary extension to the remaining quota of a usage plan
# associated with a specified API key.
#
# @option params [required, String] :usage_plan_id
# \[Required\] The Id of the usage plan associated with the usage data.
#
# @option params [required, String] :key_id
# \[Required\] The identifier of the API key associated with the usage
# plan in which a temporary extension is granted to the remaining quota.
#
# @option params [Array] :patch_operations
# A list of update operations to be applied to the specified resource
# and in the order specified in this list.
#
# @return [Types::Usage] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::Usage#usage_plan_id #usage_plan_id} => String
# * {Types::Usage#start_date #start_date} => String
# * {Types::Usage#end_date #end_date} => String
# * {Types::Usage#position #position} => String
# * {Types::Usage#items #items} => Hash<String,Array<Array<Integer>>>
#
# @example Request syntax with placeholder values
#
# resp = client.update_usage({
# usage_plan_id: "String", # required
# key_id: "String", # required
# patch_operations: [
# {
# op: "add", # accepts add, remove, replace, move, copy, test
# path: "String",
# value: "String",
# from: "String",
# },
# ],
# })
#
# @example Response structure
#
# resp.usage_plan_id #=> String
# resp.start_date #=> String
# resp.end_date #=> String
# resp.position #=> String
# resp.items #=> Hash
# resp.items["String"] #=> Array
# resp.items["String"][0] #=> Array
# resp.items["String"][0][0] #=> Integer
#
# @overload update_usage(params = {})
# @param [Hash] params ({})
def update_usage(params = {}, options = {})
req = build_request(:update_usage, params)
req.send_request(options)
end
# Updates a usage plan of a given plan Id.
#
# @option params [required, String] :usage_plan_id
# \[Required\] The Id of the to-be-updated usage plan.
#
# @option params [Array] :patch_operations
# A list of update operations to be applied to the specified resource
# and in the order specified in this list.
#
# @return [Types::UsagePlan] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::UsagePlan#id #id} => String
# * {Types::UsagePlan#name #name} => String
# * {Types::UsagePlan#description #description} => String
# * {Types::UsagePlan#api_stages #api_stages} => Array<Types::ApiStage>
# * {Types::UsagePlan#throttle #throttle} => Types::ThrottleSettings
# * {Types::UsagePlan#quota #quota} => Types::QuotaSettings
# * {Types::UsagePlan#product_code #product_code} => String
# * {Types::UsagePlan#tags #tags} => Hash<String,String>
#
# @example Request syntax with placeholder values
#
# resp = client.update_usage_plan({
# usage_plan_id: "String", # required
# patch_operations: [
# {
# op: "add", # accepts add, remove, replace, move, copy, test
# path: "String",
# value: "String",
# from: "String",
# },
# ],
# })
#
# @example Response structure
#
# resp.id #=> String
# resp.name #=> String
# resp.description #=> String
# resp.api_stages #=> Array
# resp.api_stages[0].api_id #=> String
# resp.api_stages[0].stage #=> String
# resp.api_stages[0].throttle #=> Hash
# resp.api_stages[0].throttle["String"].burst_limit #=> Integer
# resp.api_stages[0].throttle["String"].rate_limit #=> Float
# resp.throttle.burst_limit #=> Integer
# resp.throttle.rate_limit #=> Float
# resp.quota.limit #=> Integer
# resp.quota.offset #=> Integer
# resp.quota.period #=> String, one of "DAY", "WEEK", "MONTH"
# resp.product_code #=> String
# resp.tags #=> Hash
# resp.tags["String"] #=> String
#
# @overload update_usage_plan(params = {})
# @param [Hash] params ({})
def update_usage_plan(params = {}, options = {})
req = build_request(:update_usage_plan, params)
req.send_request(options)
end
# Updates an existing VpcLink of a specified identifier.
#
# @option params [required, String] :vpc_link_id
# \[Required\] The identifier of the VpcLink. It is used in an
# Integration to reference this VpcLink.
#
# @option params [Array] :patch_operations
# A list of update operations to be applied to the specified resource
# and in the order specified in this list.
#
# @return [Types::VpcLink] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::VpcLink#id #id} => String
# * {Types::VpcLink#name #name} => String
# * {Types::VpcLink#description #description} => String
# * {Types::VpcLink#target_arns #target_arns} => Array<String>
# * {Types::VpcLink#status #status} => String
# * {Types::VpcLink#status_message #status_message} => String
# * {Types::VpcLink#tags #tags} => Hash<String,String>
#
# @example Request syntax with placeholder values
#
# resp = client.update_vpc_link({
# vpc_link_id: "String", # required
# patch_operations: [
# {
# op: "add", # accepts add, remove, replace, move, copy, test
# path: "String",
# value: "String",
# from: "String",
# },
# ],
# })
#
# @example Response structure
#
# resp.id #=> String
# resp.name #=> String
# resp.description #=> String
# resp.target_arns #=> Array
# resp.target_arns[0] #=> String
# resp.status #=> String, one of "AVAILABLE", "PENDING", "DELETING", "FAILED"
# resp.status_message #=> String
# resp.tags #=> Hash
# resp.tags["String"] #=> String
#
# @overload update_vpc_link(params = {})
# @param [Hash] params ({})
def update_vpc_link(params = {}, options = {})
req = build_request(:update_vpc_link, params)
req.send_request(options)
end
# @!endgroup
# @param params ({})
# @api private
def build_request(operation_name, params = {})
handlers = @handlers.for(operation_name)
context = Seahorse::Client::RequestContext.new(
operation_name: operation_name,
operation: config.api.operation(operation_name),
client: self,
params: params,
config: config)
context[:gem_name] = 'aws-sdk-apigateway'
context[:gem_version] = '1.49.0'
Seahorse::Client::Request.new(handlers, context)
end
# @api private
# @deprecated
def waiter_names
[]
end
class << self
# @api private
attr_reader :identifier
# @api private
def errors_module
Errors
end
end
end
end