types

package
v1.23.8 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: 3 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Attendee 

type Attendee struct {

	// The Amazon Chime SDK attendee ID.
	AttendeeId *string

	// The capabilities assigned to an attendee: audio, video, or content.
	//
	// You use the capabilities with a set of values that control what the
	// capabilities can do, such as SendReceive data. For more information about those
	// values, see .
	//
	// When using capabilities, be aware of these corner cases:
	//
	//   - If you specify MeetingFeatures:Video:MaxResolution:None when you create a
	//   meeting, all API requests that include SendReceive , Send , or Receive for
	//   AttendeeCapabilities:Video will be rejected with ValidationError 400 .
	//
	//   - If you specify MeetingFeatures:Content:MaxResolution:None when you create a
	//   meeting, all API requests that include SendReceive , Send , or Receive for
	//   AttendeeCapabilities:Content will be rejected with ValidationError 400 .
	//
	//   - You can't set content capabilities to SendReceive or Receive unless you also
	//   set video capabilities to SendReceive or Receive . If you don't set the video
	//   capability to receive, the response will contain an HTTP 400 Bad Request status
	//   code. However, you can set your video capability to receive and you set your
	//   content capability to not receive.
	//
	//   - When you change an audio capability from None or Receive to Send or
	//   SendReceive , and if the attendee left their microphone unmuted, audio will
	//   flow from the attendee to the other meeting participants.
	//
	//   - When you change a video or content capability from None or Receive to Send
	//   or SendReceive , and if the attendee turned on their video or content streams,
	//   remote attendees can receive those streams, but only after media renegotiation
	//   between the client and the Amazon Chime back-end server.
	Capabilities *AttendeeCapabilities

	// The Amazon Chime SDK external user ID. An idempotency token. Links the attendee
	// to an identity managed by a builder application.
	//
	// Pattern: [-_&@+=,(){}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*
	//
	// Values that begin with aws: are reserved. You can't configure a value that uses
	// this prefix. Case insensitive.
	ExternalUserId *string

	// The join token used by the Amazon Chime SDK attendee.
	JoinToken *string
	// contains filtered or unexported fields
}

An Amazon Chime SDK meeting attendee. Includes a unique AttendeeId and JoinToken . The JoinToken allows a client to authenticate and join as the specified attendee. The JoinToken expires when the meeting ends, or when DeleteAttendee is called. After that, the attendee is unable to join the meeting.

We recommend securely transferring each JoinToken from your server application to the client so that no other client has access to the token except for the one authorized to represent the attendee.

type AttendeeCapabilities added in v1.10.0 

type AttendeeCapabilities struct {

	// The audio capability assigned to an attendee.
	//
	// This member is required.
	Audio MediaCapabilities

	// The content capability assigned to an attendee.
	//
	// This member is required.
	Content MediaCapabilities

	// The video capability assigned to an attendee.
	//
	// This member is required.
	Video MediaCapabilities
	// contains filtered or unexported fields
}

The media capabilities of an attendee: audio, video, or content.

You use the capabilities with a set of values that control what the capabilities can do, such as SendReceive data. For more information, refer to and .

When using capabilities, be aware of these corner cases:

  • If you specify MeetingFeatures:Video:MaxResolution:None when you create a meeting, all API requests that include SendReceive , Send , or Receive for AttendeeCapabilities:Video will be rejected with ValidationError 400 .

  • If you specify MeetingFeatures:Content:MaxResolution:None when you create a meeting, all API requests that include SendReceive , Send , or Receive for AttendeeCapabilities:Content will be rejected with ValidationError 400 .

  • You can't set content capabilities to SendReceive or Receive unless you also set video capabilities to SendReceive or Receive . If you don't set the video capability to receive, the response will contain an HTTP 400 Bad Request status code. However, you can set your video capability to receive and you set your content capability to not receive.

  • When you change an audio capability from None or Receive to Send or SendReceive , and an attendee unmutes their microphone, audio flows from the attendee to the other meeting participants.

  • When you change a video or content capability from None or Receive to Send or SendReceive , and the attendee turns on their video or content streams, remote attendees can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.

type AttendeeFeatures added in v1.21.0 

type AttendeeFeatures struct {

	// The maximum number of attendees allowed into the meeting.
	MaxCount *int32
	// contains filtered or unexported fields
}

Lists the maximum number of attendees allowed into the meeting.

If you specify FHD for MeetingFeatures:Video:MaxResolution , or if you specify UHD for MeetingFeatures:Content:MaxResolution , the maximum number of attendees changes from the default of 250 to 25 .

type AttendeeIdItem added in v1.10.0 

type AttendeeIdItem struct {

	// A list of one or more attendee IDs.
	//
	// This member is required.
	AttendeeId *string
	// contains filtered or unexported fields
}

A structure that contains one or more attendee IDs.

type AudioFeatures added in v1.2.0 

type AudioFeatures struct {

	// Makes echo reduction available to clients who connect to the meeting.
	EchoReduction MeetingFeatureStatus
	// contains filtered or unexported fields
}

An optional category of meeting features that contains audio-specific configurations, such as operating parameters for Amazon Voice Focus.

type BadRequestException 

type BadRequestException struct {
	Message *string

	ErrorCodeOverride *string

	Code      *string
	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 ConflictException added in v1.10.0 

type ConflictException struct {
	Message *string

	ErrorCodeOverride *string

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

Multiple instances of the same request have been made simultaneously.

func (*ConflictException) Error added in v1.10.0 

func (e *ConflictException) Error() string

func (*ConflictException) ErrorCode added in v1.10.0 

func (e *ConflictException) ErrorCode() string

func (*ConflictException) ErrorFault added in v1.10.0 

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

func (*ConflictException) ErrorMessage added in v1.10.0 

func (e *ConflictException) ErrorMessage() string

type ContentFeatures added in v1.21.0 

type ContentFeatures struct {

	// The maximum resolution for the meeting content.
	//
	// Defaults to FHD . To use UHD , you must also provide a
	// MeetingFeatures:Attendee:MaxCount value and override the default size limit of
	// 250 attendees.
	MaxResolution ContentResolution
	// contains filtered or unexported fields
}

Lists the content (screen share) features for the meeting. Applies to all attendees.

If you specify MeetingFeatures:Content:MaxResolution:None when you create a meeting, all API requests that include SendReceive , Send , or Receive for AttendeeCapabilities:Content will be rejected with ValidationError 400 .

type ContentResolution added in v1.21.0 

type ContentResolution string
const (
	ContentResolutionNone ContentResolution = "None"
	ContentResolutionFhd  ContentResolution = "FHD"
	ContentResolutionUhd  ContentResolution = "UHD"
)

Enum values for ContentResolution

func (ContentResolution) Values added in v1.21.0 

func (ContentResolution) Values() []ContentResolution

Values returns all known values for ContentResolution. 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 CreateAttendeeError 

type CreateAttendeeError struct {

	// The error code.
	ErrorCode *string

	// The error message.
	ErrorMessage *string

	// The Amazon Chime SDK external user ID. An idempotency token. Links the attendee
	// to an identity managed by a builder application.
	//
	// Pattern: [-_&@+=,(){}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*
	//
	// Values that begin with aws: are reserved. You can't configure a value that uses
	// this prefix. Case insensitive.
	ExternalUserId *string
	// contains filtered or unexported fields
}

The list of errors returned when errors are encountered during the BatchCreateAttendee and CreateAttendee actions. This includes external user IDs, error codes, and error messages.

type CreateAttendeeRequestItem 

type CreateAttendeeRequestItem struct {

	// The Amazon Chime SDK external user ID. An idempotency token. Links the attendee
	// to an identity managed by a builder application.
	//
	// Pattern: [-_&@+=,(){}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*
	//
	// Values that begin with aws: are reserved. You can't configure a value that uses
	// this prefix. Case insensitive.
	//
	// This member is required.
	ExternalUserId *string

	// A list of one or more capabilities.
	Capabilities *AttendeeCapabilities
	// contains filtered or unexported fields
}

The Amazon Chime SDK attendee fields to create, used with the BatchCreateAttendee action.

type EngineTranscribeMedicalSettings 

type EngineTranscribeMedicalSettings struct {

	// The language code specified for the Amazon Transcribe Medical engine.
	//
	// This member is required.
	LanguageCode TranscribeMedicalLanguageCode

	// The specialty specified for the Amazon Transcribe Medical engine.
	//
	// This member is required.
	Specialty TranscribeMedicalSpecialty

	// The type of transcription.
	//
	// This member is required.
	Type TranscribeMedicalType

	// Set this field to PHI to identify personal health information in the
	// transcription output.
	ContentIdentificationType TranscribeMedicalContentIdentificationType

	// The Amazon Web Services Region passed to Amazon Transcribe Medical. If you
	// don't specify a Region, Amazon Chime uses the meeting's Region.
	Region TranscribeMedicalRegion

	// The name of the vocabulary passed to Amazon Transcribe Medical.
	VocabularyName *string
	// contains filtered or unexported fields
}

Settings specific to the Amazon Transcribe Medical engine.

type EngineTranscribeSettings 

type EngineTranscribeSettings struct {

	// Labels all personally identifiable information (PII) identified in your
	// transcript. If you don't include PiiEntityTypes , all PII is identified.
	//
	// You can’t set ContentIdentificationType and ContentRedactionType .
	ContentIdentificationType TranscribeContentIdentificationType

	// Content redaction is performed at the segment level. If you don't include
	// PiiEntityTypes , all PII is redacted.
	//
	// You can’t set ContentRedactionType and ContentIdentificationType .
	ContentRedactionType TranscribeContentRedactionType

	// Enables partial result stabilization for your transcription. Partial result
	// stabilization can reduce latency in your output, but may impact accuracy.
	EnablePartialResultsStabilization bool

	// Enables automatic language identification for your transcription.
	//
	// If you include IdentifyLanguage , you can optionally use LanguageOptions to
	// include a list of language codes that you think may be present in your audio
	// stream. Including language options can improve transcription accuracy.
	//
	// You can also use PreferredLanguage to include a preferred language. Doing so
	// can help Amazon Transcribe identify the language faster.
	//
	// You must include either LanguageCode or IdentifyLanguage .
	//
	// Language identification can't be combined with custom language models or
	// redaction.
	IdentifyLanguage bool

	// Specify the language code that represents the language spoken.
	//
	// If you're unsure of the language spoken in your audio, consider using
	// IdentifyLanguage to enable automatic language identification.
	LanguageCode TranscribeLanguageCode

	// Specify 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. If
	// the languages don't match, the custom language model isn't applied. There are no
	// errors or warnings associated with a language mismatch.
	//
	// If you use Amazon Transcribe in multiple Regions, the custom language model
	// must be available in Amazon Transcribe in each Region.
	LanguageModelName *string

	// Specify two or more language codes that represent the languages you think may
	// be present in your media; including more than five is not recommended. If you're
	// unsure what languages are present, do not include this parameter.
	//
	// Including language options can improve the accuracy of language identification.
	//
	// If you include LanguageOptions , you must also include IdentifyLanguage .
	//
	// You can only include one language dialect per language. For example, you cannot
	// include en-US and en-AU .
	LanguageOptions *string

	// Specify 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.
	PartialResultsStability TranscribePartialResultsStability

	// Specify which types of personally identifiable information (PII) you want to
	// redact in your transcript. You can include as many types as you'd like, or you
	// can select ALL .
	//
	// 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 .
	//
	// Note that if you include PiiEntityTypes , you must also include
	// ContentIdentificationType or ContentRedactionType .
	//
	// If you include ContentRedactionType or ContentIdentificationType , but do not
	// include PiiEntityTypes, all PII is redacted or identified.
	PiiEntityTypes *string

	// Specify a preferred language from the subset of languages codes you specified
	// in LanguageOptions .
	//
	// You can only use this parameter if you include IdentifyLanguage and
	// LanguageOptions .
	PreferredLanguage TranscribeLanguageCode

	// The Amazon Web Services Region in which to use Amazon Transcribe.
	//
	// If you don't specify a Region, then the [MediaRegion] of the meeting is used. However, if
	// Amazon Transcribe is not available in the MediaRegion , then a TranscriptFailed
	// event is sent.
	//
	// Use auto to use Amazon Transcribe in a Region near the meeting’s MediaRegion .
	// For more information, refer to [Choosing a transcription Region]in the Amazon Chime SDK Developer Guide.
	//
	// [Choosing a transcription Region]: https://docs.aws.amazon.com/chime-sdk/latest/dg/transcription-options.html#choose-region
	// [MediaRegion]: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_CreateMeeting.html
	Region TranscribeRegion

	// Specify how you want your vocabulary filter applied to your transcript.
	//
	// To replace words with *** , choose mask .
	//
	// To delete words, choose remove .
	//
	// To flag words without changing them, choose tag .
	VocabularyFilterMethod TranscribeVocabularyFilterMethod

	// Specify the name of the custom vocabulary filter that you want to use when
	// processing your transcription. Note that vocabulary filter names are case
	// sensitive.
	//
	// If you use Amazon Transcribe in multiple Regions, the vocabulary filter must be
	// available in Amazon Transcribe in each Region.
	//
	// If you include IdentifyLanguage and want to use one or more vocabulary filters
	// with your transcription, use the VocabularyFilterNames parameter instead.
	VocabularyFilterName *string

	// Specify the names of the custom vocabulary filters that you want to use when
	// processing your transcription. Note that vocabulary filter names are case
	// sensitive.
	//
	// If you use Amazon Transcribe in multiple Regions, the vocabulary filter must be
	// available in Amazon Transcribe in each Region.
	//
	// If you're not including IdentifyLanguage and want to use a custom vocabulary
	// filter with your transcription, use the VocabularyFilterName parameter instead.
	VocabularyFilterNames *string

	// Specify the name of the custom vocabulary that you want to use when processing
	// your transcription. Note that vocabulary names are case sensitive.
	//
	// If you use Amazon Transcribe multiple Regions, the vocabulary must be available
	// in Amazon Transcribe in each Region.
	//
	// If you include IdentifyLanguage and want to use one or more custom vocabularies
	// with your transcription, use the VocabularyNames parameter instead.
	VocabularyName *string

	// Specify the names of the custom vocabularies that you want to use when
	// processing your transcription. Note that vocabulary names are case sensitive.
	//
	// If you use Amazon Transcribe in multiple Regions, the vocabulary must be
	// available in Amazon Transcribe in each Region.
	//
	// If you don't include IdentifyLanguage and want to use a custom vocabulary with
	// your transcription, use the VocabularyName parameter instead.
	VocabularyNames *string
	// contains filtered or unexported fields
}

Settings specific for Amazon Transcribe as the live transcription engine.

If you specify an invalid combination of parameters, a TranscriptFailed event will be sent with the contents of the BadRequestException generated by Amazon Transcribe. For more information on each parameter and which combinations are valid, refer to the StartStreamTranscriptionAPI in the Amazon Transcribe Developer Guide.

type ForbiddenException 

type ForbiddenException struct {
	Message *string

	ErrorCodeOverride *string

	Code      *string
	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 LimitExceededException 

type LimitExceededException struct {
	Message *string

	ErrorCodeOverride *string

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

The request exceeds the resource limit.

func (*LimitExceededException) Error 

func (e *LimitExceededException) Error() string

func (*LimitExceededException) ErrorCode 

func (e *LimitExceededException) ErrorCode() string

func (*LimitExceededException) ErrorFault 

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

func (*LimitExceededException) ErrorMessage 

func (e *LimitExceededException) ErrorMessage() string

type MediaCapabilities added in v1.10.0 

type MediaCapabilities string
const (
	MediaCapabilitiesSendReceive MediaCapabilities = "SendReceive"
	MediaCapabilitiesSend        MediaCapabilities = "Send"
	MediaCapabilitiesReceive     MediaCapabilities = "Receive"
	MediaCapabilitiesNone        MediaCapabilities = "None"
)

Enum values for MediaCapabilities

func (MediaCapabilities) Values added in v1.10.0 

func (MediaCapabilities) Values() []MediaCapabilities

Values returns all known values for MediaCapabilities. 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 MediaPlacement 

type MediaPlacement struct {

	// The audio fallback URL.
	AudioFallbackUrl *string

	// The audio host URL.
	AudioHostUrl *string

	// The event ingestion URL.
	EventIngestionUrl *string

	// The screen data URL.
	//
	// This parameter is deprecated and no longer used by the Amazon Chime SDK.
	ScreenDataUrl *string

	// The screen sharing URL.
	//
	// This parameter is deprecated and no longer used by the Amazon Chime SDK.
	ScreenSharingUrl *string

	// The screen viewing URL.
	//
	// This parameter is deprecated and no longer used by the Amazon Chime SDK.
	ScreenViewingUrl *string

	// The signaling URL.
	SignalingUrl *string

	// The turn control URL.
	//
	// This parameter is deprecated and no longer used by the Amazon Chime SDK.
	TurnControlUrl *string
	// contains filtered or unexported fields
}

A set of endpoints used by clients to connect to the media service group for an Amazon Chime SDK meeting.

type Meeting 

type Meeting struct {

	// The external meeting ID.
	//
	// Pattern: [-_&@+=,(){}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*
	//
	// Values that begin with aws: are reserved. You can't configure a value that uses
	// this prefix. Case insensitive.
	ExternalMeetingId *string

	// The media placement for the meeting.
	MediaPlacement *MediaPlacement

	// The Region in which you create the meeting. Available values: af-south-1 ,
	// ap-northeast-1 , ap-northeast-2 , ap-south-1 , ap-southeast-1 , ap-southeast-2 ,
	// ca-central-1 , eu-central-1 , eu-north-1 , eu-south-1 , eu-west-1 , eu-west-2 ,
	// eu-west-3 , sa-east-1 , us-east-1 , us-east-2 , us-west-1 , us-west-2 .
	//
	// Available values in Amazon Web Services GovCloud (US) Regions: us-gov-east-1 ,
	// us-gov-west-1 .
	MediaRegion *string

	// The ARN of the meeting.
	MeetingArn *string

	// The features available to a meeting, such as echo reduction.
	MeetingFeatures *MeetingFeaturesConfiguration

	// Reserved.
	MeetingHostId *string

	// The Amazon Chime SDK meeting ID.
	MeetingId *string

	// When specified, replicates the media from the primary meeting to this meeting.
	PrimaryMeetingId *string

	// Array of strings.
	TenantIds []string
	// contains filtered or unexported fields
}

A meeting created using the Amazon Chime SDK.

type MeetingFeatureStatus added in v1.2.0 

type MeetingFeatureStatus string
const (
	MeetingFeatureStatusAvailable   MeetingFeatureStatus = "AVAILABLE"
	MeetingFeatureStatusUnavailable MeetingFeatureStatus = "UNAVAILABLE"
)

Enum values for MeetingFeatureStatus

func (MeetingFeatureStatus) Values added in v1.2.0 

func (MeetingFeatureStatus) Values() []MeetingFeatureStatus

Values returns all known values for MeetingFeatureStatus. 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 MeetingFeaturesConfiguration added in v1.2.0 

type MeetingFeaturesConfiguration struct {

	// The configuration settings for the attendee features available to a meeting.
	Attendee *AttendeeFeatures

	// The configuration settings for the audio features available to a meeting.
	Audio *AudioFeatures

	// The configuration settings for the content features available to a meeting.
	Content *ContentFeatures

	// The configuration settings for the video features available to a meeting.
	Video *VideoFeatures
	// contains filtered or unexported fields
}

The configuration settings of the features available to a meeting.

type NotFoundException 

type NotFoundException struct {
	Message *string

	ErrorCodeOverride *string

	Code      *string
	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 NotificationsConfiguration 

type NotificationsConfiguration struct {

	// The ARN of the Amazon Web Services Lambda function in the notifications
	// configuration.
	LambdaFunctionArn *string

	// The ARN of the SNS topic.
	SnsTopicArn *string

	// The ARN of the SQS queue.
	SqsQueueArn *string
	// contains filtered or unexported fields
}

The configuration for resource targets to receive notifications when meeting and attendee events occur.

type ResourceNotFoundException added in v1.13.0 

type ResourceNotFoundException struct {
	Message *string

	ErrorCodeOverride *string

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

The resource that you want to tag couldn't be found.

func (*ResourceNotFoundException) Error added in v1.13.0 

func (e *ResourceNotFoundException) Error() string

func (*ResourceNotFoundException) ErrorCode added in v1.13.0 

func (e *ResourceNotFoundException) ErrorCode() string

func (*ResourceNotFoundException) ErrorFault added in v1.13.0 

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

func (*ResourceNotFoundException) ErrorMessage added in v1.13.0 

func (e *ResourceNotFoundException) ErrorMessage() string

type ServiceFailureException added in v1.9.0 

type ServiceFailureException struct {
	Message *string

	ErrorCodeOverride *string

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

The service encountered an unexpected error.

func (*ServiceFailureException) Error added in v1.9.0 

func (e *ServiceFailureException) Error() string

func (*ServiceFailureException) ErrorCode added in v1.9.0 

func (e *ServiceFailureException) ErrorCode() string

func (*ServiceFailureException) ErrorFault added in v1.9.0 

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

func (*ServiceFailureException) ErrorMessage added in v1.9.0 

func (e *ServiceFailureException) ErrorMessage() string

type ServiceUnavailableException 

type ServiceUnavailableException struct {
	Message *string

	ErrorCodeOverride *string

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

The service is currently unavailable.

func (*ServiceUnavailableException) Error 

func (e *ServiceUnavailableException) Error() string

func (*ServiceUnavailableException) ErrorCode 

func (e *ServiceUnavailableException) ErrorCode() string

func (*ServiceUnavailableException) ErrorFault 

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

func (*ServiceUnavailableException) ErrorMessage 

func (e *ServiceUnavailableException) ErrorMessage() string

type Tag added in v1.13.0 

type Tag struct {

	// The tag's key.
	//
	// This member is required.
	Key *string

	// The tag's value.
	//
	// This member is required.
	Value *string
	// contains filtered or unexported fields
}

A key-value pair that you define.

type ThrottlingException added in v1.9.0 

type ThrottlingException struct {
	Message *string

	ErrorCodeOverride *string

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

The number of customer requests exceeds the request rate limit.

func (*ThrottlingException) Error added in v1.9.0 

func (e *ThrottlingException) Error() string

func (*ThrottlingException) ErrorCode added in v1.9.0 

func (e *ThrottlingException) ErrorCode() string

func (*ThrottlingException) ErrorFault added in v1.9.0 

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

func (*ThrottlingException) ErrorMessage added in v1.9.0 

func (e *ThrottlingException) ErrorMessage() string

type TooManyTagsException added in v1.13.0 

type TooManyTagsException struct {
	Message *string

	ErrorCodeOverride *string

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

Too many tags were added to the specified resource.

func (*TooManyTagsException) Error added in v1.13.0 

func (e *TooManyTagsException) Error() string

func (*TooManyTagsException) ErrorCode added in v1.13.0 

func (e *TooManyTagsException) ErrorCode() string

func (*TooManyTagsException) ErrorFault added in v1.13.0 

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

func (*TooManyTagsException) ErrorMessage added in v1.13.0 

func (e *TooManyTagsException) ErrorMessage() string

type TranscribeContentIdentificationType added in v1.1.0 

type TranscribeContentIdentificationType string
const (
	TranscribeContentIdentificationTypePii TranscribeContentIdentificationType = "PII"
)

Enum values for TranscribeContentIdentificationType

func (TranscribeContentIdentificationType) Values added in v1.1.0 

func (TranscribeContentIdentificationType) Values() []TranscribeContentIdentificationType

Values returns all known values for TranscribeContentIdentificationType. 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 TranscribeContentRedactionType added in v1.1.0 

type TranscribeContentRedactionType string
const (
	TranscribeContentRedactionTypePii TranscribeContentRedactionType = "PII"
)

Enum values for TranscribeContentRedactionType

func (TranscribeContentRedactionType) Values added in v1.1.0 

func (TranscribeContentRedactionType) Values() []TranscribeContentRedactionType

Values returns all known values for TranscribeContentRedactionType. 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 TranscribeLanguageCode 

type TranscribeLanguageCode string
const (
	TranscribeLanguageCodeEnUs TranscribeLanguageCode = "en-US"
	TranscribeLanguageCodeEnGb TranscribeLanguageCode = "en-GB"
	TranscribeLanguageCodeEsUs TranscribeLanguageCode = "es-US"
	TranscribeLanguageCodeFrCa TranscribeLanguageCode = "fr-CA"
	TranscribeLanguageCodeFrFr TranscribeLanguageCode = "fr-FR"
	TranscribeLanguageCodeEnAu TranscribeLanguageCode = "en-AU"
	TranscribeLanguageCodeItIt TranscribeLanguageCode = "it-IT"
	TranscribeLanguageCodeDeDe TranscribeLanguageCode = "de-DE"
	TranscribeLanguageCodePtBr TranscribeLanguageCode = "pt-BR"
	TranscribeLanguageCodeJaJp TranscribeLanguageCode = "ja-JP"
	TranscribeLanguageCodeKoKr TranscribeLanguageCode = "ko-KR"
	TranscribeLanguageCodeZhCn TranscribeLanguageCode = "zh-CN"
	TranscribeLanguageCodeThTh TranscribeLanguageCode = "th-TH"
	TranscribeLanguageCodeHiIn TranscribeLanguageCode = "hi-IN"
)

Enum values for TranscribeLanguageCode

func (TranscribeLanguageCode) Values 

func (TranscribeLanguageCode) Values() []TranscribeLanguageCode

Values returns all known values for TranscribeLanguageCode. 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 TranscribeMedicalContentIdentificationType added in v1.1.0 

type TranscribeMedicalContentIdentificationType string
const (
	TranscribeMedicalContentIdentificationTypePhi TranscribeMedicalContentIdentificationType = "PHI"
)

Enum values for TranscribeMedicalContentIdentificationType

func (TranscribeMedicalContentIdentificationType) Values added in v1.1.0 

func (TranscribeMedicalContentIdentificationType) Values() []TranscribeMedicalContentIdentificationType

Values returns all known values for TranscribeMedicalContentIdentificationType. 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 TranscribeMedicalLanguageCode 

type TranscribeMedicalLanguageCode string
const (
	TranscribeMedicalLanguageCodeEnUs TranscribeMedicalLanguageCode = "en-US"
)

Enum values for TranscribeMedicalLanguageCode

func (TranscribeMedicalLanguageCode) Values 

func (TranscribeMedicalLanguageCode) Values() []TranscribeMedicalLanguageCode

Values returns all known values for TranscribeMedicalLanguageCode. 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 TranscribeMedicalRegion 

type TranscribeMedicalRegion string
const (
	TranscribeMedicalRegionUsEast1      TranscribeMedicalRegion = "us-east-1"
	TranscribeMedicalRegionUsEast2      TranscribeMedicalRegion = "us-east-2"
	TranscribeMedicalRegionUsWest2      TranscribeMedicalRegion = "us-west-2"
	TranscribeMedicalRegionApSoutheast2 TranscribeMedicalRegion = "ap-southeast-2"
	TranscribeMedicalRegionCaCentral1   TranscribeMedicalRegion = "ca-central-1"
	TranscribeMedicalRegionEuWest1      TranscribeMedicalRegion = "eu-west-1"
	TranscribeMedicalRegionAuto         TranscribeMedicalRegion = "auto"
)

Enum values for TranscribeMedicalRegion

func (TranscribeMedicalRegion) Values 

func (TranscribeMedicalRegion) Values() []TranscribeMedicalRegion

Values returns all known values for TranscribeMedicalRegion. 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 TranscribeMedicalSpecialty 

type TranscribeMedicalSpecialty string
const (
	TranscribeMedicalSpecialtyPrimarycare TranscribeMedicalSpecialty = "PRIMARYCARE"
	TranscribeMedicalSpecialtyCardiology  TranscribeMedicalSpecialty = "CARDIOLOGY"
	TranscribeMedicalSpecialtyNeurology   TranscribeMedicalSpecialty = "NEUROLOGY"
	TranscribeMedicalSpecialtyOncology    TranscribeMedicalSpecialty = "ONCOLOGY"
	TranscribeMedicalSpecialtyRadiology   TranscribeMedicalSpecialty = "RADIOLOGY"
	TranscribeMedicalSpecialtyUrology     TranscribeMedicalSpecialty = "UROLOGY"
)

Enum values for TranscribeMedicalSpecialty

func (TranscribeMedicalSpecialty) Values 

func (TranscribeMedicalSpecialty) Values() []TranscribeMedicalSpecialty

Values returns all known values for TranscribeMedicalSpecialty. 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 TranscribeMedicalType 

type TranscribeMedicalType string
const (
	TranscribeMedicalTypeConversation TranscribeMedicalType = "CONVERSATION"
	TranscribeMedicalTypeDictation    TranscribeMedicalType = "DICTATION"
)

Enum values for TranscribeMedicalType

func (TranscribeMedicalType) Values 

func (TranscribeMedicalType) Values() []TranscribeMedicalType

Values returns all known values for TranscribeMedicalType. 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 TranscribePartialResultsStability added in v1.1.0 

type TranscribePartialResultsStability string
const (
	TranscribePartialResultsStabilityLow    TranscribePartialResultsStability = "low"
	TranscribePartialResultsStabilityMedium TranscribePartialResultsStability = "medium"
	TranscribePartialResultsStabilityHigh   TranscribePartialResultsStability = "high"
)

Enum values for TranscribePartialResultsStability

func (TranscribePartialResultsStability) Values added in v1.1.0 

func (TranscribePartialResultsStability) Values() []TranscribePartialResultsStability

Values returns all known values for TranscribePartialResultsStability. 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 TranscribeRegion 

type TranscribeRegion string
const (
	TranscribeRegionUsEast2      TranscribeRegion = "us-east-2"
	TranscribeRegionUsEast1      TranscribeRegion = "us-east-1"
	TranscribeRegionUsWest2      TranscribeRegion = "us-west-2"
	TranscribeRegionApNortheast2 TranscribeRegion = "ap-northeast-2"
	TranscribeRegionApSoutheast2 TranscribeRegion = "ap-southeast-2"
	TranscribeRegionApNortheast1 TranscribeRegion = "ap-northeast-1"
	TranscribeRegionCaCentral1   TranscribeRegion = "ca-central-1"
	TranscribeRegionEuCentral1   TranscribeRegion = "eu-central-1"
	TranscribeRegionEuWest1      TranscribeRegion = "eu-west-1"
	TranscribeRegionEuWest2      TranscribeRegion = "eu-west-2"
	TranscribeRegionSaEast1      TranscribeRegion = "sa-east-1"
	TranscribeRegionAuto         TranscribeRegion = "auto"
	TranscribeRegionUsGovWest1   TranscribeRegion = "us-gov-west-1"
)

Enum values for TranscribeRegion

func (TranscribeRegion) Values 

func (TranscribeRegion) Values() []TranscribeRegion

Values returns all known values for TranscribeRegion. 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 TranscribeVocabularyFilterMethod 

type TranscribeVocabularyFilterMethod string
const (
	TranscribeVocabularyFilterMethodRemove TranscribeVocabularyFilterMethod = "remove"
	TranscribeVocabularyFilterMethodMask   TranscribeVocabularyFilterMethod = "mask"
	TranscribeVocabularyFilterMethodTag    TranscribeVocabularyFilterMethod = "tag"
)

Enum values for TranscribeVocabularyFilterMethod

func (TranscribeVocabularyFilterMethod) Values 

func (TranscribeVocabularyFilterMethod) Values() []TranscribeVocabularyFilterMethod

Values returns all known values for TranscribeVocabularyFilterMethod. 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 TranscriptionConfiguration 

type TranscriptionConfiguration struct {

	// The transcription configuration settings passed to Amazon Transcribe Medical.
	EngineTranscribeMedicalSettings *EngineTranscribeMedicalSettings

	// The transcription configuration settings passed to Amazon Transcribe.
	EngineTranscribeSettings *EngineTranscribeSettings
	// contains filtered or unexported fields
}

The configuration for the current transcription operation. Must contain EngineTranscribeSettings or EngineTranscribeMedicalSettings .

type UnauthorizedException 

type UnauthorizedException struct {
	Message *string

	ErrorCodeOverride *string

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

The user isn't authorized to request a resource.

func (*UnauthorizedException) Error 

func (e *UnauthorizedException) Error() string

func (*UnauthorizedException) ErrorCode 

func (e *UnauthorizedException) ErrorCode() string

func (*UnauthorizedException) ErrorFault 

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

func (*UnauthorizedException) ErrorMessage 

func (e *UnauthorizedException) ErrorMessage() string

type UnprocessableEntityException 

type UnprocessableEntityException struct {
	Message *string

	ErrorCodeOverride *string

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

The request was well-formed but was unable to be followed due to semantic errors.

func (*UnprocessableEntityException) Error 

func (e *UnprocessableEntityException) Error() string

func (*UnprocessableEntityException) ErrorCode 

func (e *UnprocessableEntityException) ErrorCode() string

func (*UnprocessableEntityException) ErrorFault 

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

func (*UnprocessableEntityException) ErrorMessage 

func (e *UnprocessableEntityException) ErrorMessage() string

type VideoFeatures added in v1.21.0 

type VideoFeatures struct {

	// The maximum video resolution for the meeting. Applies to all attendees.
	//
	// Defaults to HD . To use FHD , you must also provide a
	// MeetingFeatures:Attendee:MaxCount value and override the default size limit of
	// 250 attendees.
	MaxResolution VideoResolution
	// contains filtered or unexported fields
}

The video features set for the meeting. Applies to all attendees.

If you specify MeetingFeatures:Video:MaxResolution:None when you create a meeting, all API requests that include SendReceive , Send , or Receive for AttendeeCapabilities:Video will be rejected with ValidationError 400 .

type VideoResolution added in v1.21.0 

type VideoResolution string
const (
	VideoResolutionNone VideoResolution = "None"
	VideoResolutionHd   VideoResolution = "HD"
	VideoResolutionFhd  VideoResolution = "FHD"
)

Enum values for VideoResolution

func (VideoResolution) Values added in v1.21.0 

func (VideoResolution) Values() []VideoResolution

Values returns all known values for VideoResolution. 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.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.