Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

AWS Kinesis #X Amz Target=KinesisAnalytics 20180523.StopApplication API

The #X Amz Target=KinesisAnalytics 20180523.StopApplication API from AWS Kinesis — 1 operation(s) for #x amz target=kinesisanalytics 20180523.stopapplication.

AWS Kinesis #X Amz Target=KinesisAnalytics 20180523.StopApplication API is one of 100 APIs that AWS Kinesis publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include #X Amz Target=KinesisAnalytics 20180523.StopApplication. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, pricing, and a getting-started guide.

This API exposes 1 operation across 1 path, and defines 10 schemas. It is described by OpenAPI 3.0.0, at version 2015-08-04.

Requests are made against 4 base URLs: http://firehose.{region}.amazonaws.com, https://firehose.{region}.amazonaws.com, http://firehose.{region}.amazonaws.com.cn, https://firehose.{region}.amazonaws.com.cn.

1 operations 1 paths 10 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2015-08-04
Base URL
https://kinesis.{region}.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

AWS Kinesis #X Amz Target=KinesisAnalytics 20180523.StopApplication API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

  • hmac — Amazon Signature authorization v4

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

#X Amz Target=KinesisAnalytics 20180523.StopApplication 1
POST
/#X-Amz-Target=KinesisAnalytics_20180523.StopApplication
Stops the application from processing data. You can stop an application only if it is in the running status, unless you set the Force parameter to true . You can use the DescribeApplication operation…
StopApplication 8 params body → 200480481482483484485

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed is StopApplicationRequest (2 properties). Each schema is shown below with its type and property counts.

BooleanObject
boolean
InvalidApplicationConfigurationException
StopApplicationRequest
object
2 properties 1 required
InvalidRequestException
ResourceNotFoundException
ConcurrentModificationException
ResourceInUseException
ApplicationName
string
StopApplicationResponse
object
InvalidArgumentException

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kinesis-x-amz-target-kinesisanalytics-20180523-stopapplication-api-openapi.yml Raw ↑

Other APIs AWS Kinesis publishes across the network.

Amazon Managed Service for Apache Flink API
AWS Kinesis CreateSignalingChannel API
AWS Kinesis CreateStream API
AWS Kinesis DeleteSignalingChannel API
AWS Kinesis DeleteStream API
AWS Kinesis DescribeEdgeConfiguration API
AWS Kinesis DescribeImageGenerationConfiguration API
AWS Kinesis DescribeMappedResourceConfiguration API
AWS Kinesis DescribeMediaStorageConfiguration API
AWS Kinesis DescribeNotificationConfiguration API
AWS Kinesis DescribeSignalingChannel API
AWS Kinesis DescribeStream API