Skip to content

Kinesisvideo Classes

BaseValidatorModel

Oops! This Pydantic model is currently empty. Stay tuned!

ChannelInfoTypeDef

ChannelName

  • Type: typing.Optional[str]

ChannelARN

  • Type: typing.Optional[str]

ChannelType

  • Type: typing.Optional[typing.Literal['FULL_MESH', 'SINGLE_MASTER']]

ChannelStatus

  • Type: typing.Optional[typing.Literal['ACTIVE', 'CREATING', 'DELETING', 'UPDATING']]

CreationTime

  • Type: typing.Optional[datetime.datetime]

SingleMasterConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.kinesisvideo_classes.SingleMasterConfigurationTypeDef]

Version

  • Type: typing.Optional[str]

ChannelNameConditionTypeDef

ComparisonOperator

  • Type: typing.Optional[typing.Literal['BEGINS_WITH']]

ComparisonValue

  • Type: typing.Optional[str]

CreateSignalingChannelInputRequestTypeDef

ChannelName

  • Type:
  • Required: Yes

ChannelType

  • Type: typing.Optional[typing.Literal['FULL_MESH', 'SINGLE_MASTER']]

SingleMasterConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.kinesisvideo_classes.SingleMasterConfigurationTypeDef]

Tags

  • Type: typing.Optional[typing.Sequence[aws_resource_validator.pydantic_models.kinesisvideo_classes.TagTypeDef]]

CreateSignalingChannelOutputTypeDef

ChannelARN

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateStreamInputRequestTypeDef

StreamName

  • Type:
  • Required: Yes

DeviceName

  • Type: typing.Optional[str]

MediaType

  • Type: typing.Optional[str]

KmsKeyId

  • Type: typing.Optional[str]

DataRetentionInHours

  • Type: typing.Optional[int]

Tags

  • Type: typing.Optional[typing.Mapping[str, str]]

CreateStreamOutputTypeDef

StreamARN

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DeleteEdgeConfigurationInputRequestTypeDef

StreamName

  • Type: typing.Optional[str]

StreamARN

  • Type: typing.Optional[str]

DeleteSignalingChannelInputRequestTypeDef

ChannelARN

  • Type:
  • Required: Yes

CurrentVersion

  • Type: typing.Optional[str]

DeleteStreamInputRequestTypeDef

StreamARN

  • Type:
  • Required: Yes

CurrentVersion

  • Type: typing.Optional[str]

DeletionConfigTypeDef

EdgeRetentionInHours

  • Type: typing.Optional[int]

LocalSizeConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.kinesisvideo_classes.LocalSizeConfigTypeDef]

DeleteAfterUpload

  • Type: typing.Optional[bool]

DescribeEdgeConfigurationInputRequestTypeDef

StreamName

  • Type: typing.Optional[str]

StreamARN

  • Type: typing.Optional[str]

DescribeEdgeConfigurationOutputTypeDef

StreamName

  • Type:
  • Required: Yes

StreamARN

  • Type:
  • Required: Yes

CreationTime

  • Type:
  • Required: Yes

LastUpdatedTime

  • Type:
  • Required: Yes

SyncStatus

  • Type: typing.Literal['ACKNOWLEDGED', 'DELETE_FAILED', 'DELETING', 'DELETING_ACKNOWLEDGED', 'IN_SYNC', 'SYNCING', 'SYNC_FAILED']
  • Required: Yes

FailedStatusDetails

  • Type:
  • Required: Yes

EdgeConfig

  • Type:
  • Required: Yes

EdgeAgentStatus

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DescribeImageGenerationConfigurationInputRequestTypeDef

StreamName

  • Type: typing.Optional[str]

StreamARN

  • Type: typing.Optional[str]

DescribeImageGenerationConfigurationOutputTypeDef

ImageGenerationConfiguration

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DescribeMappedResourceConfigurationInputDescribeMappedResourceConfigurationPaginateTypeDef

StreamName

  • Type: typing.Optional[str]

StreamARN

  • Type: typing.Optional[str]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.kinesisvideo_classes.PaginatorConfigTypeDef]

DescribeMappedResourceConfigurationInputRequestTypeDef

StreamName

  • Type: typing.Optional[str]

StreamARN

  • Type: typing.Optional[str]

MaxResults

  • Type: typing.Optional[int]

NextToken

  • Type: typing.Optional[str]

DescribeMappedResourceConfigurationOutputTypeDef

MappedResourceConfigurationList

  • Type: typing.List[aws_resource_validator.pydantic_models.kinesisvideo_classes.MappedResourceConfigurationListItemTypeDef]
  • Required: Yes

NextToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DescribeMediaStorageConfigurationInputRequestTypeDef

ChannelName

  • Type: typing.Optional[str]

ChannelARN

  • Type: typing.Optional[str]

DescribeMediaStorageConfigurationOutputTypeDef

MediaStorageConfiguration

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DescribeNotificationConfigurationInputRequestTypeDef

StreamName

  • Type: typing.Optional[str]

StreamARN

  • Type: typing.Optional[str]

DescribeNotificationConfigurationOutputTypeDef

NotificationConfiguration

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DescribeSignalingChannelInputRequestTypeDef

ChannelName

  • Type: typing.Optional[str]

ChannelARN

  • Type: typing.Optional[str]

DescribeSignalingChannelOutputTypeDef

ChannelInfo

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DescribeStreamInputRequestTypeDef

StreamName

  • Type: typing.Optional[str]

StreamARN

  • Type: typing.Optional[str]

DescribeStreamOutputTypeDef

StreamInfo

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

EdgeAgentStatusTypeDef

LastRecorderStatus

  • Type: typing.Optional[aws_resource_validator.pydantic_models.kinesisvideo_classes.LastRecorderStatusTypeDef]

LastUploaderStatus

  • Type: typing.Optional[aws_resource_validator.pydantic_models.kinesisvideo_classes.LastUploaderStatusTypeDef]

EdgeConfigTypeDef

HubDeviceArn

  • Type:
  • Required: Yes

RecorderConfig

  • Type:
  • Required: Yes

UploaderConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.kinesisvideo_classes.UploaderConfigTypeDef]

DeletionConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.kinesisvideo_classes.DeletionConfigTypeDef]

GetDataEndpointInputRequestTypeDef

APIName

  • Type: typing.Literal['GET_CLIP', 'GET_DASH_STREAMING_SESSION_URL', 'GET_HLS_STREAMING_SESSION_URL', 'GET_IMAGES', 'GET_MEDIA', 'GET_MEDIA_FOR_FRAGMENT_LIST', 'LIST_FRAGMENTS', 'PUT_MEDIA']
  • Required: Yes

StreamName

  • Type: typing.Optional[str]

StreamARN

  • Type: typing.Optional[str]

GetDataEndpointOutputTypeDef

DataEndpoint

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetSignalingChannelEndpointInputRequestTypeDef

ChannelARN

  • Type:
  • Required: Yes

SingleMasterChannelEndpointConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.kinesisvideo_classes.SingleMasterChannelEndpointConfigurationTypeDef]

GetSignalingChannelEndpointOutputTypeDef

ResourceEndpointList

  • Type: typing.List[aws_resource_validator.pydantic_models.kinesisvideo_classes.ResourceEndpointListItemTypeDef]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ImageGenerationConfigurationTypeDef

Status

  • Type: typing.Literal['DISABLED', 'ENABLED']
  • Required: Yes

ImageSelectorType

  • Type: typing.Literal['PRODUCER_TIMESTAMP', 'SERVER_TIMESTAMP']
  • Required: Yes

DestinationConfig

  • Type:
  • Required: Yes

SamplingInterval

  • Type:
  • Required: Yes

Format

  • Type: typing.Literal['JPEG', 'PNG']
  • Required: Yes

FormatConfig

  • Type: typing.Optional[typing.Dict[typing.Literal['JPEGQuality'], str]]

WidthPixels

  • Type: typing.Optional[int]

HeightPixels

  • Type: typing.Optional[int]

ImageGenerationDestinationConfigTypeDef

Uri

  • Type:
  • Required: Yes

DestinationRegion

  • Type:
  • Required: Yes

LastRecorderStatusTypeDef

JobStatusDetails

  • Type: typing.Optional[str]

LastCollectedTime

  • Type: typing.Optional[datetime.datetime]

LastUpdatedTime

  • Type: typing.Optional[datetime.datetime]

RecorderStatus

  • Type: typing.Optional[typing.Literal['SUCCESS', 'SYSTEM_ERROR', 'USER_ERROR']]

LastUploaderStatusTypeDef

JobStatusDetails

  • Type: typing.Optional[str]

LastCollectedTime

  • Type: typing.Optional[datetime.datetime]

LastUpdatedTime

  • Type: typing.Optional[datetime.datetime]

UploaderStatus

  • Type: typing.Optional[typing.Literal['SUCCESS', 'SYSTEM_ERROR', 'USER_ERROR']]

ListEdgeAgentConfigurationsEdgeConfigTypeDef

StreamName

  • Type: typing.Optional[str]

StreamARN

  • Type: typing.Optional[str]

CreationTime

  • Type: typing.Optional[datetime.datetime]

LastUpdatedTime

  • Type: typing.Optional[datetime.datetime]

SyncStatus

  • Type: typing.Optional[typing.Literal['ACKNOWLEDGED', 'DELETE_FAILED', 'DELETING', 'DELETING_ACKNOWLEDGED', 'IN_SYNC', 'SYNCING', 'SYNC_FAILED']]

FailedStatusDetails

  • Type: typing.Optional[str]

EdgeConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.kinesisvideo_classes.EdgeConfigTypeDef]

ListEdgeAgentConfigurationsInputListEdgeAgentConfigurationsPaginateTypeDef

HubDeviceArn

  • Type:
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.kinesisvideo_classes.PaginatorConfigTypeDef]

ListEdgeAgentConfigurationsInputRequestTypeDef

HubDeviceArn

  • Type:
  • Required: Yes

MaxResults

  • Type: typing.Optional[int]

NextToken

  • Type: typing.Optional[str]

ListEdgeAgentConfigurationsOutputTypeDef

EdgeConfigs

  • Type: typing.List[aws_resource_validator.pydantic_models.kinesisvideo_classes.ListEdgeAgentConfigurationsEdgeConfigTypeDef]
  • Required: Yes

NextToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListSignalingChannelsInputListSignalingChannelsPaginateTypeDef

ChannelNameCondition

  • Type: typing.Optional[aws_resource_validator.pydantic_models.kinesisvideo_classes.ChannelNameConditionTypeDef]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.kinesisvideo_classes.PaginatorConfigTypeDef]

ListSignalingChannelsInputRequestTypeDef

MaxResults

  • Type: typing.Optional[int]

NextToken

  • Type: typing.Optional[str]

ChannelNameCondition

  • Type: typing.Optional[aws_resource_validator.pydantic_models.kinesisvideo_classes.ChannelNameConditionTypeDef]

ListSignalingChannelsOutputTypeDef

ChannelInfoList

  • Type: typing.List[aws_resource_validator.pydantic_models.kinesisvideo_classes.ChannelInfoTypeDef]
  • Required: Yes

NextToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListStreamsInputListStreamsPaginateTypeDef

StreamNameCondition

  • Type: typing.Optional[aws_resource_validator.pydantic_models.kinesisvideo_classes.StreamNameConditionTypeDef]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.kinesisvideo_classes.PaginatorConfigTypeDef]

ListStreamsInputRequestTypeDef

MaxResults

  • Type: typing.Optional[int]

NextToken

  • Type: typing.Optional[str]

StreamNameCondition

  • Type: typing.Optional[aws_resource_validator.pydantic_models.kinesisvideo_classes.StreamNameConditionTypeDef]

ListStreamsOutputTypeDef

StreamInfoList

  • Type: typing.List[aws_resource_validator.pydantic_models.kinesisvideo_classes.StreamInfoTypeDef]
  • Required: Yes

NextToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListTagsForResourceInputRequestTypeDef

ResourceARN

  • Type:
  • Required: Yes

NextToken

  • Type: typing.Optional[str]

ListTagsForResourceOutputTypeDef

NextToken

  • Type:
  • Required: Yes

Tags

  • Type: typing.Dict[str, str]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListTagsForStreamInputRequestTypeDef

NextToken

  • Type: typing.Optional[str]

StreamARN

  • Type: typing.Optional[str]

StreamName

  • Type: typing.Optional[str]

ListTagsForStreamOutputTypeDef

NextToken

  • Type:
  • Required: Yes

Tags

  • Type: typing.Dict[str, str]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

LocalSizeConfigTypeDef

MaxLocalMediaSizeInMB

  • Type: typing.Optional[int]

StrategyOnFullSize

  • Type: typing.Optional[typing.Literal['DELETE_OLDEST_MEDIA', 'DENY_NEW_MEDIA']]

MappedResourceConfigurationListItemTypeDef

Type

  • Type: typing.Optional[str]

ARN

  • Type: typing.Optional[str]

MediaSourceConfigTypeDef

MediaUriSecretArn

  • Type:
  • Required: Yes

MediaUriType

  • Type: typing.Literal['FILE_URI', 'RTSP_URI']
  • Required: Yes

MediaStorageConfigurationTypeDef

Status

  • Type: typing.Literal['DISABLED', 'ENABLED']
  • Required: Yes

StreamARN

  • Type: typing.Optional[str]

NotificationConfigurationTypeDef

Status

  • Type: typing.Literal['DISABLED', 'ENABLED']
  • Required: Yes

DestinationConfig

  • Type:
  • Required: Yes

NotificationDestinationConfigTypeDef

Uri

  • Type:
  • Required: Yes

PaginatorConfigTypeDef

MaxItems

  • Type: typing.Optional[int]

PageSize

  • Type: typing.Optional[int]

StartingToken

  • Type: typing.Optional[str]

RecorderConfigTypeDef

MediaSourceConfig

  • Type:
  • Required: Yes

ScheduleConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.kinesisvideo_classes.ScheduleConfigTypeDef]

ResourceEndpointListItemTypeDef

Protocol

  • Type: typing.Optional[typing.Literal['HTTPS', 'WEBRTC', 'WSS']]

ResourceEndpoint

  • Type: typing.Optional[str]

ResponseMetadataTypeDef

RequestId

  • Type:
  • Required: Yes

HostId

  • Type:
  • Required: Yes

HTTPStatusCode

  • Type:
  • Required: Yes

HTTPHeaders

  • Type: typing.Dict[str, str]
  • Required: Yes

RetryAttempts

  • Type:
  • Required: Yes

ScheduleConfigTypeDef

ScheduleExpression

  • Type:
  • Required: Yes

DurationInSeconds

  • Type:
  • Required: Yes

SingleMasterChannelEndpointConfigurationTypeDef

Protocols

  • Type: typing.Optional[typing.Sequence[typing.Literal['HTTPS', 'WEBRTC', 'WSS']]]

Role

  • Type: typing.Optional[typing.Literal['MASTER', 'VIEWER']]

SingleMasterConfigurationTypeDef

MessageTtlSeconds

  • Type: typing.Optional[int]

StartEdgeConfigurationUpdateInputRequestTypeDef

EdgeConfig

  • Type:
  • Required: Yes

StreamName

  • Type: typing.Optional[str]

StreamARN

  • Type: typing.Optional[str]

StartEdgeConfigurationUpdateOutputTypeDef

StreamName

  • Type:
  • Required: Yes

StreamARN

  • Type:
  • Required: Yes

CreationTime

  • Type:
  • Required: Yes

LastUpdatedTime

  • Type:
  • Required: Yes

SyncStatus

  • Type: typing.Literal['ACKNOWLEDGED', 'DELETE_FAILED', 'DELETING', 'DELETING_ACKNOWLEDGED', 'IN_SYNC', 'SYNCING', 'SYNC_FAILED']
  • Required: Yes

FailedStatusDetails

  • Type:
  • Required: Yes

EdgeConfig

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

StreamInfoTypeDef

DeviceName

  • Type: typing.Optional[str]

StreamName

  • Type: typing.Optional[str]

StreamARN

  • Type: typing.Optional[str]

MediaType

  • Type: typing.Optional[str]

KmsKeyId

  • Type: typing.Optional[str]

Version

  • Type: typing.Optional[str]

Status

  • Type: typing.Optional[typing.Literal['ACTIVE', 'CREATING', 'DELETING', 'UPDATING']]

CreationTime

  • Type: typing.Optional[datetime.datetime]

DataRetentionInHours

  • Type: typing.Optional[int]

StreamNameConditionTypeDef

ComparisonOperator

  • Type: typing.Optional[typing.Literal['BEGINS_WITH']]

ComparisonValue

  • Type: typing.Optional[str]

TagResourceInputRequestTypeDef

ResourceARN

  • Type:
  • Required: Yes

Tags

  • Type: typing.Sequence[aws_resource_validator.pydantic_models.kinesisvideo_classes.TagTypeDef]
  • Required: Yes

TagStreamInputRequestTypeDef

Tags

  • Type: typing.Mapping[str, str]
  • Required: Yes

StreamARN

  • Type: typing.Optional[str]

StreamName

  • Type: typing.Optional[str]

TagTypeDef

Key

  • Type:
  • Required: Yes

Value

  • Type:
  • Required: Yes

UntagResourceInputRequestTypeDef

ResourceARN

  • Type:
  • Required: Yes

TagKeyList

  • Type: typing.Sequence[str]
  • Required: Yes

UntagStreamInputRequestTypeDef

TagKeyList

  • Type: typing.Sequence[str]
  • Required: Yes

StreamARN

  • Type: typing.Optional[str]

StreamName

  • Type: typing.Optional[str]

UpdateDataRetentionInputRequestTypeDef

CurrentVersion

  • Type:
  • Required: Yes

Operation

  • Type: typing.Literal['DECREASE_DATA_RETENTION', 'INCREASE_DATA_RETENTION']
  • Required: Yes

DataRetentionChangeInHours

  • Type:
  • Required: Yes

StreamName

  • Type: typing.Optional[str]

StreamARN

  • Type: typing.Optional[str]

UpdateImageGenerationConfigurationInputRequestTypeDef

StreamName

  • Type: typing.Optional[str]

StreamARN

  • Type: typing.Optional[str]

ImageGenerationConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.kinesisvideo_classes.ImageGenerationConfigurationTypeDef]

UpdateMediaStorageConfigurationInputRequestTypeDef

ChannelARN

  • Type:
  • Required: Yes

MediaStorageConfiguration

  • Type:
  • Required: Yes

UpdateNotificationConfigurationInputRequestTypeDef

StreamName

  • Type: typing.Optional[str]

StreamARN

  • Type: typing.Optional[str]

NotificationConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.kinesisvideo_classes.NotificationConfigurationTypeDef]

UpdateSignalingChannelInputRequestTypeDef

ChannelARN

  • Type:
  • Required: Yes

CurrentVersion

  • Type:
  • Required: Yes

SingleMasterConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.kinesisvideo_classes.SingleMasterConfigurationTypeDef]

UpdateStreamInputRequestTypeDef

CurrentVersion

  • Type:
  • Required: Yes

StreamName

  • Type: typing.Optional[str]

StreamARN

  • Type: typing.Optional[str]

DeviceName

  • Type: typing.Optional[str]

MediaType

  • Type: typing.Optional[str]

UploaderConfigTypeDef

ScheduleConfig

  • Type:
  • Required: Yes