Client

apigateway

R Documentation

Amazon API Gateway¶

Description¶

Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows developers to securely connect mobile and web applications to APIs that run on Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.

Usage¶

apigateway(
  config = list(),
  credentials = list(),
  endpoint = NULL,
  region = NULL
)

Arguments¶

config

Optional configuration of credentials, endpoint, and/or region.

credentials:
- creds:
  - access_key_id: AWS access key ID
  - secret_access_key: AWS secret access key
  - session_token: AWS temporary session token
- profile: The name of a profile to use. If not given, then the default profile is used.
- anonymous: Set anonymous credentials.
endpoint: The complete URL to use for the constructed client.
region: The AWS Region used in instantiating the client.
close_connection: Immediately close all HTTP connections.
timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.
sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

credentials

Optional credentials shorthand for the config parameter

creds:
- access_key_id: AWS access key ID
- secret_access_key: AWS secret access key
- session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.

endpoint

Optional shorthand for complete URL to use for the constructed client.

region

Optional shorthand for AWS Region used in instantiating the client.

Value¶

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax¶

svc <- apigateway(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations¶

create_api_key: Create an ApiKey resource
create_authorizer: Adds a new Authorizer resource to an existing RestApi resource
create_base_path_mapping: Creates a new BasePathMapping resource
create_deployment: Creates a Deployment resource, which makes a specified RestApi callable over the internet
create_documentation_part: Creates a documentation part
create_documentation_version: Creates a documentation version
create_domain_name: Creates a new domain name
create_model: Adds a new Model resource to an existing RestApi resource
create_request_validator: Creates a RequestValidator of a given RestApi
create_resource: Creates a Resource resource
create_rest_api: Creates a new RestApi resource
create_stage: Creates a new Stage resource that references a pre-existing Deployment for the API
create_usage_plan: 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: Creates a usage plan key for adding an existing API key to a usage plan
create_vpc_link: 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: Deletes the ApiKey resource
delete_authorizer: Deletes an existing Authorizer resource
delete_base_path_mapping: Deletes the BasePathMapping resource
delete_client_certificate: Deletes the ClientCertificate resource
delete_deployment: Deletes a Deployment resource
delete_documentation_part: Deletes a documentation part
delete_documentation_version: Deletes a documentation version
delete_domain_name: Deletes the DomainName resource
delete_gateway_response: Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings
delete_integration: Represents a delete integration
delete_integration_response: Represents a delete integration response
delete_method: Deletes an existing Method resource
delete_method_response: Deletes an existing MethodResponse resource
delete_model: Deletes a model
delete_request_validator: Deletes a RequestValidator of a given RestApi
delete_resource: Deletes a Resource resource
delete_rest_api: Deletes the specified API
delete_stage: Deletes a Stage resource
delete_usage_plan: Deletes a usage plan of a given plan Id
delete_usage_plan_key: Deletes a usage plan key and remove the underlying API key from the associated usage plan
delete_vpc_link: Deletes an existing VpcLink of a specified identifier
flush_stage_authorizers_cache: Flushes all authorizer cache entries on a stage
flush_stage_cache: Flushes a stage's cache
generate_client_certificate: Generates a ClientCertificate resource
get_account: Gets information about the current Account resource
get_api_key: Gets information about the current ApiKey resource
get_api_keys: Gets information about the current ApiKeys resource
get_authorizer: Describe an existing Authorizer resource
get_authorizers: Describe an existing Authorizers resource
get_base_path_mapping: Describe a BasePathMapping resource
get_base_path_mappings: Represents a collection of BasePathMapping resources
get_client_certificate: Gets information about the current ClientCertificate resource
get_client_certificates: Gets a collection of ClientCertificate resources
get_deployment: Gets information about a Deployment resource
get_deployments: Gets information about a Deployments collection
get_documentation_part: Gets a documentation part
get_documentation_parts: Gets documentation parts
get_documentation_version: Gets a documentation version
get_documentation_versions: Gets documentation versions
get_domain_name: Represents a domain name that is contained in a simpler, more intuitive URL that can be called
get_domain_names: Represents a collection of DomainName resources
get_export: Exports a deployed version of a RestApi in a specified format
get_gateway_response: Gets a GatewayResponse of a specified response type on the given RestApi
get_gateway_responses: Gets the GatewayResponses collection on the given RestApi
get_integration: Get the integration settings
get_integration_response: Represents a get integration response
get_method: Describe an existing Method resource
get_method_response: Describes a MethodResponse resource
get_model: Describes an existing model defined for a RestApi resource
get_models: Describes existing Models defined for a RestApi resource
get_model_template: Generates a sample mapping template that can be used to transform a payload into the structure of a model
get_request_validator: Gets a RequestValidator of a given RestApi
get_request_validators: Gets the RequestValidators collection of a given RestApi
get_resource: Lists information about a resource
get_resources: Lists information about a collection of Resource resources
get_rest_api: Lists the RestApi resource in the collection
get_rest_apis: Lists the RestApis resources for your collection
get_sdk: Generates a client SDK for a RestApi and Stage
get_sdk_type: Gets an SDK type
get_sdk_types: Gets SDK types
get_stage: Gets information about a Stage resource
get_stages: Gets information about one or more Stage resources
get_tags: Gets the Tags collection for a given resource
get_usage: Gets the usage data of a usage plan in a specified time interval
get_usage_plan: Gets a usage plan of a given plan identifier
get_usage_plan_key: Gets a usage plan key of a given key identifier
get_usage_plan_keys: Gets all the usage plan keys representing the API keys added to a specified usage plan
get_usage_plans: Gets all the usage plans of the caller's account
get_vpc_link: Gets a specified VPC link under the caller's account in a region
get_vpc_links: Gets the VpcLinks collection under the caller's account in a selected region
import_api_keys: Import API keys from an external source, such as a CSV-formatted file
import_documentation_parts: Imports documentation parts
import_rest_api: A feature of the API Gateway control service for creating a new API from an external API definition file
put_gateway_response: Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi
put_integration: Sets up a method's integration
put_integration_response: Represents a put integration
put_method: Add a method to an existing Resource resource
put_method_response: Adds a MethodResponse to an existing Method resource
put_rest_api: A feature of the API Gateway control service for updating an existing API with an input of external API definitions
tag_resource: Adds or updates a tag on a given resource
test_invoke_authorizer: Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body
test_invoke_method: Simulate the invocation of a Method in your RestApi with headers, parameters, and an incoming request body
untag_resource: Removes a tag from a given resource
update_account: Changes information about the current Account resource
update_api_key: Changes information about an ApiKey resource
update_authorizer: Updates an existing Authorizer resource
update_base_path_mapping: Changes information about the BasePathMapping resource
update_client_certificate: Changes information about an ClientCertificate resource
update_deployment: Changes information about a Deployment resource
update_documentation_part: Updates a documentation part
update_documentation_version: Updates a documentation version
update_domain_name: Changes information about the DomainName resource
update_gateway_response: Updates a GatewayResponse of a specified response type on the given RestApi
update_integration: Represents an update integration
update_integration_response: Represents an update integration response
update_method: Updates an existing Method resource
update_method_response: Updates an existing MethodResponse resource
update_model: Changes information about a model
update_request_validator: Updates a RequestValidator of a given RestApi
update_resource: Changes information about a Resource resource
update_rest_api: Changes information about the specified API
update_stage: Changes information about a Stage resource
update_usage: Grants a temporary extension to the remaining quota of a usage plan associated with a specified API key
update_usage_plan: Updates a usage plan of a given plan Id
update_vpc_link: Updates an existing VpcLink of a specified identifier

Examples¶

## Not run: 
svc <- apigateway()
svc$create_api_key(
  Foo = 123
)

## End(Not run)