You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::KinesisVideo::Types::UpdateStreamInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/types.rb

Overview

Note:

When making an API call, you may pass UpdateStreamInput data as a hash:

{
  stream_name: "StreamName",
  stream_arn: "ResourceARN",
  current_version: "Version", # required
  device_name: "DeviceName",
  media_type: "MediaType",
}

Instance Attribute Summary collapse

Instance Attribute Details

#current_versionString

The version of the stream whose metadata you want to update.

Returns:

  • (String)


590
591
592
593
594
595
596
597
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/types.rb', line 590

class UpdateStreamInput < Struct.new(
  :stream_name,
  :stream_arn,
  :current_version,
  :device_name,
  :media_type)
  include Aws::Structure
end

#device_nameString

The name of the device that is writing to the stream.

In the current implementation, Kinesis Video Streams does not use this name.

Returns:

  • (String)


590
591
592
593
594
595
596
597
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/types.rb', line 590

class UpdateStreamInput < Struct.new(
  :stream_name,
  :stream_arn,
  :current_version,
  :device_name,
  :media_type)
  include Aws::Structure
end

#media_typeString

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.

Returns:

  • (String)


590
591
592
593
594
595
596
597
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/types.rb', line 590

class UpdateStreamInput < Struct.new(
  :stream_name,
  :stream_arn,
  :current_version,
  :device_name,
  :media_type)
  include Aws::Structure
end

#stream_arnString

The ARN of the stream whose metadata you want to update.

Returns:

  • (String)


590
591
592
593
594
595
596
597
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/types.rb', line 590

class UpdateStreamInput < Struct.new(
  :stream_name,
  :stream_arn,
  :current_version,
  :device_name,
  :media_type)
  include Aws::Structure
end

#stream_nameString

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.

Returns:

  • (String)


590
591
592
593
594
595
596
597
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/types.rb', line 590

class UpdateStreamInput < Struct.new(
  :stream_name,
  :stream_arn,
  :current_version,
  :device_name,
  :media_type)
  include Aws::Structure
end