int mStatusCode
String channelName
The name of the signaling channel.
Constraints:
Length: 1 - 256
Pattern: [a-zA-Z0-9_.-]+
String channelARN
The ARN of the signaling channel.
Constraints:
Length: 1 - 1024
Pattern:
arn:aws:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+
String channelType
The type of the signaling channel.
Constraints:
Allowed Values: SINGLE_MASTER
String channelStatus
Current status of the signaling channel.
Constraints:
Allowed Values: CREATING, ACTIVE, UPDATING, DELETING
Date creationTime
The time at which the signaling channel was created.
SingleMasterConfiguration singleMasterConfiguration
A structure that contains the configuration for the
SINGLE_MASTER channel type.
String version
The current version of the signaling channel.
Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9]+
String comparisonOperator
A comparison operator. Currently, you can only specify the
BEGINS_WITH operator, which finds signaling channels whose
names begin with a given prefix.
Constraints:
Allowed Values: BEGINS_WITH
String comparisonValue
A value to compare.
Constraints:
Length: 1 - 256
Pattern: [a-zA-Z0-9_.-]+
String channelName
A name for the signaling channel that you are creating. It must be unique for each account and region.
Constraints:
Length: 1 - 256
Pattern: [a-zA-Z0-9_.-]+
String channelType
A type of the signaling channel that you are creating. Currently,
SINGLE_MASTER is the only supported channel type.
Constraints:
Allowed Values: SINGLE_MASTER
SingleMasterConfiguration singleMasterConfiguration
A structure containing the configuration for the
SINGLE_MASTER channel type.
List<E> tags
A set of tags (key/value pairs) that you want to associate with this channel.
String channelARN
The ARN of the created channel.
Constraints:
Length: 1 - 1024
Pattern:
arn:aws:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+
String deviceName
The name of the device that is writing to the stream.
In the current implementation, Kinesis Video Streams does not use this name.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
String streamName
A name for the stream that you are creating.
The stream name is an identifier for the stream, and must be unique for each account and region.
Constraints:
Length: 1 - 256
Pattern: [a-zA-Z0-9_.-]+
String mediaType
The media type of the stream. Consumers of the stream can use this
information when processing the stream. For more information about media
types, see Media Types. If you choose to specify the MediaType,
see Naming
Requirements for guidelines.
Example valid values include "video/h264" and "video/h264,audio/aac".
This parameter is optional; the default value is null (or
empty in JSON).
Constraints:
Length: 1 - 128
Pattern: [\w\-\.\+]+/[\w\-\.\+]+(,[\w\-\.\+]+/[\w\-\.\+]+)*
String kmsKeyId
The ID of the AWS Key Management Service (AWS KMS) key that you want Kinesis Video Streams to use to encrypt stream data.
If no key ID is specified, the default, Kinesis Video-managed key (
aws/kinesisvideo) is used.
For more information, see DescribeKey.
Constraints:
Length: 1 - 2048
Integer dataRetentionInHours
The number of hours that you want to retain the data in the stream. Kinesis Video Streams retains the data in a data store that is associated with the stream.
The default value is 0, indicating that the stream does not persist data.
When the DataRetentionInHours value is 0, consumers can
still consume the fragments that remain in the service host buffer, which
has a retention time limit of 5 minutes and a retention memory limit of
200 MB. Fragments are removed from the buffer when either limit is
reached.
Constraints:
Range: 0 -
Map<K,V> tags
A list of tags to associate with the specified stream. Each tag is a key-value pair (the value is optional).
String streamARN
The Amazon Resource Name (ARN) of the stream.
Constraints:
Length: 1 - 1024
Pattern:
arn:aws:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+
String channelARN
The ARN of the signaling channel that you want to delete.
Constraints:
Length: 1 - 1024
Pattern:
arn:aws:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+
String currentVersion
The current version of the signaling channel that you want to delete. You
can obtain the current version by invoking the
DescribeSignalingChannel or
ListSignalingChannels APIs.
Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9]+
String streamARN
The Amazon Resource Name (ARN) of the stream that you want to delete.
Constraints:
Length: 1 - 1024
Pattern:
arn:aws:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+
String currentVersion
Optional: The version of the stream that you want to delete.
Specify the version as a safeguard to ensure that your are deleting the
correct stream. To get the stream version, use the
DescribeStream API.
If not specified, only the CreationTime is checked before
deleting the stream.
Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9]+
String channelName
The name of the signaling channel that you want to describe.
Constraints:
Length: 1 - 256
Pattern: [a-zA-Z0-9_.-]+
String channelARN
The ARN of the signaling channel that you want to describe.
Constraints:
Length: 1 - 1024
Pattern:
arn:aws:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+
ChannelInfo channelInfo
A structure that encapsulates the specified signaling channel's metadata and properties.
StreamInfo streamInfo
An object that describes the stream.
String streamName
The name of the stream that you want to get the endpoint for. You must
specify either this parameter or a StreamARN in the request.
Constraints:
Length: 1 - 256
Pattern: [a-zA-Z0-9_.-]+
String streamARN
The Amazon Resource Name (ARN) of the stream that you want to get the
endpoint for. You must specify either this parameter or a
StreamName in the request.
Constraints:
Length: 1 - 1024
Pattern:
arn:aws:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+
String aPIName
The name of the API action for which to get an endpoint.
Constraints:
Allowed Values: PUT_MEDIA, GET_MEDIA, LIST_FRAGMENTS,
GET_MEDIA_FOR_FRAGMENT_LIST, GET_HLS_STREAMING_SESSION_URL,
GET_DASH_STREAMING_SESSION_URL
String dataEndpoint
The endpoint value. To read data from the stream or to write data to it, specify this endpoint in your application.
String channelARN
The ARN of the signalling channel for which you want to get an endpoint.
Constraints:
Length: 1 - 1024
Pattern:
arn:aws:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+
SingleMasterChannelEndpointConfiguration singleMasterChannelEndpointConfiguration
A structure containing the endpoint configuration for the
SINGLE_MASTER channel type.
Integer maxResults
The maximum number of channels to return in the response. The default is 500.
Constraints:
Range: 1 - 10000
String nextToken
If you specify this parameter, when the result of a
ListSignalingChannels operation is truncated, the call
returns the NextToken in the response. To get another batch
of channels, provide this token in your next request.
Constraints:
Length: 0 - 512
Pattern: [a-zA-Z0-9+/=]*
ChannelNameCondition channelNameCondition
Optional: Returns only the channels that satisfy a specific condition.
Integer maxResults
The maximum number of streams to return in the response. The default is 10,000.
Constraints:
Range: 1 - 10000
String nextToken
If you specify this parameter, when the result of a
ListStreams operation is truncated, the call returns the
NextToken in the response. To get another batch of streams,
provide this token in your next request.
Constraints:
Length: 0 - 512
Pattern: [a-zA-Z0-9+/=]*
StreamNameCondition streamNameCondition
Optional: Returns only streams that satisfy a specific condition. Currently, you can specify only the prefix of a stream name as a condition.
String nextToken
If you specify this parameter and the result of a ListTagsForResource call is truncated, the response includes a token that you can use in the next request to fetch the next batch of tags.
Constraints:
Length: 0 - 512
Pattern: [a-zA-Z0-9+/=]*
String resourceARN
The ARN of the signaling channel for which you want to list tags.
Constraints:
Length: 1 - 1024
Pattern:
arn:aws:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+
String nextToken
If you specify this parameter and the result of a ListTagsForResource call is truncated, the response includes a token that you can use in the next request to fetch the next set of tags.
Constraints:
Length: 0 - 512
Pattern: [a-zA-Z0-9+/=]*
Map<K,V> tags
A map of tag keys and values associated with the specified signaling channel.
String nextToken
If you specify this parameter and the result of a
ListTagsForStream call is truncated, the response includes a
token that you can use in the next request to fetch the next batch of
tags.
Constraints:
Length: 0 - 512
Pattern: [a-zA-Z0-9+/=]*
String streamARN
The Amazon Resource Name (ARN) of the stream that you want to list tags for.
Constraints:
Length: 1 - 1024
Pattern:
arn:aws:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+
String streamName
The name of the stream that you want to list tags for.
Constraints:
Length: 1 - 256
Pattern: [a-zA-Z0-9_.-]+
String nextToken
If you specify this parameter and the result of a ListTags
call is truncated, the response includes a token that you can use in the
next request to fetch the next set of tags.
Constraints:
Length: 0 - 512
Pattern: [a-zA-Z0-9+/=]*
Map<K,V> tags
A map of tag keys and values associated with the specified stream.
List<E> protocols
This property is used to determine the nature of communication over this
SINGLE_MASTER signaling channel. If WSS is
specified, this API returns a websocket endpoint. If HTTPS
is specified, this API returns an HTTPS endpoint.
String role
This property is used to determine messaging permissions in this
SINGLE_MASTER signaling channel. If MASTER is
specified, this API returns an endpoint that a client can use to receive
offers from and send answers to any of the viewers on this signaling
channel. If VIEWER is specified, this API returns an
endpoint that a client can use only to send offers to another
MASTER client on this signaling channel.
Constraints:
Allowed Values: MASTER, VIEWER
Integer messageTtlSeconds
The period of time a signaling channel retains underlivered messages before they are discarded.
Constraints:
Range: 5 - 120
String deviceName
The name of the device that is associated with the stream.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
String streamName
The name of the stream.
Constraints:
Length: 1 - 256
Pattern: [a-zA-Z0-9_.-]+
String streamARN
The Amazon Resource Name (ARN) of the stream.
Constraints:
Length: 1 - 1024
Pattern:
arn:aws:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+
String mediaType
The MediaType of the stream.
Constraints:
Length: 1 - 128
Pattern: [\w\-\.\+]+/[\w\-\.\+]+(,[\w\-\.\+]+/[\w\-\.\+]+)*
String kmsKeyId
The ID of the AWS Key Management Service (AWS KMS) key that Kinesis Video Streams uses to encrypt data on the stream.
Constraints:
Length: 1 - 2048
String version
The version of the stream.
Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9]+
String status
The status of the stream.
Constraints:
Allowed Values: CREATING, ACTIVE, UPDATING, DELETING
Date creationTime
A time stamp that indicates when the stream was created.
Integer dataRetentionInHours
How long the stream retains data, in hours.
Constraints:
Range: 0 -
String comparisonOperator
A comparison operator. Currently, you can specify only the
BEGINS_WITH operator, which finds streams whose names start
with a given prefix.
Constraints:
Allowed Values: BEGINS_WITH
String comparisonValue
A value to compare.
Constraints:
Length: 1 - 256
Pattern: [a-zA-Z0-9_.-]+
String key
The key of the tag that is associated with the specified signaling channel.
Constraints:
Length: 1 - 128
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$
String value
The value of the tag that is associated with the specified signaling channel.
Constraints:
Length: 0 - 256
Pattern: [\p{L}\p{Z}\p{N}_.:/=+\-@]*
String resourceARN
The ARN of the signaling channel to which you want to add tags.
Constraints:
Length: 1 - 1024
Pattern:
arn:aws:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+
List<E> tags
A list of tags to associate with the specified signaling channel. Each tag is a key-value pair.
String streamARN
The Amazon Resource Name (ARN) of the resource that you want to add the tag or tags to.
Constraints:
Length: 1 - 1024
Pattern:
arn:aws:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+
String streamName
The name of the stream that you want to add the tag or tags to.
Constraints:
Length: 1 - 256
Pattern: [a-zA-Z0-9_.-]+
Map<K,V> tags
A list of tags to associate with the specified stream. Each tag is a key-value pair (the value is optional).
String streamARN
The Amazon Resource Name (ARN) of the stream that you want to remove tags from.
Constraints:
Length: 1 - 1024
Pattern:
arn:aws:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+
String streamName
The name of the stream that you want to remove tags from.
Constraints:
Length: 1 - 256
Pattern: [a-zA-Z0-9_.-]+
List<E> tagKeyList
A list of the keys of the tags that you want to remove.
String streamName
The name of the stream whose retention period you want to change.
Constraints:
Length: 1 - 256
Pattern: [a-zA-Z0-9_.-]+
String streamARN
The Amazon Resource Name (ARN) of the stream whose retention period you want to change.
Constraints:
Length: 1 - 1024
Pattern:
arn:aws:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+
String currentVersion
The version of the stream whose retention period you want to change. To
get the version, call either the DescribeStream or the
ListStreams API.
Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9]+
String operation
Indicates whether you want to increase or decrease the retention period.
Constraints:
Allowed Values: INCREASE_DATA_RETENTION, DECREASE_DATA_RETENTION
Integer dataRetentionChangeInHours
The retention period, in hours. The value you specify replaces the current value. The maximum value for this parameter is 87600 (ten years).
Constraints:
Range: 1 -
String channelARN
The ARN of the signaling channel that you want to update.
Constraints:
Length: 1 - 1024
Pattern:
arn:aws:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+
String currentVersion
The current version of the signaling channel that you want to update.
Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9]+
SingleMasterConfiguration singleMasterConfiguration
The structure containing the configuration for the
SINGLE_MASTER type of the signaling channel that you want to
update.
String streamName
The name of the stream whose metadata you want to update.
The stream name is an identifier for the stream, and must be unique for each account and region.
Constraints:
Length: 1 - 256
Pattern: [a-zA-Z0-9_.-]+
String streamARN
The ARN of the stream whose metadata you want to update.
Constraints:
Length: 1 - 1024
Pattern:
arn:aws:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+
String currentVersion
The version of the stream whose metadata you want to update.
Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9]+
String deviceName
The name of the device that is writing to the stream.
In the current implementation, Kinesis Video Streams does not use this name.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
String mediaType
The stream's media type. Use MediaType to specify the type
of content that the stream contains to the consumers of the stream. For
more information about media types, see Media Types. If you choose to specify the MediaType,
see Naming
Requirements.
To play video on the console, you must specify the correct video type.
For example, if the video in the stream is H.264, specify
video/h264 as the MediaType.
Constraints:
Length: 1 - 128
Pattern: [\w\-\.\+]+/[\w\-\.\+]+(,[\w\-\.\+]+/[\w\-\.\+]+)*
Copyright © 2019. All rights reserved.