Copyright | (c) 2013-2018 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
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.
- createStream :: Text -> CreateStream
- data CreateStream
- csMediaType :: Lens' CreateStream (Maybe Text)
- csDataRetentionInHours :: Lens' CreateStream (Maybe Natural)
- csKMSKeyId :: Lens' CreateStream (Maybe Text)
- csDeviceName :: Lens' CreateStream (Maybe Text)
- csStreamName :: Lens' CreateStream Text
- createStreamResponse :: Int -> CreateStreamResponse
- data CreateStreamResponse
- csrsStreamARN :: Lens' CreateStreamResponse (Maybe Text)
- csrsResponseStatus :: Lens' CreateStreamResponse Int
Creating a Request
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 theMediaType
, 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 asvideo/h264
. This parameter is optional; the default value isnull
(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 Source #
See: createStream
smart constructor.
Request Lenses
csMediaType :: Lens' CreateStream (Maybe Text) Source #
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) Source #
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) Source #
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) Source #
The name of the device that is writing to the stream.
csStreamName :: Lens' CreateStream Text Source #
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
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 Source #
See: createStreamResponse
smart constructor.
Response Lenses
csrsStreamARN :: Lens' CreateStreamResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the stream.
csrsResponseStatus :: Lens' CreateStreamResponse Int Source #
- - | The response status code.