Bindplane

The Bindplane Developer Hub

Welcome to the Bindplane developer hub. You'll find comprehensive guides and documentation to help you start working with Bindplane as quickly as possible, as well as support if you get stuck. Let's jump right in!

Amazon API Gateway

Least Privileged User

Navigate to the AWS console and create an IAM user with programmatic access. The user will need the following permissions. You can create a policy specifically for these permissions and apply the permissions to the user.

For more information, see: High Level AWS Source Configuration

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Sid": "VisualEditor0",
      "Effect": "Allow",
      "Action": [
        "cloudwatch:DescribeAlarmHistory",
        "cloudwatch:GetMetricData",
        "cloudwatch:DescribeAlarmsForMetric",
        "apigateway:HEAD",
        "cloudwatch:DescribeAlarms",
        "apigateway:GET",
        "cloudwatch:GetMetricStatistics",
        "apigateway:OPTIONS",
        "cloudwatch:ListMetrics"
      ],
      "Resource": "*"
    }
  ]
}

Connection Parameters

NameRequired?Description
Region
Access Key IDRequired
Secret Access KeyRequired
Additional ThreadsThe number of additional threads allowed to be utilized during collection.
Request Timeout (seconds)The number of seconds to allow for the API to return a response.
Collect CloudWatch Metrics
CloudWatch Historic ModeIf enabled, retrieves a history of data points from CloudWatch. Otherwise, collects only the most recent data point for each metric.

Metrics

API

NameDescription
4xx Errors (Errors)The number of client-side errors captured
5xx Errors (Errors)The number of server-side errors captured.
Binary Media TypesThe list of binary media types supported by the RestApi.
Cache Hit Count (Requests)The number of requests served from the API cache.
Cache Miss Count (Requests)The number of requests served from the back end when API caching is enabled.
Calls Count (Calls)The number of calls to API methods.
Created DateThe timestamp when the API was created.
DescriptionThe API's description.
Endpoint ConfigurationThe endpoint configuration of this RestApi showing the endpoint types of the API.
IDThe API's identifier.
Integration Latency (Milliseconds)The time between when API Gateway relays a request to the back end and when it receives a response from the back end.
Key SourceThe source of the API key for metring requests according to a usage plan.
Latency (Milliseconds)The time between when API Gateway receives a request from a client and when it returns a response to the client. The latency includes the integration latency and other API Gateway overhead.
Minimum Compression Size (Bytes)A nullable integer used to enable (non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable (null) compression on an API.
NameThe API's name.
RegionThe AWS Region this object belongs to.
VersionA version identifier for the API.
WarningsThe warning messages reported when failonwarnings is turned on during API import.

Stage

NameDescription
4xx Errors (Errors)The number of client-side errors captured
5xx Errors (Errors)The number of server-side errors captured.
API NameThe name of the API associated with the stage.
Cache Cluster EnabledSpecifies whether a cache cluster is enabled for the stage.
Cache Cluster Size (Gigabytes)The size of the cache cluster for the stage, if enabled.
Cache Cluster StatusThe status of the cache cluster for the stage, if enabled.
Cache Hit Count (Requests)The number of requests served from the API cache.
Cache Miss Count (Requests)The number of requests served from the back end when API caching is enabled.
Calls Count (Calls)The number of calls to API methods.
Client Certificate IDThe identifier of a client certificate for an API stage.
Created DateThe timestamp when the stage was created.
Deployment IDThe identifier of the Deployment that the stage points to.
DescriptionThe stage's description.
Documentation VersionThe version of the associated API documentation.
Full NameThe name of the Stage along with the corresponding API name.
Integration Latency (Milliseconds)The time between when API Gateway relays a request to the back end and when it receives a response from the back end.
Last Updated DateThe timestamp when the stage was last updated.
Latency (Milliseconds)The time between when API Gateway receives a request from a client and when it returns a response to the client. The latency includes the integration latency and other API Gateway overhead.
NameThe stage's name.
RegionThe AWS Region this object belongs to.

VPC Link

NameDescription
DescriptionThe description of the VPC link.
IDThe identifier of the VPC Link.
NameThe name used to label and identify the VPC link.
RegionThe AWS Region this object belongs to.
StatusThe status of the VPC link.
Status MessageA description about the VPC link status.
Target ARNsThe ARNs of network load balancers of the VPC targeted by the VPC link.

Updated 8 months ago

Amazon API Gateway


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.