Class: Aws::APIGateway::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::APIGateway::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb
Overview
An API client for APIGateway. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::APIGateway::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#create_api_key(params = {}) ⇒ Types::ApiKey
Create an ApiKey resource.
-
#create_authorizer(params = {}) ⇒ Types::Authorizer
Adds a new Authorizer resource to an existing RestApi resource.
-
#create_base_path_mapping(params = {}) ⇒ Types::BasePathMapping
Creates a new BasePathMapping resource.
-
#create_deployment(params = {}) ⇒ Types::Deployment
Creates a Deployment resource, which makes a specified RestApi callable over the internet.
-
#create_documentation_part(params = {}) ⇒ Types::DocumentationPart
Creates a documentation part.
-
#create_documentation_version(params = {}) ⇒ Types::DocumentationVersion
Creates a documentation version.
-
#create_domain_name(params = {}) ⇒ Types::DomainName
Creates a new domain name.
-
#create_model(params = {}) ⇒ Types::Model
Adds a new Model resource to an existing RestApi resource.
-
#create_request_validator(params = {}) ⇒ Types::RequestValidator
Creates a RequestValidator of a given RestApi.
-
#create_resource(params = {}) ⇒ Types::Resource
Creates a Resource resource.
-
#create_rest_api(params = {}) ⇒ Types::RestApi
Creates a new RestApi resource.
-
#create_stage(params = {}) ⇒ Types::Stage
Creates a new Stage resource that references a pre-existing Deployment for the API.
-
#create_usage_plan(params = {}) ⇒ Types::UsagePlan
Creates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the payload.
-
#create_usage_plan_key(params = {}) ⇒ Types::UsagePlanKey
Creates a usage plan key for adding an existing API key to a usage plan.
-
#create_vpc_link(params = {}) ⇒ Types::VpcLink
Creates a VPC link, under the caller's account in a selected region, in an asynchronous operation that typically takes 2-4 minutes to complete and become operational.
-
#delete_api_key(params = {}) ⇒ Struct
Deletes the ApiKey resource.
-
#delete_authorizer(params = {}) ⇒ Struct
Deletes an existing Authorizer resource.
-
#delete_base_path_mapping(params = {}) ⇒ Struct
Deletes the BasePathMapping resource.
-
#delete_client_certificate(params = {}) ⇒ Struct
Deletes the ClientCertificate resource.
-
#delete_deployment(params = {}) ⇒ Struct
Deletes a Deployment resource.
-
#delete_documentation_part(params = {}) ⇒ Struct
Deletes a documentation part.
-
#delete_documentation_version(params = {}) ⇒ Struct
Deletes a documentation version.
-
#delete_domain_name(params = {}) ⇒ Struct
Deletes the DomainName resource.
-
#delete_gateway_response(params = {}) ⇒ Struct
Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings.
-
#delete_integration(params = {}) ⇒ Struct
Represents a delete integration.
-
#delete_integration_response(params = {}) ⇒ Struct
Represents a delete integration response.
-
#delete_method(params = {}) ⇒ Struct
Deletes an existing Method resource.
-
#delete_method_response(params = {}) ⇒ Struct
Deletes an existing MethodResponse resource.
-
#delete_model(params = {}) ⇒ Struct
Deletes a model.
-
#delete_request_validator(params = {}) ⇒ Struct
Deletes a RequestValidator of a given RestApi.
-
#delete_resource(params = {}) ⇒ Struct
Deletes a Resource resource.
-
#delete_rest_api(params = {}) ⇒ Struct
Deletes the specified API.
-
#delete_stage(params = {}) ⇒ Struct
Deletes a Stage resource.
-
#delete_usage_plan(params = {}) ⇒ Struct
Deletes a usage plan of a given plan Id.
-
#delete_usage_plan_key(params = {}) ⇒ Struct
Deletes a usage plan key and remove the underlying API key from the associated usage plan.
-
#delete_vpc_link(params = {}) ⇒ Struct
Deletes an existing VpcLink of a specified identifier.
-
#flush_stage_authorizers_cache(params = {}) ⇒ Struct
Flushes all authorizer cache entries on a stage.
-
#flush_stage_cache(params = {}) ⇒ Struct
Flushes a stage's cache.
-
#generate_client_certificate(params = {}) ⇒ Types::ClientCertificate
Generates a ClientCertificate resource.
-
#get_account(params = {}) ⇒ Types::Account
Gets information about the current Account resource.
-
#get_api_key(params = {}) ⇒ Types::ApiKey
Gets information about the current ApiKey resource.
-
#get_api_keys(params = {}) ⇒ Types::ApiKeys
Gets information about the current ApiKeys resource.
-
#get_authorizer(params = {}) ⇒ Types::Authorizer
Describe an existing Authorizer resource.
-
#get_authorizers(params = {}) ⇒ Types::Authorizers
Describe an existing Authorizers resource.
-
#get_base_path_mapping(params = {}) ⇒ Types::BasePathMapping
Describe a BasePathMapping resource.
-
#get_base_path_mappings(params = {}) ⇒ Types::BasePathMappings
Represents a collection of BasePathMapping resources.
-
#get_client_certificate(params = {}) ⇒ Types::ClientCertificate
Gets information about the current ClientCertificate resource.
-
#get_client_certificates(params = {}) ⇒ Types::ClientCertificates
Gets a collection of ClientCertificate resources.
-
#get_deployment(params = {}) ⇒ Types::Deployment
Gets information about a Deployment resource.
-
#get_deployments(params = {}) ⇒ Types::Deployments
Gets information about a Deployments collection.
-
#get_documentation_part(params = {}) ⇒ Types::DocumentationPart
Gets a documentation part.
-
#get_documentation_parts(params = {}) ⇒ Types::DocumentationParts
Gets documentation parts.
-
#get_documentation_version(params = {}) ⇒ Types::DocumentationVersion
Gets a documentation version.
-
#get_documentation_versions(params = {}) ⇒ Types::DocumentationVersions
Gets documentation versions.
-
#get_domain_name(params = {}) ⇒ Types::DomainName
Represents a domain name that is contained in a simpler, more intuitive URL that can be called.
-
#get_domain_names(params = {}) ⇒ Types::DomainNames
Represents a collection of DomainName resources.
-
#get_export(params = {}) ⇒ Types::ExportResponse
Exports a deployed version of a RestApi in a specified format.
-
#get_gateway_response(params = {}) ⇒ Types::GatewayResponse
Gets a GatewayResponse of a specified response type on the given RestApi.
-
#get_gateway_responses(params = {}) ⇒ Types::GatewayResponses
Gets the GatewayResponses collection on the given RestApi.
-
#get_integration(params = {}) ⇒ Types::Integration
Get the integration settings.
-
#get_integration_response(params = {}) ⇒ Types::IntegrationResponse
Represents a get integration response.
-
#get_method(params = {}) ⇒ Types::Method
Describe an existing Method resource.
-
#get_method_response(params = {}) ⇒ Types::MethodResponse
Describes a MethodResponse resource.
-
#get_model(params = {}) ⇒ Types::Model
Describes an existing model defined for a RestApi resource.
-
#get_model_template(params = {}) ⇒ Types::Template
Generates a sample mapping template that can be used to transform a payload into the structure of a model.
-
#get_models(params = {}) ⇒ Types::Models
Describes existing Models defined for a RestApi resource.
-
#get_request_validator(params = {}) ⇒ Types::RequestValidator
Gets a RequestValidator of a given RestApi.
-
#get_request_validators(params = {}) ⇒ Types::RequestValidators
Gets the RequestValidators collection of a given RestApi.
-
#get_resource(params = {}) ⇒ Types::Resource
Lists information about a resource.
-
#get_resources(params = {}) ⇒ Types::Resources
Lists information about a collection of Resource resources.
-
#get_rest_api(params = {}) ⇒ Types::RestApi
Lists the RestApi resource in the collection.
-
#get_rest_apis(params = {}) ⇒ Types::RestApis
Lists the RestApis resources for your collection.
-
#get_sdk(params = {}) ⇒ Types::SdkResponse
Generates a client SDK for a RestApi and Stage.
-
#get_sdk_type(params = {}) ⇒ Types::SdkType
Gets an SDK type.
-
#get_sdk_types(params = {}) ⇒ Types::SdkTypes
Gets SDK types.
-
#get_stage(params = {}) ⇒ Types::Stage
Gets information about a Stage resource.
-
#get_stages(params = {}) ⇒ Types::Stages
Gets information about one or more Stage resources.
-
#get_tags(params = {}) ⇒ Types::Tags
Gets the Tags collection for a given resource.
-
#get_usage(params = {}) ⇒ Types::Usage
Gets the usage data of a usage plan in a specified time interval.
-
#get_usage_plan(params = {}) ⇒ Types::UsagePlan
Gets a usage plan of a given plan identifier.
-
#get_usage_plan_key(params = {}) ⇒ Types::UsagePlanKey
Gets a usage plan key of a given key identifier.
-
#get_usage_plan_keys(params = {}) ⇒ Types::UsagePlanKeys
Gets all the usage plan keys representing the API keys added to a specified usage plan.
-
#get_usage_plans(params = {}) ⇒ Types::UsagePlans
Gets all the usage plans of the caller's account.
-
#get_vpc_link(params = {}) ⇒ Types::VpcLink
Gets a specified VPC link under the caller's account in a region.
-
#get_vpc_links(params = {}) ⇒ Types::VpcLinks
Gets the VpcLinks collection under the caller's account in a selected region.
-
#import_api_keys(params = {}) ⇒ Types::ApiKeyIds
Import API keys from an external source, such as a CSV-formatted file.
-
#import_documentation_parts(params = {}) ⇒ Types::DocumentationPartIds
Imports documentation parts.
-
#import_rest_api(params = {}) ⇒ Types::RestApi
A feature of the API Gateway control service for creating a new API from an external API definition file.
-
#put_gateway_response(params = {}) ⇒ Types::GatewayResponse
Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.
-
#put_integration(params = {}) ⇒ Types::Integration
Sets up a method's integration.
-
#put_integration_response(params = {}) ⇒ Types::IntegrationResponse
Represents a put integration.
-
#put_method(params = {}) ⇒ Types::Method
Add a method to an existing Resource resource.
-
#put_method_response(params = {}) ⇒ Types::MethodResponse
Adds a MethodResponse to an existing Method resource.
-
#put_rest_api(params = {}) ⇒ Types::RestApi
A feature of the API Gateway control service for updating an existing API with an input of external API definitions.
-
#tag_resource(params = {}) ⇒ Struct
Adds or updates a tag on a given resource.
-
#test_invoke_authorizer(params = {}) ⇒ Types::TestInvokeAuthorizerResponse
Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body.
-
#test_invoke_method(params = {}) ⇒ Types::TestInvokeMethodResponse
Simulate the invocation of a Method in your RestApi with headers, parameters, and an incoming request body.
-
#untag_resource(params = {}) ⇒ Struct
Removes a tag from a given resource.
-
#update_account(params = {}) ⇒ Types::Account
Changes information about the current Account resource.
-
#update_api_key(params = {}) ⇒ Types::ApiKey
Changes information about an ApiKey resource.
-
#update_authorizer(params = {}) ⇒ Types::Authorizer
Updates an existing Authorizer resource.
-
#update_base_path_mapping(params = {}) ⇒ Types::BasePathMapping
Changes information about the BasePathMapping resource.
-
#update_client_certificate(params = {}) ⇒ Types::ClientCertificate
Changes information about an ClientCertificate resource.
-
#update_deployment(params = {}) ⇒ Types::Deployment
Changes information about a Deployment resource.
-
#update_documentation_part(params = {}) ⇒ Types::DocumentationPart
Updates a documentation part.
-
#update_documentation_version(params = {}) ⇒ Types::DocumentationVersion
Updates a documentation version.
-
#update_domain_name(params = {}) ⇒ Types::DomainName
Changes information about the DomainName resource.
-
#update_gateway_response(params = {}) ⇒ Types::GatewayResponse
Updates a GatewayResponse of a specified response type on the given RestApi.
-
#update_integration(params = {}) ⇒ Types::Integration
Represents an update integration.
-
#update_integration_response(params = {}) ⇒ Types::IntegrationResponse
Represents an update integration response.
-
#update_method(params = {}) ⇒ Types::Method
Updates an existing Method resource.
-
#update_method_response(params = {}) ⇒ Types::MethodResponse
Updates an existing MethodResponse resource.
-
#update_model(params = {}) ⇒ Types::Model
Changes information about a model.
-
#update_request_validator(params = {}) ⇒ Types::RequestValidator
Updates a RequestValidator of a given RestApi.
-
#update_resource(params = {}) ⇒ Types::Resource
Changes information about a Resource resource.
-
#update_rest_api(params = {}) ⇒ Types::RestApi
Changes information about the specified API.
-
#update_stage(params = {}) ⇒ Types::Stage
Changes information about a Stage resource.
-
#update_usage(params = {}) ⇒ Types::Usage
Grants a temporary extension to the remaining quota of a usage plan associated with a specified API key.
-
#update_usage_plan(params = {}) ⇒ Types::UsagePlan
Updates a usage plan of a given plan Id.
-
#update_vpc_link(params = {}) ⇒ Types::VpcLink
Updates an existing VpcLink of a specified identifier.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
446 447 448 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 446 def initialize(*args) super end |
Instance Method Details
#create_api_key(params = {}) ⇒ Types::ApiKey
Create an ApiKey resource.
534 535 536 537 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 534 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.
664 665 666 667 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 664 def (params = {}, = {}) req = build_request(:create_authorizer, params) req.send_request() end |
#create_base_path_mapping(params = {}) ⇒ Types::BasePathMapping
Creates a new BasePathMapping resource.
711 712 713 714 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 711 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.
797 798 799 800 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 797 def create_deployment(params = {}, = {}) req = build_request(:create_deployment, params) req.send_request() end |
#create_documentation_part(params = {}) ⇒ Types::DocumentationPart
Creates a documentation part.
848 849 850 851 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 848 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
890 891 892 893 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 890 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.
1036 1037 1038 1039 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1036 def create_domain_name(params = {}, = {}) req = build_request(:create_domain_name, params) req.send_request() end |
#create_model(params = {}) ⇒ Types::Model
Adds a new Model resource to an existing RestApi resource.
1087 1088 1089 1090 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1087 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.
1134 1135 1136 1137 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1134 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.
1219 1220 1221 1222 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1219 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.
1339 1340 1341 1342 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1339 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.
1477 1478 1479 1480 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1477 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.
1569 1570 1571 1572 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1569 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.
1612 1613 1614 1615 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1612 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.
1673 1674 1675 1676 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1673 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.
1693 1694 1695 1696 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1693 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.
1717 1718 1719 1720 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1717 def (params = {}, = {}) req = build_request(:delete_authorizer, params) req.send_request() end |
#delete_base_path_mapping(params = {}) ⇒ Struct
Deletes the BasePathMapping resource.
1743 1744 1745 1746 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1743 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.
1763 1764 1765 1766 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1763 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.
1788 1789 1790 1791 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1788 def delete_deployment(params = {}, = {}) req = build_request(:delete_deployment, params) req.send_request() end |
#delete_documentation_part(params = {}) ⇒ Struct
Deletes a documentation part
1812 1813 1814 1815 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1812 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.
1836 1837 1838 1839 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1836 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.
1856 1857 1858 1859 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1856 def delete_domain_name(params = {}, = {}) req = build_request(:delete_domain_name, params) req.send_request() end |
#delete_gateway_response(params = {}) ⇒ Struct
Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings.
1881 1882 1883 1884 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1881 def delete_gateway_response(params = {}, = {}) req = build_request(:delete_gateway_response, params) req.send_request() end |
#delete_integration(params = {}) ⇒ Struct
Represents a delete integration.
1909 1910 1911 1912 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1909 def delete_integration(params = {}, = {}) req = build_request(:delete_integration, params) req.send_request() end |
#delete_integration_response(params = {}) ⇒ Struct
Represents a delete integration response.
1942 1943 1944 1945 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1942 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.
1970 1971 1972 1973 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1970 def delete_method(params = {}, = {}) req = build_request(:delete_method, params) req.send_request() end |
#delete_method_response(params = {}) ⇒ Struct
Deletes an existing MethodResponse resource.
2002 2003 2004 2005 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2002 def delete_method_response(params = {}, = {}) req = build_request(:delete_method_response, params) req.send_request() end |
#delete_model(params = {}) ⇒ Struct
Deletes a model.
2026 2027 2028 2029 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2026 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.
2050 2051 2052 2053 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2050 def delete_request_validator(params = {}, = {}) req = build_request(:delete_request_validator, params) req.send_request() end |
#delete_resource(params = {}) ⇒ Struct
Deletes a Resource resource.
2074 2075 2076 2077 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2074 def delete_resource(params = {}, = {}) req = build_request(:delete_resource, params) req.send_request() end |
#delete_rest_api(params = {}) ⇒ Struct
Deletes the specified API.
2094 2095 2096 2097 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2094 def delete_rest_api(params = {}, = {}) req = build_request(:delete_rest_api, params) req.send_request() end |
#delete_stage(params = {}) ⇒ Struct
Deletes a Stage resource.
2118 2119 2120 2121 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2118 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.
2138 2139 2140 2141 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2138 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.
2165 2166 2167 2168 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2165 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.
2186 2187 2188 2189 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2186 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.
2210 2211 2212 2213 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2210 def (params = {}, = {}) req = build_request(:flush_stage_authorizers_cache, params) req.send_request() end |
#flush_stage_cache(params = {}) ⇒ Struct
Flushes a stage's cache.
2234 2235 2236 2237 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2234 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.
2279 2280 2281 2282 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2279 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.
2304 2305 2306 2307 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2304 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.
2355 2356 2357 2358 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2355 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.
2419 2420 2421 2422 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2419 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.
2468 2469 2470 2471 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2468 def (params = {}, = {}) req = build_request(:get_authorizer, params) req.send_request() end |
#get_authorizers(params = {}) ⇒ Types::Authorizers
Describe an existing Authorizers resource.
2516 2517 2518 2519 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2516 def (params = {}, = {}) req = build_request(:get_authorizers, params) req.send_request() end |
#get_base_path_mapping(params = {}) ⇒ Types::BasePathMapping
Describe a BasePathMapping resource.
2553 2554 2555 2556 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2553 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.
2595 2596 2597 2598 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2595 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.
2632 2633 2634 2635 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2632 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.
2674 2675 2676 2677 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2674 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.
2727 2728 2729 2730 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2727 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.
2773 2774 2775 2776 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2773 def get_deployments(params = {}, = {}) req = build_request(:get_deployments, params) req.send_request() end |
#get_documentation_part(params = {}) ⇒ Types::DocumentationPart
Gets a documentation part.
2811 2812 2813 2814 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2811 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.
2874 2875 2876 2877 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2874 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.
2908 2909 2910 2911 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2908 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.
2948 2949 2950 2951 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2948 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.
3014 3015 3016 3017 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3014 def get_domain_name(params = {}, = {}) req = build_request(:get_domain_name, params) req.send_request() end |
#get_domain_names(params = {}) ⇒ Types::DomainNames
Represents a collection of DomainName resources.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3073 3074 3075 3076 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3073 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.
3132 3133 3134 3135 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3132 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.
3173 3174 3175 3176 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3173 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.
3223 3224 3225 3226 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3223 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.
3295 3296 3297 3298 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3295 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.
3343 3344 3345 3346 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3343 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.
3429 3430 3431 3432 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3429 def get_method(params = {}, = {}) req = build_request(:get_method, params) req.send_request() end |
#get_method_response(params = {}) ⇒ Types::MethodResponse
Describes a MethodResponse resource.
3473 3474 3475 3476 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3473 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.
3517 3518 3519 3520 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3517 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.
3548 3549 3550 3551 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3548 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.
3592 3593 3594 3595 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3592 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.
3628 3629 3630 3631 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3628 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.
3669 3670 3671 3672 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3669 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.
3760 3761 3762 3763 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3760 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.
3857 3858 3859 3860 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3857 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.
3915 3916 3917 3918 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3915 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.
3970 3971 3972 3973 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3970 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.
4022 4023 4024 4025 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4022 def get_sdk(params = {}, = {}) req = build_request(:get_sdk, params) req.send_request() end |
#get_sdk_type(params = {}) ⇒ Types::SdkType
Gets an SDK type.
4059 4060 4061 4062 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4059 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
4101 4102 4103 4104 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4101 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.
4180 4181 4182 4183 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4180 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.
4244 4245 4246 4247 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4244 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.
4281 4282 4283 4284 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4281 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.
4341 4342 4343 4344 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4341 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.
4390 4391 4392 4393 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4390 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.
4429 4430 4431 4432 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4429 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.
4480 4481 4482 4483 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4480 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.
4536 4537 4538 4539 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4536 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.
4577 4578 4579 4580 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4577 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.
4622 4623 4624 4625 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4622 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.
4663 4664 4665 4666 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4663 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
4710 4711 4712 4713 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4710 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.
4797 4798 4799 4800 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4797 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.
4856 4857 4858 4859 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4856 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.
5043 5044 5045 5046 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 5043 def put_integration(params = {}, = {}) req = build_request(:put_integration, params) req.send_request() end |
#put_integration_response(params = {}) ⇒ Types::IntegrationResponse
Represents a put integration.