Network.AWS.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

createStream

Arguments

:: Text

csStreamName

-> CreateStream

Creates a value of CreateStream with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• csMediaType - 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. To play video on the console, the media must be H.264 encoded, and you need to specify this video type in this parameter as video/h264 . This parameter is optional; the default value is null (or empty in JSON).
• csDataRetentionInHours - 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.
• csKMSKeyId - The ID of the AWS Key Management Service (AWS 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 .
• csDeviceName - The name of the device that is writing to the stream.
• csStreamName - 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.

data CreateStream

See: createStream smart constructor.

Instances

Eq CreateStream

Methods

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

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

Data CreateStream

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateStream -> c CreateStream

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateStream

toConstr :: CreateStream -> Constr

dataTypeOf :: CreateStream -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateStream)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateStream)

gmapT :: (forall b. Data b => b -> b) -> CreateStream -> CreateStream

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateStream -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateStream -> r

gmapQ :: (forall d. Data d => d -> u) -> CreateStream -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateStream -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateStream -> m CreateStream

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateStream -> m CreateStream

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateStream -> m CreateStream

Read CreateStream

Methods

readsPrec :: Int -> ReadS CreateStream

readList :: ReadS [CreateStream]

readPrec :: ReadPrec CreateStream

readListPrec :: ReadPrec [CreateStream]

Show CreateStream

Methods

showsPrec :: Int -> CreateStream -> ShowS

show :: CreateStream -> String

showList :: [CreateStream] -> ShowS

Generic CreateStream

Associated Types

type Rep CreateStream :: * -> *

Methods

from :: CreateStream -> Rep CreateStream x

to :: Rep CreateStream x -> CreateStream

Hashable CreateStream

Methods

hashWithSalt :: Int -> CreateStream -> Int

hash :: CreateStream -> Int

ToJSON CreateStream

Methods

toJSON :: CreateStream -> Value

toEncoding :: CreateStream -> Encoding

toJSONList :: [CreateStream] -> Value

toEncodingList :: [CreateStream] -> Encoding

NFData CreateStream

Methods

rnf :: CreateStream -> ()

AWSRequest CreateStream

Associated Types

type Rs CreateStream :: *

Methods

request :: CreateStream -> Request CreateStream

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * CreateStream -> ClientResponse -> m (Response CreateStream)

ToHeaders CreateStream

Methods

toHeaders :: CreateStream -> [Header]

ToPath CreateStream

Methods

toPath :: CreateStream -> ByteString

ToQuery CreateStream

Methods

toQuery :: CreateStream -> QueryString

type Rep CreateStream

type Rep CreateStream = D1 * (MetaData "CreateStream" "Network.AWS.KinesisVideo.CreateStream" "amazonka-kinesis-video-1.6.0-Evo5CFODH986fZyUSJYXKc" False) (C1 * (MetaCons "CreateStream'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_csMediaType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_csDataRetentionInHours") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Nat)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_csKMSKeyId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_csDeviceName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_csStreamName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text))))))

type Rs CreateStream

type Rs CreateStream = CreateStreamResponse

Request Lenses

csMediaType :: 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. To play video on the console, the media must be H.264 encoded, and you need to specify this video type in this parameter as video/h264 . This parameter is optional; the default value is null (or empty in JSON).

csDataRetentionInHours :: 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.

csKMSKeyId :: Lens' CreateStream (Maybe Text)

The ID of the AWS Key Management Service (AWS 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 .

csDeviceName :: Lens' CreateStream (Maybe Text)

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

csStreamName :: 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

createStreamResponse

Arguments

:: Int

csrsResponseStatus

-> CreateStreamResponse

Creates a value of CreateStreamResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• csrsStreamARN - The Amazon Resource Name (ARN) of the stream.
• csrsResponseStatus - -- | The response status code.

data CreateStreamResponse

See: createStreamResponse smart constructor.

Instances

Eq CreateStreamResponse

Methods

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

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

Data CreateStreamResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateStreamResponse -> c CreateStreamResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateStreamResponse

toConstr :: CreateStreamResponse -> Constr

dataTypeOf :: CreateStreamResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateStreamResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateStreamResponse)

gmapT :: (forall b. Data b => b -> b) -> CreateStreamResponse -> CreateStreamResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateStreamResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateStreamResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> CreateStreamResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateStreamResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateStreamResponse -> m CreateStreamResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateStreamResponse -> m CreateStreamResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateStreamResponse -> m CreateStreamResponse

Read CreateStreamResponse

Methods

readsPrec :: Int -> ReadS CreateStreamResponse

readList :: ReadS [CreateStreamResponse]

readPrec :: ReadPrec CreateStreamResponse

readListPrec :: ReadPrec [CreateStreamResponse]

Show CreateStreamResponse

Methods

showsPrec :: Int -> CreateStreamResponse -> ShowS

show :: CreateStreamResponse -> String

showList :: [CreateStreamResponse] -> ShowS

Generic CreateStreamResponse

Associated Types

type Rep CreateStreamResponse :: * -> *

Methods

from :: CreateStreamResponse -> Rep CreateStreamResponse x

to :: Rep CreateStreamResponse x -> CreateStreamResponse

NFData CreateStreamResponse

Methods

rnf :: CreateStreamResponse -> ()

type Rep CreateStreamResponse

type Rep CreateStreamResponse = D1 * (MetaData "CreateStreamResponse" "Network.AWS.KinesisVideo.CreateStream" "amazonka-kinesis-video-1.6.0-Evo5CFODH986fZyUSJYXKc" False) (C1 * (MetaCons "CreateStreamResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_csrsStreamARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_csrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))

Response Lenses

csrsStreamARN :: Lens' CreateStreamResponse (Maybe Text)

The Amazon Resource Name (ARN) of the stream.

csrsResponseStatus :: Lens' CreateStreamResponse Int

• - | The response status code.