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_domain_name_access_association(params = {}) ⇒ Types::DomainNameAccessAssociation
Creates a domain name access association resource between an access association source and a private custom 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_domain_name_access_association(params = {}) ⇒ Struct
Deletes the DomainNameAccessAssociation 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_name_access_associations(params = {}) ⇒ Types::DomainNameAccessAssociations
Represents a collection on DomainNameAccessAssociations resources.
-
#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.
-
#reject_domain_name_access_association(params = {}) ⇒ Struct
Rejects a domain name access association with a private custom domain name.
-
#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.
468 469 470 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 468 def initialize(*args) super end |
Instance Method Details
#create_api_key(params = {}) ⇒ Types::ApiKey
Create an ApiKey resource.
556 557 558 559 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 556 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.
686 687 688 689 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 686 def (params = {}, = {}) req = build_request(:create_authorizer, params) req.send_request() end |
#create_base_path_mapping(params = {}) ⇒ Types::BasePathMapping
Creates a new BasePathMapping resource.
738 739 740 741 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 738 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.
824 825 826 827 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 824 def create_deployment(params = {}, = {}) req = build_request(:create_deployment, params) req.send_request() end |
#create_documentation_part(params = {}) ⇒ Types::DocumentationPart
Creates a documentation part.
875 876 877 878 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 875 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
917 918 919 920 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 917 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.
1079 1080 1081 1082 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1079 def create_domain_name(params = {}, = {}) req = build_request(:create_domain_name, params) req.send_request() end |
#create_domain_name_access_association(params = {}) ⇒ Types::DomainNameAccessAssociation
Creates a domain name access association resource between an access association source and a private custom domain name.
1132 1133 1134 1135 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1132 def create_domain_name_access_association(params = {}, = {}) req = build_request(:create_domain_name_access_association, params) req.send_request() end |
#create_model(params = {}) ⇒ Types::Model
Adds a new Model resource to an existing RestApi resource.
1183 1184 1185 1186 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1183 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.
1230 1231 1232 1233 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1230 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.
1315 1316 1317 1318 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1315 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.
1437 1438 1439 1440 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1437 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.
1575 1576 1577 1578 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1575 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.
1667 1668 1669 1670 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1667 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.
1710 1711 1712 1713 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1710 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.
1771 1772 1773 1774 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1771 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.
1791 1792 1793 1794 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1791 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.
1815 1816 1817 1818 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1815 def (params = {}, = {}) req = build_request(:delete_authorizer, params) req.send_request() end |
#delete_base_path_mapping(params = {}) ⇒ Struct
Deletes the BasePathMapping resource.
1846 1847 1848 1849 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1846 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.
1866 1867 1868 1869 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1866 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.
1891 1892 1893 1894 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1891 def delete_deployment(params = {}, = {}) req = build_request(:delete_deployment, params) req.send_request() end |
#delete_documentation_part(params = {}) ⇒ Struct
Deletes a documentation part
1915 1916 1917 1918 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1915 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.
1939 1940 1941 1942 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1939 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.
1964 1965 1966 1967 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1964 def delete_domain_name(params = {}, = {}) req = build_request(:delete_domain_name, params) req.send_request() end |
#delete_domain_name_access_association(params = {}) ⇒ Struct
Deletes the DomainNameAccessAssociation resource.
Only the AWS account that created the DomainNameAccessAssociation resource can delete it. To stop an access association source in another AWS account from accessing your private custom domain name, use the RejectDomainNameAccessAssociation operation.
1989 1990 1991 1992 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1989 def delete_domain_name_access_association(params = {}, = {}) req = build_request(:delete_domain_name_access_association, 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.
2014 2015 2016 2017 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2014 def delete_gateway_response(params = {}, = {}) req = build_request(:delete_gateway_response, params) req.send_request() end |
#delete_integration(params = {}) ⇒ Struct
Represents a delete integration.
2042 2043 2044 2045 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2042 def delete_integration(params = {}, = {}) req = build_request(:delete_integration, params) req.send_request() end |
#delete_integration_response(params = {}) ⇒ Struct
Represents a delete integration response.
2075 2076 2077 2078 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2075 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.
2103 2104 2105 2106 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2103 def delete_method(params = {}, = {}) req = build_request(:delete_method, params) req.send_request() end |
#delete_method_response(params = {}) ⇒ Struct
Deletes an existing MethodResponse resource.
2135 2136 2137 2138 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2135 def delete_method_response(params = {}, = {}) req = build_request(:delete_method_response, params) req.send_request() end |
#delete_model(params = {}) ⇒ Struct
Deletes a model.
2159 2160 2161 2162 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2159 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.
2183 2184 2185 2186 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2183 def delete_request_validator(params = {}, = {}) req = build_request(:delete_request_validator, params) req.send_request() end |
#delete_resource(params = {}) ⇒ Struct
Deletes a Resource resource.
2207 2208 2209 2210 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2207 def delete_resource(params = {}, = {}) req = build_request(:delete_resource, params) req.send_request() end |
#delete_rest_api(params = {}) ⇒ Struct
Deletes the specified API.
2227 2228 2229 2230 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2227 def delete_rest_api(params = {}, = {}) req = build_request(:delete_rest_api, params) req.send_request() end |
#delete_stage(params = {}) ⇒ Struct
Deletes a Stage resource.
2251 2252 2253 2254 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2251 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.
2271 2272 2273 2274 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2271 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.
2298 2299 2300 2301 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2298 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.
2319 2320 2321 2322 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2319 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.
2343 2344 2345 2346 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2343 def (params = {}, = {}) req = build_request(:flush_stage_authorizers_cache, params) req.send_request() end |
#flush_stage_cache(params = {}) ⇒ Struct
Flushes a stage's cache.
2367 2368 2369 2370 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2367 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.
2412 2413 2414 2415 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2412 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.
2437 2438 2439 2440 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2437 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.
2488 2489 2490 2491 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2488 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.
2552 2553 2554 2555 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2552 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.
2601 2602 2603 2604 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2601 def (params = {}, = {}) req = build_request(:get_authorizer, params) req.send_request() end |
#get_authorizers(params = {}) ⇒ Types::Authorizers
Describe an existing Authorizers resource.
2649 2650 2651 2652 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2649 def (params = {}, = {}) req = build_request(:get_authorizers, params) req.send_request() end |
#get_base_path_mapping(params = {}) ⇒ Types::BasePathMapping
Describe a BasePathMapping resource.
2691 2692 2693 2694 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2691 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.
2738 2739 2740 2741 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2738 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.
2775 2776 2777 2778 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2775 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.
2817 2818 2819 2820 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2817 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.
2870 2871 2872 2873 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2870 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.
2916 2917 2918 2919 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2916 def get_deployments(params = {}, = {}) req = build_request(:get_deployments, params) req.send_request() end |
#get_documentation_part(params = {}) ⇒ Types::DocumentationPart
Gets a documentation part.
2954 2955 2956 2957 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2954 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.
3017 3018 3019 3020 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3017 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.
3051 3052 3053 3054 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3051 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.
3091 3092 3093 3094 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3091 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.
3171 3172 3173 3174 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3171 def get_domain_name(params = {}, = {}) req = build_request(:get_domain_name, params) req.send_request() end |
#get_domain_name_access_associations(params = {}) ⇒ Types::DomainNameAccessAssociations
Represents a collection on DomainNameAccessAssociations resources.
3217 3218 3219 3220 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3217 def get_domain_name_access_associations(params = {}, = {}) req = build_request(:get_domain_name_access_associations, 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.
3285 3286 3287 3288 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3285 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.
3344 3345 3346 3347 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3344 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.
3385 3386 3387 3388 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3385 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.
3435 3436 3437 3438 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3435 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.
3507 3508 3509 3510 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3507 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.
3555 3556 3557 3558 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3555 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.
3641 3642 3643 3644 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3641 def get_method(params = {}, = {}) req = build_request(:get_method, params) req.send_request() end |
#get_method_response(params = {}) ⇒ Types::MethodResponse
Describes a MethodResponse resource.
3685 3686 3687 3688 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3685 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.
3729 3730 3731 3732 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3729 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.
3760 3761 3762 3763 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3760 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.
3804 3805 3806 3807 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3804 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.
3840 3841 3842 3843 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3840 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.
3881 3882 3883 3884 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3881 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.
3972 3973 3974 3975 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3972 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.
4069 4070 4071 4072 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4069 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.
4128 4129 4130 4131 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4128 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.
4184 4185 4186 4187 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4184 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.
4236 4237 4238 4239 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4236 def get_sdk(params = {}, = {}) req = build_request(:get_sdk, params) req.send_request() end |
#get_sdk_type(params = {}) ⇒ Types::SdkType
Gets an SDK type.
4273 4274 4275 4276 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4273 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
4315 4316 4317 4318 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4315 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.
4394 4395 4396 4397 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4394 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.
4458 4459 4460 4461 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4458 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.
4495 4496 4497 4498 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4495 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.
4555 4556 4557 4558 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4555 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.
4604 4605 4606 4607 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4604 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.
4643 4644 4645 4646 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4643 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.
4694 4695 4696 4697 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4694 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.
4750 4751 4752 4753 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4750 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.
4791 4792 4793 4794 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4791 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.
4836 4837 4838 4839 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4836 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.
4877 4878 4879 4880 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4877 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
4924 4925 4926 4927 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4924 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.
5012 5013 5014 5015 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 5012 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.
5071 5072 5073 5074 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 5071 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.
5258 5259 5260 5261 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 5258 def put_integration(params = {}, = {}) req = build_request(:put_integration, params) req.send_request() end |
#put_integration_response(params = {}) ⇒ Types::IntegrationResponse
Represents a put integration.
5343 5344 5345 5346 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 5343 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.
5491 5492 5493 5494 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 5491 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.
5562 5563 5564 5565 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 5562 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.
5652 5653 5654 5655 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 5652 def put_rest_api(params = {}, = {}) req = build_request(:put_rest_api, params) req.send_request() end |
#reject_domain_name_access_association(params = {}) ⇒ Struct
Rejects a domain name access association with a private custom domain name.
To reject a domain name access association with an access association source in another AWS account, use this operation. To remove a domain name access association with an access association source in your own account, use the DeleteDomainNameAccessAssociation operation.
5682 5683 5684 5685 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 5682 def reject_domain_name_access_association(params = {}, = {}) req = build_request(:reject_domain_name_access_association, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Adds or updates a tag on a given resource.
5710 5711 5712 5713 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 5710 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.
5795 5796 5797 5798 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 5795 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.
5879 5880 5881 5882 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 5879 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.
5903 5904 5905 5906 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 5903 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.
5949 5950 5951 5952 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 5949 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.
6011 6012 6013 6014 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 6011 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.
6076 6077 6078 6079 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 6076 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.
6133 6134 6135 6136 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 6133 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.
6186 6187 6188 6189 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 6186 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.
6242 6243 6244 6245 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 6242 def update_deployment(params = {}, = {}) req = build_request(:update_deployment, params) req.send_request() end |
#update_documentation_part(params = {}) ⇒ Types::DocumentationPart
Updates a documentation part.
6296 6297 6298 6299 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 6296 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.
6346 6347 6348 6349 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 6346 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.
6441 6442 6443 6444 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 6441 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.
6498 6499 6500 6501 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 6498 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.
6586 6587 6588 6589 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 6586 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.
6651 6652 6653 6654 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 6651 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.
6753 6754 6755 6756 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 6753 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.
6813 6814 6815 6816 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 6813 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.
6868 6869 6870 6871 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 6868 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.
6920 6921 6922 6923 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 6920 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.
7017 7018 7019 7020 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 7017 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.
7092 7093 7094 7095 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 7092 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.
7187 7188 7189 7190 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 7187 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.
7246 7247 7248 7249 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 7246 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.
7311 7312 7313 7314 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 7311 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.
7368 7369 7370 7371 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 7368 def update_vpc_link(params = {}, = {}) req = build_request(:update_vpc_link, params) req.send_request() end |