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

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#current_versionString

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)


2043
2044
2045
2046
2047
2048
2049
2050
2051
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/types.rb', line 2043

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_hoursInteger

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)


2043
2044
2045
2046
2047
2048
2049
2050
2051
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/types.rb', line 2043

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

#operationString

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

Returns:

  • (String)


2043
2044
2045
2046
2047
2048
2049
2050
2051
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/types.rb', line 2043

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

#stream_arnString

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

Returns:

  • (String)


2043
2044
2045
2046
2047
2048
2049
2050
2051
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/types.rb', line 2043

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

#stream_nameString

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

Returns:

  • (String)


2043
2044
2045
2046
2047
2048
2049
2050
2051
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/types.rb', line 2043

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