@datafire/amazonaws_ivs

Client library for Amazon Interactive Video Service

Installation and Usage

npm install --save @datafire/amazonaws_ivs

let amazonaws_ivs = require('@datafire/amazonaws_ivs').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

.then(data => {
  console.log(data);
});

Description

Actions

BatchGetChannel

amazonaws_ivs.BatchGetChannel({
  "arns": []
}, context)

Input

• input object
  • arns required array: Array of ARNs, one per channel.
    • items ChannelArn

Output

• output BatchGetChannelResponse

BatchGetStreamKey

amazonaws_ivs.BatchGetStreamKey({
  "arns": []
}, context)

Input

• input object
  • arns required array: Array of ARNs, one per channel.
    • items StreamKeyArn

Output

• output BatchGetStreamKeyResponse

CreateChannel

amazonaws_ivs.CreateChannel({}, context)

Input

• input object
  • tags object: See Channel$tags.
  • authorized boolean: Whether the channel is authorized. Default: false.
  • latencyMode string (values: NORMAL, LOW): Channel latency mode. Default: LOW.
  • name string: Channel name.
  • type string (values: BASIC, STANDARD): Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately. Valid values: STANDARD: Multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Vertical resolution can be up to 1080 and bitrate can be up to 8.5 Mbps. BASIC: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Vertical resolution can be up to 480 and bitrate can be up to 1.5 Mbps. Default: STANDARD.

Output

• output CreateChannelResponse

CreateStreamKey

amazonaws_ivs.CreateStreamKey({
  "channelArn": ""
}, context)

Input

• input object
  • tags object: See Channel$tags.
  • channelArn required string: ARN of the channel for which to create the stream key.

Output

• output CreateStreamKeyResponse

DeleteChannel

amazonaws_ivs.DeleteChannel({
  "arn": ""
}, context)

Input

• input object
  • arn required string: ARN of the channel to be deleted.

Output

Output schema unknown

DeletePlaybackKeyPair

amazonaws_ivs.DeletePlaybackKeyPair({
  "arn": ""
}, context)

Input

• input object
  • arn required string: ARN of the key pair to be deleted.

Output

• output DeletePlaybackKeyPairResponse

DeleteStreamKey

amazonaws_ivs.DeleteStreamKey({
  "arn": ""
}, context)

Input

• input object
  • arn required string: ARN of the stream key to be deleted.

Output

Output schema unknown

GetChannel

amazonaws_ivs.GetChannel({
  "arn": ""
}, context)

Input

• input object
  • arn required string: ARN of the channel for which the configuration is to be retrieved.

Output

• output GetChannelResponse

GetPlaybackKeyPair

amazonaws_ivs.GetPlaybackKeyPair({
  "arn": ""
}, context)

Input

• input object
  • arn required string: ARN of the key pair to be returned.

Output

• output GetPlaybackKeyPairResponse

GetStream

amazonaws_ivs.GetStream({
  "channelArn": ""
}, context)

Input

• input object
  • channelArn required string: Channel ARN for stream to be accessed.

Output

• output GetStreamResponse

GetStreamKey

amazonaws_ivs.GetStreamKey({
  "arn": ""
}, context)

Input

• input object
  • arn required string: ARN for the stream key to be retrieved.

Output

• output GetStreamKeyResponse

ImportPlaybackKeyPair

amazonaws_ivs.ImportPlaybackKeyPair({
  "publicKeyMaterial": ""
}, context)

Input

• input object
  • tags object: Any tags provided with the request are added to the playback key pair tags.
  • name string: An arbitrary string (a nickname) assigned to a playback key pair that helps the customer identify that resource. The value does not need to be unique.
  • publicKeyMaterial required string: The public portion of a customer-generated key pair.

Output

• output ImportPlaybackKeyPairResponse

ListChannels

amazonaws_ivs.ListChannels({}, context)

Input

• input object
  • maxResults string
  • nextToken string
  • filterByName string: Filters the channel list to match the specified name.
  • maxResults integer: Maximum number of channels to return.
  • nextToken string: The first channel to retrieve. This is used for pagination; see the nextToken response field.

Output

• output ListChannelsResponse

ListPlaybackKeyPairs

amazonaws_ivs.ListPlaybackKeyPairs({}, context)

Input

• input object
  • maxResults string
  • nextToken string
  • maxResults integer: The first key pair to retrieve. This is used for pagination; see the nextToken response field.
  • nextToken string: Maximum number of key pairs to return.

Output

• output ListPlaybackKeyPairsResponse

ListStreamKeys

amazonaws_ivs.ListStreamKeys({
  "channelArn": ""
}, context)

Input

• input object
  • maxResults string
  • nextToken string
  • channelArn required string: Channel ARN used to filter the list.
  • maxResults integer: Maximum number of streamKeys to return.
  • nextToken string: The first stream key to retrieve. This is used for pagination; see the nextToken response field.

Output

• output ListStreamKeysResponse

ListStreams

amazonaws_ivs.ListStreams({}, context)

Input

• input object
  • maxResults string
  • nextToken string
  • maxResults integer: Maximum number of streams to return.
  • nextToken string: The first stream to retrieve. This is used for pagination; see the nextToken response field.

Output

• output ListStreamsResponse

PutMetadata

amazonaws_ivs.PutMetadata({
  "channelArn": "",
  "metadata": ""
}, context)

Input

• input object
  • channelArn required string: ARN of the channel into which metadata is inserted. This channel must have an active stream.
  • metadata required string: Metadata to insert into the stream. Maximum: 1 KB per request.

Output

Output schema unknown

StopStream

amazonaws_ivs.StopStream({
  "channelArn": ""
}, context)

Input

• input object
  • channelArn required string: ARN of the channel for which the stream is to be stopped.

Output

• output StopStreamResponse

UpdateChannel

amazonaws_ivs.UpdateChannel({
  "arn": ""
}, context)

Input

• input object
  • arn required string: ARN of the channel to be updated.
  • authorized boolean: Whether the channel is authorized. Default: false.
  • latencyMode string (values: NORMAL, LOW): Channel latency mode. Default: LOW.
  • name string: Channel name.
  • type string (values: BASIC, STANDARD): Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately. Valid values: STANDARD: Multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Vertical resolution can be up to 1080 and bitrate can be up to 8.5 Mbps. BASIC: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Vertical resolution can be up to 480 and bitrate can be up to 1.5 Mbps. Default: STANDARD.

Output

• output UpdateChannelResponse

ListTagsForResource

amazonaws_ivs.ListTagsForResource({
  "resourceArn": ""
}, context)

Input

• input object
  • resourceArn required string
  • maxResults string
  • nextToken string
  • maxResults integer: Maximum number of tags to return.
  • nextToken string: The first tag to retrieve. This is used for pagination; see the nextToken response field.

Output

• output ListTagsForResourceResponse

TagResource

amazonaws_ivs.TagResource({
  "resourceArn": "",
  "tags": {}
}, context)

Input

• input object
  • resourceArn required string
  • tags required object: Array of tags to be added or updated.

Output

• output TagResourceResponse

UntagResource

amazonaws_ivs.UntagResource({
  "resourceArn": "",
  "tagKeys": []
}, context)

Input

• input object
  • resourceArn required string
  • tagKeys required array

Output

• output UntagResourceResponse

Definitions

AccessDeniedException

BatchError

• BatchError object: Error related to a specific channel, specified by its ARN.
  • arn
  • code
  • message

BatchErrors

• BatchErrors array
  • items BatchError

BatchGetChannelRequest

• BatchGetChannelRequest object
  • arns required
    • items ChannelArn

BatchGetChannelResponse

• BatchGetChannelResponse object
  • channels Channels
  • errors
    • items BatchError

BatchGetStreamKeyRequest

• BatchGetStreamKeyRequest object
  • arns required
    • items StreamKeyArn

BatchGetStreamKeyResponse

• BatchGetStreamKeyResponse object
  • errors BatchErrors
  • streamKeys StreamKeys

Boolean

• Boolean boolean

Channel

• Channel object: Object specifying a channel.
  • tags
  • arn
  • authorized
  • ingestEndpoint
  • latencyMode
  • name
  • playbackUrl
  • type

ChannelArn

• ChannelArn string

ChannelArnList

• ChannelArnList array
  • items ChannelArn

ChannelLatencyMode

• ChannelLatencyMode string (values: NORMAL, LOW)

ChannelList

• ChannelList array
  • items ChannelSummary

ChannelName

• ChannelName string

ChannelNotBroadcasting

ChannelSummary

• ChannelSummary object: Summary information about a channel.
  • tags
  • arn
  • authorized
  • latencyMode
  • name

ChannelType

• ChannelType string (values: BASIC, STANDARD)

Channels

• Channels array
  • items Channel

ConflictException

CreateChannelRequest

• CreateChannelRequest object
  • tags
  • authorized
  • latencyMode
  • name
  • type

CreateChannelResponse

• CreateChannelResponse object
  • channel Channel
  • streamKey StreamKey

CreateStreamKeyRequest

• CreateStreamKeyRequest object
  • tags
  • channelArn required

CreateStreamKeyResponse

• CreateStreamKeyResponse object
  • streamKey
    • tags
    • arn
    • channelArn
    • value

DeleteChannelRequest

• DeleteChannelRequest object
  • arn required

DeletePlaybackKeyPairRequest

• DeletePlaybackKeyPairRequest object
  • arn required

DeletePlaybackKeyPairResponse

• DeletePlaybackKeyPairResponse object

DeleteStreamKeyRequest

• DeleteStreamKeyRequest object
  • arn required

GetChannelRequest

• GetChannelRequest object
  • arn required

GetChannelResponse

• GetChannelResponse object
  • channel Channel

GetPlaybackKeyPairRequest

• GetPlaybackKeyPairRequest object
  • arn required

GetPlaybackKeyPairResponse

• GetPlaybackKeyPairResponse object
  • keyPair PlaybackKeyPair

GetStreamKeyRequest

• GetStreamKeyRequest object
  • arn required

GetStreamKeyResponse

• GetStreamKeyResponse object
  • streamKey StreamKey

GetStreamRequest

• GetStreamRequest object
  • channelArn required

GetStreamResponse

• GetStreamResponse object
  • stream Stream

ImportPlaybackKeyPairRequest

• ImportPlaybackKeyPairRequest object
  • tags
  • name
  • publicKeyMaterial required

ImportPlaybackKeyPairResponse

• ImportPlaybackKeyPairResponse object
  • keyPair PlaybackKeyPair

IngestEndpoint

• IngestEndpoint string

InternalServerException

IsAuthorized

• IsAuthorized boolean

ListChannelsRequest

• ListChannelsRequest object
  • filterByName
  • maxResults
  • nextToken

ListChannelsResponse

• ListChannelsResponse object
  • channels required
    • items ChannelSummary
  • nextToken

ListPlaybackKeyPairsRequest

• ListPlaybackKeyPairsRequest object
  • maxResults
  • nextToken

ListPlaybackKeyPairsResponse

• ListPlaybackKeyPairsResponse object
  • keyPairs required
    • items PlaybackKeyPairSummary
  • nextToken

ListStreamKeysRequest

• ListStreamKeysRequest object
  • channelArn required
  • maxResults
  • nextToken

ListStreamKeysResponse

• ListStreamKeysResponse object
  • nextToken
  • streamKeys required
    • items StreamKeySummary

ListStreamsRequest

• ListStreamsRequest object
  • maxResults
  • nextToken

ListStreamsResponse

• ListStreamsResponse object
  • nextToken
  • streams required
    • items StreamSummary

ListTagsForResourceRequest

• ListTagsForResourceRequest object
  • maxResults
  • nextToken

ListTagsForResourceResponse

• ListTagsForResourceResponse object
  • tags required Tags
  • nextToken

MaxChannelResults

• MaxChannelResults integer

MaxPlaybackKeyPairResults

• MaxPlaybackKeyPairResults integer

MaxStreamKeyResults

• MaxStreamKeyResults integer

MaxStreamResults

• MaxStreamResults integer

MaxTagResults

• MaxTagResults integer

PaginationToken

• PaginationToken string

PendingVerification

PlaybackKeyPair

• PlaybackKeyPair object: A key pair used to sign and validate a playback authorization token.
  • tags
  • arn
  • fingerprint
  • name

PlaybackKeyPairArn

• PlaybackKeyPairArn string

PlaybackKeyPairFingerprint

• PlaybackKeyPairFingerprint string

PlaybackKeyPairList

• PlaybackKeyPairList array
  • items PlaybackKeyPairSummary

PlaybackKeyPairName

• PlaybackKeyPairName string

PlaybackKeyPairSummary

• PlaybackKeyPairSummary object: Summary information about a playback key pair.
  • tags
  • arn
  • name

PlaybackPublicKeyMaterial

• PlaybackPublicKeyMaterial string

PlaybackURL

• PlaybackURL string

PutMetadataRequest

• PutMetadataRequest object
  • channelArn required
  • metadata required

ResourceArn

• ResourceArn string

ResourceNotFoundException

ServiceQuotaExceededException

StopStreamRequest

• StopStreamRequest object
  • channelArn required

StopStreamResponse

• StopStreamResponse object

Stream

• Stream object: Specifies a live video stream that has been ingested and distributed.
  • channelArn
  • health
  • playbackUrl
  • startTime
  • state
  • viewerCount

StreamHealth

• StreamHealth string (values: HEALTHY, STARVING, UNKNOWN)

StreamKey

• StreamKey object: Object specifying a stream key.
  • tags
  • arn
  • channelArn
  • value

StreamKeyArn

• StreamKeyArn string

StreamKeyArnList

• StreamKeyArnList array
  • items StreamKeyArn

StreamKeyList

• StreamKeyList array
  • items StreamKeySummary

StreamKeySummary

• StreamKeySummary object: Summary information about a stream key.
  • tags
  • arn
  • channelArn

StreamKeyValue

• StreamKeyValue string

StreamKeys

• StreamKeys array
  • items StreamKey

StreamList

• StreamList array
  • items StreamSummary

StreamMetadata

• StreamMetadata string

StreamStartTime

• StreamStartTime string

StreamState

• StreamState string (values: LIVE, OFFLINE)

StreamSummary

• StreamSummary object: Summary information about a stream.
  • channelArn
  • health
  • startTime
  • state
  • viewerCount

StreamUnavailable

StreamViewerCount

• StreamViewerCount integer

String

• String string

TagKey

• TagKey string

TagKeyList

• TagKeyList array
  • items TagKey

TagResourceRequest

• TagResourceRequest object
  • tags required

TagResourceResponse

• TagResourceResponse object

TagValue

• TagValue string

Tags

• Tags object

ThrottlingException

UntagResourceRequest

• UntagResourceRequest object

UntagResourceResponse

• UntagResourceResponse object

UpdateChannelRequest

• UpdateChannelRequest object
  • arn required
  • authorized
  • latencyMode
  • name
  • type

UpdateChannelResponse

• UpdateChannelResponse object
  • channel Channel

ValidationException

errorCode

• errorCode string

errorMessage

• errorMessage string