Class: Aws::APIGateway::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::APIGateway::Client
- Includes:
- ClientStubs
- Defined in:
- lib/aws-sdk-apigateway/client.rb
Overview
An API client for APIGateway. To construct a client, you need to configure a ‘:region` and `:credentials`.
client = Aws::APIGateway::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
See #initialize for a full list of supported configuration options.
Class Attribute Summary collapse
- .identifier ⇒ Object readonly private
API Operations collapse
-
#create_api_key(params = {}) ⇒ Types::ApiKey
Create an ApiKey resource.
-
#create_authorizer(params = {}) ⇒ Types::Authorizer
Adds a new Authorizer resource to an existing RestApi resource.
-
#create_base_path_mapping(params = {}) ⇒ Types::BasePathMapping
Creates a new BasePathMapping resource.
-
#create_deployment(params = {}) ⇒ Types::Deployment
Creates a Deployment resource, which makes a specified RestApi callable over the internet.
-
#create_documentation_part(params = {}) ⇒ Types::DocumentationPart
Creates a documentation part.
-
#create_documentation_version(params = {}) ⇒ Types::DocumentationVersion
Creates a documentation version.
-
#create_domain_name(params = {}) ⇒ Types::DomainName
Creates a new domain name.
-
#create_model(params = {}) ⇒ Types::Model
Adds a new Model resource to an existing RestApi resource.
-
#create_request_validator(params = {}) ⇒ Types::RequestValidator
Creates a RequestValidator of a given RestApi.
-
#create_resource(params = {}) ⇒ Types::Resource
Creates a Resource resource.
-
#create_rest_api(params = {}) ⇒ Types::RestApi
Creates a new RestApi resource.
-
#create_stage(params = {}) ⇒ Types::Stage
Creates a new Stage resource that references a pre-existing Deployment for the API.
-
#create_usage_plan(params = {}) ⇒ Types::UsagePlan
Creates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the payload.
-
#create_usage_plan_key(params = {}) ⇒ Types::UsagePlanKey
Creates a usage plan key for adding an existing API key to a usage plan.
-
#create_vpc_link(params = {}) ⇒ Types::VpcLink
Creates a VPC link, under the caller’s account in a selected region, in an asynchronous operation that typically takes 2-4 minutes to complete and become operational.
-
#delete_api_key(params = {}) ⇒ Struct
Deletes the ApiKey resource.
-
#delete_authorizer(params = {}) ⇒ Struct
Deletes an existing Authorizer resource.
-
#delete_base_path_mapping(params = {}) ⇒ Struct
Deletes the BasePathMapping resource.
-
#delete_client_certificate(params = {}) ⇒ Struct
Deletes the ClientCertificate resource.
-
#delete_deployment(params = {}) ⇒ Struct
Deletes a Deployment resource.
-
#delete_documentation_part(params = {}) ⇒ Struct
Deletes a documentation part.
-
#delete_documentation_version(params = {}) ⇒ Struct
Deletes a documentation version.
-
#delete_domain_name(params = {}) ⇒ Struct
Deletes the DomainName resource.
-
#delete_gateway_response(params = {}) ⇒ Struct
Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings.
-
#delete_integration(params = {}) ⇒ Struct
Represents a delete integration.
-
#delete_integration_response(params = {}) ⇒ Struct
Represents a delete integration response.
-
#delete_method(params = {}) ⇒ Struct
Deletes an existing Method resource.
-
#delete_method_response(params = {}) ⇒ Struct
Deletes an existing MethodResponse resource.
-
#delete_model(params = {}) ⇒ Struct
Deletes a model.
-
#delete_request_validator(params = {}) ⇒ Struct
Deletes a RequestValidator of a given RestApi.
-
#delete_resource(params = {}) ⇒ Struct
Deletes a Resource resource.
-
#delete_rest_api(params = {}) ⇒ Struct
Deletes the specified API.
-
#delete_stage(params = {}) ⇒ Struct
Deletes a Stage resource.
-
#delete_usage_plan(params = {}) ⇒ Struct
Deletes a usage plan of a given plan Id.
-
#delete_usage_plan_key(params = {}) ⇒ Struct
Deletes a usage plan key and remove the underlying API key from the associated usage plan.
-
#delete_vpc_link(params = {}) ⇒ Struct
Deletes an existing VpcLink of a specified identifier.
-
#flush_stage_authorizers_cache(params = {}) ⇒ Struct
Flushes all authorizer cache entries on a stage.
-
#flush_stage_cache(params = {}) ⇒ Struct
Flushes a stage’s cache.
-
#generate_client_certificate(params = {}) ⇒ Types::ClientCertificate
Generates a ClientCertificate resource.
-
#get_account(params = {}) ⇒ Types::Account
Gets information about the current Account resource.
-
#get_api_key(params = {}) ⇒ Types::ApiKey
Gets information about the current ApiKey resource.
-
#get_api_keys(params = {}) ⇒ Types::ApiKeys
Gets information about the current ApiKeys resource.
-
#get_authorizer(params = {}) ⇒ Types::Authorizer
Describe an existing Authorizer resource.
-
#get_authorizers(params = {}) ⇒ Types::Authorizers
Describe an existing Authorizers resource.
-
#get_base_path_mapping(params = {}) ⇒ Types::BasePathMapping
Describe a BasePathMapping resource.
-
#get_base_path_mappings(params = {}) ⇒ Types::BasePathMappings
Represents a collection of BasePathMapping resources.
-
#get_client_certificate(params = {}) ⇒ Types::ClientCertificate
Gets information about the current ClientCertificate resource.
-
#get_client_certificates(params = {}) ⇒ Types::ClientCertificates
Gets a collection of ClientCertificate resources.
-
#get_deployment(params = {}) ⇒ Types::Deployment
Gets information about a Deployment resource.
-
#get_deployments(params = {}) ⇒ Types::Deployments
Gets information about a Deployments collection.
-
#get_documentation_part(params = {}) ⇒ Types::DocumentationPart
Gets a documentation part.
-
#get_documentation_parts(params = {}) ⇒ Types::DocumentationParts
Gets documentation parts.
-
#get_documentation_version(params = {}) ⇒ Types::DocumentationVersion
Gets a documentation version.
-
#get_documentation_versions(params = {}) ⇒ Types::DocumentationVersions
Gets documentation versions.
-
#get_domain_name(params = {}) ⇒ Types::DomainName
Represents a domain name that is contained in a simpler, more intuitive URL that can be called.
-
#get_domain_names(params = {}) ⇒ Types::DomainNames
Represents a collection of DomainName resources.
-
#get_export(params = {}) ⇒ Types::ExportResponse
Exports a deployed version of a RestApi in a specified format.
-
#get_gateway_response(params = {}) ⇒ Types::GatewayResponse
Gets a GatewayResponse of a specified response type on the given RestApi.
-
#get_gateway_responses(params = {}) ⇒ Types::GatewayResponses
Gets the GatewayResponses collection on the given RestApi.
-
#get_integration(params = {}) ⇒ Types::Integration
Get the integration settings.
-
#get_integration_response(params = {}) ⇒ Types::IntegrationResponse
Represents a get integration response.
-
#get_method(params = {}) ⇒ Types::Method
Describe an existing Method resource.
-
#get_method_response(params = {}) ⇒ Types::MethodResponse
Describes a MethodResponse resource.
-
#get_model(params = {}) ⇒ Types::Model
Describes an existing model defined for a RestApi resource.
-
#get_model_template(params = {}) ⇒ Types::Template
Generates a sample mapping template that can be used to transform a payload into the structure of a model.
-
#get_models(params = {}) ⇒ Types::Models
Describes existing Models defined for a RestApi resource.
-
#get_request_validator(params = {}) ⇒ Types::RequestValidator
Gets a RequestValidator of a given RestApi.
-
#get_request_validators(params = {}) ⇒ Types::RequestValidators
Gets the RequestValidators collection of a given RestApi.
-
#get_resource(params = {}) ⇒ Types::Resource
Lists information about a resource.
-
#get_resources(params = {}) ⇒ Types::Resources
Lists information about a collection of Resource resources.
-
#get_rest_api(params = {}) ⇒ Types::RestApi
Lists the RestApi resource in the collection.
-
#get_rest_apis(params = {}) ⇒ Types::RestApis
Lists the RestApis resources for your collection.
-
#get_sdk(params = {}) ⇒ Types::SdkResponse
Generates a client SDK for a RestApi and Stage.
-
#get_sdk_type(params = {}) ⇒ Types::SdkType
Gets an SDK type.
-
#get_sdk_types(params = {}) ⇒ Types::SdkTypes
Gets SDK types.
-
#get_stage(params = {}) ⇒ Types::Stage
Gets information about a Stage resource.
-
#get_stages(params = {}) ⇒ Types::Stages
Gets information about one or more Stage resources.
-
#get_tags(params = {}) ⇒ Types::Tags
Gets the Tags collection for a given resource.
-
#get_usage(params = {}) ⇒ Types::Usage
Gets the usage data of a usage plan in a specified time interval.
-
#get_usage_plan(params = {}) ⇒ Types::UsagePlan
Gets a usage plan of a given plan identifier.
-
#get_usage_plan_key(params = {}) ⇒ Types::UsagePlanKey
Gets a usage plan key of a given key identifier.
-
#get_usage_plan_keys(params = {}) ⇒ Types::UsagePlanKeys
Gets all the usage plan keys representing the API keys added to a specified usage plan.
-
#get_usage_plans(params = {}) ⇒ Types::UsagePlans
Gets all the usage plans of the caller’s account.
-
#get_vpc_link(params = {}) ⇒ Types::VpcLink
Gets a specified VPC link under the caller’s account in a region.
-
#get_vpc_links(params = {}) ⇒ Types::VpcLinks
Gets the VpcLinks collection under the caller’s account in a selected region.
-
#import_api_keys(params = {}) ⇒ Types::ApiKeyIds
Import API keys from an external source, such as a CSV-formatted file.
-
#import_documentation_parts(params = {}) ⇒ Types::DocumentationPartIds
Imports documentation parts.
-
#import_rest_api(params = {}) ⇒ Types::RestApi
A feature of the API Gateway control service for creating a new API from an external API definition file.
-
#put_gateway_response(params = {}) ⇒ Types::GatewayResponse
Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.
-
#put_integration(params = {}) ⇒ Types::Integration
Sets up a method’s integration.
-
#put_integration_response(params = {}) ⇒ Types::IntegrationResponse
Represents a put integration.
-
#put_method(params = {}) ⇒ Types::Method
Add a method to an existing Resource resource.
-
#put_method_response(params = {}) ⇒ Types::MethodResponse
Adds a MethodResponse to an existing Method resource.
-
#put_rest_api(params = {}) ⇒ Types::RestApi
A feature of the API Gateway control service for updating an existing API with an input of external API definitions.
-
#tag_resource(params = {}) ⇒ Struct
Adds or updates a tag on a given resource.
-
#test_invoke_authorizer(params = {}) ⇒ Types::TestInvokeAuthorizerResponse
Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body.
-
#test_invoke_method(params = {}) ⇒ Types::TestInvokeMethodResponse
Simulate the invocation of a Method in your RestApi with headers, parameters, and an incoming request body.
-
#untag_resource(params = {}) ⇒ Struct
Removes a tag from a given resource.
-
#update_account(params = {}) ⇒ Types::Account
Changes information about the current Account resource.
-
#update_api_key(params = {}) ⇒ Types::ApiKey
Changes information about an ApiKey resource.
-
#update_authorizer(params = {}) ⇒ Types::Authorizer
Updates an existing Authorizer resource.
-
#update_base_path_mapping(params = {}) ⇒ Types::BasePathMapping
Changes information about the BasePathMapping resource.
-
#update_client_certificate(params = {}) ⇒ Types::ClientCertificate
Changes information about an ClientCertificate resource.
-
#update_deployment(params = {}) ⇒ Types::Deployment
Changes information about a Deployment resource.
-
#update_documentation_part(params = {}) ⇒ Types::DocumentationPart
Updates a documentation part.
-
#update_documentation_version(params = {}) ⇒ Types::DocumentationVersion
Updates a documentation version.
-
#update_domain_name(params = {}) ⇒ Types::DomainName
Changes information about the DomainName resource.
-
#update_gateway_response(params = {}) ⇒ Types::GatewayResponse
Updates a GatewayResponse of a specified response type on the given RestApi.
-
#update_integration(params = {}) ⇒ Types::Integration
Represents an update integration.
-
#update_integration_response(params = {}) ⇒ Types::IntegrationResponse
Represents an update integration response.
-
#update_method(params = {}) ⇒ Types::Method
Updates an existing Method resource.
-
#update_method_response(params = {}) ⇒ Types::MethodResponse
Updates an existing MethodResponse resource.
-
#update_model(params = {}) ⇒ Types::Model
Changes information about a model.
-
#update_request_validator(params = {}) ⇒ Types::RequestValidator
Updates a RequestValidator of a given RestApi.
-
#update_resource(params = {}) ⇒ Types::Resource
Changes information about a Resource resource.
-
#update_rest_api(params = {}) ⇒ Types::RestApi
Changes information about the specified API.
-
#update_stage(params = {}) ⇒ Types::Stage
Changes information about a Stage resource.
-
#update_usage(params = {}) ⇒ Types::Usage
Grants a temporary extension to the remaining quota of a usage plan associated with a specified API key.
-
#update_usage_plan(params = {}) ⇒ Types::UsagePlan
Updates a usage plan of a given plan Id.
-
#update_vpc_link(params = {}) ⇒ Types::VpcLink
Updates an existing VpcLink of a specified identifier.
Class Method Summary collapse
- .errors_module ⇒ Object private
Instance Method Summary collapse
- #build_request(operation_name, params = {}) ⇒ Object private
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
- #waiter_names ⇒ Object deprecated private Deprecated.
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
424 425 426 |
# File 'lib/aws-sdk-apigateway/client.rb', line 424 def initialize(*args) super end |
Class Attribute Details
.identifier ⇒ Object (readonly)
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
7114 7115 7116 |
# File 'lib/aws-sdk-apigateway/client.rb', line 7114 def identifier @identifier end |
Class Method Details
.errors_module ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
7117 7118 7119 |
# File 'lib/aws-sdk-apigateway/client.rb', line 7117 def errors_module Errors end |
Instance Method Details
#build_request(operation_name, params = {}) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
7092 7093 7094 7095 7096 7097 7098 7099 7100 7101 7102 7103 |
# File 'lib/aws-sdk-apigateway/client.rb', line 7092 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.101.0' Seahorse::Client::Request.new(handlers, context) end |
#create_api_key(params = {}) ⇒ Types::ApiKey
Create an ApiKey resource.
512 513 514 515 |
# File 'lib/aws-sdk-apigateway/client.rb', line 512 def create_api_key(params = {}, = {}) req = build_request(:create_api_key, params) req.send_request() end |
#create_authorizer(params = {}) ⇒ Types::Authorizer
Adds a new Authorizer resource to an existing RestApi resource.
642 643 644 645 |
# File 'lib/aws-sdk-apigateway/client.rb', line 642 def (params = {}, = {}) req = build_request(:create_authorizer, params) req.send_request() end |
#create_base_path_mapping(params = {}) ⇒ Types::BasePathMapping
Creates a new BasePathMapping resource.
689 690 691 692 |
# File 'lib/aws-sdk-apigateway/client.rb', line 689 def create_base_path_mapping(params = {}, = {}) req = build_request(:create_base_path_mapping, params) req.send_request() end |
#create_deployment(params = {}) ⇒ Types::Deployment
Creates a Deployment resource, which makes a specified RestApi callable over the internet.
775 776 777 778 |
# File 'lib/aws-sdk-apigateway/client.rb', line 775 def create_deployment(params = {}, = {}) req = build_request(:create_deployment, params) req.send_request() end |
#create_documentation_part(params = {}) ⇒ Types::DocumentationPart
Creates a documentation part.
826 827 828 829 |
# File 'lib/aws-sdk-apigateway/client.rb', line 826 def create_documentation_part(params = {}, = {}) req = build_request(:create_documentation_part, params) req.send_request() end |
#create_documentation_version(params = {}) ⇒ Types::DocumentationVersion
Creates a documentation version
868 869 870 871 |
# File 'lib/aws-sdk-apigateway/client.rb', line 868 def create_documentation_version(params = {}, = {}) req = build_request(:create_documentation_version, params) req.send_request() end |
#create_domain_name(params = {}) ⇒ Types::DomainName
Creates a new domain name.
1014 1015 1016 1017 |
# File 'lib/aws-sdk-apigateway/client.rb', line 1014 def create_domain_name(params = {}, = {}) req = build_request(:create_domain_name, params) req.send_request() end |
#create_model(params = {}) ⇒ Types::Model
Adds a new Model resource to an existing RestApi resource.
1065 1066 1067 1068 |
# File 'lib/aws-sdk-apigateway/client.rb', line 1065 def create_model(params = {}, = {}) req = build_request(:create_model, params) req.send_request() end |
#create_request_validator(params = {}) ⇒ Types::RequestValidator
Creates a RequestValidator of a given RestApi.
1112 1113 1114 1115 |
# File 'lib/aws-sdk-apigateway/client.rb', line 1112 def create_request_validator(params = {}, = {}) req = build_request(:create_request_validator, params) req.send_request() end |
#create_resource(params = {}) ⇒ Types::Resource
Creates a Resource resource.
1197 1198 1199 1200 |
# File 'lib/aws-sdk-apigateway/client.rb', line 1197 def create_resource(params = {}, = {}) req = build_request(:create_resource, params) req.send_request() end |
#create_rest_api(params = {}) ⇒ Types::RestApi
Creates a new RestApi resource.
1317 1318 1319 1320 |
# File 'lib/aws-sdk-apigateway/client.rb', line 1317 def create_rest_api(params = {}, = {}) req = build_request(:create_rest_api, params) req.send_request() end |
#create_stage(params = {}) ⇒ Types::Stage
Creates a new Stage resource that references a pre-existing Deployment for the API.
1455 1456 1457 1458 |
# File 'lib/aws-sdk-apigateway/client.rb', line 1455 def create_stage(params = {}, = {}) req = build_request(:create_stage, params) req.send_request() end |
#create_usage_plan(params = {}) ⇒ Types::UsagePlan
Creates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the payload.
1547 1548 1549 1550 |
# File 'lib/aws-sdk-apigateway/client.rb', line 1547 def create_usage_plan(params = {}, = {}) req = build_request(:create_usage_plan, params) req.send_request() end |
#create_usage_plan_key(params = {}) ⇒ Types::UsagePlanKey
Creates a usage plan key for adding an existing API key to a usage plan.
1590 1591 1592 1593 |
# File 'lib/aws-sdk-apigateway/client.rb', line 1590 def create_usage_plan_key(params = {}, = {}) req = build_request(:create_usage_plan_key, params) req.send_request() end |
#create_vpc_link(params = {}) ⇒ Types::VpcLink
Creates a VPC link, under the caller’s account in a selected region, in an asynchronous operation that typically takes 2-4 minutes to complete and become operational. The caller must have permissions to create and update VPC Endpoint services.
1651 1652 1653 1654 |
# File 'lib/aws-sdk-apigateway/client.rb', line 1651 def create_vpc_link(params = {}, = {}) req = build_request(:create_vpc_link, params) req.send_request() end |
#delete_api_key(params = {}) ⇒ Struct
Deletes the ApiKey resource.
1671 1672 1673 1674 |
# File 'lib/aws-sdk-apigateway/client.rb', line 1671 def delete_api_key(params = {}, = {}) req = build_request(:delete_api_key, params) req.send_request() end |
#delete_authorizer(params = {}) ⇒ Struct
Deletes an existing Authorizer resource.
1695 1696 1697 1698 |
# File 'lib/aws-sdk-apigateway/client.rb', line 1695 def (params = {}, = {}) req = build_request(:delete_authorizer, params) req.send_request() end |
#delete_base_path_mapping(params = {}) ⇒ Struct
Deletes the BasePathMapping resource.
1721 1722 1723 1724 |
# File 'lib/aws-sdk-apigateway/client.rb', line 1721 def delete_base_path_mapping(params = {}, = {}) req = build_request(:delete_base_path_mapping, params) req.send_request() end |
#delete_client_certificate(params = {}) ⇒ Struct
Deletes the ClientCertificate resource.
1741 1742 1743 1744 |
# File 'lib/aws-sdk-apigateway/client.rb', line 1741 def delete_client_certificate(params = {}, = {}) req = build_request(:delete_client_certificate, params) req.send_request() end |
#delete_deployment(params = {}) ⇒ Struct
Deletes a Deployment resource. Deleting a deployment will only succeed if there are no Stage resources associated with it.
1766 1767 1768 1769 |
# File 'lib/aws-sdk-apigateway/client.rb', line 1766 def delete_deployment(params = {}, = {}) req = build_request(:delete_deployment, params) req.send_request() end |
#delete_documentation_part(params = {}) ⇒ Struct
Deletes a documentation part
1790 1791 1792 1793 |
# File 'lib/aws-sdk-apigateway/client.rb', line 1790 def delete_documentation_part(params = {}, = {}) req = build_request(:delete_documentation_part, params) req.send_request() end |
#delete_documentation_version(params = {}) ⇒ Struct
Deletes a documentation version.
1814 1815 1816 1817 |
# File 'lib/aws-sdk-apigateway/client.rb', line 1814 def delete_documentation_version(params = {}, = {}) req = build_request(:delete_documentation_version, params) req.send_request() end |
#delete_domain_name(params = {}) ⇒ Struct
Deletes the DomainName resource.
1834 1835 1836 1837 |
# File 'lib/aws-sdk-apigateway/client.rb', line 1834 def delete_domain_name(params = {}, = {}) req = build_request(:delete_domain_name, params) req.send_request() end |
#delete_gateway_response(params = {}) ⇒ Struct
Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings.
1859 1860 1861 1862 |
# File 'lib/aws-sdk-apigateway/client.rb', line 1859 def delete_gateway_response(params = {}, = {}) req = build_request(:delete_gateway_response, params) req.send_request() end |
#delete_integration(params = {}) ⇒ Struct
Represents a delete integration.
1887 1888 1889 1890 |
# File 'lib/aws-sdk-apigateway/client.rb', line 1887 def delete_integration(params = {}, = {}) req = build_request(:delete_integration, params) req.send_request() end |
#delete_integration_response(params = {}) ⇒ Struct
Represents a delete integration response.
1920 1921 1922 1923 |
# File 'lib/aws-sdk-apigateway/client.rb', line 1920 def delete_integration_response(params = {}, = {}) req = build_request(:delete_integration_response, params) req.send_request() end |
#delete_method(params = {}) ⇒ Struct
Deletes an existing Method resource.
1948 1949 1950 1951 |
# File 'lib/aws-sdk-apigateway/client.rb', line 1948 def delete_method(params = {}, = {}) req = build_request(:delete_method, params) req.send_request() end |
#delete_method_response(params = {}) ⇒ Struct
Deletes an existing MethodResponse resource.
1980 1981 1982 1983 |
# File 'lib/aws-sdk-apigateway/client.rb', line 1980 def delete_method_response(params = {}, = {}) req = build_request(:delete_method_response, params) req.send_request() end |
#delete_model(params = {}) ⇒ Struct
Deletes a model.
2004 2005 2006 2007 |
# File 'lib/aws-sdk-apigateway/client.rb', line 2004 def delete_model(params = {}, = {}) req = build_request(:delete_model, params) req.send_request() end |
#delete_request_validator(params = {}) ⇒ Struct
Deletes a RequestValidator of a given RestApi.
2028 2029 2030 2031 |
# File 'lib/aws-sdk-apigateway/client.rb', line 2028 def delete_request_validator(params = {}, = {}) req = build_request(:delete_request_validator, params) req.send_request() end |
#delete_resource(params = {}) ⇒ Struct
Deletes a Resource resource.
2052 2053 2054 2055 |
# File 'lib/aws-sdk-apigateway/client.rb', line 2052 def delete_resource(params = {}, = {}) req = build_request(:delete_resource, params) req.send_request() end |
#delete_rest_api(params = {}) ⇒ Struct
Deletes the specified API.
2072 2073 2074 2075 |
# File 'lib/aws-sdk-apigateway/client.rb', line 2072 def delete_rest_api(params = {}, = {}) req = build_request(:delete_rest_api, params) req.send_request() end |
#delete_stage(params = {}) ⇒ Struct
Deletes a Stage resource.
2096 2097 2098 2099 |
# File 'lib/aws-sdk-apigateway/client.rb', line 2096 def delete_stage(params = {}, = {}) req = build_request(:delete_stage, params) req.send_request() end |
#delete_usage_plan(params = {}) ⇒ Struct
Deletes a usage plan of a given plan Id.
2116 2117 2118 2119 |
# File 'lib/aws-sdk-apigateway/client.rb', line 2116 def delete_usage_plan(params = {}, = {}) req = build_request(:delete_usage_plan, params) req.send_request() end |
#delete_usage_plan_key(params = {}) ⇒ Struct
Deletes a usage plan key and remove the underlying API key from the associated usage plan.
2143 2144 2145 2146 |
# File 'lib/aws-sdk-apigateway/client.rb', line 2143 def delete_usage_plan_key(params = {}, = {}) req = build_request(:delete_usage_plan_key, params) req.send_request() end |
#delete_vpc_link(params = {}) ⇒ Struct
Deletes an existing VpcLink of a specified identifier.
2164 2165 2166 2167 |
# File 'lib/aws-sdk-apigateway/client.rb', line 2164 def delete_vpc_link(params = {}, = {}) req = build_request(:delete_vpc_link, params) req.send_request() end |
#flush_stage_authorizers_cache(params = {}) ⇒ Struct
Flushes all authorizer cache entries on a stage.
2188 2189 2190 2191 |
# File 'lib/aws-sdk-apigateway/client.rb', line 2188 def (params = {}, = {}) req = build_request(:flush_stage_authorizers_cache, params) req.send_request() end |
#flush_stage_cache(params = {}) ⇒ Struct
Flushes a stage’s cache.
2212 2213 2214 2215 |
# File 'lib/aws-sdk-apigateway/client.rb', line 2212 def flush_stage_cache(params = {}, = {}) req = build_request(:flush_stage_cache, params) req.send_request() end |
#generate_client_certificate(params = {}) ⇒ Types::ClientCertificate
Generates a ClientCertificate resource.
2257 2258 2259 2260 |
# File 'lib/aws-sdk-apigateway/client.rb', line 2257 def generate_client_certificate(params = {}, = {}) req = build_request(:generate_client_certificate, params) req.send_request() end |
#get_account(params = {}) ⇒ Types::Account
Gets information about the current Account resource.
2282 2283 2284 2285 |
# File 'lib/aws-sdk-apigateway/client.rb', line 2282 def get_account(params = {}, = {}) req = build_request(:get_account, params) req.send_request() end |
#get_api_key(params = {}) ⇒ Types::ApiKey
Gets information about the current ApiKey resource.
2333 2334 2335 2336 |
# File 'lib/aws-sdk-apigateway/client.rb', line 2333 def get_api_key(params = {}, = {}) req = build_request(:get_api_key, params) req.send_request() end |
#get_api_keys(params = {}) ⇒ Types::ApiKeys
Gets information about the current ApiKeys resource.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2397 2398 2399 2400 |
# File 'lib/aws-sdk-apigateway/client.rb', line 2397 def get_api_keys(params = {}, = {}) req = build_request(:get_api_keys, params) req.send_request() end |
#get_authorizer(params = {}) ⇒ Types::Authorizer
Describe an existing Authorizer resource.
2446 2447 2448 2449 |
# File 'lib/aws-sdk-apigateway/client.rb', line 2446 def (params = {}, = {}) req = build_request(:get_authorizer, params) req.send_request() end |
#get_authorizers(params = {}) ⇒ Types::Authorizers
Describe an existing Authorizers resource.
2494 2495 2496 2497 |
# File 'lib/aws-sdk-apigateway/client.rb', line 2494 def (params = {}, = {}) req = build_request(:get_authorizers, params) req.send_request() end |
#get_base_path_mapping(params = {}) ⇒ Types::BasePathMapping
Describe a BasePathMapping resource.
2531 2532 2533 2534 |
# File 'lib/aws-sdk-apigateway/client.rb', line 2531 def get_base_path_mapping(params = {}, = {}) req = build_request(:get_base_path_mapping, params) req.send_request() end |
#get_base_path_mappings(params = {}) ⇒ Types::BasePathMappings
Represents a collection of BasePathMapping resources.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2573 2574 2575 2576 |
# File 'lib/aws-sdk-apigateway/client.rb', line 2573 def get_base_path_mappings(params = {}, = {}) req = build_request(:get_base_path_mappings, params) req.send_request() end |
#get_client_certificate(params = {}) ⇒ Types::ClientCertificate
Gets information about the current ClientCertificate resource.
2610 2611 2612 2613 |
# File 'lib/aws-sdk-apigateway/client.rb', line 2610 def get_client_certificate(params = {}, = {}) req = build_request(:get_client_certificate, params) req.send_request() end |
#get_client_certificates(params = {}) ⇒ Types::ClientCertificates
Gets a collection of ClientCertificate resources.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2652 2653 2654 2655 |
# File 'lib/aws-sdk-apigateway/client.rb', line 2652 def get_client_certificates(params = {}, = {}) req = build_request(:get_client_certificates, params) req.send_request() end |
#get_deployment(params = {}) ⇒ Types::Deployment
Gets information about a Deployment resource.
2705 2706 2707 2708 |
# File 'lib/aws-sdk-apigateway/client.rb', line 2705 def get_deployment(params = {}, = {}) req = build_request(:get_deployment, params) req.send_request() end |
#get_deployments(params = {}) ⇒ Types::Deployments
Gets information about a Deployments collection.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2751 2752 2753 2754 |
# File 'lib/aws-sdk-apigateway/client.rb', line 2751 def get_deployments(params = {}, = {}) req = build_request(:get_deployments, params) req.send_request() end |
#get_documentation_part(params = {}) ⇒ Types::DocumentationPart
Gets a documentation part.
2789 2790 2791 2792 |
# File 'lib/aws-sdk-apigateway/client.rb', line 2789 def get_documentation_part(params = {}, = {}) req = build_request(:get_documentation_part, params) req.send_request() end |
#get_documentation_parts(params = {}) ⇒ Types::DocumentationParts
Gets documentation parts.
2852 2853 2854 2855 |
# File 'lib/aws-sdk-apigateway/client.rb', line 2852 def get_documentation_parts(params = {}, = {}) req = build_request(:get_documentation_parts, params) req.send_request() end |
#get_documentation_version(params = {}) ⇒ Types::DocumentationVersion
Gets a documentation version.
2886 2887 2888 2889 |
# File 'lib/aws-sdk-apigateway/client.rb', line 2886 def get_documentation_version(params = {}, = {}) req = build_request(:get_documentation_version, params) req.send_request() end |
#get_documentation_versions(params = {}) ⇒ Types::DocumentationVersions
Gets documentation versions.
2926 2927 2928 2929 |
# File 'lib/aws-sdk-apigateway/client.rb', line 2926 def get_documentation_versions(params = {}, = {}) req = build_request(:get_documentation_versions, params) req.send_request() end |
#get_domain_name(params = {}) ⇒ Types::DomainName
Represents a domain name that is contained in a simpler, more intuitive URL that can be called.
2992 2993 2994 2995 |
# File 'lib/aws-sdk-apigateway/client.rb', line 2992 def get_domain_name(params = {}, = {}) req = build_request(:get_domain_name, params) req.send_request() end |
#get_domain_names(params = {}) ⇒ Types::DomainNames
Represents a collection of DomainName resources.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3051 3052 3053 3054 |
# File 'lib/aws-sdk-apigateway/client.rb', line 3051 def get_domain_names(params = {}, = {}) req = build_request(:get_domain_names, params) req.send_request() end |
#get_export(params = {}) ⇒ Types::ExportResponse
Exports a deployed version of a RestApi in a specified format.
3110 3111 3112 3113 |
# File 'lib/aws-sdk-apigateway/client.rb', line 3110 def get_export(params = {}, = {}) req = build_request(:get_export, params) req.send_request() end |
#get_gateway_response(params = {}) ⇒ Types::GatewayResponse
Gets a GatewayResponse of a specified response type on the given RestApi.
3151 3152 3153 3154 |
# File 'lib/aws-sdk-apigateway/client.rb', line 3151 def get_gateway_response(params = {}, = {}) req = build_request(:get_gateway_response, params) req.send_request() end |
#get_gateway_responses(params = {}) ⇒ Types::GatewayResponses
Gets the GatewayResponses collection on the given RestApi. If an API developer has not added any definitions for gateway responses, the result will be the API Gateway-generated default GatewayResponses collection for the supported response types.
3201 3202 3203 3204 |
# File 'lib/aws-sdk-apigateway/client.rb', line 3201 def get_gateway_responses(params = {}, = {}) req = build_request(:get_gateway_responses, params) req.send_request() end |
#get_integration(params = {}) ⇒ Types::Integration
Get the integration settings.
3273 3274 3275 3276 |
# File 'lib/aws-sdk-apigateway/client.rb', line 3273 def get_integration(params = {}, = {}) req = build_request(:get_integration, params) req.send_request() end |
#get_integration_response(params = {}) ⇒ Types::IntegrationResponse
Represents a get integration response.
3321 3322 3323 3324 |
# File 'lib/aws-sdk-apigateway/client.rb', line 3321 def get_integration_response(params = {}, = {}) req = build_request(:get_integration_response, params) req.send_request() end |
#get_method(params = {}) ⇒ Types::Method
Describe an existing Method resource.
3407 3408 3409 3410 |
# File 'lib/aws-sdk-apigateway/client.rb', line 3407 def get_method(params = {}, = {}) req = build_request(:get_method, params) req.send_request() end |
#get_method_response(params = {}) ⇒ Types::MethodResponse
Describes a MethodResponse resource.
3451 3452 3453 3454 |
# File 'lib/aws-sdk-apigateway/client.rb', line 3451 def get_method_response(params = {}, = {}) req = build_request(:get_method_response, params) req.send_request() end |
#get_model(params = {}) ⇒ Types::Model
Describes an existing model defined for a RestApi resource.
3495 3496 3497 3498 |
# File 'lib/aws-sdk-apigateway/client.rb', line 3495 def get_model(params = {}, = {}) req = build_request(:get_model, params) req.send_request() end |
#get_model_template(params = {}) ⇒ Types::Template
Generates a sample mapping template that can be used to transform a payload into the structure of a model.
3526 3527 3528 3529 |
# File 'lib/aws-sdk-apigateway/client.rb', line 3526 def get_model_template(params = {}, = {}) req = build_request(:get_model_template, params) req.send_request() end |
#get_models(params = {}) ⇒ Types::Models
Describes existing Models defined for a RestApi resource.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3570 3571 3572 3573 |
# File 'lib/aws-sdk-apigateway/client.rb', line 3570 def get_models(params = {}, = {}) req = build_request(:get_models, params) req.send_request() end |
#get_request_validator(params = {}) ⇒ Types::RequestValidator
Gets a RequestValidator of a given RestApi.
3606 3607 3608 3609 |
# File 'lib/aws-sdk-apigateway/client.rb', line 3606 def get_request_validator(params = {}, = {}) req = build_request(:get_request_validator, params) req.send_request() end |
#get_request_validators(params = {}) ⇒ Types::RequestValidators
Gets the RequestValidators collection of a given RestApi.
3647 3648 3649 3650 |
# File 'lib/aws-sdk-apigateway/client.rb', line 3647 def get_request_validators(params = {}, = {}) req = build_request(:get_request_validators, params) req.send_request() end |
#get_resource(params = {}) ⇒ Types::Resource
Lists information about a resource.
3738 3739 3740 3741 |
# File 'lib/aws-sdk-apigateway/client.rb', line 3738 def get_resource(params = {}, = {}) req = build_request(:get_resource, params) req.send_request() end |
#get_resources(params = {}) ⇒ Types::Resources
Lists information about a collection of Resource resources.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3835 3836 3837 3838 |
# File 'lib/aws-sdk-apigateway/client.rb', line 3835 def get_resources(params = {}, = {}) req = build_request(:get_resources, params) req.send_request() end |
#get_rest_api(params = {}) ⇒ Types::RestApi
Lists the RestApi resource in the collection.
3893 3894 3895 3896 |
# File 'lib/aws-sdk-apigateway/client.rb', line 3893 def get_rest_api(params = {}, = {}) req = build_request(:get_rest_api, params) req.send_request() end |
#get_rest_apis(params = {}) ⇒ Types::RestApis
Lists the RestApis resources for your collection.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3948 3949 3950 3951 |
# File 'lib/aws-sdk-apigateway/client.rb', line 3948 def get_rest_apis(params = {}, = {}) req = build_request(:get_rest_apis, params) req.send_request() end |
#get_sdk(params = {}) ⇒ Types::SdkResponse
Generates a client SDK for a RestApi and Stage.
4000 4001 4002 4003 |
# File 'lib/aws-sdk-apigateway/client.rb', line 4000 def get_sdk(params = {}, = {}) req = build_request(:get_sdk, params) req.send_request() end |
#get_sdk_type(params = {}) ⇒ Types::SdkType
Gets an SDK type.
4037 4038 4039 4040 |
# File 'lib/aws-sdk-apigateway/client.rb', line 4037 def get_sdk_type(params = {}, = {}) req = build_request(:get_sdk_type, params) req.send_request() end |
#get_sdk_types(params = {}) ⇒ Types::SdkTypes
Gets SDK types
4079 4080 4081 4082 |
# File 'lib/aws-sdk-apigateway/client.rb', line 4079 def get_sdk_types(params = {}, = {}) req = build_request(:get_sdk_types, params) req.send_request() end |
#get_stage(params = {}) ⇒ Types::Stage
Gets information about a Stage resource.
4158 4159 4160 4161 |
# File 'lib/aws-sdk-apigateway/client.rb', line 4158 def get_stage(params = {}, = {}) req = build_request(:get_stage, params) req.send_request() end |
#get_stages(params = {}) ⇒ Types::Stages
Gets information about one or more Stage resources.
4222 4223 4224 4225 |
# File 'lib/aws-sdk-apigateway/client.rb', line 4222 def get_stages(params = {}, = {}) req = build_request(:get_stages, params) req.send_request() end |
#get_tags(params = {}) ⇒ Types::Tags
Gets the Tags collection for a given resource.
4259 4260 4261 4262 |
# File 'lib/aws-sdk-apigateway/client.rb', line 4259 def (params = {}, = {}) req = build_request(:get_tags, params) req.send_request() end |
#get_usage(params = {}) ⇒ Types::Usage
Gets the usage data of a usage plan in a specified time interval.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4319 4320 4321 4322 |
# File 'lib/aws-sdk-apigateway/client.rb', line 4319 def get_usage(params = {}, = {}) req = build_request(:get_usage, params) req.send_request() end |
#get_usage_plan(params = {}) ⇒ Types::UsagePlan
Gets a usage plan of a given plan identifier.
4368 4369 4370 4371 |
# File 'lib/aws-sdk-apigateway/client.rb', line 4368 def get_usage_plan(params = {}, = {}) req = build_request(:get_usage_plan, params) req.send_request() end |
#get_usage_plan_key(params = {}) ⇒ Types::UsagePlanKey
Gets a usage plan key of a given key identifier.
4407 4408 4409 4410 |
# File 'lib/aws-sdk-apigateway/client.rb', line 4407 def get_usage_plan_key(params = {}, = {}) req = build_request(:get_usage_plan_key, params) req.send_request() end |
#get_usage_plan_keys(params = {}) ⇒ Types::UsagePlanKeys
Gets all the usage plan keys representing the API keys added to a specified usage plan.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4458 4459 4460 4461 |
# File 'lib/aws-sdk-apigateway/client.rb', line 4458 def get_usage_plan_keys(params = {}, = {}) req = build_request(:get_usage_plan_keys, params) req.send_request() end |
#get_usage_plans(params = {}) ⇒ Types::UsagePlans
Gets all the usage plans of the caller’s account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4514 4515 4516 4517 |
# File 'lib/aws-sdk-apigateway/client.rb', line 4514 def get_usage_plans(params = {}, = {}) req = build_request(:get_usage_plans, params) req.send_request() end |
#get_vpc_link(params = {}) ⇒ Types::VpcLink
Gets a specified VPC link under the caller’s account in a region.
4555 4556 4557 4558 |
# File 'lib/aws-sdk-apigateway/client.rb', line 4555 def get_vpc_link(params = {}, = {}) req = build_request(:get_vpc_link, params) req.send_request() end |
#get_vpc_links(params = {}) ⇒ Types::VpcLinks
Gets the VpcLinks collection under the caller’s account in a selected region.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4600 4601 4602 4603 |
# File 'lib/aws-sdk-apigateway/client.rb', line 4600 def get_vpc_links(params = {}, = {}) req = build_request(:get_vpc_links, params) req.send_request() end |
#import_api_keys(params = {}) ⇒ Types::ApiKeyIds
Import API keys from an external source, such as a CSV-formatted file.
4641 4642 4643 4644 |
# File 'lib/aws-sdk-apigateway/client.rb', line 4641 def import_api_keys(params = {}, = {}) req = build_request(:import_api_keys, params) req.send_request() end |
#import_documentation_parts(params = {}) ⇒ Types::DocumentationPartIds
Imports documentation parts
4688 4689 4690 4691 |
# File 'lib/aws-sdk-apigateway/client.rb', line 4688 def import_documentation_parts(params = {}, = {}) req = build_request(:import_documentation_parts, params) req.send_request() end |
#import_rest_api(params = {}) ⇒ Types::RestApi
A feature of the API Gateway control service for creating a new API from an external API definition file.
4775 4776 4777 4778 |
# File 'lib/aws-sdk-apigateway/client.rb', line 4775 def import_rest_api(params = {}, = {}) req = build_request(:import_rest_api, params) req.send_request() end |
#put_gateway_response(params = {}) ⇒ Types::GatewayResponse
Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.
4834 4835 4836 4837 |
# File 'lib/aws-sdk-apigateway/client.rb', line 4834 def put_gateway_response(params = {}, = {}) req = build_request(:put_gateway_response, params) req.send_request() end |
#put_integration(params = {}) ⇒ Types::Integration
Sets up a method’s integration.
5023 5024 5025 5026 |
# File 'lib/aws-sdk-apigateway/client.rb', line 5023 def put_integration(params = {}, = {}) req = build_request(:put_integration, params) req.send_request() end |
#put_integration_response(params = {}) ⇒ Types::IntegrationResponse
Represents a put integration.
5108 5109 5110 5111 |
# File 'lib/aws-sdk-apigateway/client.rb', line 5108 def put_integration_response(params = {}, = {}) req = build_request(:put_integration_response, params) req.send_request() end |
#put_method(params = {}) ⇒ Types::Method
Add a method to an existing Resource resource.
5257 5258 5259 5260 |
# File 'lib/aws-sdk-apigateway/client.rb', line 5257 def put_method(params = {}, = {}) req = build_request(:put_method, params) req.send_request() end |
#put_method_response(params = {}) ⇒ Types::MethodResponse
Adds a MethodResponse to an existing Method resource.
5328 5329 5330 5331 |
# File 'lib/aws-sdk-apigateway/client.rb', line 5328 def put_method_response(params = {}, = {}) req = build_request(:put_method_response, params) req.send_request() end |
#put_rest_api(params = {}) ⇒ Types::RestApi
A feature of the API Gateway control service for updating an existing API with an input of external API definitions. The update can take the form of merging the supplied definition into the existing API or overwriting the existing API.
5417 5418 5419 5420 |
# File 'lib/aws-sdk-apigateway/client.rb', line 5417 def put_rest_api(params = {}, = {}) req = build_request(:put_rest_api, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Adds or updates a tag on a given resource.
5445 5446 5447 5448 |
# File 'lib/aws-sdk-apigateway/client.rb', line 5445 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#test_invoke_authorizer(params = {}) ⇒ Types::TestInvokeAuthorizerResponse
Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body.
5530 5531 5532 5533 |
# File 'lib/aws-sdk-apigateway/client.rb', line 5530 def (params = {}, = {}) req = build_request(:test_invoke_authorizer, params) req.send_request() end |
#test_invoke_method(params = {}) ⇒ Types::TestInvokeMethodResponse
Simulate the invocation of a Method in your RestApi with headers, parameters, and an incoming request body.
5614 5615 5616 5617 |
# File 'lib/aws-sdk-apigateway/client.rb', line 5614 def test_invoke_method(params = {}, = {}) req = build_request(:test_invoke_method, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes a tag from a given resource.
5638 5639 5640 5641 |
# File 'lib/aws-sdk-apigateway/client.rb', line 5638 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_account(params = {}) ⇒ Types::Account
Changes information about the current Account resource.
5684 5685 5686 5687 |
# File 'lib/aws-sdk-apigateway/client.rb', line 5684 def update_account(params = {}, = {}) req = build_request(:update_account, params) req.send_request() end |
#update_api_key(params = {}) ⇒ Types::ApiKey
Changes information about an ApiKey resource.
5746 5747 5748 5749 |
# File 'lib/aws-sdk-apigateway/client.rb', line 5746 def update_api_key(params = {}, = {}) req = build_request(:update_api_key, params) req.send_request() end |
#update_authorizer(params = {}) ⇒ Types::Authorizer
Updates an existing Authorizer resource.
5811 5812 5813 5814 |
# File 'lib/aws-sdk-apigateway/client.rb', line 5811 def (params = {}, = {}) req = build_request(:update_authorizer, params) req.send_request() end |
#update_base_path_mapping(params = {}) ⇒ Types::BasePathMapping
Changes information about the BasePathMapping resource.
5863 5864 5865 5866 |
# File 'lib/aws-sdk-apigateway/client.rb', line 5863 def update_base_path_mapping(params = {}, = {}) req = build_request(:update_base_path_mapping, params) req.send_request() end |
#update_client_certificate(params = {}) ⇒ Types::ClientCertificate
Changes information about an ClientCertificate resource.
5916 5917 5918 5919 |
# File 'lib/aws-sdk-apigateway/client.rb', line 5916 def update_client_certificate(params = {}, = {}) req = build_request(:update_client_certificate, params) req.send_request() end |
#update_deployment(params = {}) ⇒ Types::Deployment
Changes information about a Deployment resource.
5972 5973 5974 5975 |
# File 'lib/aws-sdk-apigateway/client.rb', line 5972 def update_deployment(params = {}, = {}) req = build_request(:update_deployment, params) req.send_request() end |
#update_documentation_part(params = {}) ⇒ Types::DocumentationPart
Updates a documentation part.
6026 6027 6028 6029 |
# File 'lib/aws-sdk-apigateway/client.rb', line 6026 def update_documentation_part(params = {}, = {}) req = build_request(:update_documentation_part, params) req.send_request() end |
#update_documentation_version(params = {}) ⇒ Types::DocumentationVersion
Updates a documentation version.
6076 6077 6078 6079 |
# File 'lib/aws-sdk-apigateway/client.rb', line 6076 def update_documentation_version(params = {}, = {}) req = build_request(:update_documentation_version, params) req.send_request() end |
#update_domain_name(params = {}) ⇒ Types::DomainName
Changes information about the DomainName resource.
6157 6158 6159 6160 |
# File 'lib/aws-sdk-apigateway/client.rb', line 6157 def update_domain_name(params = {}, = {}) req = build_request(:update_domain_name, params) req.send_request() end |
#update_gateway_response(params = {}) ⇒ Types::GatewayResponse
Updates a GatewayResponse of a specified response type on the given RestApi.
6214 6215 6216 6217 |
# File 'lib/aws-sdk-apigateway/client.rb', line 6214 def update_gateway_response(params = {}, = {}) req = build_request(:update_gateway_response, params) req.send_request() end |
#update_integration(params = {}) ⇒ Types::Integration
Represents an update integration.
6302 6303 6304 6305 |
# File 'lib/aws-sdk-apigateway/client.rb', line 6302 def update_integration(params = {}, = {}) req = build_request(:update_integration, params) req.send_request() end |
#update_integration_response(params = {}) ⇒ Types::IntegrationResponse
Represents an update integration response.
6367 6368 6369 6370 |
# File 'lib/aws-sdk-apigateway/client.rb', line 6367 def update_integration_response(params = {}, = {}) req = build_request(:update_integration_response, params) req.send_request() end |
#update_method(params = {}) ⇒ Types::Method
Updates an existing Method resource.
6469 6470 6471 6472 |
# File 'lib/aws-sdk-apigateway/client.rb', line 6469 def update_method(params = {}, = {}) req = build_request(:update_method, params) req.send_request() end |
#update_method_response(params = {}) ⇒ Types::MethodResponse
Updates an existing MethodResponse resource.
6529 6530 6531 6532 |
# File 'lib/aws-sdk-apigateway/client.rb', line 6529 def update_method_response(params = {}, = {}) req = build_request(:update_method_response, params) req.send_request() end |
#update_model(params = {}) ⇒ Types::Model
Changes information about a model. The maximum size of the model is 400 KB.
6584 6585 6586 6587 |
# File 'lib/aws-sdk-apigateway/client.rb', line 6584 def update_model(params = {}, = {}) req = build_request(:update_model, params) req.send_request() end |
#update_request_validator(params = {}) ⇒ Types::RequestValidator
Updates a RequestValidator of a given RestApi.
6636 6637 6638 6639 |
# File 'lib/aws-sdk-apigateway/client.rb', line 6636 def update_request_validator(params = {}, = {}) req = build_request(:update_request_validator, params) req.send_request() end |
#update_resource(params = {}) ⇒ Types::Resource
Changes information about a Resource resource.
6733 6734 6735 6736 |
# File 'lib/aws-sdk-apigateway/client.rb', line 6733 def update_resource(params = {}, = {}) req = build_request(:update_resource, params) req.send_request() end |
#update_rest_api(params = {}) ⇒ Types::RestApi
Changes information about the specified API.
6807 6808 6809 6810 |
# File 'lib/aws-sdk-apigateway/client.rb', line 6807 def update_rest_api(params = {}, = {}) req = build_request(:update_rest_api, params) req.send_request() end |
#update_stage(params = {}) ⇒ Types::Stage
Changes information about a Stage resource.
6902 6903 6904 6905 |
# File 'lib/aws-sdk-apigateway/client.rb', line 6902 def update_stage(params = {}, = {}) req = build_request(:update_stage, params) req.send_request() end |
#update_usage(params = {}) ⇒ Types::Usage
Grants a temporary extension to the remaining quota of a usage plan associated with a specified API key.
6961 6962 6963 6964 |
# File 'lib/aws-sdk-apigateway/client.rb', line 6961 def update_usage(params = {}, = {}) req = build_request(:update_usage, params) req.send_request() end |
#update_usage_plan(params = {}) ⇒ Types::UsagePlan
Updates a usage plan of a given plan Id.
7026 7027 7028 7029 |
# File 'lib/aws-sdk-apigateway/client.rb', line 7026 def update_usage_plan(params = {}, = {}) req = build_request(:update_usage_plan, params) req.send_request() end |
#update_vpc_link(params = {}) ⇒ Types::VpcLink
Updates an existing VpcLink of a specified identifier.
7083 7084 7085 7086 |
# File 'lib/aws-sdk-apigateway/client.rb', line 7083 def update_vpc_link(params = {}, = {}) req = build_request(:update_vpc_link, params) req.send_request() end |
#waiter_names ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
7107 7108 7109 |
# File 'lib/aws-sdk-apigateway/client.rb', line 7107 def waiter_names [] end |