Class: Aws::KinesisVideo::Types::UpdateDataRetentionInput

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#current_version ⇒ String

The version of the stream whose retention period you want to change. To get the version, call either the ‘DescribeStream` or the `ListStreams` API.

Returns:

  • (String) 


1952
1953
1954
1955
1956
1957
1958
1959
1960
 
# File 'lib/aws-sdk-kinesisvideo/types.rb', line 1952

class UpdateDataRetentionInput < Struct.new(
  :stream_name,
  :stream_arn,
  :current_version,
  :operation,
  :data_retention_change_in_hours)
  SENSITIVE = []
  include Aws::Structure
end

#data_retention_change_in_hours ⇒ Integer

The number of hours to adjust the current retention by. The value you specify is added to or subtracted from the current value, depending on the ‘operation`.

The minimum value for data retention is 0 and the maximum value is 87600 (ten years).

Returns:

  • (Integer) 


1952
1953
1954
1955
1956
1957
1958
1959
1960
 
# File 'lib/aws-sdk-kinesisvideo/types.rb', line 1952

class UpdateDataRetentionInput < Struct.new(
  :stream_name,
  :stream_arn,
  :current_version,
  :operation,
  :data_retention_change_in_hours)
  SENSITIVE = []
  include Aws::Structure
end

#operation ⇒ String

Indicates whether you want to increase or decrease the retention period.

Returns:

  • (String) 


1952
1953
1954
1955
1956
1957
1958
1959
1960
 
# File 'lib/aws-sdk-kinesisvideo/types.rb', line 1952

class UpdateDataRetentionInput < Struct.new(
  :stream_name,
  :stream_arn,
  :current_version,
  :operation,
  :data_retention_change_in_hours)
  SENSITIVE = []
  include Aws::Structure
end

#stream_arn ⇒ String

The Amazon Resource Name (ARN) of the stream whose retention period you want to change.

Returns:

  • (String) 


1952
1953
1954
1955
1956
1957
1958
1959
1960
 
# File 'lib/aws-sdk-kinesisvideo/types.rb', line 1952

class UpdateDataRetentionInput < Struct.new(
  :stream_name,
  :stream_arn,
  :current_version,
  :operation,
  :data_retention_change_in_hours)
  SENSITIVE = []
  include Aws::Structure
end

#stream_name ⇒ String

The name of the stream whose retention period you want to change.

Returns:

  • (String) 


1952
1953
1954
1955
1956
1957
1958
1959
1960
 
# File 'lib/aws-sdk-kinesisvideo/types.rb', line 1952

class UpdateDataRetentionInput < Struct.new(
  :stream_name,
  :stream_arn,
  :current_version,
  :operation,
  :data_retention_change_in_hours)
  SENSITIVE = []
  include Aws::Structure
end