npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@datafire/amazonaws_kinesis

v5.0.0

Published

DataFire integration for Amazon Kinesis

Downloads

7

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

datafiredatafire

Keywords

Readme

@datafire/amazonaws_kinesis

Client library for Amazon Kinesis

Installation and Usage

npm install --save @datafire/amazonaws_kinesis
let amazonaws_kinesis = require('@datafire/amazonaws_kinesis').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

amazonaws_kinesis.AddTagsToStream({
  "StreamName": "",
  "Tags": []
}).then(data => {
  console.log(data);
});

Description

Amazon Kinesis Data Streams Service API Reference Amazon Kinesis Data Streams is a managed service that scales elastically for real-time processing of streaming big data.

Actions

AddTagsToStream

amazonaws_kinesis.AddTagsToStream({
  "StreamName": "",
  "Tags": []
}, context)

Input

Output

Output schema unknown

CreateStream

amazonaws_kinesis.CreateStream({
  "StreamName": "",
  "ShardCount": 0
}, context)

Input

Output

Output schema unknown

DecreaseStreamRetentionPeriod

amazonaws_kinesis.DecreaseStreamRetentionPeriod({
  "StreamName": "",
  "RetentionPeriodHours": 0
}, context)

Input

Output

Output schema unknown

DeleteStream

amazonaws_kinesis.DeleteStream({
  "StreamName": ""
}, context)

Input

Output

Output schema unknown

DescribeLimits

amazonaws_kinesis.DescribeLimits({}, context)

Input

  • input object

Output

DescribeStream

amazonaws_kinesis.DescribeStream({
  "StreamName": ""
}, context)

Input

Output

DescribeStreamSummary

amazonaws_kinesis.DescribeStreamSummary({
  "StreamName": ""
}, context)

Input

Output

DisableEnhancedMonitoring

amazonaws_kinesis.DisableEnhancedMonitoring({
  "StreamName": "",
  "ShardLevelMetrics": []
}, context)

Input

Output

EnableEnhancedMonitoring

amazonaws_kinesis.EnableEnhancedMonitoring({
  "StreamName": "",
  "ShardLevelMetrics": []
}, context)

Input

Output

GetRecords

amazonaws_kinesis.GetRecords({
  "ShardIterator": ""
}, context)

Input

Output

GetShardIterator

amazonaws_kinesis.GetShardIterator({
  "StreamName": "",
  "ShardId": "",
  "ShardIteratorType": ""
}, context)

Input

Output

IncreaseStreamRetentionPeriod

amazonaws_kinesis.IncreaseStreamRetentionPeriod({
  "StreamName": "",
  "RetentionPeriodHours": 0
}, context)

Input

Output

Output schema unknown

ListShards

amazonaws_kinesis.ListShards({}, context)

Input

Output

ListStreams

amazonaws_kinesis.ListStreams({}, context)

Input

Output

ListTagsForStream

amazonaws_kinesis.ListTagsForStream({
  "StreamName": ""
}, context)

Input

Output

MergeShards

amazonaws_kinesis.MergeShards({
  "StreamName": "",
  "ShardToMerge": "",
  "AdjacentShardToMerge": ""
}, context)

Input

Output

Output schema unknown

PutRecord

amazonaws_kinesis.PutRecord({
  "StreamName": "",
  "Data": "",
  "PartitionKey": ""
}, context)

Input

Output

PutRecords

amazonaws_kinesis.PutRecords({
  "Records": [],
  "StreamName": ""
}, context)

Input

Output

RemoveTagsFromStream

amazonaws_kinesis.RemoveTagsFromStream({
  "StreamName": "",
  "TagKeys": []
}, context)

Input

Output

Output schema unknown

SplitShard

amazonaws_kinesis.SplitShard({
  "StreamName": "",
  "ShardToSplit": "",
  "NewStartingHashKey": ""
}, context)

Input

Output

Output schema unknown

StartStreamEncryption

amazonaws_kinesis.StartStreamEncryption({
  "StreamName": "",
  "EncryptionType": "",
  "KeyId": ""
}, context)

Input

Output

Output schema unknown

StopStreamEncryption

amazonaws_kinesis.StopStreamEncryption({
  "StreamName": "",
  "EncryptionType": "",
  "KeyId": ""
}, context)

Input

Output

Output schema unknown

UpdateShardCount

amazonaws_kinesis.UpdateShardCount({
  "StreamName": "",
  "TargetShardCount": 0,
  "ScalingType": ""
}, context)

Input

Output

Definitions

AddTagsToStreamInput

  • AddTagsToStreamInput object: Represents the input for AddTagsToStream.

BooleanObject

  • BooleanObject boolean

CreateStreamInput

Data

  • Data string

DecreaseStreamRetentionPeriodInput

  • DecreaseStreamRetentionPeriodInput object: Represents the input for DecreaseStreamRetentionPeriod.

DeleteStreamInput

  • DeleteStreamInput object: Represents the input for DeleteStream.

DescribeLimitsInput

  • DescribeLimitsInput object

DescribeLimitsOutput

DescribeStreamInput

DescribeStreamInputLimit

  • DescribeStreamInputLimit integer

DescribeStreamOutput

  • DescribeStreamOutput object: Represents the output for DescribeStream.

DescribeStreamSummaryInput

  • DescribeStreamSummaryInput object

DescribeStreamSummaryOutput

DisableEnhancedMonitoringInput

  • DisableEnhancedMonitoringInput object: Represents the input for DisableEnhancedMonitoring.

EnableEnhancedMonitoringInput

  • EnableEnhancedMonitoringInput object: Represents the input for EnableEnhancedMonitoring.

EncryptionType

  • EncryptionType string (values: NONE, KMS)

EnhancedMetrics

  • EnhancedMetrics object: Represents enhanced metrics types.

EnhancedMonitoringList

EnhancedMonitoringOutput

  • EnhancedMonitoringOutput object: Represents the output for EnableEnhancedMonitoring and DisableEnhancedMonitoring.

ErrorCode

  • ErrorCode string

ErrorMessage

  • ErrorMessage string

ExpiredIteratorException

  • ExpiredIteratorException object: The provided iterator exceeds the maximum age allowed.

ExpiredNextTokenException

  • ExpiredNextTokenException object: The pagination token passed to the ListShards operation is expired. For more information, see ListShardsInput$NextToken.

GetRecordsInput

GetRecordsInputLimit

  • GetRecordsInputLimit integer

GetRecordsOutput

GetShardIteratorInput

GetShardIteratorOutput

  • GetShardIteratorOutput object: Represents the output for GetShardIterator.

HashKey

  • HashKey string

HashKeyRange

  • HashKeyRange object: The range of possible hash key values for the shard, which is a set of ordered contiguous positive integers.

IncreaseStreamRetentionPeriodInput

  • IncreaseStreamRetentionPeriodInput object: Represents the input for IncreaseStreamRetentionPeriod.

InvalidArgumentException

  • InvalidArgumentException object: A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.

KMSAccessDeniedException

  • KMSAccessDeniedException object: The ciphertext references a key that doesn't exist or that you don't have access to.

KMSDisabledException

  • KMSDisabledException object: The request was rejected because the specified customer master key (CMK) isn't enabled.

KMSInvalidStateException

  • KMSInvalidStateException object: The request was rejected because the state of the specified resource isn't valid for this request. For more information, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

KMSNotFoundException

  • KMSNotFoundException object: The request was rejected because the specified entity or resource can't be found.

KMSOptInRequired

  • KMSOptInRequired object: The AWS access key ID needs a subscription for the service.

KMSThrottlingException

  • KMSThrottlingException object: The request was denied due to request throttling. For more information about throttling, see Limits in the AWS Key Management Service Developer Guide.

KeyId

  • KeyId string

LimitExceededException

  • LimitExceededException object: The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.

ListShardsInput

ListShardsInputLimit

  • ListShardsInputLimit integer

ListShardsOutput

ListStreamsInput

ListStreamsInputLimit

  • ListStreamsInputLimit integer

ListStreamsOutput

  • ListStreamsOutput object: Represents the output for ListStreams.

ListTagsForStreamInput

ListTagsForStreamInputLimit

  • ListTagsForStreamInputLimit integer

ListTagsForStreamOutput

  • ListTagsForStreamOutput object: Represents the output for ListTagsForStream.

MergeShardsInput

  • MergeShardsInput object: Represents the input for MergeShards.

MetricsName

  • MetricsName string (values: IncomingBytes, IncomingRecords, OutgoingBytes, OutgoingRecords, WriteProvisionedThroughputExceeded, ReadProvisionedThroughputExceeded, IteratorAgeMilliseconds, ALL)

MetricsNameList

MillisBehindLatest

  • MillisBehindLatest integer

NextToken

  • NextToken string

PartitionKey

  • PartitionKey string

PositiveIntegerObject

  • PositiveIntegerObject integer

ProvisionedThroughputExceededException

  • ProvisionedThroughputExceededException object: The request rate for the stream is too high, or the requested data is too large for the available throughput. Reduce the frequency or size of your requests. For more information, see Streams Limits in the Amazon Kinesis Data Streams Developer Guide, and Error Retries and Exponential Backoff in AWS in the AWS General Reference.

PutRecordInput

PutRecordOutput

PutRecordsInput

PutRecordsOutput

PutRecordsRequestEntry

  • PutRecordsRequestEntry object: Represents the output for PutRecords.

PutRecordsRequestEntryList

PutRecordsResultEntry

  • PutRecordsResultEntry object: Represents the result of an individual record from a PutRecords request. A record that is successfully added to a stream includes SequenceNumber and ShardId in the result. A record that fails to be added to the stream includes ErrorCode and ErrorMessage in the result.

PutRecordsResultEntryList

Record

  • Record object: The unit of data of the Kinesis data stream, which is composed of a sequence number, a partition key, and a data blob.

RecordList

RemoveTagsFromStreamInput

  • RemoveTagsFromStreamInput object: Represents the input for RemoveTagsFromStream.

ResourceInUseException

  • ResourceInUseException object: The resource is not available for this operation. For successful operation, the resource must be in the ACTIVE state.

ResourceNotFoundException

  • ResourceNotFoundException object: The requested resource could not be found. The stream might not be specified correctly.

RetentionPeriodHours

  • RetentionPeriodHours integer

ScalingType

  • ScalingType string (values: UNIFORM_SCALING)

SequenceNumber

  • SequenceNumber string

SequenceNumberRange

  • SequenceNumberRange object: The range of possible sequence numbers for the shard.

Shard

ShardCountObject

  • ShardCountObject integer

ShardId

  • ShardId string

ShardIterator

  • ShardIterator string

ShardIteratorType

  • ShardIteratorType string (values: AT_SEQUENCE_NUMBER, AFTER_SEQUENCE_NUMBER, TRIM_HORIZON, LATEST, AT_TIMESTAMP)

ShardList

  • ShardList array

SplitShardInput

  • SplitShardInput object: Represents the input for SplitShard.

StartStreamEncryptionInput

StopStreamEncryptionInput

StreamARN

  • StreamARN string

StreamDescription

StreamDescriptionSummary

StreamName

  • StreamName string

StreamNameList

StreamStatus

  • StreamStatus string (values: CREATING, DELETING, ACTIVE, UPDATING)

Tag

  • Tag object: Metadata assigned to the stream, consisting of a key-value pair.

TagKey

  • TagKey string

TagKeyList

TagList

  • TagList array

TagMap

TagValue

  • TagValue string

Timestamp

  • Timestamp string

UpdateShardCountInput

UpdateShardCountOutput