naftiko: 1.0.0-alpha2 info: label: Amazon Kinesis Video Streams description: 'Amazon Kinesis Video Streams. 28 operations. Lead operation: Amazon Kinesis Video Streams. Self-contained Naftiko capability covering one Kinesis business surface.' tags: - Kinesis - Amazon Kinesis Video Streams created: '2026-05-19' modified: '2026-05-19' binds: - namespace: env keys: KINESIS_API_KEY: KINESIS_API_KEY capability: consumes: - type: http namespace: amazon-kinesis-video-streams baseUri: http://kinesisvideo.{region}.amazonaws.com description: Amazon Kinesis Video Streams business capability. Self-contained, no shared references. resources: - name: ListTagsForResource path: /ListTagsForResource operations: - name: listtagsforresource method: POST description: Returns a list of tags associated with the specified signaling channel. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: TagResource path: /TagResource operations: - name: tagresource method: POST description: Adds one or more tags to a signaling channel. A tag is a key-value pair (the value is optional) that you can define and assign to Amazon Web Services resources. If you specify a tag that already exists, the tag value is replaced with outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: UntagResource path: /UntagResource operations: - name: untagresource method: POST description: Removes one or more tags from a signaling channel. In the request, specify only a tag key or keys; don't specify the value. If you specify a tag key that does not exist, it's ignored. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: createSignalingChannel path: /createSignalingChannel operations: - name: createsignalingchannel method: POST description:
Creates a signaling channel.
CreateSignalingChannel is an asynchronous operation.
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.
CreateStreamDeleteSignalingChannel is an asynchronous operation.
If you don't specify the channel's current version, the most recent version is deleted.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: deleteStream
path: /deleteStream
operations:
- name: deletestream
method: POST
description:
Deletes a Kinesis video stream and the data contained in the stream.
This method marks the stream for deletion, and makes the data in the stream inaccessible immediately.
To ensure that
you have the latest versio
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: describeEdgeConfiguration
path: /describeEdgeConfiguration
operations:
- name: describeedgeconfiguration
method: POST
description: Describes a stream’s edge configuration that was set using the StartEdgeConfigurationUpdate
API. Use this API to get the status of the configuration if the configuration is in sync with the Edge Agent.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: describeImageGenerationConfiguration
path: /describeImageGenerationConfiguration
operations:
- name: describeimagegenerationconfiguration
method: POST
description: Gets the ImageGenerationConfiguration for a given Kinesis video stream.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: describeMappedResourceConfiguration
path: /describeMappedResourceConfiguration
operations:
- name: describemappedresourceconfiguration
method: POST
description:
Returns the most current information about the stream. Either streamName or streamARN should be provided in the input.
Returns the most current information about the stream. The streamName or streamARN
sh
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: MaxResults
in: query
type: string
description: Pagination limit
- name: NextToken
in: query
type: string
description: Pagination token
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: describeMediaStorageConfiguration
path: /describeMediaStorageConfiguration
operations:
- name: describemediastorageconfiguration
method: POST
description: Returns the most current information about the channel. Specify the ChannelName or ChannelARN
in the input.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: describeNotificationConfiguration
path: /describeNotificationConfiguration
operations:
- name: describenotificationconfiguration
method: POST
description: Gets the NotificationConfiguration for a given Kinesis video stream.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: describeSignalingChannel
path: /describeSignalingChannel
operations:
- name: describesignalingchannel
method: POST
description: Returns the most current information about the signaling channel. You must specify either the name or
the Amazon Resource Name (ARN) of the channel that you want to describe.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: describeStream
path: /describeStream
operations:
- name: describestream
method: POST
description: Returns the most current information about the specified stream. You must specify either the StreamName
or the StreamARN.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: getDataEndpoint
path: /getDataEndpoint
operations:
- name: getdataendpoint
method: POST
description: '
Gets an endpoint for a specified stream for either reading or writing. Use this endpoint in your
application to read from the specified stream (using the GetMedia or GetMediaForFragmentList
operations) or write '
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: getSignalingChannelEndpoint
path: /getSignalingChannelEndpoint
operations:
- name: getsignalingchannelendpoint
method: POST
description:
Provides an endpoint for the specified signaling channel to send and receive messages. This API uses
the Returns a list of tags associated with the specified stream. In the request, you must specify
either the An asynchronous API that updates a stream’s existing edge configuration. The Kinesis Video Stream
will sync the stream’s edge configuration with the Edge Agent IoT Greengrass component that runs on an IoT Hub Device,
setup at your premis
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: tagStream
path: /tagStream
operations:
- name: tagstream
method: POST
description: Adds one or more tags to a stream. A tag is a key-value pair (the value is optional) that you
can define and assign to Amazon Web Services resources. If you specify a tag that already exists, the tag value
is replaced with the val
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: untagStream
path: /untagStream
operations:
- name: untagstream
method: POST
description: Removes one or more tags from a stream. In the request, specify only a tag key or keys; don't specify
the value. If you specify a tag key that does not exist, it's ignored. In the request, you must provide the
Associates a If the Updates the existing signaling channel. This is an asynchronous operation and takes time to complete.
If the Updates stream metadata, such as the device name and media type. You must provide the stream
name or the Amazon Resource Name (ARN) of the stream. To make sure that you have the latest version of the
stream before updating '
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: body
in: body
type: object
description: Request body (JSON).
required: true
authentication:
type: apikey
key: Authorization
value: '{{env.KINESIS_API_KEY}}'
placement: header
exposes:
- type: rest
namespace: amazon-kinesis-video-streams-rest
port: 8080
description: REST adapter for Amazon Kinesis Video Streams. One Spectral-compliant resource per consumed operation, prefixed
with /v1.
resources:
- path: /v1/listtagsforresource
name: listtagsforresource
description: REST surface for ListTagsForResource.
operations:
- method: POST
name: listtagsforresource
description: Returns a list of tags associated with the specified signaling channel.
call: amazon-kinesis-video-streams.listtagsforresource
with:
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/tagresource
name: tagresource
description: REST surface for TagResource.
operations:
- method: POST
name: tagresource
description: Adds one or more tags to a signaling channel. A tag is a key-value pair (the value is optional)
that you can define and assign to Amazon Web Services resources. If you specify a tag that already exists, the tag
value is replaced with
call: amazon-kinesis-video-streams.tagresource
with:
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/untagresource
name: untagresource
description: REST surface for UntagResource.
operations:
- method: POST
name: untagresource
description: Removes one or more tags from a signaling channel. In the request, specify only a tag key or keys; don't
specify the value. If you specify a tag key that does not exist, it's ignored.
call: amazon-kinesis-video-streams.untagresource
with:
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/createsignalingchannel
name: createsignalingchannel
description: REST surface for createSignalingChannel.
operations:
- method: POST
name: createsignalingchannel
description: Creates a signaling channel. 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.
Deletes a Kinesis video stream and the data contained in the stream. This method marks the
stream for deletion, and makes the data in the stream inaccessible immediately. To ensure that
you have the latest versio
call: amazon-kinesis-video-streams.deletestream
with:
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/describeedgeconfiguration
name: describeedgeconfiguration
description: REST surface for describeEdgeConfiguration.
operations:
- method: POST
name: describeedgeconfiguration
description: Describes a stream’s edge configuration that was set using the Returns the most current information about the stream. Either streamName or streamARN should be provided
in the input. Returns the most current information about the stream. The Gets an endpoint for a specified stream for either reading or writing. Use this endpoint in your
application to read from the specified stream (using the Provides an endpoint for the specified signaling channel to send and receive messages. This API uses
the Returns a list of tags associated with the specified stream. In the request, you must specify
either the An asynchronous API that updates a stream’s existing edge configuration. The Kinesis Video Stream
will sync the stream’s edge configuration with the Edge Agent IoT Greengrass component that runs on an IoT Hub Device,
setup at your premis
call: amazon-kinesis-video-streams.startedgeconfigurationupdate
with:
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/tagstream
name: tagstream
description: REST surface for tagStream.
operations:
- method: POST
name: tagstream
description: Adds one or more tags to a stream. A tag is a key-value pair (the value is optional) that you
can define and assign to Amazon Web Services resources. If you specify a tag that already exists, the tag value
is replaced with the val
call: amazon-kinesis-video-streams.tagstream
with:
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/untagstream
name: untagstream
description: REST surface for untagStream.
operations:
- method: POST
name: untagstream
description: Removes one or more tags from a stream. In the request, specify only a tag key or keys; don't specify
the value. If you specify a tag key that does not exist, it's ignored. In the request, you must provide the
Associates a If the Updates the existing signaling channel. This is an asynchronous operation and takes time to complete.
If the Updates stream metadata, such as the device name and media type. You must provide the stream
name or the Amazon Resource Name (ARN) of the stream. To make sure that you have the latest version of the
stream before updating '
call: amazon-kinesis-video-streams.updatestream
with:
body: rest.body
outputParameters:
- type: object
mapping: $.
- type: mcp
namespace: amazon-kinesis-video-streams-mcp
port: 9090
transport: http
description: MCP adapter for Amazon Kinesis Video Streams. One tool per consumed operation, routed inline through this
capability's consumes block.
tools:
- name: returns-list-tags-associated-specified
description: Returns a list of tags associated with the specified signaling channel.
hints:
readOnly: true
destructive: false
idempotent: false
call: amazon-kinesis-video-streams.listtagsforresource
with:
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: adds-one-more-tags-signaling
description: Adds one or more tags to a signaling channel. A tag is a key-value pair (the value is optional)
that you can define and assign to Amazon Web Services resources. If you specify a tag that already exists, the tag
value is replaced with
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-kinesis-video-streams.tagresource
with:
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: removes-one-more-tags-signaling
description: Removes one or more tags from a signaling channel. In the request, specify only a tag key or keys; don't
specify the value. If you specify a tag key that does not exist, it's ignored.
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-kinesis-video-streams.untagresource
with:
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: p-creates-signaling-channel-p-p
description: Creates a signaling channel. 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. Deletes a Kinesis video stream and the data contained in the stream. This method marks the stream
for deletion, and makes the data in the stream inaccessible immediately. To ensure that you have
the latest versio
hints:
readOnly: true
destructive: false
idempotent: false
call: amazon-kinesis-video-streams.deletestream
with:
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: describes-stream-s-edge-configuration-that
description: Describes a stream’s edge configuration that was set using the Returns the most current information about the stream. Either streamName or streamARN should be provided
in the input. Returns the most current information about the stream. The Gets an endpoint for a specified stream for either reading or writing. Use this endpoint in your application
to read from the specified stream (using the Provides an endpoint for the specified signaling channel to send and receive messages. This API uses
the Returns a list of tags associated with the specified stream. In the request, you must specify
either the An asynchronous API that updates a stream’s existing edge configuration. The Kinesis Video Stream will
sync the stream’s edge configuration with the Edge Agent IoT Greengrass component that runs on an IoT Hub Device,
setup at your premis
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-kinesis-video-streams.startedgeconfigurationupdate
with:
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: p-adds-one-more-tags-stream
description: Adds one or more tags to a stream. A tag is a key-value pair (the value is optional) that you
can define and assign to Amazon Web Services resources. If you specify a tag that already exists, the tag value is
replaced with the val
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-kinesis-video-streams.tagstream
with:
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: p-removes-one-more-tags-stream
description: Removes one or more tags from a stream. In the request, specify only a tag key or keys; don't specify
the value. If you specify a tag key that does not exist, it's ignored. In the request, you must provide the
Associates a If the Updates the existing signaling channel. This is an asynchronous operation and takes time to complete.
If the Updates stream metadata, such as the device name and media type. You must provide the stream
name or the Amazon Resource Name (ARN) of the stream. To make sure that you have the latest version of the
stream before updating '
hints:
readOnly: true
destructive: false
idempotent: false
call: amazon-kinesis-video-streams.updatestream
with:
body: tools.body
outputParameters:
- type: object
mapping: $.
SingleMasterChannelEndpointConfiguration input parameter, which consists of the Protocols
and Role
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: listSignalingChannels
path: /listSignalingChannels
operations:
- name: listsignalingchannels
method: POST
description: Returns an array of ChannelInfo objects. Each object describes a signaling channel. To retrieve
only those channels that satisfy a specific condition, you can specify a ChannelNameCondition.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: MaxResults
in: query
type: string
description: Pagination limit
- name: NextToken
in: query
type: string
description: Pagination token
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: listStreams
path: /listStreams
operations:
- name: liststreams
method: POST
description: Returns an array of StreamInfo objects. Each object describes a stream. To retrieve only
streams that satisfy a specific condition, you can specify a StreamNameCondition.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: MaxResults
in: query
type: string
description: Pagination limit
- name: NextToken
in: query
type: string
description: Pagination token
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: listTagsForStream
path: /listTagsForStream
operations:
- name: listtagsforstream
method: POST
description: StreamName or the StreamARN. StreamName Increases or decreases the stream's data retention period by the value that you specify. To indicate
whether you want to increase or decrease the data retention period, specify the Operation parameter
in the request body. I
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: updateImageGenerationConfiguration
path: /updateImageGenerationConfiguration
operations:
- name: updateimagegenerationconfiguration
method: POST
description: Updates the StreamInfo and ImageProcessingConfiguration fields.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: updateMediaStorageConfiguration
path: /updateMediaStorageConfiguration
operations:
- name: updatemediastorageconfiguration
method: POST
description: SignalingChannel to a stream to store the media. There are two signaling
modes that can specified :
StorageStatus is disabled, no data will be stored,
and the StreamARN
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: updateNotificationConfiguration
path: /updateNotificationConfiguration
operations:
- name: updatenotificationconfiguration
method: POST
description: Updates the notification information for a stream.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: updateSignalingChannel
path: /updateSignalingChannel
operations:
- name: updatesignalingchannel
method: POST
description: 'MessageTtlSeconds value is updated (either increased or reduced), it only applies to
new messages sent via '
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: body
in: body
type: object
description: Request body (JSON).
required: true
- name: updateStream
path: /updateStream
operations:
- name: updatestream
method: POST
description: 'CreateSignalingChannel is an asynchronous operation.CreateStreamDeleteSignalingChannel is an asynchronous operation.
If you don't specify the channel's current version, the most recent version is deleted.
call: amazon-kinesis-video-streams.deletesignalingchannel
with:
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/deletestream
name: deletestream
description: REST surface for deleteStream.
operations:
- method: POST
name: deletestream
description: StartEdgeConfigurationUpdate
API. Use this API to get the status of the configuration if the configuration is in sync with the Edge Agent.
call: amazon-kinesis-video-streams.describeedgeconfiguration
with:
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/describeimagegenerationconfiguration
name: describeimagegenerationconfiguration
description: REST surface for describeImageGenerationConfiguration.
operations:
- method: POST
name: describeimagegenerationconfiguration
description: Gets the ImageGenerationConfiguration for a given Kinesis video stream.
call: amazon-kinesis-video-streams.describeimagegenerationconfiguration
with:
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/describemappedresourceconfiguration
name: describemappedresourceconfiguration
description: REST surface for describeMappedResourceConfiguration.
operations:
- method: POST
name: describemappedresourceconfiguration
description: streamName or streamARN
sh
call: amazon-kinesis-video-streams.describemappedresourceconfiguration
with:
MaxResults: rest.MaxResults
NextToken: rest.NextToken
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/describemediastorageconfiguration
name: describemediastorageconfiguration
description: REST surface for describeMediaStorageConfiguration.
operations:
- method: POST
name: describemediastorageconfiguration
description: Returns the most current information about the channel. Specify the ChannelName or ChannelARN
in the input.
call: amazon-kinesis-video-streams.describemediastorageconfiguration
with:
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/describenotificationconfiguration
name: describenotificationconfiguration
description: REST surface for describeNotificationConfiguration.
operations:
- method: POST
name: describenotificationconfiguration
description: Gets the NotificationConfiguration for a given Kinesis video stream.
call: amazon-kinesis-video-streams.describenotificationconfiguration
with:
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/describesignalingchannel
name: describesignalingchannel
description: REST surface for describeSignalingChannel.
operations:
- method: POST
name: describesignalingchannel
description: Returns the most current information about the signaling channel. You must specify either the name or
the Amazon Resource Name (ARN) of the channel that you want to describe.
call: amazon-kinesis-video-streams.describesignalingchannel
with:
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/describestream
name: describestream
description: REST surface for describeStream.
operations:
- method: POST
name: describestream
description: Returns the most current information about the specified stream. You must specify either the StreamName
or the StreamARN.
call: amazon-kinesis-video-streams.describestream
with:
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/getdataendpoint
name: getdataendpoint
description: REST surface for getDataEndpoint.
operations:
- method: POST
name: getdataendpoint
description: 'GetMedia or GetMediaForFragmentList
operations) or write '
call: amazon-kinesis-video-streams.getdataendpoint
with:
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/getsignalingchannelendpoint
name: getsignalingchannelendpoint
description: REST surface for getSignalingChannelEndpoint.
operations:
- method: POST
name: getsignalingchannelendpoint
description: SingleMasterChannelEndpointConfiguration input parameter, which consists of the Protocols
and Role
call: amazon-kinesis-video-streams.getsignalingchannelendpoint
with:
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/listsignalingchannels
name: listsignalingchannels
description: REST surface for listSignalingChannels.
operations:
- method: POST
name: listsignalingchannels
description: Returns an array of ChannelInfo objects. Each object describes a signaling channel. To retrieve
only those channels that satisfy a specific condition, you can specify a ChannelNameCondition.
call: amazon-kinesis-video-streams.listsignalingchannels
with:
MaxResults: rest.MaxResults
NextToken: rest.NextToken
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/liststreams
name: liststreams
description: REST surface for listStreams.
operations:
- method: POST
name: liststreams
description: Returns an array of StreamInfo objects. Each object describes a stream. To retrieve only
streams that satisfy a specific condition, you can specify a StreamNameCondition.
call: amazon-kinesis-video-streams.liststreams
with:
MaxResults: rest.MaxResults
NextToken: rest.NextToken
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/listtagsforstream
name: listtagsforstream
description: REST surface for listTagsForStream.
operations:
- method: POST
name: listtagsforstream
description: StreamName or the StreamARN. StreamName Increases or decreases the stream's data retention period by the value that you specify. To indicate
whether you want to increase or decrease the data retention period, specify the Operation parameter
in the request body. I
call: amazon-kinesis-video-streams.updatedataretention
with:
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/updateimagegenerationconfiguration
name: updateimagegenerationconfiguration
description: REST surface for updateImageGenerationConfiguration.
operations:
- method: POST
name: updateimagegenerationconfiguration
description: Updates the StreamInfo and ImageProcessingConfiguration fields.
call: amazon-kinesis-video-streams.updateimagegenerationconfiguration
with:
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/updatemediastorageconfiguration
name: updatemediastorageconfiguration
description: REST surface for updateMediaStorageConfiguration.
operations:
- method: POST
name: updatemediastorageconfiguration
description: SignalingChannel to a stream to store the media. There are two signaling
modes that can specified :
StorageStatus is disabled, no data will be stored,
and the StreamARN
call: amazon-kinesis-video-streams.updatemediastorageconfiguration
with:
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/updatenotificationconfiguration
name: updatenotificationconfiguration
description: REST surface for updateNotificationConfiguration.
operations:
- method: POST
name: updatenotificationconfiguration
description: Updates the notification information for a stream.
call: amazon-kinesis-video-streams.updatenotificationconfiguration
with:
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/updatesignalingchannel
name: updatesignalingchannel
description: REST surface for updateSignalingChannel.
operations:
- method: POST
name: updatesignalingchannel
description: 'MessageTtlSeconds value is updated (either increased or reduced), it only applies to
new messages sent via '
call: amazon-kinesis-video-streams.updatesignalingchannel
with:
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/updatestream
name: updatestream
description: REST surface for updateStream.
operations:
- method: POST
name: updatestream
description: 'CreateSignalingChannel is an asynchronous operation.CreateStreamDeleteSignalingChannel is an asynchronous operation.
If you don't specify the channel's current version, the most recent version is deleted.
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-kinesis-video-streams.deletesignalingchannel
with:
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: p-deletes-kinesis-video-stream-and
description: StartEdgeConfigurationUpdate
API. Use this API to get the status of the configuration if the configuration is in sync with the Edge Agent.
hints:
readOnly: true
destructive: false
idempotent: false
call: amazon-kinesis-video-streams.describeedgeconfiguration
with:
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: gets-code-imagegenerationconfiguration-code-given-kinesis
description: Gets the ImageGenerationConfiguration for a given Kinesis video stream.
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-kinesis-video-streams.describeimagegenerationconfiguration
with:
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: p-returns-most-current-information-about
description: streamName or streamARN
sh
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-kinesis-video-streams.describemappedresourceconfiguration
with:
MaxResults: tools.MaxResults
NextToken: tools.NextToken
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: returns-most-current-information-about
description: Returns the most current information about the channel. Specify the ChannelName or ChannelARN
in the input.
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-kinesis-video-streams.describemediastorageconfiguration
with:
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: gets-code-notificationconfiguration-code-given-kinesis
description: Gets the NotificationConfiguration for a given Kinesis video stream.
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-kinesis-video-streams.describenotificationconfiguration
with:
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: returns-most-current-information-about-2
description: Returns the most current information about the signaling channel. You must specify either the name or the
Amazon Resource Name (ARN) of the channel that you want to describe.
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-kinesis-video-streams.describesignalingchannel
with:
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: returns-most-current-information-about-3
description: Returns the most current information about the specified stream. You must specify either the StreamName
or the StreamARN.
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-kinesis-video-streams.describestream
with:
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: p-gets-endpoint-specified-stream-either
description: 'GetMedia or GetMediaForFragmentList operations)
or write '
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-kinesis-video-streams.getdataendpoint
with:
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: p-provides-endpoint-specified-signaling-channel
description: SingleMasterChannelEndpointConfiguration input parameter, which consists of the Protocols
and Role
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-kinesis-video-streams.getsignalingchannelendpoint
with:
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: returns-array-code-channelinfo-code-objects
description: Returns an array of ChannelInfo objects. Each object describes a signaling channel. To retrieve
only those channels that satisfy a specific condition, you can specify a ChannelNameCondition.
hints:
readOnly: true
destructive: false
idempotent: false
call: amazon-kinesis-video-streams.listsignalingchannels
with:
MaxResults: tools.MaxResults
NextToken: tools.NextToken
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: returns-array-code-streaminfo-code-objects
description: Returns an array of StreamInfo objects. Each object describes a stream. To retrieve only streams
that satisfy a specific condition, you can specify a StreamNameCondition.
hints:
readOnly: true
destructive: false
idempotent: false
call: amazon-kinesis-video-streams.liststreams
with:
MaxResults: tools.MaxResults
NextToken: tools.NextToken
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: p-returns-list-tags-associated-specified
description: StreamName or the StreamARN. StreamName Increases or decreases the stream's data retention period by the value that you specify. To indicate
whether you want to increase or decrease the data retention period, specify the Operation parameter in
the request body. I
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-kinesis-video-streams.updatedataretention
with:
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: updates-code-streaminfo-code-and-code-imageprocessingconfiguration
description: Updates the StreamInfo and ImageProcessingConfiguration fields.
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-kinesis-video-streams.updateimagegenerationconfiguration
with:
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: p-associates-code-signalingchannel-code-stream-store
description: SignalingChannel to a stream to store the media. There are two signaling modes
that can specified :
StorageStatus is disabled, no data will be stored, and the
StreamARN
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-kinesis-video-streams.updatemediastorageconfiguration
with:
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: updates-notification-information-stream
description: Updates the notification information for a stream.
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-kinesis-video-streams.updatenotificationconfiguration
with:
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: p-updates-existing-signaling-channel-this
description: 'MessageTtlSeconds value is updated (either increased or reduced), it only applies to new
messages sent via '
hints:
readOnly: false
destructive: false
idempotent: false
call: amazon-kinesis-video-streams.updatesignalingchannel
with:
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: p-updates-stream-metadata-such-device
description: '