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.
481 482 483 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 481 def initialize(*args) super end |
Instance Method Details
#create_api_key(params = {}) ⇒ Types::ApiKey
Create an ApiKey resource.
569 570 571 572 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 569 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.
743 744 745 746 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 743 def (params = {}, = {}) req = build_request(:create_authorizer, params) req.send_request() end |
#create_base_path_mapping(params = {}) ⇒ Types::BasePathMapping
Creates a new BasePathMapping resource.
795 796 797 798 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 795 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.
881 882 883 884 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 881 def create_deployment(params = {}, = {}) req = build_request(:create_deployment, params) req.send_request() end |
#create_documentation_part(params = {}) ⇒ Types::DocumentationPart
Creates a documentation part.
932 933 934 935 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 932 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
974 975 976 977 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 974 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.
1152 1153 1154 1155 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1152 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.
1205 1206 1207 1208 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1205 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.
1256 1257 1258 1259 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1256 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.
1303 1304 1305 1306 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1303 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.
1390 1391 1392 1393 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1390 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.
1530 1531 1532 1533 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1530 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.
1668 1669 1670 1671 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1668 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.
1760 1761 1762 1763 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1760 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.
1803 1804 1805 1806 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1803 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.
1864 1865 1866 1867 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1864 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.
1884 1885 1886 1887 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1884 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.
1908 1909 1910 1911 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1908 def (params = {}, = {}) req = build_request(:delete_authorizer, params) req.send_request() end |
#delete_base_path_mapping(params = {}) ⇒ Struct
Deletes the BasePathMapping resource.
1939 1940 1941 1942 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1939 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.
1959 1960 1961 1962 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1959 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.
1984 1985 1986 1987 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1984 def delete_deployment(params = {}, = {}) req = build_request(:delete_deployment, params) req.send_request() end |
#delete_documentation_part(params = {}) ⇒ Struct
Deletes a documentation part
2008 2009 2010 2011 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2008 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.
2032 2033 2034 2035 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2032 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.
2057 2058 2059 2060 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2057 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 Amazon Web Services account that created the DomainNameAccessAssociation resource can delete it. To stop an access association source in another Amazon Web Services account from accessing your private custom domain name, use the RejectDomainNameAccessAssociation operation.
2083 2084 2085 2086 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2083 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.
2108 2109 2110 2111 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2108 def delete_gateway_response(params = {}, = {}) req = build_request(:delete_gateway_response, params) req.send_request() end |
#delete_integration(params = {}) ⇒ Struct
Represents a delete integration.
2136 2137 2138 2139 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2136 def delete_integration(params = {}, = {}) req = build_request(:delete_integration, params) req.send_request() end |
#delete_integration_response(params = {}) ⇒ Struct
Represents a delete integration response.
2169 2170 2171 2172 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2169 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.
2197 2198 2199 2200 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2197 def delete_method(params = {}, = {}) req = build_request(:delete_method, params) req.send_request() end |
#delete_method_response(params = {}) ⇒ Struct
Deletes an existing MethodResponse resource.
2229 2230 2231 2232 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2229 def delete_method_response(params = {}, = {}) req = build_request(:delete_method_response, params) req.send_request() end |
#delete_model(params = {}) ⇒ Struct
Deletes a model.
2253 2254 2255 2256 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2253 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.
2277 2278 2279 2280 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2277 def delete_request_validator(params = {}, = {}) req = build_request(:delete_request_validator, params) req.send_request() end |
#delete_resource(params = {}) ⇒ Struct
Deletes a Resource resource.
2301 2302 2303 2304 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2301 def delete_resource(params = {}, = {}) req = build_request(:delete_resource, params) req.send_request() end |
#delete_rest_api(params = {}) ⇒ Struct
Deletes the specified API.
2321 2322 2323 2324 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2321 def delete_rest_api(params = {}, = {}) req = build_request(:delete_rest_api, params) req.send_request() end |
#delete_stage(params = {}) ⇒ Struct
Deletes a Stage resource.
2345 2346 2347 2348 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2345 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.
2365 2366 2367 2368 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2365 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.
2392 2393 2394 2395 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2392 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.
2413 2414 2415 2416 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2413 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.
2437 2438 2439 2440 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2437 def (params = {}, = {}) req = build_request(:flush_stage_authorizers_cache, params) req.send_request() end |
#flush_stage_cache(params = {}) ⇒ Struct
Flushes a stage's cache.
2461 2462 2463 2464 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2461 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.
2506 2507 2508 2509 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2506 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.
2531 2532 2533 2534 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2531 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.
2582 2583 2584 2585 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2582 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.
2646 2647 2648 2649 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2646 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.
2709 2710 2711 2712 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2709 def (params = {}, = {}) req = build_request(:get_authorizer, params) req.send_request() end |
#get_authorizers(params = {}) ⇒ Types::Authorizers
Describe an existing Authorizers resource.
2770 2771 2772 2773 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2770 def (params = {}, = {}) req = build_request(:get_authorizers, params) req.send_request() end |
#get_base_path_mapping(params = {}) ⇒ Types::BasePathMapping
Describe a BasePathMapping resource.
2812 2813 2814 2815 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2812 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.
2859 2860 2861 2862 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2859 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.
2896 2897 2898 2899 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2896 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.
2938 2939 2940 2941 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2938 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.
2991 2992 2993 2994 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2991 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.
3037 3038 3039 3040 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3037 def get_deployments(params = {}, = {}) req = build_request(:get_deployments, params) req.send_request() end |
#get_documentation_part(params = {}) ⇒ Types::DocumentationPart
Gets a documentation part.
3075 3076 3077 3078 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3075 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.
3138 3139 3140 3141 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3138 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.
3172 3173 3174 3175 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3172 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.
3212 3213 3214 3215 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3212 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.
3296 3297 3298 3299 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3296 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.
3343 3344 3345 3346 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3343 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.
3413 3414 3415 3416 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3413 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.
3472 3473 3474 3475 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3472 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.
3513 3514 3515 3516 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3513 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.
3563 3564 3565 3566 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3563 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.
3639 3640 3641 3642 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3639 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.
3687 3688 3689 3690 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3687 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.
3775 3776 3777 3778 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3775 def get_method(params = {}, = {}) req = build_request(:get_method, params) req.send_request() end |
#get_method_response(params = {}) ⇒ Types::MethodResponse
Describes a MethodResponse resource.
3819 3820 3821 3822 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3819 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.
3863 3864 3865 3866 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3863 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.
3894 3895 3896 3897 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3894 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.
3938 3939 3940 3941 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3938 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.
3974 3975 3976 3977 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3974 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.
4015 4016 4017 4018 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4015 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.
4108 4109 4110 4111 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4108 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.
4207 4208 4209 4210 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4207 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.
4274 4275 4276 4277 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4274 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.
4334 4335 4336 4337 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4334 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.
4386 4387 4388 4389 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4386 def get_sdk(params = {}, = {}) req = build_request(:get_sdk, params) req.send_request() end |
#get_sdk_type(params = {}) ⇒ Types::SdkType
Gets an SDK type.
4423 4424 4425 4426 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4423 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
4465 4466 4467 4468 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4465 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.
4544 4545 4546 4547 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4544 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.
4608 4609 4610 4611 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4608 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.
4645 4646 4647 4648 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4645 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.
4705 4706 4707 4708 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4705 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.
4754 4755 4756 4757 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4754 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.
4793 4794 4795 4796 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4793 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.
4844 4845 4846 4847 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4844 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.
4900 4901 4902 4903 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4900 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.
4941 4942 4943 4944 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4941 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.
4986 4987 4988 4989 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4986 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.
5027 5028 5029 5030 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 5027 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
5074 5075 5076 5077 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 5074 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.
5170 5171 5172 5173 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 5170 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.
5229 5230 5231 5232 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 5229 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.
5429 5430 5431 5432 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 5429 def put_integration(params = {}, = {}) req = build_request(:put_integration, params) req.send_request() end |
#put_integration_response(params = {}) ⇒ Types::IntegrationResponse
Represents a put integration.
5514 5515 5516 5517 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 5514 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.
5666 5667 5668 5669 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 5666 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.
5737 5738 5739 5740 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 5737 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.
5835 5836 5837 5838 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 5835 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 Amazon Web Services account, use this operation. To remove a domain name access association with an access association source in your own account, use the DeleteDomainNameAccessAssociation operation.
5866 5867 5868 5869 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 5866 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.
5894 5895 5896 5897 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 5894 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.
5979 5980 5981 5982 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 5979 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.
6063 6064 6065 6066 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 6063 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.
6087 6088 6089 6090 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 6087 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.
6133 6134 6135 6136 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 6133 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.
6195 6196 6197 6198 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 6195 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. For a JWT authorizer, the
only JWT patch operation is replace on the path /jwtConfiguration.
Its value is the complete configuration as a JSON string in the
JwtConfigurationInput shape. This replaces the entire configuration;
nothing from the previous configuration is retained. A replace
operation on the path /type is supported in both directions.
6279 6280 6281 6282 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 6279 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.
6336 6337 6338 6339 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 6336 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.
6389 6390 6391 6392 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 6389 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.
6445 6446 6447 6448 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 6445 def update_deployment(params = {}, = {}) req = build_request(:update_deployment, params) req.send_request() end |
#update_documentation_part(params = {}) ⇒ Types::DocumentationPart
Updates a documentation part.
6499 6500 6501 6502 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 6499 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.
6549 6550 6551 6552 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 6549 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.
6648 6649 6650 6651 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 6648 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.
6705 6706 6707 6708 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 6705 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.
6797 6798 6799 6800 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 6797 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.
6862 6863 6864 6865 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 6862 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.
6966 6967 6968 6969 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 6966 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.
7026 7027 7028 7029 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 7026 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.
7081 7082 7083 7084 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 7081 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.
7133 7134 7135 7136 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 7133 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.
7232 7233 7234 7235 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 7232 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.
7315 7316 7317 7318 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 7315 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.
7410 7411 7412 7413 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 7410 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.
7469 7470 7471 7472 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 7469 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.
7534 7535 7536 7537 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 7534 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.
7591 7592 7593 7594 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 7591 def update_vpc_link(params = {}, = {}) req = build_request(:update_vpc_link, params) req.send_request() end |