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

Class: Aws::KinesisVideo::Types::DeleteStreamInput

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 DeleteStreamInput data as a hash:

{
  stream_arn: "ResourceARN", # required
  current_version: "Version",
}

Instance Attribute Summary collapse

Instance Attribute Details

#current_versionString

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.

Returns:

  • (String)


128
129
130
131
132
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/types.rb', line 128

class DeleteStreamInput < Struct.new(
  :stream_arn,
  :current_version)
  include Aws::Structure
end

#stream_arnString

The Amazon Resource Name (ARN) of the stream that you want to delete.

Returns:

  • (String)


128
129
130
131
132
# File 'gems/aws-sdk-kinesisvideo/lib/aws-sdk-kinesisvideo/types.rb', line 128

class DeleteStreamInput < Struct.new(
  :stream_arn,
  :current_version)
  include Aws::Structure
end