amazonka-chime-sdk-media-pipelines-2.0: Amazon Chime SDK Media Pipelines SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.ChimeSdkMediaPipelines.Lens

Description

 
Synopsis

Operations

CreateMediaCapturePipeline

createMediaCapturePipeline_chimeSdkMeetingConfiguration :: Lens' CreateMediaCapturePipeline (Maybe ChimeSdkMeetingConfiguration) Source #

The configuration for a specified media pipeline. SourceType must be ChimeSdkMeeting.

createMediaCapturePipeline_clientRequestToken :: Lens' CreateMediaCapturePipeline (Maybe Text) Source #

The unique identifier for the client request. The token makes the API request idempotent. Use a unique token for each media pipeline request.

createMediaCapturePipeline_sourceType :: Lens' CreateMediaCapturePipeline MediaPipelineSourceType Source #

Source type from which the media artifacts are captured. A Chime SDK Meeting is the only supported source.

createMediaCapturePipeline_sourceArn :: Lens' CreateMediaCapturePipeline Text Source #

ARN of the source from which the media artifacts are captured.

createMediaCapturePipeline_sinkType :: Lens' CreateMediaCapturePipeline MediaPipelineSinkType Source #

Destination type to which the media artifacts are saved. You must use an S3 bucket.

createMediaCapturePipelineResponse_mediaCapturePipeline :: Lens' CreateMediaCapturePipelineResponse (Maybe MediaCapturePipeline) Source #

A media pipeline object, the ID, source type, source ARN, sink type, and sink ARN of a media pipeline object.

CreateMediaConcatenationPipeline

createMediaConcatenationPipeline_clientRequestToken :: Lens' CreateMediaConcatenationPipeline (Maybe Text) Source #

The unique identifier for the client request. The token makes the API request idempotent. Use a unique token for each media concatenation pipeline request.

createMediaConcatenationPipeline_tags :: Lens' CreateMediaConcatenationPipeline (Maybe (NonEmpty Tag)) Source #

The tags associated with the media concatenation pipeline.

createMediaConcatenationPipeline_sources :: Lens' CreateMediaConcatenationPipeline (NonEmpty ConcatenationSource) Source #

An object that specifies the sources for the media concatenation pipeline.

createMediaConcatenationPipeline_sinks :: Lens' CreateMediaConcatenationPipeline (NonEmpty ConcatenationSink) Source #

An object that specifies the data sinks for the media concatenation pipeline.

createMediaConcatenationPipelineResponse_mediaConcatenationPipeline :: Lens' CreateMediaConcatenationPipelineResponse (Maybe MediaConcatenationPipeline) Source #

A media concatenation pipeline object, the ID, source type, MediaPipelineARN, and sink of a media concatenation pipeline object.

CreateMediaLiveConnectorPipeline

DeleteMediaCapturePipeline

DeleteMediaPipeline

deleteMediaPipeline_mediaPipelineId :: Lens' DeleteMediaPipeline Text Source #

The ID of the media pipeline to delete.

GetMediaCapturePipeline

getMediaCapturePipeline_mediaPipelineId :: Lens' GetMediaCapturePipeline Text Source #

The ID of the pipeline that you want to get.

GetMediaPipeline

getMediaPipeline_mediaPipelineId :: Lens' GetMediaPipeline Text Source #

The ID of the pipeline that you want to get.

ListMediaCapturePipelines

listMediaCapturePipelines_maxResults :: Lens' ListMediaCapturePipelines (Maybe Natural) Source #

The maximum number of results to return in a single call. Valid Range: 1 - 99.

listMediaCapturePipelines_nextToken :: Lens' ListMediaCapturePipelines (Maybe Text) Source #

The token used to retrieve the next page of results.

ListMediaPipelines

listMediaPipelines_maxResults :: Lens' ListMediaPipelines (Maybe Natural) Source #

The maximum number of results to return in a single call. Valid Range: 1 - 99.

listMediaPipelines_nextToken :: Lens' ListMediaPipelines (Maybe Text) Source #

The token used to retrieve the next page of results.

listMediaPipelinesResponse_nextToken :: Lens' ListMediaPipelinesResponse (Maybe Text) Source #

The token used to retrieve the next page of results.

ListTagsForResource

listTagsForResource_resourceARN :: Lens' ListTagsForResource Text Source #

The ARN of the media pipeline associated with any tags. The ARN consists of the pipeline's region, resource ID, and pipeline ID.

listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe (NonEmpty Tag)) Source #

The tags associated with the specified media pipeline.

TagResource

tagResource_resourceARN :: Lens' TagResource Text Source #

The ARN of the media pipeline associated with any tags. The ARN consists of the pipeline's endpoint region, resource ID, and pipeline ID.

tagResource_tags :: Lens' TagResource (NonEmpty Tag) Source #

The tags associated with the specified media pipeline.

UntagResource

untagResource_resourceARN :: Lens' UntagResource Text Source #

The ARN of the pipeline that you want to untag.

untagResource_tagKeys :: Lens' UntagResource (NonEmpty Text) Source #

The key/value pairs in the tag that you want to remove.

Types

ArtifactsConcatenationConfiguration

ArtifactsConfiguration

AudioArtifactsConfiguration

audioArtifactsConfiguration_muxType :: Lens' AudioArtifactsConfiguration AudioMuxType Source #

The MUX type of the audio artifact configuration object.

AudioConcatenationConfiguration

audioConcatenationConfiguration_state :: Lens' AudioConcatenationConfiguration AudioArtifactsConcatenationState Source #

Enables the name object, where name is the name of the configuration object, such as AudioConcatenation.

ChimeSdkMeetingConcatenationConfiguration

ChimeSdkMeetingConfiguration

ChimeSdkMeetingLiveConnectorConfiguration

CompositedVideoArtifactsConfiguration

compositedVideoArtifactsConfiguration_layout :: Lens' CompositedVideoArtifactsConfiguration (Maybe LayoutOption) Source #

The layout setting, such as GridView in the configuration object.

compositedVideoArtifactsConfiguration_resolution :: Lens' CompositedVideoArtifactsConfiguration (Maybe ResolutionOption) Source #

The video resolution setting in the configuration object. Default: HD at 1280 x 720. FHD resolution: 1920 x 1080.

CompositedVideoConcatenationConfiguration

ConcatenationSink

concatenationSink_type :: Lens' ConcatenationSink ConcatenationSinkType Source #

The type of data sink in the configuration object.

ConcatenationSource

concatenationSource_type :: Lens' ConcatenationSource ConcatenationSourceType Source #

The type of concatenation source in a configuration object.

ContentArtifactsConfiguration

contentArtifactsConfiguration_state :: Lens' ContentArtifactsConfiguration ArtifactsState Source #

Indicates whether the content artifact is enabled or disabled.

ContentConcatenationConfiguration

DataChannelConcatenationConfiguration

GridViewConfiguration

gridViewConfiguration_presenterOnlyConfiguration :: Lens' GridViewConfiguration (Maybe PresenterOnlyConfiguration) Source #

Defines the configuration options for a presenter only video tile.

gridViewConfiguration_contentShareLayout :: Lens' GridViewConfiguration ContentShareLayoutOption Source #

Defines the layout of the video tiles when content sharing is enabled.

LiveConnectorRTMPConfiguration

liveConnectorRTMPConfiguration_audioSampleRate :: Lens' LiveConnectorRTMPConfiguration (Maybe Text) Source #

The audio sample rate set for the RTMP configuration. Default: 48000.

LiveConnectorSinkConfiguration

LiveConnectorSourceConfiguration

MediaCapturePipeline

mediaCapturePipeline_chimeSdkMeetingConfiguration :: Lens' MediaCapturePipeline (Maybe ChimeSdkMeetingConfiguration) Source #

The configuration for a specified media pipeline. SourceType must be ChimeSdkMeeting.

mediaCapturePipeline_createdTimestamp :: Lens' MediaCapturePipeline (Maybe UTCTime) Source #

The time at which the pipeline was created, in ISO 8601 format.

mediaCapturePipeline_sinkArn :: Lens' MediaCapturePipeline (Maybe Text) Source #

ARN of the destination to which the media artifacts are saved.

mediaCapturePipeline_sinkType :: Lens' MediaCapturePipeline (Maybe MediaPipelineSinkType) Source #

Destination type to which the media artifacts are saved. You must use an S3 Bucket.

mediaCapturePipeline_sourceArn :: Lens' MediaCapturePipeline (Maybe Text) Source #

ARN of the source from which the media artifacts are saved.

mediaCapturePipeline_sourceType :: Lens' MediaCapturePipeline (Maybe MediaPipelineSourceType) Source #

Source type from which media artifacts are saved. You must use ChimeMeeting.

mediaCapturePipeline_updatedTimestamp :: Lens' MediaCapturePipeline (Maybe UTCTime) Source #

The time at which the pipeline was updated, in ISO 8601 format.

MediaCapturePipelineSourceConfiguration

mediaCapturePipelineSourceConfiguration_mediaPipelineArn :: Lens' MediaCapturePipelineSourceConfiguration Text Source #

The media pipeline ARN in the configuration object of a media capture pipeline.

MediaCapturePipelineSummary

MediaConcatenationPipeline

mediaConcatenationPipeline_createdTimestamp :: Lens' MediaConcatenationPipeline (Maybe UTCTime) Source #

The time at which the concatenation pipeline was created.

mediaConcatenationPipeline_mediaPipelineArn :: Lens' MediaConcatenationPipeline (Maybe Text) Source #

The ARN of the media pipeline that you specify in the SourceConfiguration object.

mediaConcatenationPipeline_updatedTimestamp :: Lens' MediaConcatenationPipeline (Maybe UTCTime) Source #

The time at which the concatenation pipeline was last updated.

MediaLiveConnectorPipeline

mediaLiveConnectorPipeline_createdTimestamp :: Lens' MediaLiveConnectorPipeline (Maybe UTCTime) Source #

Thetime at which the connector pipeline was created.

mediaLiveConnectorPipeline_updatedTimestamp :: Lens' MediaLiveConnectorPipeline (Maybe UTCTime) Source #

The time at which the connector pipeline was last updated.

MediaPipeline

mediaPipeline_mediaCapturePipeline :: Lens' MediaPipeline (Maybe MediaCapturePipeline) Source #

A pipeline that enables users to capture audio and video.

mediaPipeline_mediaConcatenationPipeline :: Lens' MediaPipeline (Maybe MediaConcatenationPipeline) Source #

The media concatenation pipeline in a media pipeline.

MediaPipelineSummary

mediaPipelineSummary_mediaPipelineArn :: Lens' MediaPipelineSummary (Maybe Text) Source #

The ARN of the media pipeline in the summary.

mediaPipelineSummary_mediaPipelineId :: Lens' MediaPipelineSummary (Maybe Text) Source #

The ID of the media pipeline in the summary.

MeetingEventsConcatenationConfiguration

PresenterOnlyConfiguration

presenterOnlyConfiguration_presenterPosition :: Lens' PresenterOnlyConfiguration (Maybe PresenterPosition) Source #

Defines the position of the presenter video tile. Default: TopRight.

S3BucketSinkConfiguration

SelectedVideoStreams

selectedVideoStreams_attendeeIds :: Lens' SelectedVideoStreams (Maybe (NonEmpty Text)) Source #

The attendee IDs of the streams selected for a media pipeline.

selectedVideoStreams_externalUserIds :: Lens' SelectedVideoStreams (Maybe (NonEmpty Text)) Source #

The external user IDs of the streams selected for a media pipeline.

SourceConfiguration

sourceConfiguration_selectedVideoStreams :: Lens' SourceConfiguration (Maybe SelectedVideoStreams) Source #

The selected video streams for a specified media pipeline. The number of video streams can't exceed 25.

Tag

tag_key :: Lens' Tag Text Source #

The key half of a tag.

tag_value :: Lens' Tag Text Source #

The value half of a tag.

TranscriptionMessagesConcatenationConfiguration

VideoArtifactsConfiguration

videoArtifactsConfiguration_muxType :: Lens' VideoArtifactsConfiguration (Maybe VideoMuxType) Source #

The MUX type of the video artifact configuration object.

videoArtifactsConfiguration_state :: Lens' VideoArtifactsConfiguration ArtifactsState Source #

Indicates whether the video artifact is enabled or disabled.

VideoConcatenationConfiguration