Amazonka.KinesisVideo.CreateStream

Creates a new Kinesis video stream.

When you create a new stream, Kinesis Video Streams assigns it a version number. When you change the stream's metadata, Kinesis Video Streams updates the version.

CreateStream is an asynchronous operation.

For information about how the service works, see How it Works.

You must have permissions for the KinesisVideo:CreateStream action.

Creating a Request

data CreateStream

See: newCreateStream smart constructor.

Constructors

CreateStream'

Fields

• dataRetentionInHours :: Maybe Natural

  The number of hours that you want to retain the data in the stream. Kinesis Video Streams retains the data in a data store that is associated with the stream.

  The default value is 0, indicating that the stream does not persist data.

  When the DataRetentionInHours value is 0, consumers can still consume the fragments that remain in the service host buffer, which has a retention time limit of 5 minutes and a retention memory limit of 200 MB. Fragments are removed from the buffer when either limit is reached.

• deviceName :: Maybe Text

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

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

• kmsKeyId :: Maybe Text

  The ID of the Key Management Service (KMS) key that you want Kinesis Video Streams to use to encrypt stream data.

  If no key ID is specified, the default, Kinesis Video-managed key (aws/kinesisvideo) is used.

  For more information, see DescribeKey.

• mediaType :: Maybe Text

  The media type of the stream. Consumers of the stream can use this information when processing the stream. For more information about media types, see Media Types. If you choose to specify the MediaType, see Naming Requirements for guidelines.

  Example valid values include "video/h264" and "video/h264,audio/aac".

  This parameter is optional; the default value is null (or empty in JSON).

• tags :: Maybe (HashMap Text Text)

  A list of tags to associate with the specified stream. Each tag is a key-value pair (the value is optional).

• streamName :: Text

  A name for the stream that you are creating.

  The stream name is an identifier for the stream, and must be unique for each account and region.

Instances

ToJSON CreateStream

Defined in Amazonka.KinesisVideo.CreateStream

Methods

toJSON :: CreateStream -> Value

toEncoding :: CreateStream -> Encoding

toJSONList :: [CreateStream] -> Value

toEncodingList :: [CreateStream] -> Encoding

ToHeaders CreateStream

Defined in Amazonka.KinesisVideo.CreateStream

Methods

toHeaders :: CreateStream -> [Header]

ToPath CreateStream

Defined in Amazonka.KinesisVideo.CreateStream

Methods

toPath :: CreateStream -> ByteString

ToQuery CreateStream

Defined in Amazonka.KinesisVideo.CreateStream

Methods

toQuery :: CreateStream -> QueryString

AWSRequest CreateStream

Defined in Amazonka.KinesisVideo.CreateStream

Associated Types

type AWSResponse CreateStream

Methods

request :: (Service -> Service) -> CreateStream -> Request CreateStream

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateStream -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateStream)))

Generic CreateStream

Defined in Amazonka.KinesisVideo.CreateStream

Associated Types

type Rep CreateStream :: Type -> Type

Methods

from :: CreateStream -> Rep CreateStream x

to :: Rep CreateStream x -> CreateStream

Read CreateStream

Defined in Amazonka.KinesisVideo.CreateStream

Methods

readsPrec :: Int -> ReadS CreateStream

readList :: ReadS [CreateStream]

readPrec :: ReadPrec CreateStream

readListPrec :: ReadPrec [CreateStream]

Show CreateStream

Defined in Amazonka.KinesisVideo.CreateStream

Methods

showsPrec :: Int -> CreateStream -> ShowS

show :: CreateStream -> String

showList :: [CreateStream] -> ShowS

NFData CreateStream

Defined in Amazonka.KinesisVideo.CreateStream

Methods

rnf :: CreateStream -> ()

Eq CreateStream

Defined in Amazonka.KinesisVideo.CreateStream

Methods

(==) :: CreateStream -> CreateStream -> Bool

(/=) :: CreateStream -> CreateStream -> Bool

Hashable CreateStream

Defined in Amazonka.KinesisVideo.CreateStream

Methods

hashWithSalt :: Int -> CreateStream -> Int

hash :: CreateStream -> Int

type AWSResponse CreateStream

Defined in Amazonka.KinesisVideo.CreateStream

type AWSResponse CreateStream = CreateStreamResponse

type Rep CreateStream

Defined in Amazonka.KinesisVideo.CreateStream

type Rep CreateStream = D1 ('MetaData "CreateStream" "Amazonka.KinesisVideo.CreateStream" "amazonka-kinesis-video-2.0-5DR7d8jw2IyAvZJM3U7dwM" 'False) (C1 ('MetaCons "CreateStream'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dataRetentionInHours") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "deviceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "mediaType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "streamName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateStream

Arguments

:: Text

CreateStream

-> CreateStream

Create a value of CreateStream with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateStream, createStream_dataRetentionInHours - The number of hours that you want to retain the data in the stream. Kinesis Video Streams retains the data in a data store that is associated with the stream.

The default value is 0, indicating that the stream does not persist data.

When the DataRetentionInHours value is 0, consumers can still consume the fragments that remain in the service host buffer, which has a retention time limit of 5 minutes and a retention memory limit of 200 MB. Fragments are removed from the buffer when either limit is reached.

CreateStream, createStream_deviceName - The name of the device that is writing to the stream.

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

CreateStream, createStream_kmsKeyId - The ID of the Key Management Service (KMS) key that you want Kinesis Video Streams to use to encrypt stream data.

If no key ID is specified, the default, Kinesis Video-managed key (aws/kinesisvideo) is used.

For more information, see DescribeKey.

CreateStream, createStream_mediaType - The media type of the stream. Consumers of the stream can use this information when processing the stream. For more information about media types, see Media Types. If you choose to specify the MediaType, see Naming Requirements for guidelines.

Example valid values include "video/h264" and "video/h264,audio/aac".

This parameter is optional; the default value is null (or empty in JSON).

$sel:tags:CreateStream', createStream_tags - A list of tags to associate with the specified stream. Each tag is a key-value pair (the value is optional).

CreateStream, createStream_streamName - A name for the stream that you are creating.

The stream name is an identifier for the stream, and must be unique for each account and region.

Request Lenses

createStream_dataRetentionInHours :: Lens' CreateStream (Maybe Natural)

The number of hours that you want to retain the data in the stream. Kinesis Video Streams retains the data in a data store that is associated with the stream.

The default value is 0, indicating that the stream does not persist data.

When the DataRetentionInHours value is 0, consumers can still consume the fragments that remain in the service host buffer, which has a retention time limit of 5 minutes and a retention memory limit of 200 MB. Fragments are removed from the buffer when either limit is reached.

createStream_deviceName :: Lens' CreateStream (Maybe Text)

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

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

createStream_kmsKeyId :: Lens' CreateStream (Maybe Text)

The ID of the Key Management Service (KMS) key that you want Kinesis Video Streams to use to encrypt stream data.

If no key ID is specified, the default, Kinesis Video-managed key (aws/kinesisvideo) is used.

For more information, see DescribeKey.

createStream_mediaType :: Lens' CreateStream (Maybe Text)

The media type of the stream. Consumers of the stream can use this information when processing the stream. For more information about media types, see Media Types. If you choose to specify the MediaType, see Naming Requirements for guidelines.

Example valid values include "video/h264" and "video/h264,audio/aac".

This parameter is optional; the default value is null (or empty in JSON).

createStream_tags :: Lens' CreateStream (Maybe (HashMap Text Text))

A list of tags to associate with the specified stream. Each tag is a key-value pair (the value is optional).

createStream_streamName :: Lens' CreateStream Text

A name for the stream that you are creating.

The stream name is an identifier for the stream, and must be unique for each account and region.

Destructuring the Response

data CreateStreamResponse

See: newCreateStreamResponse smart constructor.

Constructors

CreateStreamResponse'

Fields

• streamARN :: Maybe Text

  The Amazon Resource Name (ARN) of the stream.

• httpStatus :: Int

  The response's http status code.

Instances

Generic CreateStreamResponse

Defined in Amazonka.KinesisVideo.CreateStream

Associated Types

type Rep CreateStreamResponse :: Type -> Type

Methods

from :: CreateStreamResponse -> Rep CreateStreamResponse x

to :: Rep CreateStreamResponse x -> CreateStreamResponse

Read CreateStreamResponse

Defined in Amazonka.KinesisVideo.CreateStream

Methods

readsPrec :: Int -> ReadS CreateStreamResponse

readList :: ReadS [CreateStreamResponse]

readPrec :: ReadPrec CreateStreamResponse

readListPrec :: ReadPrec [CreateStreamResponse]

Show CreateStreamResponse

Defined in Amazonka.KinesisVideo.CreateStream

Methods

showsPrec :: Int -> CreateStreamResponse -> ShowS

show :: CreateStreamResponse -> String

showList :: [CreateStreamResponse] -> ShowS

NFData CreateStreamResponse

Defined in Amazonka.KinesisVideo.CreateStream

Methods

rnf :: CreateStreamResponse -> ()

Eq CreateStreamResponse

Defined in Amazonka.KinesisVideo.CreateStream

Methods

(==) :: CreateStreamResponse -> CreateStreamResponse -> Bool

(/=) :: CreateStreamResponse -> CreateStreamResponse -> Bool

type Rep CreateStreamResponse

Defined in Amazonka.KinesisVideo.CreateStream

type Rep CreateStreamResponse = D1 ('MetaData "CreateStreamResponse" "Amazonka.KinesisVideo.CreateStream" "amazonka-kinesis-video-2.0-5DR7d8jw2IyAvZJM3U7dwM" 'False) (C1 ('MetaCons "CreateStreamResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "streamARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateStreamResponse

Arguments

:: Int

$sel:httpStatus:CreateStreamResponse'

-> CreateStreamResponse

Create a value of CreateStreamResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateStreamResponse, createStreamResponse_streamARN - The Amazon Resource Name (ARN) of the stream.

$sel:httpStatus:CreateStreamResponse', createStreamResponse_httpStatus - The response's http status code.

Response Lenses

createStreamResponse_streamARN :: Lens' CreateStreamResponse (Maybe Text)

The Amazon Resource Name (ARN) of the stream.

createStreamResponse_httpStatus :: Lens' CreateStreamResponse Int

The response's http status code.