@datafire/amazonaws_kinesisvideo
v5.0.0
Published
DataFire integration for Amazon Kinesis Video Streams
Downloads
4
Readme
@datafire/amazonaws_kinesisvideo
Client library for Amazon Kinesis Video Streams
Installation and Usage
npm install --save @datafire/amazonaws_kinesisvideo
let amazonaws_kinesisvideo = require('@datafire/amazonaws_kinesisvideo').create({
accessKeyId: "",
secretAccessKey: "",
region: ""
});
amazonaws_kinesisvideo.CreateStream({
"StreamName": ""
}).then(data => {
console.log(data);
});
Description
Actions
CreateStream
amazonaws_kinesisvideo.CreateStream({
"StreamName": ""
}, context)
Input
- input
object
- DataRetentionInHours DataRetentionInHours
- DeviceName DeviceName
- KmsKeyId KmsKeyId
- MediaType MediaType
- StreamName required StreamName
Output
- output CreateStreamOutput
DeleteStream
amazonaws_kinesisvideo.DeleteStream({
"StreamARN": ""
}, context)
Input
- input
object
- CurrentVersion Version
- StreamARN required ResourceARN
Output
- output DeleteStreamOutput
DescribeStream
amazonaws_kinesisvideo.DescribeStream({}, context)
Input
- input
object
- StreamARN ResourceARN
- StreamName StreamName
Output
- output DescribeStreamOutput
GetDataEndpoint
amazonaws_kinesisvideo.GetDataEndpoint({
"APIName": ""
}, context)
Input
- input
object
- APIName required APIName
- StreamARN ResourceARN
- StreamName StreamName
Output
- output GetDataEndpointOutput
ListStreams
amazonaws_kinesisvideo.ListStreams({}, context)
Input
- input
object
- MaxResults ListStreamsInputLimit
- NextToken NextToken
- StreamNameCondition StreamNameCondition
Output
- output ListStreamsOutput
ListTagsForStream
amazonaws_kinesisvideo.ListTagsForStream({}, context)
Input
- input
object
- NextToken NextToken
- StreamARN ResourceARN
- StreamName StreamName
Output
- output ListTagsForStreamOutput
TagStream
amazonaws_kinesisvideo.TagStream({
"Tags": []
}, context)
Input
- input
object
- StreamARN ResourceARN
- StreamName StreamName
- Tags required ResourceTags
Output
- output TagStreamOutput
UntagStream
amazonaws_kinesisvideo.UntagStream({
"TagKeyList": []
}, context)
Input
- input
object
- StreamARN ResourceARN
- StreamName StreamName
- TagKeyList required TagKeyList
Output
- output UntagStreamOutput
UpdateDataRetention
amazonaws_kinesisvideo.UpdateDataRetention({
"CurrentVersion": "",
"Operation": "",
"DataRetentionChangeInHours": 0
}, context)
Input
- input
object
- CurrentVersion required Version
- DataRetentionChangeInHours required DataRetentionChangeInHours
- Operation required UpdateDataRetentionOperation
- StreamARN ResourceARN
- StreamName StreamName
Output
- output UpdateDataRetentionOutput
UpdateStream
amazonaws_kinesisvideo.UpdateStream({
"CurrentVersion": ""
}, context)
Input
- input
object
- CurrentVersion required Version
- DeviceName DeviceName
- MediaType MediaType
- StreamARN ResourceARN
- StreamName StreamName
Output
- output UpdateStreamOutput
Definitions
APIName
- APIName
string
(values: PUT_MEDIA, GET_MEDIA, LIST_FRAGMENTS, GET_MEDIA_FOR_FRAGMENT_LIST)
AccountStreamLimitExceededException
- AccountStreamLimitExceededException
object
: The number of streams created for the account is too high.- Message ErrorMessage
ClientLimitExceededException
- ClientLimitExceededException
object
: Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.- Message ErrorMessage
ComparisonOperator
- ComparisonOperator
string
(values: BEGINS_WITH)
CreateStreamInput
- CreateStreamInput
object
- DataRetentionInHours DataRetentionInHours
- DeviceName DeviceName
- KmsKeyId KmsKeyId
- MediaType MediaType
- StreamName required StreamName
CreateStreamOutput
- CreateStreamOutput
object
- StreamARN ResourceARN
DataEndpoint
- DataEndpoint
string
DataRetentionChangeInHours
- DataRetentionChangeInHours
integer
DataRetentionInHours
- DataRetentionInHours
integer
DeleteStreamInput
- DeleteStreamInput
object
- CurrentVersion Version
- StreamARN required ResourceARN
DeleteStreamOutput
- DeleteStreamOutput
object
DescribeStreamInput
- DescribeStreamInput
object
- StreamARN ResourceARN
- StreamName StreamName
DescribeStreamOutput
- DescribeStreamOutput
object
- StreamInfo StreamInfo
DeviceName
- DeviceName
string
DeviceStreamLimitExceededException
- DeviceStreamLimitExceededException
object
: Not implemented.- Message ErrorMessage
ErrorMessage
- ErrorMessage
string
GetDataEndpointInput
- GetDataEndpointInput
object
- APIName required APIName
- StreamARN ResourceARN
- StreamName StreamName
GetDataEndpointOutput
- GetDataEndpointOutput
object
- DataEndpoint DataEndpoint
InvalidArgumentException
- InvalidArgumentException
object
: The value for this input parameter is invalid.- Message ErrorMessage
InvalidDeviceException
- InvalidDeviceException
object
: Not implemented.- Message ErrorMessage
InvalidResourceFormatException
- InvalidResourceFormatException
object
: The format of the StreamARN is invalid.- Message ErrorMessage
KmsKeyId
- KmsKeyId
string
ListStreamsInput
- ListStreamsInput
object
- MaxResults ListStreamsInputLimit
- NextToken NextToken
- StreamNameCondition StreamNameCondition
ListStreamsInputLimit
- ListStreamsInputLimit
integer
ListStreamsOutput
- ListStreamsOutput
object
- NextToken NextToken
- StreamInfoList StreamInfoList
ListTagsForStreamInput
- ListTagsForStreamInput
object
- NextToken NextToken
- StreamARN ResourceARN
- StreamName StreamName
ListTagsForStreamOutput
- ListTagsForStreamOutput
object
- NextToken NextToken
- Tags ResourceTags
MediaType
- MediaType
string
NextToken
- NextToken
string
NotAuthorizedException
- NotAuthorizedException
object
: The caller is not authorized to perform this operation.- Message ErrorMessage
ResourceARN
- ResourceARN
string
ResourceInUseException
- ResourceInUseException
object
: The stream is currently not available for this operation.- Message ErrorMessage
ResourceNotFoundException
- ResourceNotFoundException
object
: Amazon Kinesis Video Streams can't find the stream that you specified.- Message ErrorMessage
ResourceTags
Status
- Status
string
(values: CREATING, ACTIVE, UPDATING, DELETING)
StreamInfo
- StreamInfo
object
: An object describing a Kinesis video stream.- CreationTime Timestamp
- DataRetentionInHours DataRetentionInHours
- DeviceName DeviceName
- KmsKeyId KmsKeyId
- MediaType MediaType
- Status Status
- StreamARN ResourceARN
- StreamName StreamName
- Version Version
StreamInfoList
- StreamInfoList
array
- items StreamInfo
StreamName
- StreamName
string
StreamNameCondition
- StreamNameCondition
object
: Specifies the condition that streams must satisfy to be returned when you list streams (see the ListStreams API). A condition has a comparison operation and a value. Currently, you can specify only the BEGINS_WITH operator, which finds streams whose names start with a given prefix.- ComparisonOperator ComparisonOperator
- ComparisonValue StreamName
TagKey
- TagKey
string
TagKeyList
- TagKeyList
array
- items TagKey
TagStreamInput
- TagStreamInput
object
- StreamARN ResourceARN
- StreamName StreamName
- Tags required ResourceTags
TagStreamOutput
- TagStreamOutput
object
TagValue
- TagValue
string
TagsPerResourceExceededLimitException
- TagsPerResourceExceededLimitException
object
: You have exceeded the limit of tags that you can associate with the resource. Kinesis video streams support up to 50 tags.- Message ErrorMessage
Timestamp
- Timestamp
string
UntagStreamInput
- UntagStreamInput
object
- StreamARN ResourceARN
- StreamName StreamName
- TagKeyList required TagKeyList
UntagStreamOutput
- UntagStreamOutput
object
UpdateDataRetentionInput
- UpdateDataRetentionInput
object
- CurrentVersion required Version
- DataRetentionChangeInHours required DataRetentionChangeInHours
- Operation required UpdateDataRetentionOperation
- StreamARN ResourceARN
- StreamName StreamName
UpdateDataRetentionOperation
- UpdateDataRetentionOperation
string
(values: INCREASE_DATA_RETENTION, DECREASE_DATA_RETENTION)
UpdateDataRetentionOutput
- UpdateDataRetentionOutput
object
UpdateStreamInput
- UpdateStreamInput
object
- CurrentVersion required Version
- DeviceName DeviceName
- MediaType MediaType
- StreamARN ResourceARN
- StreamName StreamName
UpdateStreamOutput
- UpdateStreamOutput
object
Version
- Version
string
VersionMismatchException
- VersionMismatchException
object
: The stream version that you specified is not the latest version. To get the latest version, use the DescribeStream API.- Message ErrorMessage