paws.networking: apigatewaymanagementapi – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

apigatewaymanagementapi

AmazonApiGatewayManagementApi

Description

The Amazon API Gateway Management API allows you to directly manage runtime aspects of your deployed APIs. To use it, you must explicitly set the SDK's endpoint to point to the endpoint of your deployed API. The endpoint will be of the form https://{api-id}.execute-api.{region}.amazonaws.com/{stage}, or will be the endpoint corresponding to your API's custom domain and base path, if applicable.

Usage

apigatewaymanagementapi(config = list())

Arguments

config

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

Service syntax

svc <- apigatewaymanagementapi(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string"
    ),
    endpoint = "string",
    region = "string"
  )
)

Operations

delete_connection	Delete the connection with the provided id
get_connection	Get information about the connection with the provided id
post_to_connection	Sends the provided data to the specified connection

Examples

## Not run: 
svc <- apigatewaymanagementapi()
svc$delete_connection(
  Foo = 123
)

## End(Not run)

paws.networking

Amazon Web Services Networking & Content Delivery Services

v0.1.11

Apache License (>= 2.0)

Authors

David Kretch [aut, cre], Adam Banker [aut], Amazon.com, Inc. [cph]

Initial release