AmazonApiGatewayV2¶

Description¶

Amazon API Gateway V2

Usage¶

apigatewayv2(
  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
- use_dual_stack: Set this to true to use the dualstack (IPv4 and IPv6) endpoint for a service, where available, falling back to the regular endpoint when it isn't. Defaults to the AWS_USE_DUALSTACK_ENDPOINT environment variable when unset.
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 <- apigatewayv2(
  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",
    use_dual_stack = "logical"
  ),
  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`	Creates an Api resource
`create_api_mapping`	Creates an API mapping
`create_authorizer`	Creates an Authorizer for an API
`create_deployment`	Creates a Deployment for an API
`create_domain_name`	Creates a domain name
`create_integration`	Creates an Integration
`create_integration_response`	Creates an IntegrationResponses
`create_model`	Creates a Model for an API
`create_portal`	Creates a portal
`create_portal_product`	Creates a new portal product
`create_product_page`	Creates a new product page for a portal product
`create_product_rest_endpoint_page`	Creates a product REST endpoint page for a portal product
`create_route`	Creates a Route for an API
`create_route_response`	Creates a RouteResponse for a Route
`create_routing_rule`	Creates a RoutingRule
`create_stage`	Creates a Stage for an API
`create_vpc_link`	Creates a VPC link
`delete_access_log_settings`	Deletes the AccessLogSettings for a Stage
`delete_api`	Deletes an Api resource
`delete_api_mapping`	Deletes an API mapping
`delete_authorizer`	Deletes an Authorizer
`delete_cors_configuration`	Deletes a CORS configuration
`delete_deployment`	Deletes a Deployment
`delete_domain_name`	Deletes a domain name
`delete_integration`	Deletes an Integration
`delete_integration_response`	Deletes an IntegrationResponses
`delete_model`	Deletes a Model
`delete_portal`	Deletes a portal
`delete_portal_product`	Deletes a portal product
`delete_portal_product_sharing_policy`	Deletes the sharing policy for a portal product
`delete_product_page`	Deletes a product page of a portal product
`delete_product_rest_endpoint_page`	Deletes a product REST endpoint page
`delete_route`	Deletes a Route
`delete_route_request_parameter`	Deletes a route request parameter
`delete_route_response`	Deletes a RouteResponse
`delete_route_settings`	Deletes the RouteSettings for a stage
`delete_routing_rule`	Deletes a routing rule
`delete_stage`	Deletes a Stage
`delete_vpc_link`	Deletes a VPC link
`disable_portal`	Deletes the publication of a portal portal
`export_api`	Export api
`get_api`	Gets an Api resource
`get_api_mapping`	Gets an API mapping
`get_api_mappings`	Gets API mappings
`get_apis`	Gets a collection of Api resources
`get_authorizer`	Gets an Authorizer
`get_authorizers`	Gets the Authorizers for an API
`get_deployment`	Gets a Deployment
`get_deployments`	Gets the Deployments for an API
`get_domain_name`	Gets a domain name
`get_domain_names`	Gets the domain names for an AWS account
`get_integration`	Gets an Integration
`get_integration_response`	Gets an IntegrationResponses
`get_integration_responses`	Gets the IntegrationResponses for an Integration
`get_integrations`	Gets the Integrations for an API
`get_model`	Gets a Model
`get_models`	Gets the Models for an API
`get_model_template`	Gets a model template
`get_portal`	Gets a portal
`get_portal_product`	Gets a portal product
`get_portal_product_sharing_policy`	Gets the sharing policy for a portal product
`get_product_page`	Gets a product page of a portal product
`get_product_rest_endpoint_page`	Gets a product REST endpoint page
`get_route`	Gets a Route
`get_route_response`	Gets a RouteResponse
`get_route_responses`	Gets the RouteResponses for a Route
`get_routes`	Gets the Routes for an API
`get_routing_rule`	Gets a routing rule
`get_stage`	Gets a Stage
`get_stages`	Gets the Stages for an API
`get_tags`	Gets a collection of Tag resources
`get_vpc_link`	Gets a VPC link
`get_vpc_links`	Gets a collection of VPC links
`import_api`	Imports an API
`list_portal_products`	Lists portal products
`list_portals`	Lists portals
`list_product_pages`	Lists the product pages for a portal product
`list_product_rest_endpoint_pages`	Lists the product REST endpoint pages of a portal product
`list_routing_rules`	Lists routing rules
`preview_portal`	Creates a portal preview
`publish_portal`	Publishes a portal
`put_portal_product_sharing_policy`	Updates the sharing policy for a portal product
`put_routing_rule`	Updates a routing rule
`reimport_api`	Puts an Api resource
`reset_authorizers_cache`	Resets all authorizer cache entries on a stage
`tag_resource`	Creates a new Tag resource to represent a tag
`untag_resource`	Deletes a Tag
`update_api`	Updates an Api resource
`update_api_mapping`	The API mapping
`update_authorizer`	Updates an Authorizer
`update_deployment`	Updates a Deployment
`update_domain_name`	Updates a domain name
`update_integration`	Updates an Integration
`update_integration_response`	Updates an IntegrationResponses
`update_model`	Updates a Model
`update_portal`	Updates a portal
`update_portal_product`	Updates the portal product
`update_product_page`	Updates a product page of a portal product
`update_product_rest_endpoint_page`	Updates a product REST endpoint page
`update_route`	Updates a Route
`update_route_response`	Updates a RouteResponse
`update_stage`	Updates a Stage
`update_vpc_link`	Updates a VPC link

Examples¶

svc <- apigatewayv2()
svc$create_api(
  Foo = 123
)