Class: Aws::APIGateway::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::APIGateway::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-apigateway/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.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
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.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
412 413 414 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 412 def initialize(*args) super end |
Instance Method Details
#create_api_key(params = {}) ⇒ Types::ApiKey
Create an ApiKey resource.
500 501 502 503 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 500 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.
630 631 632 633 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 630 def (params = {}, = {}) req = build_request(:create_authorizer, params) req.send_request() end |
#create_base_path_mapping(params = {}) ⇒ Types::BasePathMapping
Creates a new BasePathMapping resource.
677 678 679 680 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 677 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.
763 764 765 766 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 763 def create_deployment(params = {}, = {}) req = build_request(:create_deployment, params) req.send_request() end |
#create_documentation_part(params = {}) ⇒ Types::DocumentationPart
Creates a documentation part.
814 815 816 817 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 814 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
856 857 858 859 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 856 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.
1002 1003 1004 1005 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1002 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.
1053 1054 1055 1056 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1053 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.
1100 1101 1102 1103 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1100 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.
1185 1186 1187 1188 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1185 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.
1305 1306 1307 1308 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1305 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.
1443 1444 1445 1446 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1443 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.
1535 1536 1537 1538 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1535 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.
1578 1579 1580 1581 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1578 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.
1639 1640 1641 1642 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1639 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.
1659 1660 1661 1662 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1659 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.
1683 1684 1685 1686 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1683 def (params = {}, = {}) req = build_request(:delete_authorizer, params) req.send_request() end |
#delete_base_path_mapping(params = {}) ⇒ Struct
Deletes the BasePathMapping resource.
1709 1710 1711 1712 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1709 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.
1729 1730 1731 1732 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1729 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.
1754 1755 1756 1757 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1754 def delete_deployment(params = {}, = {}) req = build_request(:delete_deployment, params) req.send_request() end |
#delete_documentation_part(params = {}) ⇒ Struct
Deletes a documentation part
1778 1779 1780 1781 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1778 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.
1802 1803 1804 1805 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1802 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.
1822 1823 1824 1825 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1822 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.
1847 1848 1849 1850 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1847 def delete_gateway_response(params = {}, = {}) req = build_request(:delete_gateway_response, params) req.send_request() end |
#delete_integration(params = {}) ⇒ Struct
Represents a delete integration.
1875 1876 1877 1878 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1875 def delete_integration(params = {}, = {}) req = build_request(:delete_integration, params) req.send_request() end |
#delete_integration_response(params = {}) ⇒ Struct
Represents a delete integration response.
1908 1909 1910 1911 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1908 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.
1936 1937 1938 1939 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1936 def delete_method(params = {}, = {}) req = build_request(:delete_method, params) req.send_request() end |
#delete_method_response(params = {}) ⇒ Struct
Deletes an existing MethodResponse resource.
1968 1969 1970 1971 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1968 def delete_method_response(params = {}, = {}) req = build_request(:delete_method_response, params) req.send_request() end |
#delete_model(params = {}) ⇒ Struct
Deletes a model.
1992 1993 1994 1995 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1992 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.
2016 2017 2018 2019 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2016 def delete_request_validator(params = {}, = {}) req = build_request(:delete_request_validator, params) req.send_request() end |
#delete_resource(params = {}) ⇒ Struct
Deletes a Resource resource.
2040 2041 2042 2043 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2040 def delete_resource(params = {}, = {}) req = build_request(:delete_resource, params) req.send_request() end |
#delete_rest_api(params = {}) ⇒ Struct
Deletes the specified API.
2060 2061 2062 2063 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2060 def delete_rest_api(params = {}, = {}) req = build_request(:delete_rest_api, params) req.send_request() end |
#delete_stage(params = {}) ⇒ Struct
Deletes a Stage resource.
2084 2085 2086 2087 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2084 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.
2104 2105 2106 2107 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2104 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.
2131 2132 2133 2134 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2131 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.
2152 2153 2154 2155 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2152 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.
2176 2177 2178 2179 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2176 def (params = {}, = {}) req = build_request(:flush_stage_authorizers_cache, params) req.send_request() end |
#flush_stage_cache(params = {}) ⇒ Struct
Flushes a stage's cache.
2200 2201 2202 2203 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2200 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.
2245 2246 2247 2248 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2245 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.
2270 2271 2272 2273 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2270 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.
2321 2322 2323 2324 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2321 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.
2385 2386 2387 2388 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2385 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.
2434 2435 2436 2437 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2434 def (params = {}, = {}) req = build_request(:get_authorizer, params) req.send_request() end |
#get_authorizers(params = {}) ⇒ Types::Authorizers
Describe an existing Authorizers resource.
2482 2483 2484 2485 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2482 def (params = {}, = {}) req = build_request(:get_authorizers, params) req.send_request() end |
#get_base_path_mapping(params = {}) ⇒ Types::BasePathMapping
Describe a BasePathMapping resource.
2519 2520 2521 2522 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2519 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.
2561 2562 2563 2564 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2561 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.
2598 2599 2600 2601 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2598 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.
2640 2641 2642 2643 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2640 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.
2693 2694 2695 2696 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2693 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.
2739 2740 2741 2742 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2739 def get_deployments(params = {}, = {}) req = build_request(:get_deployments, params) req.send_request() end |
#get_documentation_part(params = {}) ⇒ Types::DocumentationPart
Gets a documentation part.
2777 2778 2779 2780 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2777 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.
2840 2841 2842 2843 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2840 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.
2874 2875 2876 2877 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2874 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.
2914 2915 2916 2917 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2914 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.
2980 2981 2982 2983 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2980 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.
3039 3040 3041 3042 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3039 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.
3098 3099 3100 3101 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3098 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.
3139 3140 3141 3142 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3139 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.
3189 3190 3191 3192 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3189 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.
3261 3262 3263 3264 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3261 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.
3309 3310 3311 3312 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3309 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.
3395 3396 3397 3398 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3395 def get_method(params = {}, = {}) req = build_request(:get_method, params) req.send_request() end |
#get_method_response(params = {}) ⇒ Types::MethodResponse
Describes a MethodResponse resource.
3439 3440 3441 3442 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3439 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.
3483 3484 3485 3486 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3483 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.
3514 3515 3516 3517 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3514 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.
3558 3559 3560 3561 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3558 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.
3594 3595 3596 3597 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3594 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.
3635 3636 3637 3638 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3635 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.
3726 3727 3728 3729 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3726 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.
3823 3824 3825 3826 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3823 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.
3881 3882 3883 3884 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3881 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.
3936 3937 3938 3939 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3936 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.
3988 3989 3990 3991 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3988 def get_sdk(params = {}, = {}) req = build_request(:get_sdk, params) req.send_request() end |
#get_sdk_type(params = {}) ⇒ Types::SdkType
Gets an SDK type.
4025 4026 4027 4028 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4025 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
4067 4068 4069 4070 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4067 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.
4146 4147 4148 4149 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4146 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.
4210 4211 4212 4213 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4210 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.
4247 4248 4249 4250 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4247 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.
4307 4308 4309 4310 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4307 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.
4356 4357 4358 4359 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4356 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.
4395 4396 4397 4398 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4395 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.
4446 4447 4448 4449 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4446 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.
4502 4503 4504 4505 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4502 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.
4543 4544 4545 4546 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4543 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.
4588 4589 4590 4591 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4588 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.
4629 4630 4631 4632 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4629 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
4676 4677 4678 4679 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4676 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.
4763 4764 4765 4766 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4763 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.
4822 4823 4824 4825 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4822 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.
5011 5012 5013 5014 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 5011 def put_integration(params = {}, = {}) req = build_request(:put_integration, params) req.send_request() end |
#put_integration_response(params = {}) ⇒ Types::IntegrationResponse
Represents a put integration.
5096 5097 5098 5099 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 5096 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.
5245 5246 5247 5248 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 5245 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.
5316 5317 5318 5319 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 5316 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.
5405 5406 5407 5408 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 5405 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.
5433 5434 5435 5436 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 5433 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.
5518 5519 5520 5521 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 5518 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.
5602 5603 5604 5605 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 5602 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.
5626 5627 5628 5629 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 5626 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.
5672 5673 5674 5675 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 5672 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.
5734 5735 5736 5737 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 5734 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.
5799 5800 5801 5802 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 5799 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.
5851 5852 5853 5854 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 5851 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.
5904 5905 5906 5907 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 5904 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.
5960 5961 5962 5963 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 5960 def update_deployment(params = {}, = {}) req = build_request(:update_deployment, params) req.send_request() end |
#update_documentation_part(params = {}) ⇒ Types::DocumentationPart
Updates a documentation part.
6014 6015 6016 6017 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 6014 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.
6064 6065 6066 6067 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 6064 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.
6145 6146 6147 6148 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 6145 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.
6202 6203 6204 6205 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 6202 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.
6290 6291 6292 6293 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 6290 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.
6355 6356 6357 6358 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 6355 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.
6457 6458 6459 6460 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 6457 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.
6517 6518 6519 6520 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 6517 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.
6572 6573 6574 6575 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 6572 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.
6624 6625 6626 6627 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 6624 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.
6721 6722 6723 6724 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 6721 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.
6795 6796 6797 6798 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 6795 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.
6890 6891 6892 6893 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 6890 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.
6949 6950 6951 6952 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 6949 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.
7014 7015 7016 7017 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 7014 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.
7071 7072 7073 7074 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 7071 def update_vpc_link(params = {}, = {}) req = build_request(:update_vpc_link, params) req.send_request() end |