types

package
v1.15.9 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 23, 2024 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ActiveSpeakerOnlyConfiguration added in v1.5.0

type ActiveSpeakerOnlyConfiguration struct {

	// The position of the ActiveSpeakerOnly video tile.
	ActiveSpeakerPosition ActiveSpeakerPosition
	// contains filtered or unexported fields
}

Defines the configuration for an ActiveSpeakerOnly video tile.

type ActiveSpeakerPosition added in v1.5.0

type ActiveSpeakerPosition string
const (
	ActiveSpeakerPositionTopLeft     ActiveSpeakerPosition = "TopLeft"
	ActiveSpeakerPositionTopRight    ActiveSpeakerPosition = "TopRight"
	ActiveSpeakerPositionBottomLeft  ActiveSpeakerPosition = "BottomLeft"
	ActiveSpeakerPositionBottomRight ActiveSpeakerPosition = "BottomRight"
)

Enum values for ActiveSpeakerPosition

func (ActiveSpeakerPosition) Values added in v1.5.0

Values returns all known values for ActiveSpeakerPosition. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AmazonTranscribeCallAnalyticsProcessorConfiguration added in v1.3.0

type AmazonTranscribeCallAnalyticsProcessorConfiguration struct {

	// The language code in the configuration.
	//
	// This member is required.
	LanguageCode CallAnalyticsLanguageCode

	// By default, all CategoryEvents are sent to the insights target. If this
	// parameter is specified, only included categories are sent to the insights
	// target.
	CallAnalyticsStreamCategories []string

	// Labels all personally identifiable information (PII) identified in your
	// transcript.
	//
	// Content identification is performed at the segment level; PII specified in
	// PiiEntityTypes is flagged upon complete transcription of an audio segment.
	//
	// You can’t set ContentIdentificationType and ContentRedactionType in the same
	// request. If you do, your request returns a BadRequestException .
	//
	// For more information, see [Redacting or identifying personally identifiable information] in the Amazon Transcribe Developer Guide.
	//
	// [Redacting or identifying personally identifiable information]: https://docs.aws.amazon.com/transcribe/latest/dg/pii-redaction.html
	ContentIdentificationType ContentType

	// Redacts all personally identifiable information (PII) identified in your
	// transcript.
	//
	// Content redaction is performed at the segment level; PII specified in
	// PiiEntityTypes is redacted upon complete transcription of an audio segment.
	//
	// You can’t set ContentRedactionType and ContentIdentificationType in the same
	// request. If you do, your request returns a BadRequestException .
	//
	// For more information, see [Redacting or identifying personally identifiable information] in the Amazon Transcribe Developer Guide.
	//
	// [Redacting or identifying personally identifiable information]: https://docs.aws.amazon.com/transcribe/latest/dg/pii-redaction.html
	ContentRedactionType ContentType

	// Enables partial result stabilization for your transcription. Partial result
	// stabilization can reduce latency in your output, but may impact accuracy. For
	// more information, see [Partial-result stabilization]in the Amazon Transcribe Developer Guide.
	//
	// [Partial-result stabilization]: https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html#streaming-partial-result-stabilization
	EnablePartialResultsStabilization bool

	// If true, UtteranceEvents with IsPartial: true are filtered out of the insights
	// target.
	FilterPartialResults bool

	// Specifies the name of the custom language model to use when processing a
	// transcription. Note that language model names are case sensitive.
	//
	// The language of the specified language model must match the language code
	// specified in the transcription request. If the languages don't match, the custom
	// language model isn't applied. Language mismatches don't generate errors or
	// warnings.
	//
	// For more information, see [Custom language models] in the Amazon Transcribe Developer Guide.
	//
	// [Custom language models]: https://docs.aws.amazon.com/transcribe/latest/dg/custom-language-models.html
	LanguageModelName *string

	// Specifies the level of stability to use when you enable partial results
	// stabilization ( EnablePartialResultsStabilization ).
	//
	// Low stability provides the highest accuracy. High stability transcribes faster,
	// but with slightly lower accuracy.
	//
	// For more information, see [Partial-result stabilization] in the Amazon Transcribe Developer Guide.
	//
	// [Partial-result stabilization]: https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html#streaming-partial-result-stabilization
	PartialResultsStability PartialResultsStability

	// Specifies the types of personally identifiable information (PII) to redact from
	// a transcript. You can include as many types as you'd like, or you can select ALL
	// .
	//
	// To include PiiEntityTypes in your Call Analytics request, you must also include
	// ContentIdentificationType or ContentRedactionType , but you can't include both.
	//
	// Values must be comma-separated and can include: ADDRESS , BANK_ACCOUNT_NUMBER ,
	// BANK_ROUTING , CREDIT_DEBIT_CVV , CREDIT_DEBIT_EXPIRY , CREDIT_DEBIT_NUMBER ,
	// EMAIL , NAME , PHONE , PIN , SSN , or ALL .
	//
	// Length Constraints: Minimum length of 1. Maximum length of 300.
	PiiEntityTypes *string

	// The settings for a post-call analysis task in an analytics configuration.
	PostCallAnalyticsSettings *PostCallAnalyticsSettings

	// Specifies how to apply a vocabulary filter to a transcript.
	//
	// To replace words with ***, choose mask .
	//
	// To delete words, choose remove .
	//
	// To flag words without changing them, choose tag .
	VocabularyFilterMethod VocabularyFilterMethod

	// Specifies the name of the custom vocabulary filter to use when processing a
	// transcription. Note that vocabulary filter names are case sensitive.
	//
	// If the language of the specified custom vocabulary filter doesn't match the
	// language identified in your media, the vocabulary filter is not applied to your
	// transcription.
	//
	// For more information, see [Using vocabulary filtering with unwanted words] in the Amazon Transcribe Developer Guide.
	//
	// Length Constraints: Minimum length of 1. Maximum length of 200.
	//
	// [Using vocabulary filtering with unwanted words]: https://docs.aws.amazon.com/transcribe/latest/dg/vocabulary-filtering.html
	VocabularyFilterName *string

	// Specifies the name of the custom vocabulary to use when processing a
	// transcription. Note that vocabulary names are case sensitive.
	//
	// If the language of the specified custom vocabulary doesn't match the language
	// identified in your media, the custom vocabulary is not applied to your
	// transcription.
	//
	// For more information, see [Custom vocabularies] in the Amazon Transcribe Developer Guide.
	//
	// Length Constraints: Minimum length of 1. Maximum length of 200.
	//
	// [Custom vocabularies]: https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html
	VocabularyName *string
	// contains filtered or unexported fields
}

A structure that contains the configuration settings for an Amazon Transcribe call analytics processor.

type AmazonTranscribeProcessorConfiguration added in v1.3.0

type AmazonTranscribeProcessorConfiguration struct {

	// Labels all personally identifiable information (PII) identified in your
	// transcript.
	//
	// Content identification is performed at the segment level; PII specified in
	// PiiEntityTypes is flagged upon complete transcription of an audio segment.
	//
	// You can’t set ContentIdentificationType and ContentRedactionType in the same
	// request. If you set both, your request returns a BadRequestException .
	//
	// For more information, see [Redacting or identifying personally identifiable information] in the Amazon Transcribe Developer Guide.
	//
	// [Redacting or identifying personally identifiable information]: https://docs.aws.amazon.com/transcribe/latest/dg/pii-redaction.html
	ContentIdentificationType ContentType

	// Redacts all personally identifiable information (PII) identified in your
	// transcript.
	//
	// Content redaction is performed at the segment level; PII specified in
	// PiiEntityTypes is redacted upon complete transcription of an audio segment.
	//
	// You can’t set ContentRedactionType and ContentIdentificationType in the same
	// request. If you set both, your request returns a BadRequestException .
	//
	// For more information, see [Redacting or identifying personally identifiable information] in the Amazon Transcribe Developer Guide.
	//
	// [Redacting or identifying personally identifiable information]: https://docs.aws.amazon.com/transcribe/latest/dg/pii-redaction.html
	ContentRedactionType ContentType

	// Enables partial result stabilization for your transcription. Partial result
	// stabilization can reduce latency in your output, but may impact accuracy.
	//
	// For more information, see [Partial-result stabilization] in the Amazon Transcribe Developer Guide.
	//
	// [Partial-result stabilization]: https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html#streaming-partial-result-stabilization
	EnablePartialResultsStabilization bool

	// If true, TranscriptEvents with IsPartial: true are filtered out of the insights
	// target.
	FilterPartialResults bool

	// Turns language identification on or off.
	IdentifyLanguage bool

	// The language code that represents the language spoken in your audio.
	//
	// If you're unsure of the language spoken in your audio, consider using
	// IdentifyLanguage to enable automatic language identification.
	//
	// For a list of languages that real-time Call Analytics supports, see the [Supported languages table] in the
	// Amazon Transcribe Developer Guide.
	//
	// [Supported languages table]: https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html
	LanguageCode CallAnalyticsLanguageCode

	// The name of the custom language model that you want to use when processing your
	// transcription. Note that language model names are case sensitive.
	//
	// The language of the specified language model must match the language code you
	// specify in your transcription request. If the languages don't match, the custom
	// language model isn't applied. There are no errors or warnings associated with a
	// language mismatch.
	//
	// For more information, see [Custom language models] in the Amazon Transcribe Developer Guide.
	//
	// [Custom language models]: https://docs.aws.amazon.com/transcribe/latest/dg/custom-language-models.html
	LanguageModelName *string

	// The language options for the transcription, such as automatic language
	// detection.
	LanguageOptions *string

	// The level of stability to use when you enable partial results stabilization (
	// EnablePartialResultsStabilization ).
	//
	// Low stability provides the highest accuracy. High stability transcribes faster,
	// but with slightly lower accuracy.
	//
	// For more information, see [Partial-result stabilization] in the Amazon Transcribe Developer Guide.
	//
	// [Partial-result stabilization]: https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html#streaming-partial-result-stabilization
	PartialResultsStability PartialResultsStability

	// The types of personally identifiable information (PII) to redact from a
	// transcript. You can include as many types as you'd like, or you can select ALL .
	//
	// To include PiiEntityTypes in your Call Analytics request, you must also include
	// ContentIdentificationType or ContentRedactionType , but you can't include both.
	//
	// Values must be comma-separated and can include: ADDRESS , BANK_ACCOUNT_NUMBER ,
	// BANK_ROUTING , CREDIT_DEBIT_CVV , CREDIT_DEBIT_EXPIRY , CREDIT_DEBIT_NUMBER ,
	// EMAIL , NAME , PHONE , PIN , SSN , or ALL .
	//
	// If you leave this parameter empty, the default behavior is equivalent to ALL .
	PiiEntityTypes *string

	// The preferred language for the transcription.
	PreferredLanguage CallAnalyticsLanguageCode

	// Enables speaker partitioning (diarization) in your transcription output.
	// Speaker partitioning labels the speech from individual speakers in your media
	// file.
	//
	// For more information, see [Partitioning speakers (diarization)] in the Amazon Transcribe Developer Guide.
	//
	// [Partitioning speakers (diarization)]: https://docs.aws.amazon.com/transcribe/latest/dg/diarization.html
	ShowSpeakerLabel bool

	// The vocabulary filtering method used in your Call Analytics transcription.
	VocabularyFilterMethod VocabularyFilterMethod

	// The name of the custom vocabulary filter that you specified in your Call
	// Analytics request.
	//
	// Length Constraints: Minimum length of 1. Maximum length of 200.
	VocabularyFilterName *string

	// The names of the custom vocabulary filter or filters using during transcription.
	VocabularyFilterNames *string

	// The name of the custom vocabulary that you specified in your Call Analytics
	// request.
	//
	// Length Constraints: Minimum length of 1. Maximum length of 200.
	VocabularyName *string

	// The names of the custom vocabulary or vocabularies used during transcription.
	VocabularyNames *string
	// contains filtered or unexported fields
}

A structure that contains the configuration settings for an Amazon Transcribe processor.

type ArtifactsConcatenationConfiguration added in v1.1.0

type ArtifactsConcatenationConfiguration struct {

	// The configuration for the audio artifacts concatenation.
	//
	// This member is required.
	Audio *AudioConcatenationConfiguration

	// The configuration for the composited video artifacts concatenation.
	//
	// This member is required.
	CompositedVideo *CompositedVideoConcatenationConfiguration

	// The configuration for the content artifacts concatenation.
	//
	// This member is required.
	Content *ContentConcatenationConfiguration

	// The configuration for the data channel artifacts concatenation.
	//
	// This member is required.
	DataChannel *DataChannelConcatenationConfiguration

	// The configuration for the meeting events artifacts concatenation.
	//
	// This member is required.
	MeetingEvents *MeetingEventsConcatenationConfiguration

	// The configuration for the transcription messages artifacts concatenation.
	//
	// This member is required.
	TranscriptionMessages *TranscriptionMessagesConcatenationConfiguration

	// The configuration for the video artifacts concatenation.
	//
	// This member is required.
	Video *VideoConcatenationConfiguration
	// contains filtered or unexported fields
}

The configuration for the artifacts concatenation.

type ArtifactsConcatenationState added in v1.1.0

type ArtifactsConcatenationState string
const (
	ArtifactsConcatenationStateEnabled  ArtifactsConcatenationState = "Enabled"
	ArtifactsConcatenationStateDisabled ArtifactsConcatenationState = "Disabled"
)

Enum values for ArtifactsConcatenationState

func (ArtifactsConcatenationState) Values added in v1.1.0

Values returns all known values for ArtifactsConcatenationState. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ArtifactsConfiguration

type ArtifactsConfiguration struct {

	// The configuration for the audio artifacts.
	//
	// This member is required.
	Audio *AudioArtifactsConfiguration

	// The configuration for the content artifacts.
	//
	// This member is required.
	Content *ContentArtifactsConfiguration

	// The configuration for the video artifacts.
	//
	// This member is required.
	Video *VideoArtifactsConfiguration

	// Enables video compositing.
	CompositedVideo *CompositedVideoArtifactsConfiguration
	// contains filtered or unexported fields
}

The configuration for the artifacts.

type ArtifactsState

type ArtifactsState string
const (
	ArtifactsStateEnabled  ArtifactsState = "Enabled"
	ArtifactsStateDisabled ArtifactsState = "Disabled"
)

Enum values for ArtifactsState

func (ArtifactsState) Values

func (ArtifactsState) Values() []ArtifactsState

Values returns all known values for ArtifactsState. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AudioArtifactsConcatenationState added in v1.1.0

type AudioArtifactsConcatenationState string
const (
	AudioArtifactsConcatenationStateEnabled AudioArtifactsConcatenationState = "Enabled"
)

Enum values for AudioArtifactsConcatenationState

func (AudioArtifactsConcatenationState) Values added in v1.1.0

Values returns all known values for AudioArtifactsConcatenationState. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AudioArtifactsConfiguration

type AudioArtifactsConfiguration struct {

	// The MUX type of the audio artifact configuration object.
	//
	// This member is required.
	MuxType AudioMuxType
	// contains filtered or unexported fields
}

The audio artifact configuration object.

type AudioChannelsOption added in v1.1.0

type AudioChannelsOption string
const (
	AudioChannelsOptionStereo AudioChannelsOption = "Stereo"
	AudioChannelsOptionMono   AudioChannelsOption = "Mono"
)

Enum values for AudioChannelsOption

func (AudioChannelsOption) Values added in v1.1.0

Values returns all known values for AudioChannelsOption. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AudioConcatenationConfiguration added in v1.1.0

type AudioConcatenationConfiguration struct {

	// Enables or disables the configuration object.
	//
	// This member is required.
	State AudioArtifactsConcatenationState
	// contains filtered or unexported fields
}

The audio artifact concatenation configuration object.

type AudioMuxType

type AudioMuxType string
const (
	AudioMuxTypeAudioOnly                   AudioMuxType = "AudioOnly"
	AudioMuxTypeAudioWithActiveSpeakerVideo AudioMuxType = "AudioWithActiveSpeakerVideo"
	AudioMuxTypeAudioWithCompositedVideo    AudioMuxType = "AudioWithCompositedVideo"
)

Enum values for AudioMuxType

func (AudioMuxType) Values

func (AudioMuxType) Values() []AudioMuxType

Values returns all known values for AudioMuxType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type BadRequestException

type BadRequestException struct {
	Message *string

	ErrorCodeOverride *string

	Code      ErrorCode
	RequestId *string
	// contains filtered or unexported fields
}

The input parameters don't match the service's restrictions.

func (*BadRequestException) Error

func (e *BadRequestException) Error() string

func (*BadRequestException) ErrorCode

func (e *BadRequestException) ErrorCode() string

func (*BadRequestException) ErrorFault

func (e *BadRequestException) ErrorFault() smithy.ErrorFault

func (*BadRequestException) ErrorMessage

func (e *BadRequestException) ErrorMessage() string

type BorderColor added in v1.5.0

type BorderColor string
const (
	BorderColorBlack  BorderColor = "Black"
	BorderColorBlue   BorderColor = "Blue"
	BorderColorRed    BorderColor = "Red"
	BorderColorGreen  BorderColor = "Green"
	BorderColorWhite  BorderColor = "White"
	BorderColorYellow BorderColor = "Yellow"
)

Enum values for BorderColor

func (BorderColor) Values added in v1.5.0

func (BorderColor) Values() []BorderColor

Values returns all known values for BorderColor. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type CallAnalyticsLanguageCode added in v1.3.0

type CallAnalyticsLanguageCode string
const (
	CallAnalyticsLanguageCodeEnUs CallAnalyticsLanguageCode = "en-US"
	CallAnalyticsLanguageCodeEnGb CallAnalyticsLanguageCode = "en-GB"
	CallAnalyticsLanguageCodeEsUs CallAnalyticsLanguageCode = "es-US"
	CallAnalyticsLanguageCodeFrCa CallAnalyticsLanguageCode = "fr-CA"
	CallAnalyticsLanguageCodeFrFr CallAnalyticsLanguageCode = "fr-FR"
	CallAnalyticsLanguageCodeEnAu CallAnalyticsLanguageCode = "en-AU"
	CallAnalyticsLanguageCodeItIt CallAnalyticsLanguageCode = "it-IT"
	CallAnalyticsLanguageCodeDeDe CallAnalyticsLanguageCode = "de-DE"
	CallAnalyticsLanguageCodePtBr CallAnalyticsLanguageCode = "pt-BR"
)

Enum values for CallAnalyticsLanguageCode

func (CallAnalyticsLanguageCode) Values added in v1.3.0

Values returns all known values for CallAnalyticsLanguageCode. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type CanvasOrientation added in v1.5.0

type CanvasOrientation string
const (
	CanvasOrientationLandscape CanvasOrientation = "Landscape"
	CanvasOrientationPortrait  CanvasOrientation = "Portrait"
)

Enum values for CanvasOrientation

func (CanvasOrientation) Values added in v1.5.0

Values returns all known values for CanvasOrientation. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ChannelDefinition added in v1.3.0

type ChannelDefinition struct {

	// The channel ID.
	//
	// This member is required.
	ChannelId int32

	// Specifies whether the audio in a channel belongs to the AGENT or CUSTOMER .
	ParticipantRole ParticipantRole
	// contains filtered or unexported fields
}

Defines an audio channel in a Kinesis video stream.

type ChimeSdkMeetingConcatenationConfiguration added in v1.1.0

type ChimeSdkMeetingConcatenationConfiguration struct {

	// The configuration for the artifacts in an Amazon Chime SDK meeting
	// concatenation.
	//
	// This member is required.
	ArtifactsConfiguration *ArtifactsConcatenationConfiguration
	// contains filtered or unexported fields
}

The configuration object of the Amazon Chime SDK meeting concatenation for a specified media pipeline.

type ChimeSdkMeetingConfiguration

type ChimeSdkMeetingConfiguration struct {

	// The configuration for the artifacts in an Amazon Chime SDK meeting.
	ArtifactsConfiguration *ArtifactsConfiguration

	// The source configuration for a specified media pipeline.
	SourceConfiguration *SourceConfiguration
	// contains filtered or unexported fields
}

The configuration object of the Amazon Chime SDK meeting for a specified media pipeline. SourceType must be ChimeSdkMeeting .

type ChimeSdkMeetingLiveConnectorConfiguration added in v1.1.0

type ChimeSdkMeetingLiveConnectorConfiguration struct {

	// The configuration object's Chime SDK meeting ARN.
	//
	// This member is required.
	Arn *string

	// The configuration object's multiplex type.
	//
	// This member is required.
	MuxType LiveConnectorMuxType

	// The media pipeline's composited video.
	CompositedVideo *CompositedVideoArtifactsConfiguration

	// The source configuration settings of the media pipeline's configuration object.
	SourceConfiguration *SourceConfiguration
	// contains filtered or unexported fields
}

The media pipeline's configuration object.

type CompositedVideoArtifactsConfiguration added in v1.1.0

type CompositedVideoArtifactsConfiguration struct {

	// The GridView configuration setting.
	//
	// This member is required.
	GridViewConfiguration *GridViewConfiguration

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

	// The video resolution setting in the configuration object. Default: HD at 1280 x
	// 720. FHD resolution: 1920 x 1080.
	Resolution ResolutionOption
	// contains filtered or unexported fields
}

Specifies the configuration for compositing video artifacts.

type CompositedVideoConcatenationConfiguration added in v1.1.0

type CompositedVideoConcatenationConfiguration struct {

	// Enables or disables the configuration object.
	//
	// This member is required.
	State ArtifactsConcatenationState
	// contains filtered or unexported fields
}

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

type ConcatenationSink added in v1.1.0

type ConcatenationSink struct {

	// The configuration settings for an Amazon S3 bucket sink.
	//
	// This member is required.
	S3BucketSinkConfiguration *S3BucketSinkConfiguration

	// The type of data sink in the configuration object.
	//
	// This member is required.
	Type ConcatenationSinkType
	// contains filtered or unexported fields
}

The data sink of the configuration object.

type ConcatenationSinkType added in v1.1.0

type ConcatenationSinkType string
const (
	ConcatenationSinkTypeS3Bucket ConcatenationSinkType = "S3Bucket"
)

Enum values for ConcatenationSinkType

func (ConcatenationSinkType) Values added in v1.1.0

Values returns all known values for ConcatenationSinkType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ConcatenationSource added in v1.1.0

type ConcatenationSource struct {

	// The concatenation settings for the media pipeline in a configuration object.
	//
	// This member is required.
	MediaCapturePipelineSourceConfiguration *MediaCapturePipelineSourceConfiguration

	// The type of concatenation source in a configuration object.
	//
	// This member is required.
	Type ConcatenationSourceType
	// contains filtered or unexported fields
}

The source type and media pipeline configuration settings in a configuration object.

type ConcatenationSourceType added in v1.1.0

type ConcatenationSourceType string
const (
	ConcatenationSourceTypeMediaCapturePipeline ConcatenationSourceType = "MediaCapturePipeline"
)

Enum values for ConcatenationSourceType

func (ConcatenationSourceType) Values added in v1.1.0

Values returns all known values for ConcatenationSourceType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ConflictException added in v1.3.0

type ConflictException struct {
	Message *string

	ErrorCodeOverride *string

	Code      ErrorCode
	RequestId *string
	// contains filtered or unexported fields
}

The request could not be processed because of conflict in the current state of the resource.

func (*ConflictException) Error added in v1.3.0

func (e *ConflictException) Error() string

func (*ConflictException) ErrorCode added in v1.3.0

func (e *ConflictException) ErrorCode() string

func (*ConflictException) ErrorFault added in v1.3.0

func (e *ConflictException) ErrorFault() smithy.ErrorFault

func (*ConflictException) ErrorMessage added in v1.3.0

func (e *ConflictException) ErrorMessage() string

type ContentArtifactsConfiguration

type ContentArtifactsConfiguration struct {

	// Indicates whether the content artifact is enabled or disabled.
	//
	// This member is required.
	State ArtifactsState

	// The MUX type of the artifact configuration.
	MuxType ContentMuxType
	// contains filtered or unexported fields
}

The content artifact object.

type ContentConcatenationConfiguration added in v1.1.0

type ContentConcatenationConfiguration struct {

	// Enables or disables the configuration object.
	//
	// This member is required.
	State ArtifactsConcatenationState
	// contains filtered or unexported fields
}

The composited content configuration object for a specified media pipeline.

type ContentMuxType

type ContentMuxType string
const (
	ContentMuxTypeContentOnly ContentMuxType = "ContentOnly"
)

Enum values for ContentMuxType

func (ContentMuxType) Values

func (ContentMuxType) Values() []ContentMuxType

Values returns all known values for ContentMuxType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ContentRedactionOutput added in v1.3.0

type ContentRedactionOutput string
const (
	ContentRedactionOutputRedacted              ContentRedactionOutput = "redacted"
	ContentRedactionOutputRedactedAndUnredacted ContentRedactionOutput = "redacted_and_unredacted"
)

Enum values for ContentRedactionOutput

func (ContentRedactionOutput) Values added in v1.3.0

Values returns all known values for ContentRedactionOutput. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ContentShareLayoutOption added in v1.1.0

type ContentShareLayoutOption string
const (
	ContentShareLayoutOptionPresenterOnly     ContentShareLayoutOption = "PresenterOnly"
	ContentShareLayoutOptionHorizontal        ContentShareLayoutOption = "Horizontal"
	ContentShareLayoutOptionVertical          ContentShareLayoutOption = "Vertical"
	ContentShareLayoutOptionActiveSpeakerOnly ContentShareLayoutOption = "ActiveSpeakerOnly"
)

Enum values for ContentShareLayoutOption

func (ContentShareLayoutOption) Values added in v1.1.0

Values returns all known values for ContentShareLayoutOption. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ContentType added in v1.3.0

type ContentType string
const (
	ContentTypePii ContentType = "PII"
)

Enum values for ContentType

func (ContentType) Values added in v1.3.0

func (ContentType) Values() []ContentType

Values returns all known values for ContentType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type DataChannelConcatenationConfiguration added in v1.1.0

type DataChannelConcatenationConfiguration struct {

	// Enables or disables the configuration object.
	//
	// This member is required.
	State ArtifactsConcatenationState
	// contains filtered or unexported fields
}

The content configuration object's data channel.

type ErrorCode

type ErrorCode string
const (
	ErrorCodeBadRequest            ErrorCode = "BadRequest"
	ErrorCodeForbidden             ErrorCode = "Forbidden"
	ErrorCodeNotFound              ErrorCode = "NotFound"
	ErrorCodeResourceLimitExceeded ErrorCode = "ResourceLimitExceeded"
	ErrorCodeServiceFailure        ErrorCode = "ServiceFailure"
	ErrorCodeServiceUnavailable    ErrorCode = "ServiceUnavailable"
	ErrorCodeThrottling            ErrorCode = "Throttling"
)

Enum values for ErrorCode

func (ErrorCode) Values

func (ErrorCode) Values() []ErrorCode

Values returns all known values for ErrorCode. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ForbiddenException

type ForbiddenException struct {
	Message *string

	ErrorCodeOverride *string

	Code      ErrorCode
	RequestId *string
	// contains filtered or unexported fields
}

The client is permanently forbidden from making the request.

func (*ForbiddenException) Error

func (e *ForbiddenException) Error() string

func (*ForbiddenException) ErrorCode

func (e *ForbiddenException) ErrorCode() string

func (*ForbiddenException) ErrorFault

func (e *ForbiddenException) ErrorFault() smithy.ErrorFault

func (*ForbiddenException) ErrorMessage

func (e *ForbiddenException) ErrorMessage() string

type FragmentSelector added in v1.3.0

type FragmentSelector struct {

	// The origin of the timestamps to use, Server or Producer . For more information,
	// see [StartSelectorType]in the Amazon Kinesis Video Streams Developer Guide.
	//
	// [StartSelectorType]: https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_dataplane_StartSelector.html
	//
	// This member is required.
	FragmentSelectorType FragmentSelectorType

	// The range of timestamps to return.
	//
	// This member is required.
	TimestampRange *TimestampRange
	// contains filtered or unexported fields
}

Describes the timestamp range and timestamp origin of a range of fragments.

Only fragments with a start timestamp greater than or equal to the given start time and less than or equal to the end time are returned. For example, say a stream contains fragments with the following start timestamps:

  • 00:00:00

  • 00:00:02

  • 00:00:04

  • 00:00:06

A fragment selector range with a start time of 00:00:01 and end time of 00:00:04 would return the fragments with start times of 00:00:02 and 00:00:04.

type FragmentSelectorType added in v1.3.0

type FragmentSelectorType string
const (
	FragmentSelectorTypeProducerTimestamp FragmentSelectorType = "ProducerTimestamp"
	FragmentSelectorTypeServerTimestamp   FragmentSelectorType = "ServerTimestamp"
)

Enum values for FragmentSelectorType

func (FragmentSelectorType) Values added in v1.3.0

Values returns all known values for FragmentSelectorType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type GridViewConfiguration added in v1.1.0

type GridViewConfiguration struct {

	// Defines the layout of the video tiles when content sharing is enabled.
	//
	// This member is required.
	ContentShareLayout ContentShareLayoutOption

	// The configuration settings for an ActiveSpeakerOnly video tile.
	ActiveSpeakerOnlyConfiguration *ActiveSpeakerOnlyConfiguration

	// The orientation setting, horizontal or vertical.
	CanvasOrientation CanvasOrientation

	// The configuration settings for a horizontal layout.
	HorizontalLayoutConfiguration *HorizontalLayoutConfiguration

	// Defines the configuration options for a presenter only video tile.
	PresenterOnlyConfiguration *PresenterOnlyConfiguration

	// The configuration settings for a vertical layout.
	VerticalLayoutConfiguration *VerticalLayoutConfiguration

	// The attribute settings for the video tiles.
	VideoAttribute *VideoAttribute
	// contains filtered or unexported fields
}

Specifies the type of grid layout.

type HighlightColor added in v1.5.0

type HighlightColor string
const (
	HighlightColorBlack  HighlightColor = "Black"
	HighlightColorBlue   HighlightColor = "Blue"
	HighlightColorRed    HighlightColor = "Red"
	HighlightColorGreen  HighlightColor = "Green"
	HighlightColorWhite  HighlightColor = "White"
	HighlightColorYellow HighlightColor = "Yellow"
)

Enum values for HighlightColor

func (HighlightColor) Values added in v1.5.0

func (HighlightColor) Values() []HighlightColor

Values returns all known values for HighlightColor. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type HorizontalLayoutConfiguration added in v1.5.0

type HorizontalLayoutConfiguration struct {

	// Specifies the aspect ratio of all video tiles.
	TileAspectRatio *string

	// The maximum number of video tiles to display.
	TileCount *int32

	// Sets the automatic ordering of the video tiles.
	TileOrder TileOrder

	// Sets the position of horizontal tiles.
	TilePosition HorizontalTilePosition
	// contains filtered or unexported fields
}

Defines the configuration settings for the horizontal layout.

type HorizontalTilePosition added in v1.5.0

type HorizontalTilePosition string
const (
	HorizontalTilePositionTop    HorizontalTilePosition = "Top"
	HorizontalTilePositionBottom HorizontalTilePosition = "Bottom"
)

Enum values for HorizontalTilePosition

func (HorizontalTilePosition) Values added in v1.5.0

Values returns all known values for HorizontalTilePosition. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type IssueDetectionConfiguration added in v1.3.0

type IssueDetectionConfiguration struct {

	// The name of the issue detection rule.
	//
	// This member is required.
	RuleName *string
	// contains filtered or unexported fields
}

A structure that contains the configuration settings for an issue detection task.

type KeywordMatchConfiguration added in v1.3.0

type KeywordMatchConfiguration struct {

	// The keywords or phrases that you want to match.
	//
	// This member is required.
	Keywords []string

	// The name of the keyword match rule.
	//
	// This member is required.
	RuleName *string

	// Matches keywords or phrases on their presence or absence. If set to TRUE , the
	// rule matches when all the specified keywords or phrases are absent. Default:
	// FALSE .
	Negate bool
	// contains filtered or unexported fields
}

A structure that contains the settings for a keyword match task.

type KinesisDataStreamSinkConfiguration added in v1.3.0

type KinesisDataStreamSinkConfiguration struct {

	// The ARN of the sink.
	InsightsTarget *string
	// contains filtered or unexported fields
}

A structure that contains the configuration settings for a Kinesis Data Stream sink.

type KinesisVideoStreamConfiguration added in v1.9.0

type KinesisVideoStreamConfiguration struct {

	// The Amazon Web Services Region of the video stream.
	//
	// This member is required.
	Region *string

	// The amount of time that data is retained.
	DataRetentionInHours *int32
	// contains filtered or unexported fields
}

The configuration of an Kinesis video stream.

type KinesisVideoStreamConfigurationUpdate added in v1.9.0

type KinesisVideoStreamConfigurationUpdate struct {

	// The updated time that data is retained.
	DataRetentionInHours *int32
	// contains filtered or unexported fields
}

The updated Kinesis video stream configuration object.

type KinesisVideoStreamPoolConfiguration added in v1.9.0

type KinesisVideoStreamPoolConfiguration struct {

	// The time at which the configuration was created.
	CreatedTimestamp *time.Time

	// The ARN of the video stream pool configuration.
	PoolArn *string

	// The ID of the video stream pool in the configuration.
	PoolId *string

	// The name of the video stream pool configuration.
	PoolName *string

	// The size of the video stream pool in the configuration.
	PoolSize *int32

	// The status of the video stream pool in the configuration.
	PoolStatus KinesisVideoStreamPoolStatus

	// The Kinesis video stream pool configuration object.
	StreamConfiguration *KinesisVideoStreamConfiguration

	// The time at which the configuration was updated.
	UpdatedTimestamp *time.Time
	// contains filtered or unexported fields
}

The video stream pool configuration object.

type KinesisVideoStreamPoolStatus added in v1.9.0

type KinesisVideoStreamPoolStatus string
const (
	KinesisVideoStreamPoolStatusCreating KinesisVideoStreamPoolStatus = "CREATING"
	KinesisVideoStreamPoolStatusActive   KinesisVideoStreamPoolStatus = "ACTIVE"
	KinesisVideoStreamPoolStatusUpdating KinesisVideoStreamPoolStatus = "UPDATING"
	KinesisVideoStreamPoolStatusDeleting KinesisVideoStreamPoolStatus = "DELETING"
	KinesisVideoStreamPoolStatusFailed   KinesisVideoStreamPoolStatus = "FAILED"
)

Enum values for KinesisVideoStreamPoolStatus

func (KinesisVideoStreamPoolStatus) Values added in v1.9.0

Values returns all known values for KinesisVideoStreamPoolStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type KinesisVideoStreamPoolSummary added in v1.9.0

type KinesisVideoStreamPoolSummary struct {

	// The ARN of the video stream pool.
	PoolArn *string

	// The ID of the video stream pool.
	PoolId *string

	// The name of the video stream pool.
	PoolName *string
	// contains filtered or unexported fields
}

A summary of the Kinesis video stream pool.

type KinesisVideoStreamRecordingSourceRuntimeConfiguration added in v1.3.0

type KinesisVideoStreamRecordingSourceRuntimeConfiguration struct {

	// Describes the timestamp range and timestamp origin of a range of fragments in
	// the Kinesis video stream.
	//
	// This member is required.
	FragmentSelector *FragmentSelector

	// The stream or streams to be recorded.
	//
	// This member is required.
	Streams []RecordingStreamConfiguration
	// contains filtered or unexported fields
}

A structure that contains the runtime settings for recording a Kinesis video stream.

type KinesisVideoStreamSourceRuntimeConfiguration added in v1.3.0

type KinesisVideoStreamSourceRuntimeConfiguration struct {

	// Specifies the encoding of your input audio. Supported format: PCM (only signed
	// 16-bit little-endian audio formats, which does not include WAV)
	//
	// For more information, see [Media formats] in the Amazon Transcribe Developer Guide.
	//
	// [Media formats]: https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio
	//
	// This member is required.
	MediaEncoding MediaEncoding

	// The sample rate of the input audio (in hertz). Low-quality audio, such as
	// telephone audio, is typically around 8,000 Hz. High-quality audio typically
	// ranges from 16,000 Hz to 48,000 Hz. Note that the sample rate you specify must
	// match that of your audio.
	//
	// Valid Range: Minimum value of 8000. Maximum value of 48000.
	//
	// This member is required.
	MediaSampleRate *int32

	// The streams in the source runtime configuration of a Kinesis video stream.
	//
	// This member is required.
	Streams []StreamConfiguration
	// contains filtered or unexported fields
}

The runtime configuration settings for the Kinesis video stream source.

type KinesisVideoStreamSourceTaskConfiguration added in v1.8.0

type KinesisVideoStreamSourceTaskConfiguration struct {

	// The channel ID.
	//
	// This member is required.
	ChannelId int32

	// The ARN of the stream.
	//
	// This member is required.
	StreamArn *string

	// The unique identifier of the fragment to begin processing.
	FragmentNumber *string
	// contains filtered or unexported fields
}

The task configuration settings for the Kinesis video stream source.

type LambdaFunctionSinkConfiguration added in v1.3.0

type LambdaFunctionSinkConfiguration struct {

	// The ARN of the sink.
	InsightsTarget *string
	// contains filtered or unexported fields
}

A structure that contains the configuration settings for an AWS Lambda function's data sink.

type LayoutOption added in v1.1.0

type LayoutOption string
const (
	LayoutOptionGridView LayoutOption = "GridView"
)

Enum values for LayoutOption

func (LayoutOption) Values added in v1.1.0

func (LayoutOption) Values() []LayoutOption

Values returns all known values for LayoutOption. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type LiveConnectorMuxType added in v1.1.0

type LiveConnectorMuxType string
const (
	LiveConnectorMuxTypeAudioWithCompositedVideo    LiveConnectorMuxType = "AudioWithCompositedVideo"
	LiveConnectorMuxTypeAudioWithActiveSpeakerVideo LiveConnectorMuxType = "AudioWithActiveSpeakerVideo"
)

Enum values for LiveConnectorMuxType

func (LiveConnectorMuxType) Values added in v1.1.0

Values returns all known values for LiveConnectorMuxType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type LiveConnectorRTMPConfiguration added in v1.1.0

type LiveConnectorRTMPConfiguration struct {

	// The URL of the RTMP configuration.
	//
	// This member is required.
	Url *string

	// The audio channels set for the RTMP configuration
	AudioChannels AudioChannelsOption

	// The audio sample rate set for the RTMP configuration. Default: 48000.
	AudioSampleRate *string
	// contains filtered or unexported fields
}

The media pipeline's RTMP configuration object.

type LiveConnectorSinkConfiguration added in v1.1.0

type LiveConnectorSinkConfiguration struct {

	// The sink configuration's RTMP configuration settings.
	//
	// This member is required.
	RTMPConfiguration *LiveConnectorRTMPConfiguration

	// The sink configuration's sink type.
	//
	// This member is required.
	SinkType LiveConnectorSinkType
	// contains filtered or unexported fields
}

The media pipeline's sink configuration settings.

type LiveConnectorSinkType added in v1.1.0

type LiveConnectorSinkType string
const (
	LiveConnectorSinkTypeRtmp LiveConnectorSinkType = "RTMP"
)

Enum values for LiveConnectorSinkType

func (LiveConnectorSinkType) Values added in v1.1.0

Values returns all known values for LiveConnectorSinkType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type LiveConnectorSourceConfiguration added in v1.1.0

type LiveConnectorSourceConfiguration struct {

	// The configuration settings of the connector pipeline.
	//
	// This member is required.
	ChimeSdkMeetingLiveConnectorConfiguration *ChimeSdkMeetingLiveConnectorConfiguration

	// The source configuration's media source type.
	//
	// This member is required.
	SourceType LiveConnectorSourceType
	// contains filtered or unexported fields
}

The data source configuration object of a streaming media pipeline.

type LiveConnectorSourceType added in v1.1.0

type LiveConnectorSourceType string
const (
	LiveConnectorSourceTypeChimeSdkMeeting LiveConnectorSourceType = "ChimeSdkMeeting"
)

Enum values for LiveConnectorSourceType

func (LiveConnectorSourceType) Values added in v1.1.0

Values returns all known values for LiveConnectorSourceType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type MediaCapturePipeline

type MediaCapturePipeline struct {

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

	// The time at which the pipeline was created, in ISO 8601 format.
	CreatedTimestamp *time.Time

	// The ARN of the media capture pipeline
	MediaPipelineArn *string

	// The ID of a media pipeline.
	MediaPipelineId *string

	// ARN of the destination to which the media artifacts are saved.
	SinkArn *string

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

	// ARN of the source from which the media artifacts are saved.
	SourceArn *string

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

	// The status of the media pipeline.
	Status MediaPipelineStatus

	// The time at which the pipeline was updated, in ISO 8601 format.
	UpdatedTimestamp *time.Time
	// contains filtered or unexported fields
}

A media pipeline object consisting of an ID, source type, source ARN, a sink type, a sink ARN, and a configuration object.

type MediaCapturePipelineSourceConfiguration added in v1.1.0

type MediaCapturePipelineSourceConfiguration struct {

	// The meeting configuration settings in a media capture pipeline configuration
	// object.
	//
	// This member is required.
	ChimeSdkMeetingConfiguration *ChimeSdkMeetingConcatenationConfiguration

	// The media pipeline ARN in the configuration object of a media capture pipeline.
	//
	// This member is required.
	MediaPipelineArn *string
	// contains filtered or unexported fields
}

The source configuration object of a media capture pipeline.

type MediaCapturePipelineSummary

type MediaCapturePipelineSummary struct {

	// The ARN of the media pipeline in the summary.
	MediaPipelineArn *string

	// The ID of the media pipeline in the summary.
	MediaPipelineId *string
	// contains filtered or unexported fields
}

The summary data of a media capture pipeline.

type MediaConcatenationPipeline added in v1.1.0

type MediaConcatenationPipeline struct {

	// The time at which the concatenation pipeline was created.
	CreatedTimestamp *time.Time

	// The ARN of the media pipeline that you specify in the SourceConfiguration
	// object.
	MediaPipelineArn *string

	// The ID of the media pipeline being concatenated.
	MediaPipelineId *string

	// The data sinks of the concatenation pipeline.
	Sinks []ConcatenationSink

	// The data sources being concatenated.
	Sources []ConcatenationSource

	// The status of the concatenation pipeline.
	Status MediaPipelineStatus

	// The time at which the concatenation pipeline was last updated.
	UpdatedTimestamp *time.Time
	// contains filtered or unexported fields
}

Concatenates audio and video data from one or more data streams.

type MediaEncoding added in v1.3.0

type MediaEncoding string
const (
	MediaEncodingPcm MediaEncoding = "pcm"
)

Enum values for MediaEncoding

func (MediaEncoding) Values added in v1.3.0

func (MediaEncoding) Values() []MediaEncoding

Values returns all known values for MediaEncoding. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type MediaInsightsPipeline added in v1.3.0

type MediaInsightsPipeline struct {

	// The time at which the media insights pipeline was created.
	CreatedTimestamp *time.Time

	// The statuses that the elements in a media insights pipeline can have during
	// data processing.
	ElementStatuses []MediaInsightsPipelineElementStatus

	// The runtime configuration settings for a Kinesis recording video stream in a
	// media insights pipeline.
	KinesisVideoStreamRecordingSourceRuntimeConfiguration *KinesisVideoStreamRecordingSourceRuntimeConfiguration

	// The configuration settings for a Kinesis runtime video stream in a media
	// insights pipeline.
	KinesisVideoStreamSourceRuntimeConfiguration *KinesisVideoStreamSourceRuntimeConfiguration

	// The ARN of a media insight pipeline's configuration settings.
	MediaInsightsPipelineConfigurationArn *string

	// The runtime metadata of a media insights pipeline.
	MediaInsightsRuntimeMetadata map[string]string

	// The ARN of a media insights pipeline.
	MediaPipelineArn *string

	// The ID of a media insights pipeline.
	MediaPipelineId *string

	// The runtime configuration of the Amazon S3 bucket that stores recordings in a
	// media insights pipeline.
	S3RecordingSinkRuntimeConfiguration *S3RecordingSinkRuntimeConfiguration

	// The status of a media insights pipeline.
	Status MediaPipelineStatus
	// contains filtered or unexported fields
}

A media pipeline that streams call analytics data.

type MediaInsightsPipelineConfiguration added in v1.3.0

type MediaInsightsPipelineConfiguration struct {

	// The time at which the configuration was created.
	CreatedTimestamp *time.Time

	// The elements in the configuration.
	Elements []MediaInsightsPipelineConfigurationElement

	// The ARN of the configuration.
	MediaInsightsPipelineConfigurationArn *string

	// The ID of the configuration.
	MediaInsightsPipelineConfigurationId *string

	// The name of the configuration.
	MediaInsightsPipelineConfigurationName *string

	// Lists the rules that trigger a real-time alert.
	RealTimeAlertConfiguration *RealTimeAlertConfiguration

	// The ARN of the role used by the service to access Amazon Web Services resources.
	ResourceAccessRoleArn *string

	// The time at which the configuration was last updated.
	UpdatedTimestamp *time.Time
	// contains filtered or unexported fields
}

A structure that contains the configuration settings for a media insights pipeline.

type MediaInsightsPipelineConfigurationElement added in v1.3.0

type MediaInsightsPipelineConfigurationElement struct {

	// The element type.
	//
	// This member is required.
	Type MediaInsightsPipelineConfigurationElementType

	// The analytics configuration settings for transcribing audio in a media insights
	// pipeline configuration element.
	AmazonTranscribeCallAnalyticsProcessorConfiguration *AmazonTranscribeCallAnalyticsProcessorConfiguration

	// The transcription processor configuration settings in a media insights pipeline
	// configuration element.
	AmazonTranscribeProcessorConfiguration *AmazonTranscribeProcessorConfiguration

	// The configuration settings for the Kinesis Data Stream Sink in a media insights
	// pipeline configuration element.
	KinesisDataStreamSinkConfiguration *KinesisDataStreamSinkConfiguration

	// The configuration settings for the Amazon Web Services Lambda sink in a media
	// insights pipeline configuration element.
	LambdaFunctionSinkConfiguration *LambdaFunctionSinkConfiguration

	// The configuration settings for the Amazon S3 recording bucket in a media
	// insights pipeline configuration element.
	S3RecordingSinkConfiguration *S3RecordingSinkConfiguration

	// The configuration settings for an SNS topic sink in a media insights pipeline
	// configuration element.
	SnsTopicSinkConfiguration *SnsTopicSinkConfiguration

	// The configuration settings for an SQS queue sink in a media insights pipeline
	// configuration element.
	SqsQueueSinkConfiguration *SqsQueueSinkConfiguration

	// The voice analytics configuration settings in a media insights pipeline
	// configuration element.
	VoiceAnalyticsProcessorConfiguration *VoiceAnalyticsProcessorConfiguration

	// The configuration settings for voice enhancement sink in a media insights
	// pipeline configuration element.
	VoiceEnhancementSinkConfiguration *VoiceEnhancementSinkConfiguration
	// contains filtered or unexported fields
}

An element in a media insights pipeline configuration.

type MediaInsightsPipelineConfigurationElementType added in v1.3.0

type MediaInsightsPipelineConfigurationElementType string
const (
	MediaInsightsPipelineConfigurationElementTypeAmazonTranscribeCallAnalyticsProcessor MediaInsightsPipelineConfigurationElementType = "AmazonTranscribeCallAnalyticsProcessor"
	MediaInsightsPipelineConfigurationElementTypeVoiceAnalyticsProcessor                MediaInsightsPipelineConfigurationElementType = "VoiceAnalyticsProcessor"
	MediaInsightsPipelineConfigurationElementTypeAmazonTranscribeProcessor              MediaInsightsPipelineConfigurationElementType = "AmazonTranscribeProcessor"
	MediaInsightsPipelineConfigurationElementTypeKinesisDataStreamSink                  MediaInsightsPipelineConfigurationElementType = "KinesisDataStreamSink"
	MediaInsightsPipelineConfigurationElementTypeLambdaFunctionSink                     MediaInsightsPipelineConfigurationElementType = "LambdaFunctionSink"
	MediaInsightsPipelineConfigurationElementTypeSqsQueueSink                           MediaInsightsPipelineConfigurationElementType = "SqsQueueSink"
	MediaInsightsPipelineConfigurationElementTypeSnsTopicSink                           MediaInsightsPipelineConfigurationElementType = "SnsTopicSink"
	MediaInsightsPipelineConfigurationElementTypeS3RecordingSink                        MediaInsightsPipelineConfigurationElementType = "S3RecordingSink"
	MediaInsightsPipelineConfigurationElementTypeVoiceEnhancementSink                   MediaInsightsPipelineConfigurationElementType = "VoiceEnhancementSink"
)

Enum values for MediaInsightsPipelineConfigurationElementType

func (MediaInsightsPipelineConfigurationElementType) Values added in v1.3.0

Values returns all known values for MediaInsightsPipelineConfigurationElementType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type MediaInsightsPipelineConfigurationSummary added in v1.3.0

type MediaInsightsPipelineConfigurationSummary struct {

	// The ARN of the media insights pipeline configuration.
	MediaInsightsPipelineConfigurationArn *string

	// The ID of the media insights pipeline configuration.
	MediaInsightsPipelineConfigurationId *string

	// The name of the media insights pipeline configuration.
	MediaInsightsPipelineConfigurationName *string
	// contains filtered or unexported fields
}

A summary of the media insights pipeline configuration.

type MediaInsightsPipelineElementStatus added in v1.7.0

type MediaInsightsPipelineElementStatus struct {

	// The element's status.
	Status MediaPipelineElementStatus

	// The type of status.
	Type MediaInsightsPipelineConfigurationElementType
	// contains filtered or unexported fields
}

The status of the pipeline element.

type MediaLiveConnectorPipeline added in v1.1.0

type MediaLiveConnectorPipeline struct {

	// The time at which the connector pipeline was created.
	CreatedTimestamp *time.Time

	// The connector pipeline's ARN.
	MediaPipelineArn *string

	// The connector pipeline's ID.
	MediaPipelineId *string

	// The connector pipeline's data sinks.
	Sinks []LiveConnectorSinkConfiguration

	// The connector pipeline's data sources.
	Sources []LiveConnectorSourceConfiguration

	// The connector pipeline's status.
	Status MediaPipelineStatus

	// The time at which the connector pipeline was last updated.
	UpdatedTimestamp *time.Time
	// contains filtered or unexported fields
}

The connector pipeline.

type MediaPipeline added in v1.1.0

type MediaPipeline struct {

	// A pipeline that enables users to capture audio and video.
	MediaCapturePipeline *MediaCapturePipeline

	// The media concatenation pipeline in a media pipeline.
	MediaConcatenationPipeline *MediaConcatenationPipeline

	// The media insights pipeline of a media pipeline.
	MediaInsightsPipeline *MediaInsightsPipeline

	// The connector pipeline of the media pipeline.
	MediaLiveConnectorPipeline *MediaLiveConnectorPipeline

	// Designates a media pipeline as a media stream pipeline.
	MediaStreamPipeline *MediaStreamPipeline
	// contains filtered or unexported fields
}

A pipeline consisting of a media capture, media concatenation, or live-streaming pipeline.

type MediaPipelineElementStatus added in v1.7.0

type MediaPipelineElementStatus string
const (
	MediaPipelineElementStatusNotStarted   MediaPipelineElementStatus = "NotStarted"
	MediaPipelineElementStatusNotSupported MediaPipelineElementStatus = "NotSupported"
	MediaPipelineElementStatusInitializing MediaPipelineElementStatus = "Initializing"
	MediaPipelineElementStatusInProgress   MediaPipelineElementStatus = "InProgress"
	MediaPipelineElementStatusFailed       MediaPipelineElementStatus = "Failed"
	MediaPipelineElementStatusStopping     MediaPipelineElementStatus = "Stopping"
	MediaPipelineElementStatusStopped      MediaPipelineElementStatus = "Stopped"
	MediaPipelineElementStatusPaused       MediaPipelineElementStatus = "Paused"
)

Enum values for MediaPipelineElementStatus

func (MediaPipelineElementStatus) Values added in v1.7.0

Values returns all known values for MediaPipelineElementStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type MediaPipelineSinkType

type MediaPipelineSinkType string
const (
	MediaPipelineSinkTypeS3Bucket MediaPipelineSinkType = "S3Bucket"
)

Enum values for MediaPipelineSinkType

func (MediaPipelineSinkType) Values

Values returns all known values for MediaPipelineSinkType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type MediaPipelineSourceType

type MediaPipelineSourceType string
const (
	MediaPipelineSourceTypeChimeSdkMeeting MediaPipelineSourceType = "ChimeSdkMeeting"
)

Enum values for MediaPipelineSourceType

func (MediaPipelineSourceType) Values

Values returns all known values for MediaPipelineSourceType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type MediaPipelineStatus

type MediaPipelineStatus string
const (
	MediaPipelineStatusInitializing MediaPipelineStatus = "Initializing"
	MediaPipelineStatusInProgress   MediaPipelineStatus = "InProgress"
	MediaPipelineStatusFailed       MediaPipelineStatus = "Failed"
	MediaPipelineStatusStopping     MediaPipelineStatus = "Stopping"
	MediaPipelineStatusStopped      MediaPipelineStatus = "Stopped"
	MediaPipelineStatusPaused       MediaPipelineStatus = "Paused"
	MediaPipelineStatusNotStarted   MediaPipelineStatus = "NotStarted"
)

Enum values for MediaPipelineStatus

func (MediaPipelineStatus) Values

Values returns all known values for MediaPipelineStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type MediaPipelineStatusUpdate added in v1.3.0

type MediaPipelineStatusUpdate string
const (
	MediaPipelineStatusUpdatePause  MediaPipelineStatusUpdate = "Pause"
	MediaPipelineStatusUpdateResume MediaPipelineStatusUpdate = "Resume"
)

Enum values for MediaPipelineStatusUpdate

func (MediaPipelineStatusUpdate) Values added in v1.3.0

Values returns all known values for MediaPipelineStatusUpdate. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type MediaPipelineSummary added in v1.1.0

type MediaPipelineSummary struct {

	// The ARN of the media pipeline in the summary.
	MediaPipelineArn *string

	// The ID of the media pipeline in the summary.
	MediaPipelineId *string
	// contains filtered or unexported fields
}

The summary of the media pipeline.

type MediaPipelineTaskStatus added in v1.8.0

type MediaPipelineTaskStatus string
const (
	MediaPipelineTaskStatusNotStarted   MediaPipelineTaskStatus = "NotStarted"
	MediaPipelineTaskStatusInitializing MediaPipelineTaskStatus = "Initializing"
	MediaPipelineTaskStatusInProgress   MediaPipelineTaskStatus = "InProgress"
	MediaPipelineTaskStatusFailed       MediaPipelineTaskStatus = "Failed"
	MediaPipelineTaskStatusStopping     MediaPipelineTaskStatus = "Stopping"
	MediaPipelineTaskStatusStopped      MediaPipelineTaskStatus = "Stopped"
)

Enum values for MediaPipelineTaskStatus

func (MediaPipelineTaskStatus) Values added in v1.8.0

Values returns all known values for MediaPipelineTaskStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type MediaStreamPipeline added in v1.9.0

type MediaStreamPipeline struct {

	// The time at which the media stream pipeline was created.
	CreatedTimestamp *time.Time

	// The ARN of the media stream pipeline.
	MediaPipelineArn *string

	// The ID of the media stream pipeline
	MediaPipelineId *string

	// The media stream pipeline's data sinks.
	Sinks []MediaStreamSink

	// The media stream pipeline's data sources.
	Sources []MediaStreamSource

	// The status of the media stream pipeline.
	Status MediaPipelineStatus

	// The time at which the media stream pipeline was updated.
	UpdatedTimestamp *time.Time
	// contains filtered or unexported fields
}

Structure that contains the settings for a media stream pipeline.

type MediaStreamPipelineSinkType added in v1.9.0

type MediaStreamPipelineSinkType string
const (
	MediaStreamPipelineSinkTypeKinesisVideoStreamPool MediaStreamPipelineSinkType = "KinesisVideoStreamPool"
)

Enum values for MediaStreamPipelineSinkType

func (MediaStreamPipelineSinkType) Values added in v1.9.0

Values returns all known values for MediaStreamPipelineSinkType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type MediaStreamSink added in v1.9.0

type MediaStreamSink struct {

	// The media stream sink's media stream type.
	//
	// This member is required.
	MediaStreamType MediaStreamType

	// Specifies the number of streams that the sink can accept.
	//
	// This member is required.
	ReservedStreamCapacity *int32

	// The ARN of the media stream sink.
	//
	// This member is required.
	SinkArn *string

	// The media stream sink's type.
	//
	// This member is required.
	SinkType MediaStreamPipelineSinkType
	// contains filtered or unexported fields
}

Structure that contains the settings for a media stream sink.

type MediaStreamSource added in v1.9.0

type MediaStreamSource struct {

	// The ARN of the media stream source.
	//
	// This member is required.
	SourceArn *string

	// The type of media stream source.
	//
	// This member is required.
	SourceType MediaPipelineSourceType
	// contains filtered or unexported fields
}

Structure that contains the settings for media stream sources.

type MediaStreamType added in v1.9.0

type MediaStreamType string
const (
	MediaStreamTypeMixedAudio      MediaStreamType = "MixedAudio"
	MediaStreamTypeIndividualAudio MediaStreamType = "IndividualAudio"
)

Enum values for MediaStreamType

func (MediaStreamType) Values added in v1.9.0

func (MediaStreamType) Values() []MediaStreamType

Values returns all known values for MediaStreamType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type MeetingEventsConcatenationConfiguration added in v1.1.0

type MeetingEventsConcatenationConfiguration struct {

	// Enables or disables the configuration object.
	//
	// This member is required.
	State ArtifactsConcatenationState
	// contains filtered or unexported fields
}

The configuration object for an event concatenation pipeline.

type NotFoundException

type NotFoundException struct {
	Message *string

	ErrorCodeOverride *string

	Code      ErrorCode
	RequestId *string
	// contains filtered or unexported fields
}

One or more of the resources in the request does not exist in the system.

func (*NotFoundException) Error

func (e *NotFoundException) Error() string

func (*NotFoundException) ErrorCode

func (e *NotFoundException) ErrorCode() string

func (*NotFoundException) ErrorFault

func (e *NotFoundException) ErrorFault() smithy.ErrorFault

func (*NotFoundException) ErrorMessage

func (e *NotFoundException) ErrorMessage() string

type PartialResultsStability added in v1.3.0

type PartialResultsStability string
const (
	PartialResultsStabilityHigh   PartialResultsStability = "high"
	PartialResultsStabilityMedium PartialResultsStability = "medium"
	PartialResultsStabilityLow    PartialResultsStability = "low"
)

Enum values for PartialResultsStability

func (PartialResultsStability) Values added in v1.3.0

Values returns all known values for PartialResultsStability. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ParticipantRole added in v1.3.0

type ParticipantRole string
const (
	ParticipantRoleAgent    ParticipantRole = "AGENT"
	ParticipantRoleCustomer ParticipantRole = "CUSTOMER"
)

Enum values for ParticipantRole

func (ParticipantRole) Values added in v1.3.0

func (ParticipantRole) Values() []ParticipantRole

Values returns all known values for ParticipantRole. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type PostCallAnalyticsSettings added in v1.3.0

type PostCallAnalyticsSettings struct {

	// The ARN of the role used by Amazon Web Services Transcribe to upload your post
	// call analysis. For more information, see [Post-call analytics with real-time transcriptions]in the Amazon Transcribe Developer
	// Guide.
	//
	// [Post-call analytics with real-time transcriptions]: https://docs.aws.amazon.com/transcribe/latest/dg/tca-post-call.html
	//
	// This member is required.
	DataAccessRoleArn *string

	// The URL of the Amazon S3 bucket that contains the post-call data.
	//
	// This member is required.
	OutputLocation *string

	// The content redaction output settings for a post-call analysis task.
	ContentRedactionOutput ContentRedactionOutput

	// The ID of the KMS (Key Management Service) key used to encrypt the output.
	OutputEncryptionKMSKeyId *string
	// contains filtered or unexported fields
}

Allows you to specify additional settings for your Call Analytics post-call request, including output locations for your redacted transcript, which IAM role to use, and which encryption key to use.

DataAccessRoleArn and OutputLocation are required fields.

PostCallAnalyticsSettings provides the same insights as a Call Analytics post-call transcription. For more information, refer to Post-call analytics with real-time transcriptionsin the Amazon Transcribe Developer Guide.

type PresenterOnlyConfiguration added in v1.1.0

type PresenterOnlyConfiguration struct {

	// Defines the position of the presenter video tile. Default: TopRight .
	PresenterPosition PresenterPosition
	// contains filtered or unexported fields
}

Defines the configuration for a presenter-only video tile.

type PresenterPosition added in v1.1.0

type PresenterPosition string
const (
	PresenterPositionTopLeft     PresenterPosition = "TopLeft"
	PresenterPositionTopRight    PresenterPosition = "TopRight"
	PresenterPositionBottomLeft  PresenterPosition = "BottomLeft"
	PresenterPositionBottomRight PresenterPosition = "BottomRight"
)

Enum values for PresenterPosition

func (PresenterPosition) Values added in v1.1.0

Values returns all known values for PresenterPosition. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type RealTimeAlertConfiguration added in v1.3.0

type RealTimeAlertConfiguration struct {

	// Turns off real-time alerts.
	Disabled bool

	// The rules in the alert. Rules specify the words or phrases that you want to be
	// notified about.
	Rules []RealTimeAlertRule
	// contains filtered or unexported fields
}

A structure that contains the configuration settings for real-time alerts.

type RealTimeAlertRule added in v1.3.0

type RealTimeAlertRule struct {

	// The type of alert rule.
	//
	// This member is required.
	Type RealTimeAlertRuleType

	// Specifies the issue detection settings for a real-time alert rule.
	IssueDetectionConfiguration *IssueDetectionConfiguration

	// Specifies the settings for matching the keywords in a real-time alert rule.
	KeywordMatchConfiguration *KeywordMatchConfiguration

	// Specifies the settings for predicting sentiment in a real-time alert rule.
	SentimentConfiguration *SentimentConfiguration
	// contains filtered or unexported fields
}

Specifies the words or phrases that trigger an alert.

type RealTimeAlertRuleType added in v1.3.0

type RealTimeAlertRuleType string
const (
	RealTimeAlertRuleTypeKeywordMatch   RealTimeAlertRuleType = "KeywordMatch"
	RealTimeAlertRuleTypeSentiment      RealTimeAlertRuleType = "Sentiment"
	RealTimeAlertRuleTypeIssueDetection RealTimeAlertRuleType = "IssueDetection"
)

Enum values for RealTimeAlertRuleType

func (RealTimeAlertRuleType) Values added in v1.3.0

Values returns all known values for RealTimeAlertRuleType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type RecordingFileFormat added in v1.3.0

type RecordingFileFormat string
const (
	RecordingFileFormatWav  RecordingFileFormat = "Wav"
	RecordingFileFormatOpus RecordingFileFormat = "Opus"
)

Enum values for RecordingFileFormat

func (RecordingFileFormat) Values added in v1.3.0

Values returns all known values for RecordingFileFormat. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type RecordingStreamConfiguration added in v1.3.0

type RecordingStreamConfiguration struct {

	// The ARN of the recording stream.
	StreamArn *string
	// contains filtered or unexported fields
}

A structure that holds the settings for recording media.

type ResolutionOption added in v1.1.0

type ResolutionOption string
const (
	ResolutionOptionHd  ResolutionOption = "HD"
	ResolutionOptionFhd ResolutionOption = "FHD"
)

Enum values for ResolutionOption

func (ResolutionOption) Values added in v1.1.0

Values returns all known values for ResolutionOption. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ResourceLimitExceededException

type ResourceLimitExceededException struct {
	Message *string

	ErrorCodeOverride *string

	Code      ErrorCode
	RequestId *string
	// contains filtered or unexported fields
}

The request exceeds the resource limit.

func (*ResourceLimitExceededException) Error

func (*ResourceLimitExceededException) ErrorCode

func (e *ResourceLimitExceededException) ErrorCode() string

func (*ResourceLimitExceededException) ErrorFault

func (*ResourceLimitExceededException) ErrorMessage

func (e *ResourceLimitExceededException) ErrorMessage() string

type S3BucketSinkConfiguration added in v1.1.0

type S3BucketSinkConfiguration struct {

	// The destination URL of the S3 bucket.
	//
	// This member is required.
	Destination *string
	// contains filtered or unexported fields
}

The configuration settings for the S3 bucket.

type S3RecordingSinkConfiguration added in v1.3.0

type S3RecordingSinkConfiguration struct {

	// The default URI of the Amazon S3 bucket used as the recording sink.
	Destination *string

	// The default file format for the media files sent to the Amazon S3 bucket.
	RecordingFileFormat RecordingFileFormat
	// contains filtered or unexported fields
}

The structure that holds the settings for transmitting media to the Amazon S3 bucket. These values are used as defaults if S3RecordingSinkRuntimeConfiguration is not specified.

type S3RecordingSinkRuntimeConfiguration added in v1.3.0

type S3RecordingSinkRuntimeConfiguration struct {

	// The URI of the S3 bucket used as the sink.
	//
	// This member is required.
	Destination *string

	// The file format for the media files sent to the Amazon S3 bucket.
	//
	// This member is required.
	RecordingFileFormat RecordingFileFormat
	// contains filtered or unexported fields
}

A structure that holds the settings for transmitting media files to the Amazon S3 bucket. If specified, the settings in this structure override any settings in S3RecordingSinkConfiguration .

type SelectedVideoStreams

type SelectedVideoStreams struct {

	// The attendee IDs of the streams selected for a media pipeline.
	AttendeeIds []string

	// The external user IDs of the streams selected for a media pipeline.
	ExternalUserIds []string
	// contains filtered or unexported fields
}

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

type SentimentConfiguration added in v1.3.0

type SentimentConfiguration struct {

	// The name of the rule in the sentiment configuration.
	//
	// This member is required.
	RuleName *string

	// The type of sentiment, POSITIVE , NEGATIVE , or NEUTRAL .
	//
	// This member is required.
	SentimentType SentimentType

	// Specifies the analysis interval.
	//
	// This member is required.
	TimePeriod *int32
	// contains filtered or unexported fields
}

A structure that contains the configuration settings for a sentiment analysis task.

type SentimentType added in v1.3.0

type SentimentType string
const (
	SentimentTypeNegative SentimentType = "NEGATIVE"
)

Enum values for SentimentType

func (SentimentType) Values added in v1.3.0

func (SentimentType) Values() []SentimentType

Values returns all known values for SentimentType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ServiceFailureException

type ServiceFailureException struct {
	Message *string

	ErrorCodeOverride *string

	Code      ErrorCode
	RequestId *string
	// contains filtered or unexported fields
}

The service encountered an unexpected error.

func (*ServiceFailureException) Error

func (e *ServiceFailureException) Error() string

func (*ServiceFailureException) ErrorCode

func (e *ServiceFailureException) ErrorCode() string

func (*ServiceFailureException) ErrorFault

func (e *ServiceFailureException) ErrorFault() smithy.ErrorFault

func (*ServiceFailureException) ErrorMessage

func (e *ServiceFailureException) ErrorMessage() string

type ServiceUnavailableException

type ServiceUnavailableException struct {
	Message *string

	ErrorCodeOverride *string

	Code      ErrorCode
	RequestId *string
	// contains filtered or unexported fields
}

The service is currently unavailable.

func (*ServiceUnavailableException) Error

func (*ServiceUnavailableException) ErrorCode

func (e *ServiceUnavailableException) ErrorCode() string

func (*ServiceUnavailableException) ErrorFault

func (*ServiceUnavailableException) ErrorMessage

func (e *ServiceUnavailableException) ErrorMessage() string

type SnsTopicSinkConfiguration added in v1.3.0

type SnsTopicSinkConfiguration struct {

	// The ARN of the SNS sink.
	InsightsTarget *string
	// contains filtered or unexported fields
}

The configuration settings for the SNS topic sink.

type SourceConfiguration

type SourceConfiguration struct {

	// The selected video streams for a specified media pipeline. The number of video
	// streams can't exceed 25.
	SelectedVideoStreams *SelectedVideoStreams
	// contains filtered or unexported fields
}

Source configuration for a specified media pipeline.

type SpeakerSearchTask added in v1.8.0

type SpeakerSearchTask struct {

	// The time at which a speaker search task was created.
	CreatedTimestamp *time.Time

	// The speaker search task ID.
	SpeakerSearchTaskId *string

	// The status of the speaker search task.
	SpeakerSearchTaskStatus MediaPipelineTaskStatus

	// The time at which a speaker search task was updated.
	UpdatedTimestamp *time.Time
	// contains filtered or unexported fields
}

A representation of an asynchronous request to perform speaker search analysis on a media insights pipeline.

type SqsQueueSinkConfiguration added in v1.3.0

type SqsQueueSinkConfiguration struct {

	// The ARN of the SQS sink.
	InsightsTarget *string
	// contains filtered or unexported fields
}

The configuration settings for the SQS sink.

type StreamChannelDefinition added in v1.3.0

type StreamChannelDefinition struct {

	// The number of channels in a streaming channel.
	//
	// This member is required.
	NumberOfChannels *int32

	// The definitions of the channels in a streaming channel.
	ChannelDefinitions []ChannelDefinition
	// contains filtered or unexported fields
}

Defines a streaming channel.

type StreamConfiguration added in v1.3.0

type StreamConfiguration struct {

	// The ARN of the stream.
	//
	// This member is required.
	StreamArn *string

	// The streaming channel definition in the stream configuration.
	//
	// This member is required.
	StreamChannelDefinition *StreamChannelDefinition

	// The unique identifier of the fragment to begin processing.
	FragmentNumber *string
	// contains filtered or unexported fields
}

The configuration settings for a stream.

type Tag

type Tag struct {

	// The key half of a tag.
	//
	// This member is required.
	Key *string

	// The value half of a tag.
	//
	// This member is required.
	Value *string
	// contains filtered or unexported fields
}

A key/value pair that grants users access to meeting resources.

type ThrottledClientException

type ThrottledClientException struct {
	Message *string

	ErrorCodeOverride *string

	Code      ErrorCode
	RequestId *string
	// contains filtered or unexported fields
}

The client exceeded its request rate limit.

func (*ThrottledClientException) Error

func (e *ThrottledClientException) Error() string

func (*ThrottledClientException) ErrorCode

func (e *ThrottledClientException) ErrorCode() string

func (*ThrottledClientException) ErrorFault

func (e *ThrottledClientException) ErrorFault() smithy.ErrorFault

func (*ThrottledClientException) ErrorMessage

func (e *ThrottledClientException) ErrorMessage() string

type TileOrder added in v1.5.0

type TileOrder string
const (
	TileOrderJoinSequence    TileOrder = "JoinSequence"
	TileOrderSpeakerSequence TileOrder = "SpeakerSequence"
)

Enum values for TileOrder

func (TileOrder) Values added in v1.5.0

func (TileOrder) Values() []TileOrder

Values returns all known values for TileOrder. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type TimestampRange added in v1.3.0

type TimestampRange struct {

	// The ending timestamp for the specified range.
	//
	// This member is required.
	EndTimestamp *time.Time

	// The starting timestamp for the specified range.
	//
	// This member is required.
	StartTimestamp *time.Time
	// contains filtered or unexported fields
}

The range of timestamps to return.

type TranscriptionMessagesConcatenationConfiguration added in v1.1.0

type TranscriptionMessagesConcatenationConfiguration struct {

	// Enables or disables the configuration object.
	//
	// This member is required.
	State ArtifactsConcatenationState
	// contains filtered or unexported fields
}

The configuration object for concatenating transcription messages.

type UnauthorizedClientException

type UnauthorizedClientException struct {
	Message *string

	ErrorCodeOverride *string

	Code      ErrorCode
	RequestId *string
	// contains filtered or unexported fields
}

The client is not currently authorized to make the request.

func (*UnauthorizedClientException) Error

func (*UnauthorizedClientException) ErrorCode

func (e *UnauthorizedClientException) ErrorCode() string

func (*UnauthorizedClientException) ErrorFault

func (*UnauthorizedClientException) ErrorMessage

func (e *UnauthorizedClientException) ErrorMessage() string

type VerticalLayoutConfiguration added in v1.5.0

type VerticalLayoutConfiguration struct {

	// Sets the aspect ratio of the video tiles, such as 16:9.
	TileAspectRatio *string

	// The maximum number of tiles to display.
	TileCount *int32

	// Sets the automatic ordering of the video tiles.
	TileOrder TileOrder

	// Sets the position of vertical tiles.
	TilePosition VerticalTilePosition
	// contains filtered or unexported fields
}

Defines the configuration settings for a vertical layout.

type VerticalTilePosition added in v1.5.0

type VerticalTilePosition string
const (
	VerticalTilePositionLeft  VerticalTilePosition = "Left"
	VerticalTilePositionRight VerticalTilePosition = "Right"
)

Enum values for VerticalTilePosition

func (VerticalTilePosition) Values added in v1.5.0

Values returns all known values for VerticalTilePosition. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type VideoArtifactsConfiguration

type VideoArtifactsConfiguration struct {

	// Indicates whether the video artifact is enabled or disabled.
	//
	// This member is required.
	State ArtifactsState

	// The MUX type of the video artifact configuration object.
	MuxType VideoMuxType
	// contains filtered or unexported fields
}

The video artifact configuration object.

type VideoAttribute added in v1.5.0

type VideoAttribute struct {

	// Defines the border color of all video tiles.
	BorderColor BorderColor

	// Defines the border thickness for all video tiles.
	BorderThickness *int32

	// Sets the corner radius of all video tiles.
	CornerRadius *int32

	// Defines the highlight color for the active video tile.
	HighlightColor HighlightColor
	// contains filtered or unexported fields
}

Defines the settings for a video tile.

type VideoConcatenationConfiguration added in v1.1.0

type VideoConcatenationConfiguration struct {

	// Enables or disables the configuration object.
	//
	// This member is required.
	State ArtifactsConcatenationState
	// contains filtered or unexported fields
}

The configuration object of a video concatenation pipeline.

type VideoMuxType

type VideoMuxType string
const (
	VideoMuxTypeVideoOnly VideoMuxType = "VideoOnly"
)

Enum values for VideoMuxType

func (VideoMuxType) Values

func (VideoMuxType) Values() []VideoMuxType

Values returns all known values for VideoMuxType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type VocabularyFilterMethod added in v1.3.0

type VocabularyFilterMethod string
const (
	VocabularyFilterMethodRemove VocabularyFilterMethod = "remove"
	VocabularyFilterMethodMask   VocabularyFilterMethod = "mask"
	VocabularyFilterMethodTag    VocabularyFilterMethod = "tag"
)

Enum values for VocabularyFilterMethod

func (VocabularyFilterMethod) Values added in v1.3.0

Values returns all known values for VocabularyFilterMethod. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type VoiceAnalyticsConfigurationStatus added in v1.3.0

type VoiceAnalyticsConfigurationStatus string
const (
	VoiceAnalyticsConfigurationStatusEnabled  VoiceAnalyticsConfigurationStatus = "Enabled"
	VoiceAnalyticsConfigurationStatusDisabled VoiceAnalyticsConfigurationStatus = "Disabled"
)

Enum values for VoiceAnalyticsConfigurationStatus

func (VoiceAnalyticsConfigurationStatus) Values added in v1.3.0

Values returns all known values for VoiceAnalyticsConfigurationStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type VoiceAnalyticsLanguageCode added in v1.8.0

type VoiceAnalyticsLanguageCode string
const (
	VoiceAnalyticsLanguageCodeEnUs VoiceAnalyticsLanguageCode = "en-US"
)

Enum values for VoiceAnalyticsLanguageCode

func (VoiceAnalyticsLanguageCode) Values added in v1.8.0

Values returns all known values for VoiceAnalyticsLanguageCode. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type VoiceAnalyticsProcessorConfiguration added in v1.3.0

type VoiceAnalyticsProcessorConfiguration struct {

	// The status of the speaker search task.
	SpeakerSearchStatus VoiceAnalyticsConfigurationStatus

	// The status of the voice tone analysis task.
	VoiceToneAnalysisStatus VoiceAnalyticsConfigurationStatus
	// contains filtered or unexported fields
}

The configuration settings for a voice analytics processor.

type VoiceEnhancementSinkConfiguration added in v1.7.0

type VoiceEnhancementSinkConfiguration struct {

	// Disables the VoiceEnhancementSinkConfiguration element.
	Disabled bool
	// contains filtered or unexported fields
}

A static structure that contains the configuration data for a VoiceEnhancementSinkConfiguration element.

type VoiceToneAnalysisTask added in v1.8.0

type VoiceToneAnalysisTask struct {

	// The time at which a voice tone analysis task was created.
	CreatedTimestamp *time.Time

	// The time at which a voice tone analysis task was updated.
	UpdatedTimestamp *time.Time

	// The ID of the voice tone analysis task.
	VoiceToneAnalysisTaskId *string

	// The status of a voice tone analysis task.
	VoiceToneAnalysisTaskStatus MediaPipelineTaskStatus
	// contains filtered or unexported fields
}

A representation of an asynchronous request to perform voice tone analysis on a media insights pipeline.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL