transcribe – github.com/aws/aws-sdk-go-v2/service/transcribe Index | Files | Directories

package transcribe

import "github.com/aws/aws-sdk-go-v2/service/transcribe"

Package transcribe provides the API client, operations, and parameter types for Amazon Transcribe Service.

Operations and objects for transcribing speech to text.

Index

Constants

const ServiceAPIVersion = "2017-10-26"
const ServiceID = "Transcribe"

Functions

func NewDefaultEndpointResolver

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions

func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

WithAPIOptions returns a functional option for setting the Client's APIOptions option.

func WithEndpointResolver

func WithEndpointResolver(v EndpointResolver) func(*Options)

WithEndpointResolver returns a functional option for setting the Client's EndpointResolver option.

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client provides the API client to make operations call for Amazon Transcribe Service.

func New

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) CreateCallAnalyticsCategory

func (c *Client) CreateCallAnalyticsCategory(ctx context.Context, params *CreateCallAnalyticsCategoryInput, optFns ...func(*Options)) (*CreateCallAnalyticsCategoryOutput, error)

Creates a call analytics category. Amazon Transcribe applies the conditions specified by your call analytics categories to your call analytics jobs. For each analytics category, you must create between 1 and 20 rules. For example, you can create a 'greeting' category with a rule that flags calls in which your agent does not use a specified phrase (for example: "Please note this call may be recorded.") in the first 15 seconds of the call. When you start a call analytics job, Amazon Transcribe applies all your existing call analytics categories to that job.

func (*Client) CreateLanguageModel

func (c *Client) CreateLanguageModel(ctx context.Context, params *CreateLanguageModelInput, optFns ...func(*Options)) (*CreateLanguageModelOutput, error)

Creates a new custom language model. When creating a new language model, you must specify if you want a Wideband (audio sample rates over 16,000 Hz) or Narrowband (audio sample rates under 16,000 Hz) base model. You then include the S3 URI location of your training and tuning files, the language for the model, a unique name, and any tags you want associated with your model.

func (*Client) CreateMedicalVocabulary

func (c *Client) CreateMedicalVocabulary(ctx context.Context, params *CreateMedicalVocabularyInput, optFns ...func(*Options)) (*CreateMedicalVocabularyOutput, error)

Creates a new custom medical vocabulary. When creating a new medical vocabulary, you must upload a text file that contains your new entries, phrases, and terms into an S3 bucket. Note that this differs from , where you can include a list of terms within your request using the Phrases flag, as CreateMedicalVocabulary does not support the Phrases flag. For more information on creating a custom vocabulary text file, see Creating a custom vocabulary (https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary-create.html).

func (*Client) CreateVocabulary

func (c *Client) CreateVocabulary(ctx context.Context, params *CreateVocabularyInput, optFns ...func(*Options)) (*CreateVocabularyOutput, error)

Creates a new custom vocabulary. When creating a new medical vocabulary, you can either upload a text file that contains your new entries, phrases, and terms into an S3 bucket or include a list of terms directly in your request using the Phrases flag. For more information on creating a custom vocabulary, see Creating a custom vocabulary (https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary-create.html).

func (*Client) CreateVocabularyFilter

func (c *Client) CreateVocabularyFilter(ctx context.Context, params *CreateVocabularyFilterInput, optFns ...func(*Options)) (*CreateVocabularyFilterOutput, error)

Creates a new vocabulary filter that you can use to filter words from your transcription output. For example, you can use this operation to remove profanity from your transcript.

func (*Client) DeleteCallAnalyticsCategory

func (c *Client) DeleteCallAnalyticsCategory(ctx context.Context, params *DeleteCallAnalyticsCategoryInput, optFns ...func(*Options)) (*DeleteCallAnalyticsCategoryOutput, error)

Deletes a call analytics category. To use this operation, specify the name of the category you want to delete using CategoryName.

func (*Client) DeleteCallAnalyticsJob

func (c *Client) DeleteCallAnalyticsJob(ctx context.Context, params *DeleteCallAnalyticsJobInput, optFns ...func(*Options)) (*DeleteCallAnalyticsJobOutput, error)

Deletes a call analytics job. To use this operation, specify the name of the job you want to delete using CallAnalyticsJobName.

func (*Client) DeleteLanguageModel

func (c *Client) DeleteLanguageModel(ctx context.Context, params *DeleteLanguageModelInput, optFns ...func(*Options)) (*DeleteLanguageModelOutput, error)

Deletes a custom language model. To use this operation, specify the name of the language model you want to delete using ModelName.

func (*Client) DeleteMedicalTranscriptionJob

func (c *Client) DeleteMedicalTranscriptionJob(ctx context.Context, params *DeleteMedicalTranscriptionJobInput, optFns ...func(*Options)) (*DeleteMedicalTranscriptionJobOutput, error)

Deletes a medical transcription job, along with any related information. To use this operation, specify the name of the job you want to delete using MedicalTranscriptionJobName.

func (*Client) DeleteMedicalVocabulary

func (c *Client) DeleteMedicalVocabulary(ctx context.Context, params *DeleteMedicalVocabularyInput, optFns ...func(*Options)) (*DeleteMedicalVocabularyOutput, error)

Deletes a custom medical vocabulary. To use this operation, specify the name of the vocabulary you want to delete using VocabularyName.

func (*Client) DeleteTranscriptionJob

func (c *Client) DeleteTranscriptionJob(ctx context.Context, params *DeleteTranscriptionJobInput, optFns ...func(*Options)) (*DeleteTranscriptionJobOutput, error)

Deletes a transcription job, along with any related information. To use this operation, specify the name of the job you want to delete using TranscriptionJobName.

func (*Client) DeleteVocabulary

func (c *Client) DeleteVocabulary(ctx context.Context, params *DeleteVocabularyInput, optFns ...func(*Options)) (*DeleteVocabularyOutput, error)

Deletes a custom vocabulary. To use this operation, specify the name of the vocabulary you want to delete using VocabularyName.

func (*Client) DeleteVocabularyFilter

func (c *Client) DeleteVocabularyFilter(ctx context.Context, params *DeleteVocabularyFilterInput, optFns ...func(*Options)) (*DeleteVocabularyFilterOutput, error)

Deletes a vocabulary filter. To use this operation, specify the name of the vocabulary filter you want to delete using VocabularyFilterName.

func (*Client) DescribeLanguageModel

func (c *Client) DescribeLanguageModel(ctx context.Context, params *DescribeLanguageModelInput, optFns ...func(*Options)) (*DescribeLanguageModelOutput, error)

Provides information about a specific custom language model in your Amazon Web Services account. This operation also shows if the base language model you used to create your custom language model has been updated. If Amazon Transcribe has updated the base model, you can create a new custom language model using the updated base model. If you tried to create a new custom language model and the request wasn't successful, you can use this operation to help identify the reason.

func (*Client) GetCallAnalyticsCategory

func (c *Client) GetCallAnalyticsCategory(ctx context.Context, params *GetCallAnalyticsCategoryInput, optFns ...func(*Options)) (*GetCallAnalyticsCategoryOutput, error)

Retrieves information about a call analytics category.

func (*Client) GetCallAnalyticsJob

func (c *Client) GetCallAnalyticsJob(ctx context.Context, params *GetCallAnalyticsJobInput, optFns ...func(*Options)) (*GetCallAnalyticsJobOutput, error)

Retrieves information about a call analytics job. To view the job's status, refer to the CallAnalyticsJobStatus field. If the status is COMPLETED, the job is finished. You can then find your transcript at the URI specified in the TranscriptFileUri field. If you enabled personally identifiable information (PII) redaction, the redacted transcript appears in the RedactedTranscriptFileUri field.

func (*Client) GetMedicalTranscriptionJob

func (c *Client) GetMedicalTranscriptionJob(ctx context.Context, params *GetMedicalTranscriptionJobInput, optFns ...func(*Options)) (*GetMedicalTranscriptionJobOutput, error)

Retrieves information about a medical transcription job. To view the job's status, refer to the TranscriptionJobStatus field. If the status is COMPLETED, the job is finished. You can then find your transcript at the URI specified in the TranscriptFileUri field.

func (*Client) GetMedicalVocabulary

func (c *Client) GetMedicalVocabulary(ctx context.Context, params *GetMedicalVocabularyInput, optFns ...func(*Options)) (*GetMedicalVocabularyOutput, error)

Retrieves information about a medical vocabulary.

func (*Client) GetTranscriptionJob

func (c *Client) GetTranscriptionJob(ctx context.Context, params *GetTranscriptionJobInput, optFns ...func(*Options)) (*GetTranscriptionJobOutput, error)

Returns information about a transcription job. To see the status of the job, check the TranscriptionJobStatus field. If the status is COMPLETED, the job is finished and you can find the results at the location specified in the TranscriptFileUri field. If you enable content redaction, the redacted transcript appears in RedactedTranscriptFileUri.

func (*Client) GetVocabulary

func (c *Client) GetVocabulary(ctx context.Context, params *GetVocabularyInput, optFns ...func(*Options)) (*GetVocabularyOutput, error)

Gets information about a vocabulary.

func (*Client) GetVocabularyFilter

func (c *Client) GetVocabularyFilter(ctx context.Context, params *GetVocabularyFilterInput, optFns ...func(*Options)) (*GetVocabularyFilterOutput, error)

Returns information about a vocabulary filter.

func (*Client) ListCallAnalyticsCategories

func (c *Client) ListCallAnalyticsCategories(ctx context.Context, params *ListCallAnalyticsCategoriesInput, optFns ...func(*Options)) (*ListCallAnalyticsCategoriesOutput, error)

Provides more information about the call analytics categories that you've created. You can use the information in this list to find a specific category. You can then use the operation to get more information about it.

func (*Client) ListCallAnalyticsJobs

func (c *Client) ListCallAnalyticsJobs(ctx context.Context, params *ListCallAnalyticsJobsInput, optFns ...func(*Options)) (*ListCallAnalyticsJobsOutput, error)

List call analytics jobs with a specified status or substring that matches their names.

func (*Client) ListLanguageModels

func (c *Client) ListLanguageModels(ctx context.Context, params *ListLanguageModelsInput, optFns ...func(*Options)) (*ListLanguageModelsOutput, error)

Provides more information about the custom language models you've created. You can use the information in this list to find a specific custom language model. You can then use the operation to get more information about it.

func (*Client) ListMedicalTranscriptionJobs

func (c *Client) ListMedicalTranscriptionJobs(ctx context.Context, params *ListMedicalTranscriptionJobsInput, optFns ...func(*Options)) (*ListMedicalTranscriptionJobsOutput, error)

Lists medical transcription jobs with a specified status or substring that matches their names.

func (*Client) ListMedicalVocabularies

func (c *Client) ListMedicalVocabularies(ctx context.Context, params *ListMedicalVocabulariesInput, optFns ...func(*Options)) (*ListMedicalVocabulariesOutput, error)

Returns a list of vocabularies that match the specified criteria. If you don't enter a value in any of the request parameters, returns the entire list of vocabularies.

func (*Client) ListTagsForResource

func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

Lists all tags associated with a given transcription job, vocabulary, or resource.

func (*Client) ListTranscriptionJobs

func (c *Client) ListTranscriptionJobs(ctx context.Context, params *ListTranscriptionJobsInput, optFns ...func(*Options)) (*ListTranscriptionJobsOutput, error)

Lists transcription jobs with the specified status.

func (*Client) ListVocabularies

func (c *Client) ListVocabularies(ctx context.Context, params *ListVocabulariesInput, optFns ...func(*Options)) (*ListVocabulariesOutput, error)

Returns a list of vocabularies that match the specified criteria. If no criteria are specified, returns the entire list of vocabularies.

func (*Client) ListVocabularyFilters

func (c *Client) ListVocabularyFilters(ctx context.Context, params *ListVocabularyFiltersInput, optFns ...func(*Options)) (*ListVocabularyFiltersOutput, error)

Gets information about vocabulary filters.

func (*Client) StartCallAnalyticsJob

func (c *Client) StartCallAnalyticsJob(ctx context.Context, params *StartCallAnalyticsJobInput, optFns ...func(*Options)) (*StartCallAnalyticsJobOutput, error)

Starts an asynchronous analytics job that not only transcribes the audio recording of a caller and agent, but also returns additional insights. These insights include how quickly or loudly the caller or agent was speaking. To retrieve additional insights with your analytics jobs, create categories. A category is a way to classify analytics jobs based on attributes, such as a customer's sentiment or a particular phrase being used during the call. For more information, see the operation.

func (*Client) StartMedicalTranscriptionJob

func (c *Client) StartMedicalTranscriptionJob(ctx context.Context, params *StartMedicalTranscriptionJobInput, optFns ...func(*Options)) (*StartMedicalTranscriptionJobOutput, error)

Starts a batch job to transcribe medical speech to text.

func (*Client) StartTranscriptionJob

func (c *Client) StartTranscriptionJob(ctx context.Context, params *StartTranscriptionJobInput, optFns ...func(*Options)) (*StartTranscriptionJobOutput, error)

Starts an asynchronous job to transcribe speech to text.

func (*Client) TagResource

func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)

Tags an Amazon Transcribe resource with the given list of tags.

func (*Client) UntagResource

func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)

Removes specified tags from a specified Amazon Transcribe resource.

func (*Client) UpdateCallAnalyticsCategory

func (c *Client) UpdateCallAnalyticsCategory(ctx context.Context, params *UpdateCallAnalyticsCategoryInput, optFns ...func(*Options)) (*UpdateCallAnalyticsCategoryOutput, error)

Updates the call analytics category with new values. The UpdateCallAnalyticsCategory operation overwrites all of the existing information with the values that you provide in the request.

func (*Client) UpdateMedicalVocabulary

func (c *Client) UpdateMedicalVocabulary(ctx context.Context, params *UpdateMedicalVocabularyInput, optFns ...func(*Options)) (*UpdateMedicalVocabularyOutput, error)

Updates a vocabulary with new values that you provide in a different text file from the one you used to create the vocabulary. The UpdateMedicalVocabulary operation overwrites all of the existing information with the values that you provide in the request.

func (*Client) UpdateVocabulary

func (c *Client) UpdateVocabulary(ctx context.Context, params *UpdateVocabularyInput, optFns ...func(*Options)) (*UpdateVocabularyOutput, error)

Updates an existing vocabulary with new values. The UpdateVocabulary operation overwrites all of the existing information with the values that you provide in the request.

func (*Client) UpdateVocabularyFilter

func (c *Client) UpdateVocabularyFilter(ctx context.Context, params *UpdateVocabularyFilterInput, optFns ...func(*Options)) (*UpdateVocabularyFilterOutput, error)

Updates a vocabulary filter with a new list of filtered words.

type CreateCallAnalyticsCategoryInput

type CreateCallAnalyticsCategoryInput struct {

	// A unique name, chosen by you, for your call analytics category. For example,
	// sentiment-positive-last30seconds.
	//
	// This member is required.
	CategoryName *string

	// Rules make up a call analytics category. When creating a call analytics
	// category, you must create between 1 and 20 rules for your category. For each
	// rule, you specify a filter you want applied to the attributes of a call. For
	// example, you can choose a sentiment filter that detects if a customer's
	// sentiment was positive during the last 30 seconds of the call.
	//
	// This member is required.
	Rules []types.Rule
	// contains filtered or unexported fields
}

type CreateCallAnalyticsCategoryOutput

type CreateCallAnalyticsCategoryOutput struct {

	// If your audio matches one of your categories, this field contains data on that
	// category and its associated rules. This parameter shows which category is
	// flagged (CategoryName) along with metadata for the rules that match your audio.
	// Metadata includes the rule filter (such as InterruptionFilter,
	// NonTalkTimeFilter, SentimentFilter, and TranscriptFilter) and where in your
	// audio (StartTime and EndTime) the rule has a match.
	CategoryProperties *types.CategoryProperties

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateLanguageModelInput

type CreateLanguageModelInput struct {

	// The Amazon Transcribe standard language model, or base model, used to create
	// your custom language model. Amazon Transcribe offers two options for base
	// models: Wideband and Narrowband. If the audio you want to transcribe has a
	// sample rate of 16,000 Hz or greater, choose WideBand. To transcribe audio with a
	// sample rate less than 16,000 Hz, choose NarrowBand.
	//
	// This member is required.
	BaseModelName types.BaseModelName

	// Contains your data access role ARN (Amazon Resource Name) and the Amazon S3
	// locations of your training (S3Uri) and tuning (TuningDataS3Uri) data.
	//
	// This member is required.
	InputDataConfig *types.InputDataConfig

	// The language of your custom language model; note that the language code you
	// select must match the language of your training and tuning data.
	//
	// This member is required.
	LanguageCode types.CLMLanguageCode

	// The name of your new custom language model. This name is case sensitive, cannot
	// contain spaces, and must be unique within an Amazon Web Services account. If you
	// try to create a language model with the same name as a previous language model,
	// you get a ConflictException error.
	//
	// This member is required.
	ModelName *string

	// Optionally add tags, each in the form of a key:value pair, to your new language
	// model. See also: .
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateLanguageModelOutput

type CreateLanguageModelOutput struct {

	// The Amazon Transcribe standard language model, or base model, you used when
	// creating your custom language model. If your audio has a sample rate of 16,000
	// Hz or greater, this value should be WideBand. If your audio has a sample rate of
	// less than 16,000 Hz, this value should be NarrowBand.
	BaseModelName types.BaseModelName

	// Lists your data access role ARN (Amazon Resource Name) and the Amazon S3
	// locations your provided for your training (S3Uri) and tuning (TuningDataS3Uri)
	// data.
	InputDataConfig *types.InputDataConfig

	// The language code you selected for your custom language model.
	LanguageCode types.CLMLanguageCode

	// The unique name you chose for your custom language model.
	ModelName *string

	// The status of your custom language model. When the status shows as COMPLETED,
	// your model is ready to use.
	ModelStatus types.ModelStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateMedicalVocabularyInput

type CreateMedicalVocabularyInput struct {

	// The language code that represents the language of the entries in your custom
	// vocabulary. Note that U.S. English (en-US) is the only language supported with
	// Amazon Transcribe Medical.
	//
	// This member is required.
	LanguageCode types.LanguageCode

	// The Amazon S3 location (URI) of the text file that contains your custom
	// vocabulary. The URI must be in the same Amazon Web Services Region as the
	// resource that you're calling. Here's an example URI path:
	// https://s3.us-east-1.amazonaws.com/my-s3-bucket/my-vocab-file.txt
	//
	// This member is required.
	VocabularyFileUri *string

	// The name of your new vocabulary. This name is case sensitive, cannot contain
	// spaces, and must be unique within an Amazon Web Services account. If you try to
	// create a vocabulary with the same name as a previous vocabulary, you get a
	// ConflictException error.
	//
	// This member is required.
	VocabularyName *string

	// Adds one or more tags, each in the form of a key:value pair, to a new medical
	// vocabulary at the time you create the new vocabulary. To learn more about using
	// tags with Amazon Transcribe, refer to Tagging resources
	// (https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html).
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateMedicalVocabularyOutput

type CreateMedicalVocabularyOutput struct {

	// If the VocabularyState field is FAILED, FailureReason contains information about
	// why the job failed.
	FailureReason *string

	// The language code you selected for your medical vocabulary. Note that U.S.
	// English (en-US) is the only language supported with Amazon Transcribe Medical.
	LanguageCode types.LanguageCode

	// The date and time you created your custom medical vocabulary.
	LastModifiedTime *time.Time

	// The name you chose for your vocabulary.
	VocabularyName *string

	// The processing state of your custom medical vocabulary. If the state is READY,
	// you can use the vocabulary in a StartMedicalTranscriptionJob request.
	VocabularyState types.VocabularyState

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateVocabularyFilterInput

type CreateVocabularyFilterInput struct {

	// The language code of the words in the vocabulary filter. All words in the filter
	// must be in the same language. The vocabulary filter can only be used with
	// transcription jobs in the specified language.
	//
	// This member is required.
	LanguageCode types.LanguageCode

	// The name of your new vocabulary filter. This name is case sensitive, cannot
	// contain spaces, and must be unique within an Amazon Web Services account. If you
	// try to create a vocabulary filter with the same name as a previous vocabulary
	// filter, you get a ConflictException error.
	//
	// This member is required.
	VocabularyFilterName *string

	// Adds one or more tags, each in the form of a key:value pair, to a new vocabulary
	// filter at the time you create this new vocabulary filter.
	Tags []types.Tag

	// The Amazon S3 location of a text file used as input to create the vocabulary
	// filter. Only use characters from the character set defined for custom
	// vocabularies. For a list of character sets, see Character Sets for Custom
	// Vocabularies (https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html).
	// Your vocabulary filter file must be less than 50 KB in size. Note that if you
	// include VocabularyFilterFileUri in your request, you cannot use Words; you must
	// choose one or the other.
	VocabularyFilterFileUri *string

	// The words you want in your vocabulary filter. Only use characters specified in
	// the Character sets
	// (https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html) for the
	// language you're transcribing. Note that if you include Words in your request,
	// you cannot use VocabularyFilterFileUri; you must choose one or the other.
	Words []string
	// contains filtered or unexported fields
}

type CreateVocabularyFilterOutput

type CreateVocabularyFilterOutput struct {

	// The language code associated with your vocabulary filter.
	LanguageCode types.LanguageCode

	// The date and time the vocabulary filter was modified.
	LastModifiedTime *time.Time

	// The name of the vocabulary filter.
	VocabularyFilterName *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateVocabularyInput

type CreateVocabularyInput struct {

	// The language code that represents the language of the entries in your custom
	// vocabulary. Each vocabulary must contain terms in only one language. For a list
	// of languages and their corresponding language codes, see Supported languages
	// (https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html).
	//
	// This member is required.
	LanguageCode types.LanguageCode

	// The name of your new vocabulary. This name is case sensitive, cannot contain
	// spaces, and must be unique within an Amazon Web Services account. If you try to
	// create a vocabulary with the same name as a previous vocabulary, you get a
	// ConflictException error.
	//
	// This member is required.
	VocabularyName *string

	// Use this flag to include a list of terms within your request. Note that if you
	// include Phrases in your request, you cannot use VocabularyFileUri; you must
	// choose one or the other.
	Phrases []string

	// Adds one or more tags, each in the form of a key:value pair, to a new custom
	// vocabulary at the time you create this new vocabulary.
	Tags []types.Tag

	// The S3 location of the text file that contains your custom vocabulary. The URI
	// must be located in the same region as the API endpoint you're calling. Here's an
	// example URI path:
	// https://s3.us-east-1.amazonaws.com/my-s3-bucket/my-vocab-file.txt Note that if
	// you include VocabularyFileUri in your request, you cannot use the Phrases flag;
	// you must choose one or the other.
	VocabularyFileUri *string
	// contains filtered or unexported fields
}

type CreateVocabularyOutput

type CreateVocabularyOutput struct {

	// If the VocabularyState field is FAILED, FailureReason contains information about
	// why the job failed.
	FailureReason *string

	// The language code you selected for your vocabulary.
	LanguageCode types.LanguageCode

	// The date and time you created your custom vocabulary.
	LastModifiedTime *time.Time

	// The name you chose for your vocabulary.
	VocabularyName *string

	// The processing state of your vocabulary. If the state is READY, you can use the
	// vocabulary in a StartTranscriptionJob request.
	VocabularyState types.VocabularyState

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteCallAnalyticsCategoryInput

type DeleteCallAnalyticsCategoryInput struct {

	// The name of the call analytics category you want to delete. Category names are
	// case-sensitive.
	//
	// This member is required.
	CategoryName *string
	// contains filtered or unexported fields
}

type DeleteCallAnalyticsCategoryOutput

type DeleteCallAnalyticsCategoryOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteCallAnalyticsJobInput

type DeleteCallAnalyticsJobInput struct {

	// The name of the call analytics job you want to delete. Job names are
	// case-sensitive.
	//
	// This member is required.
	CallAnalyticsJobName *string
	// contains filtered or unexported fields
}

type DeleteCallAnalyticsJobOutput

type DeleteCallAnalyticsJobOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteLanguageModelInput

type DeleteLanguageModelInput struct {

	// The name of the model you want to delete. Model names are case-sensitive.
	//
	// This member is required.
	ModelName *string
	// contains filtered or unexported fields
}

type DeleteLanguageModelOutput

type DeleteLanguageModelOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteMedicalTranscriptionJobInput

type DeleteMedicalTranscriptionJobInput struct {

	// The name of the medical transcription job you want to delete. Job names are
	// case-sensitive.
	//
	// This member is required.
	MedicalTranscriptionJobName *string
	// contains filtered or unexported fields
}

type DeleteMedicalTranscriptionJobOutput

type DeleteMedicalTranscriptionJobOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteMedicalVocabularyInput

type DeleteMedicalVocabularyInput struct {

	// The name of the vocabulary that you want to delete. Vocabulary names are
	// case-sensitive.
	//
	// This member is required.
	VocabularyName *string
	// contains filtered or unexported fields
}

type DeleteMedicalVocabularyOutput

type DeleteMedicalVocabularyOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteTranscriptionJobInput

type DeleteTranscriptionJobInput struct {

	// The name of the transcription job you want to delete. Job names are
	// case-sensitive.
	//
	// This member is required.
	TranscriptionJobName *string
	// contains filtered or unexported fields
}

type DeleteTranscriptionJobOutput

type DeleteTranscriptionJobOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteVocabularyFilterInput

type DeleteVocabularyFilterInput struct {

	// The name of the vocabulary filter you want to delete. Vocabulary filter names
	// are case-sensitive.
	//
	// This member is required.
	VocabularyFilterName *string
	// contains filtered or unexported fields
}

type DeleteVocabularyFilterOutput

type DeleteVocabularyFilterOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteVocabularyInput

type DeleteVocabularyInput struct {

	// The name of the vocabulary you want to delete. Vocabulary names are
	// case-sensitive.
	//
	// This member is required.
	VocabularyName *string
	// contains filtered or unexported fields
}

type DeleteVocabularyOutput

type DeleteVocabularyOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeLanguageModelInput

type DescribeLanguageModelInput struct {

	// The name of the custom language model you want described. Model names are
	// case-sensitive.
	//
	// This member is required.
	ModelName *string
	// contains filtered or unexported fields
}

type DescribeLanguageModelOutput

type DescribeLanguageModelOutput struct {

	// The name of the custom language model you requested more information about.
	LanguageModel *types.LanguageModel

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type EndpointResolver

type EndpointResolver interface {
	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL

func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

type EndpointResolverFunc

type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

type EndpointResolverOptions

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type GetCallAnalyticsCategoryInput

type GetCallAnalyticsCategoryInput struct {

	// The name of the category you want information about. Category names are case
	// sensitive.
	//
	// This member is required.
	CategoryName *string
	// contains filtered or unexported fields
}

type GetCallAnalyticsCategoryOutput

type GetCallAnalyticsCategoryOutput struct {

	// Provides you with the rules associated with the category you specified in your
	// GetCallAnalyticsCategory request.
	CategoryProperties *types.CategoryProperties

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetCallAnalyticsJobInput

type GetCallAnalyticsJobInput struct {

	// The name of the analytics job you want information about. This value is case
	// sensitive.
	//
	// This member is required.
	CallAnalyticsJobName *string
	// contains filtered or unexported fields
}

type GetCallAnalyticsJobOutput

type GetCallAnalyticsJobOutput struct {

	// An object that contains detailed information about your call analytics job.
	// Returned fields include: CallAnalyticsJobName, CallAnalyticsJobStatus,
	// ChannelDefinitions, CompletionTime, CreationTime, DataAccessRoleArn,
	// FailureReason, IdentifiedLanguageScore, LanguageCode, Media, MediaFormat,
	// MediaSampleRateHertz, Settings, StartTime, and Transcript.
	CallAnalyticsJob *types.CallAnalyticsJob

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetMedicalTranscriptionJobInput

type GetMedicalTranscriptionJobInput struct {

	// The name of the medical transcription job you want information about. This value
	// is case sensitive.
	//
	// This member is required.
	MedicalTranscriptionJobName *string
	// contains filtered or unexported fields
}

type GetMedicalTranscriptionJobOutput

type GetMedicalTranscriptionJobOutput struct {

	// An object that contains detailed information about your medical transcription
	// job. Returned fields include: CompletionTime, ContentIdentificationType,
	// CreationTime, FailureReason, LanguageCode, Media, MediaFormat,
	// MediaSampleRateHertz, MedicalTranscriptionJobName, Settings, Specialty,
	// StartTime, Tags, Transcript, TranscriptionJobStatus, and Type.
	MedicalTranscriptionJob *types.MedicalTranscriptionJob

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetMedicalVocabularyInput

type GetMedicalVocabularyInput struct {

	// The name of the medical vocabulary you want information about. This value is
	// case sensitive.
	//
	// This member is required.
	VocabularyName *string
	// contains filtered or unexported fields
}

type GetMedicalVocabularyOutput

type GetMedicalVocabularyOutput struct {

	// The S3 location where the vocabulary is stored; use this URI to view or download
	// the vocabulary.
	DownloadUri *string

	// If your request returns a VocabularyState that is FAILED, the FailureReason
	// field contains information about why the request failed. For more information,
	// refer to the Common Errors
	// (https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html)
	// section.
	FailureReason *string

	// The valid language code for your vocabulary entries.
	LanguageCode types.LanguageCode

	// The date and time that the vocabulary was last modified with a text file
	// different from the one that was previously used.
	LastModifiedTime *time.Time

	// The name of the vocabulary returned by Amazon Transcribe Medical.
	VocabularyName *string

	// The processing state of the vocabulary. If the VocabularyState is READY then you
	// can use it in the StartMedicalTranscriptionJob operation.
	VocabularyState types.VocabularyState

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetTranscriptionJobInput

type GetTranscriptionJobInput struct {

	// The name of the job.
	//
	// This member is required.
	TranscriptionJobName *string
	// contains filtered or unexported fields
}

type GetTranscriptionJobOutput

type GetTranscriptionJobOutput struct {

	// An object that contains the results of the transcription job.
	TranscriptionJob *types.TranscriptionJob

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetVocabularyFilterInput

type GetVocabularyFilterInput struct {

	// The name of the vocabulary filter for which to return information.
	//
	// This member is required.
	VocabularyFilterName *string
	// contains filtered or unexported fields
}

type GetVocabularyFilterOutput

type GetVocabularyFilterOutput struct {

	// The URI of the list of words in the vocabulary filter. You can use this URI to
	// get the list of words.
	DownloadUri *string

	// The language code of the words in the vocabulary filter.
	LanguageCode types.LanguageCode

	// The date and time that the contents of the vocabulary filter were updated.
	LastModifiedTime *time.Time

	// The name of the vocabulary filter.
	VocabularyFilterName *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetVocabularyInput

type GetVocabularyInput struct {

	// The name of the vocabulary to return information about. The name is case
	// sensitive.
	//
	// This member is required.
	VocabularyName *string
	// contains filtered or unexported fields
}

type GetVocabularyOutput

type GetVocabularyOutput struct {

	// The S3 location where the vocabulary is stored. Use this URI to get the contents
	// of the vocabulary. The URI is available for a limited time.
	DownloadUri *string

	// If the VocabularyState field is FAILED, this field contains information about
	// why the job failed.
	FailureReason *string

	// The language code of the vocabulary entries.
	LanguageCode types.LanguageCode

	// The date and time that the vocabulary was last modified.
	LastModifiedTime *time.Time

	// The name of the vocabulary to return.
	VocabularyName *string

	// The processing state of the vocabulary.
	VocabularyState types.VocabularyState

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type HTTPClient

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
}

type ListCallAnalyticsCategoriesAPIClient

type ListCallAnalyticsCategoriesAPIClient interface {
	ListCallAnalyticsCategories(context.Context, *ListCallAnalyticsCategoriesInput, ...func(*Options)) (*ListCallAnalyticsCategoriesOutput, error)
}

ListCallAnalyticsCategoriesAPIClient is a client that implements the ListCallAnalyticsCategories operation.

type ListCallAnalyticsCategoriesInput

type ListCallAnalyticsCategoriesInput struct {

	// The maximum number of categories to return in each page of results. If there are
	// fewer results than the value you specify, only the actual results are returned.
	// If you do not specify a value, the default of 5 is used.
	MaxResults *int32

	// When included, NextTokenfetches the next set of categories if the result of the
	// previous request was truncated.
	NextToken *string
	// contains filtered or unexported fields
}

type ListCallAnalyticsCategoriesOutput

type ListCallAnalyticsCategoriesOutput struct {

	// A list of objects containing information about analytics categories.
	Categories []types.CategoryProperties

	// The operation returns a page of jobs at a time. The maximum size of the list is
	// set by the MaxResults parameter. If there are more categories in the list than
	// the page size, Amazon Transcribe returns the NextPage token. Include the token
	// in the next request to the operation to return the next page of analytics
	// categories.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListCallAnalyticsCategoriesPaginator

type ListCallAnalyticsCategoriesPaginator struct {
	// contains filtered or unexported fields
}

ListCallAnalyticsCategoriesPaginator is a paginator for ListCallAnalyticsCategories

func NewListCallAnalyticsCategoriesPaginator

NewListCallAnalyticsCategoriesPaginator returns a new ListCallAnalyticsCategoriesPaginator

func (*ListCallAnalyticsCategoriesPaginator) HasMorePages

func (p *ListCallAnalyticsCategoriesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListCallAnalyticsCategoriesPaginator) NextPage

NextPage retrieves the next ListCallAnalyticsCategories page.

type ListCallAnalyticsCategoriesPaginatorOptions

type ListCallAnalyticsCategoriesPaginatorOptions struct {
	// The maximum number of categories to return in each page of results. If there are
	// fewer results than the value you specify, only the actual results are returned.
	// If you do not specify a value, the default of 5 is used.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListCallAnalyticsCategoriesPaginatorOptions is the paginator options for ListCallAnalyticsCategories

type ListCallAnalyticsJobsAPIClient

type ListCallAnalyticsJobsAPIClient interface {
	ListCallAnalyticsJobs(context.Context, *ListCallAnalyticsJobsInput, ...func(*Options)) (*ListCallAnalyticsJobsOutput, error)
}

ListCallAnalyticsJobsAPIClient is a client that implements the ListCallAnalyticsJobs operation.

type ListCallAnalyticsJobsInput

type ListCallAnalyticsJobsInput struct {

	// When specified, the jobs returned in the list are limited to jobs whose name
	// contains the specified string.
	JobNameContains *string

	// The maximum number of call analytics jobs to return in each page of results. If
	// there are fewer results than the value you specify, only the actual results are
	// returned. If you do not specify a value, the default of 5 is used.
	MaxResults *int32

	// If you receive a truncated result in the previous request of , include NextToken
	// to fetch the next set of jobs.
	NextToken *string

	// When specified, returns only call analytics jobs with the specified status. Jobs
	// are ordered by creation date, with the most recent jobs returned first. If you
	// don't specify a status, Amazon Transcribe returns all analytics jobs ordered by
	// creation date.
	Status types.CallAnalyticsJobStatus
	// contains filtered or unexported fields
}

type ListCallAnalyticsJobsOutput

type ListCallAnalyticsJobsOutput struct {

	// A list of objects containing summary information for a transcription job.
	CallAnalyticsJobSummaries []types.CallAnalyticsJobSummary

	// The operation returns a page of jobs at a time. The maximum size of the page is
	// set by the MaxResults parameter. If there are more jobs in the list than the
	// page size, Amazon Transcribe returns the NextPage token. Include the token in
	// your next request to the operation to return next page of jobs.
	NextToken *string

	// When specified, returns only call analytics jobs with that status. Jobs are
	// ordered by creation date, with the most recent jobs returned first. If you don't
	// specify a status, Amazon Transcribe returns all transcription jobs ordered by
	// creation date.
	Status types.CallAnalyticsJobStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListCallAnalyticsJobsPaginator

type ListCallAnalyticsJobsPaginator struct {
	// contains filtered or unexported fields
}

ListCallAnalyticsJobsPaginator is a paginator for ListCallAnalyticsJobs

func NewListCallAnalyticsJobsPaginator

NewListCallAnalyticsJobsPaginator returns a new ListCallAnalyticsJobsPaginator

func (*ListCallAnalyticsJobsPaginator) HasMorePages

func (p *ListCallAnalyticsJobsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListCallAnalyticsJobsPaginator) NextPage

NextPage retrieves the next ListCallAnalyticsJobs page.

type ListCallAnalyticsJobsPaginatorOptions

type ListCallAnalyticsJobsPaginatorOptions struct {
	// The maximum number of call analytics jobs to return in each page of results. If
	// there are fewer results than the value you specify, only the actual results are
	// returned. If you do not specify a value, the default of 5 is used.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListCallAnalyticsJobsPaginatorOptions is the paginator options for ListCallAnalyticsJobs

type ListLanguageModelsAPIClient

type ListLanguageModelsAPIClient interface {
	ListLanguageModels(context.Context, *ListLanguageModelsInput, ...func(*Options)) (*ListLanguageModelsOutput, error)
}

ListLanguageModelsAPIClient is a client that implements the ListLanguageModels operation.

type ListLanguageModelsInput

type ListLanguageModelsInput struct {

	// The maximum number of language models to return in each page of results. If
	// there are fewer results than the value you specify, only the actual results are
	// returned. If you do not specify a value, the default of 5 is used.
	MaxResults *int32

	// When specified, the custom language model names returned contain the substring
	// you've specified.
	NameContains *string

	// When included, fetches the next set of jobs if the result of the previous
	// request was truncated.
	NextToken *string

	// When specified, returns only custom language models with the specified status.
	// Language models are ordered by creation date, with the newest models first. If
	// you don't specify a status, Amazon Transcribe returns all custom language models
	// ordered by date.
	StatusEquals types.ModelStatus
	// contains filtered or unexported fields
}

type ListLanguageModelsOutput

type ListLanguageModelsOutput struct {

	// A list of objects containing information about custom language models.
	Models []types.LanguageModel

	// The operation returns a page of jobs at a time. The maximum size of the list is
	// set by the MaxResults parameter. If there are more language models in the list
	// than the page size, Amazon Transcribe returns the NextPage token. Include the
	// token in the next request to the operation to return the next page of language
	// models.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListLanguageModelsPaginator

type ListLanguageModelsPaginator struct {
	// contains filtered or unexported fields
}

ListLanguageModelsPaginator is a paginator for ListLanguageModels

func NewListLanguageModelsPaginator

func NewListLanguageModelsPaginator(client ListLanguageModelsAPIClient, params *ListLanguageModelsInput, optFns ...func(*ListLanguageModelsPaginatorOptions)) *ListLanguageModelsPaginator

NewListLanguageModelsPaginator returns a new ListLanguageModelsPaginator

func (*ListLanguageModelsPaginator) HasMorePages

func (p *ListLanguageModelsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListLanguageModelsPaginator) NextPage

func (p *ListLanguageModelsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListLanguageModelsOutput, error)

NextPage retrieves the next ListLanguageModels page.

type ListLanguageModelsPaginatorOptions

type ListLanguageModelsPaginatorOptions struct {
	// The maximum number of language models to return in each page of results. If
	// there are fewer results than the value you specify, only the actual results are
	// returned. If you do not specify a value, the default of 5 is used.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListLanguageModelsPaginatorOptions is the paginator options for ListLanguageModels

type ListMedicalTranscriptionJobsAPIClient

type ListMedicalTranscriptionJobsAPIClient interface {
	ListMedicalTranscriptionJobs(context.Context, *ListMedicalTranscriptionJobsInput, ...func(*Options)) (*ListMedicalTranscriptionJobsOutput, error)
}

ListMedicalTranscriptionJobsAPIClient is a client that implements the ListMedicalTranscriptionJobs operation.

type ListMedicalTranscriptionJobsInput

type ListMedicalTranscriptionJobsInput struct {

	// When specified, the jobs returned in the list are limited to jobs whose name
	// contains the specified string.
	JobNameContains *string

	// The maximum number of medical transcription jobs to return in each page of
	// results. If there are fewer results than the value you specify, only the actual
	// results are returned. If you do not specify a value, the default of 5 is used.
	MaxResults *int32

	// If you a receive a truncated result in the previous request of
	// ListMedicalTranscriptionJobs, include NextToken to fetch the next set of jobs.
	NextToken *string

	// When specified, returns only medical transcription jobs with the specified
	// status. Jobs are ordered by creation date, with the newest jobs returned first.
	// If you don't specify a status, Amazon Transcribe Medical returns all
	// transcription jobs ordered by creation date.
	Status types.TranscriptionJobStatus
	// contains filtered or unexported fields
}

type ListMedicalTranscriptionJobsOutput

type ListMedicalTranscriptionJobsOutput struct {

	// A list of objects containing summary information for a transcription job.
	MedicalTranscriptionJobSummaries []types.MedicalTranscriptionJobSummary

	// The ListMedicalTranscriptionJobs operation returns a page of jobs at a time. The
	// maximum size of the page is set by the MaxResults parameter. If the number of
	// jobs exceeds what can fit on a page, Amazon Transcribe Medical returns the
	// NextPage token. Include the token in the next request to the
	// ListMedicalTranscriptionJobs operation to return in the next page of jobs.
	NextToken *string

	// The requested status of the medical transcription jobs returned.
	Status types.TranscriptionJobStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListMedicalTranscriptionJobsPaginator

type ListMedicalTranscriptionJobsPaginator struct {
	// contains filtered or unexported fields
}

ListMedicalTranscriptionJobsPaginator is a paginator for ListMedicalTranscriptionJobs

func NewListMedicalTranscriptionJobsPaginator

NewListMedicalTranscriptionJobsPaginator returns a new ListMedicalTranscriptionJobsPaginator

func (*ListMedicalTranscriptionJobsPaginator) HasMorePages

func (p *ListMedicalTranscriptionJobsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListMedicalTranscriptionJobsPaginator) NextPage

NextPage retrieves the next ListMedicalTranscriptionJobs page.

type ListMedicalTranscriptionJobsPaginatorOptions

type ListMedicalTranscriptionJobsPaginatorOptions struct {
	// The maximum number of medical transcription jobs to return in each page of
	// results. If there are fewer results than the value you specify, only the actual
	// results are returned. If you do not specify a value, the default of 5 is used.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListMedicalTranscriptionJobsPaginatorOptions is the paginator options for ListMedicalTranscriptionJobs

type ListMedicalVocabulariesAPIClient

type ListMedicalVocabulariesAPIClient interface {
	ListMedicalVocabularies(context.Context, *ListMedicalVocabulariesInput, ...func(*Options)) (*ListMedicalVocabulariesOutput, error)
}

ListMedicalVocabulariesAPIClient is a client that implements the ListMedicalVocabularies operation.

type ListMedicalVocabulariesInput

type ListMedicalVocabulariesInput struct {

	// The maximum number of vocabularies to return in each page of results. If there
	// are fewer results than the value you specify, only the actual results are
	// returned. If you do not specify a value, the default of 5 is used.
	MaxResults *int32

	// Returns vocabularies whose names contain the specified string. The search is not
	// case sensitive. ListMedicalVocabularies returns both "vocabularyname" and
	// "VocabularyName".
	NameContains *string

	// If the result of your previous request to ListMedicalVocabularies was truncated,
	// include the NextToken to fetch the next set of vocabularies.
	NextToken *string

	// When specified, returns only vocabularies with the VocabularyState equal to the
	// specified vocabulary state. Use this field to see which vocabularies are ready
	// for your medical transcription jobs.
	StateEquals types.VocabularyState
	// contains filtered or unexported fields
}

type ListMedicalVocabulariesOutput

type ListMedicalVocabulariesOutput struct {

	// The ListMedicalVocabularies operation returns a page of vocabularies at a time.
	// You set the maximum number of vocabularies to return on a page with the
	// MaxResults parameter. If there are more jobs in the list will fit on a page,
	// Amazon Transcribe Medical returns the NextPage token. To return the next page of
	// vocabularies, include the token in the next request to the
	// ListMedicalVocabularies operation.
	NextToken *string

	// The requested vocabulary state.
	Status types.VocabularyState

	// A list of objects that describe the vocabularies that match your search
	// criteria.
	Vocabularies []types.VocabularyInfo

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListMedicalVocabulariesPaginator

type ListMedicalVocabulariesPaginator struct {
	// contains filtered or unexported fields
}

ListMedicalVocabulariesPaginator is a paginator for ListMedicalVocabularies

func NewListMedicalVocabulariesPaginator

NewListMedicalVocabulariesPaginator returns a new ListMedicalVocabulariesPaginator

func (*ListMedicalVocabulariesPaginator) HasMorePages

func (p *ListMedicalVocabulariesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListMedicalVocabulariesPaginator) NextPage

NextPage retrieves the next ListMedicalVocabularies page.

type ListMedicalVocabulariesPaginatorOptions

type ListMedicalVocabulariesPaginatorOptions struct {
	// The maximum number of vocabularies to return in each page of results. If there
	// are fewer results than the value you specify, only the actual results are
	// returned. If you do not specify a value, the default of 5 is used.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListMedicalVocabulariesPaginatorOptions is the paginator options for ListMedicalVocabularies

type ListTagsForResourceInput

type ListTagsForResourceInput struct {

	// Lists all tags associated with a given Amazon Resource Name (ARN). ARNs have the
	// format arn:partition:service:region:account-id:resource-type/resource-id (for
	// example,
	// arn:aws:transcribe:us-east-1:account-id:transcription-job/your-job-name). Valid
	// values for resource-type are: transcription-job, medical-transcription-job,
	// vocabulary, medical-vocabulary, vocabulary-filter, and language-model.
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput

type ListTagsForResourceOutput struct {

	// Lists all tags associated with the given Amazon Resource Name (ARN).
	ResourceArn *string

	// Lists all tags associated with the given transcription job, vocabulary, or
	// resource.
	Tags []types.Tag

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListTranscriptionJobsAPIClient

type ListTranscriptionJobsAPIClient interface {
	ListTranscriptionJobs(context.Context, *ListTranscriptionJobsInput, ...func(*Options)) (*ListTranscriptionJobsOutput, error)
}

ListTranscriptionJobsAPIClient is a client that implements the ListTranscriptionJobs operation.

type ListTranscriptionJobsInput

type ListTranscriptionJobsInput struct {

	// When specified, the jobs returned in the list are limited to jobs whose name
	// contains the specified string.
	JobNameContains *string

	// The maximum number of jobs to return in each page of results. If there are fewer
	// results than the value you specify, only the actual results are returned. If you
	// do not specify a value, the default of 5 is used.
	MaxResults *int32

	// If the result of the previous request to ListTranscriptionJobs is truncated,
	// include the NextToken to fetch the next set of jobs.
	NextToken *string

	// When specified, returns only transcription jobs with the specified status. Jobs
	// are ordered by creation date, with the newest jobs returned first. If you don’t
	// specify a status, Amazon Transcribe returns all transcription jobs ordered by
	// creation date.
	Status types.TranscriptionJobStatus
	// contains filtered or unexported fields
}

type ListTranscriptionJobsOutput

type ListTranscriptionJobsOutput struct {

	// The ListTranscriptionJobs operation returns a page of jobs at a time. The
	// maximum size of the page is set by the MaxResults parameter. If there are more
	// jobs in the list than the page size, Amazon Transcribe returns the NextPage
	// token. Include the token in the next request to the ListTranscriptionJobs
	// operation to return in the next page of jobs.
	NextToken *string

	// The requested status of the jobs returned.
	Status types.TranscriptionJobStatus

	// A list of objects containing summary information for a transcription job.
	TranscriptionJobSummaries []types.TranscriptionJobSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListTranscriptionJobsPaginator

type ListTranscriptionJobsPaginator struct {
	// contains filtered or unexported fields
}

ListTranscriptionJobsPaginator is a paginator for ListTranscriptionJobs

func NewListTranscriptionJobsPaginator

NewListTranscriptionJobsPaginator returns a new ListTranscriptionJobsPaginator

func (*ListTranscriptionJobsPaginator) HasMorePages

func (p *ListTranscriptionJobsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListTranscriptionJobsPaginator) NextPage

NextPage retrieves the next ListTranscriptionJobs page.

type ListTranscriptionJobsPaginatorOptions

type ListTranscriptionJobsPaginatorOptions struct {
	// The maximum number of jobs to return in each page of results. If there are fewer
	// results than the value you specify, only the actual results are returned. If you
	// do not specify a value, the default of 5 is used.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListTranscriptionJobsPaginatorOptions is the paginator options for ListTranscriptionJobs

type ListVocabulariesAPIClient

type ListVocabulariesAPIClient interface {
	ListVocabularies(context.Context, *ListVocabulariesInput, ...func(*Options)) (*ListVocabulariesOutput, error)
}

ListVocabulariesAPIClient is a client that implements the ListVocabularies operation.

type ListVocabulariesInput

type ListVocabulariesInput struct {

	// The maximum number of vocabularies to return in each page of results. If there
	// are fewer results than the value you specify, only the actual results are
	// returned. If you do not specify a value, the default of 5 is used.
	MaxResults *int32

	// When specified, the vocabularies returned in the list are limited to
	// vocabularies whose name contains the specified string. The search is not case
	// sensitive, ListVocabularies returns both "vocabularyname" and "VocabularyName"
	// in the response list.
	NameContains *string

	// If the result of the previous request to ListVocabularies was truncated, include
	// the NextToken to fetch the next set of jobs.
	NextToken *string

	// When specified, only returns vocabularies with the VocabularyState field equal
	// to the specified state.
	StateEquals types.VocabularyState
	// contains filtered or unexported fields
}

type ListVocabulariesOutput

type ListVocabulariesOutput struct {

	// The ListVocabularies operation returns a page of vocabularies at a time. The
	// maximum size of the page is set in the MaxResults parameter. If there are more
	// jobs in the list than will fit on the page, Amazon Transcribe returns the
	// NextPage token. To return in the next page of jobs, include the token in the
	// next request to the ListVocabularies operation.
	NextToken *string

	// The requested vocabulary state.
	Status types.VocabularyState

	// A list of objects that describe the vocabularies that match the search criteria
	// in the request.
	Vocabularies []types.VocabularyInfo

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListVocabulariesPaginator

type ListVocabulariesPaginator struct {
	// contains filtered or unexported fields
}

ListVocabulariesPaginator is a paginator for ListVocabularies

func NewListVocabulariesPaginator

func NewListVocabulariesPaginator(client ListVocabulariesAPIClient, params *ListVocabulariesInput, optFns ...func(*ListVocabulariesPaginatorOptions)) *ListVocabulariesPaginator

NewListVocabulariesPaginator returns a new ListVocabulariesPaginator

func (*ListVocabulariesPaginator) HasMorePages

func (p *ListVocabulariesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListVocabulariesPaginator) NextPage

func (p *ListVocabulariesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListVocabulariesOutput, error)

NextPage retrieves the next ListVocabularies page.

type ListVocabulariesPaginatorOptions

type ListVocabulariesPaginatorOptions struct {
	// The maximum number of vocabularies to return in each page of results. If there
	// are fewer results than the value you specify, only the actual results are
	// returned. If you do not specify a value, the default of 5 is used.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListVocabulariesPaginatorOptions is the paginator options for ListVocabularies

type ListVocabularyFiltersAPIClient

type ListVocabularyFiltersAPIClient interface {
	ListVocabularyFilters(context.Context, *ListVocabularyFiltersInput, ...func(*Options)) (*ListVocabularyFiltersOutput, error)
}

ListVocabularyFiltersAPIClient is a client that implements the ListVocabularyFilters operation.

type ListVocabularyFiltersInput

type ListVocabularyFiltersInput struct {

	// The maximum number of filters to return in each page of results. If there are
	// fewer results than the value you specify, only the actual results are returned.
	// If you do not specify a value, the default of 5 is used.
	MaxResults *int32

	// Filters the response so that it only contains vocabulary filters whose name
	// contains the specified string.
	NameContains *string

	// If the result of the previous request to ListVocabularyFilters was truncated,
	// include the NextToken to fetch the next set of collections.
	NextToken *string
	// contains filtered or unexported fields
}

type ListVocabularyFiltersOutput

type ListVocabularyFiltersOutput struct {

	// The ListVocabularyFilters operation returns a page of collections at a time. The
	// maximum size of the page is set by the MaxResults parameter. If there are more
	// jobs in the list than the page size, Amazon Transcribe returns the NextPage
	// token. Include the token in the next request to the ListVocabularyFilters
	// operation to return in the next page of jobs.
	NextToken *string

	// The list of vocabulary filters. It contains at most MaxResults number of
	// filters. If there are more filters, call the ListVocabularyFilters operation
	// again with the NextToken parameter in the request set to the value of the
	// NextToken field in the response.
	VocabularyFilters []types.VocabularyFilterInfo

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListVocabularyFiltersPaginator

type ListVocabularyFiltersPaginator struct {
	// contains filtered or unexported fields
}

ListVocabularyFiltersPaginator is a paginator for ListVocabularyFilters

func NewListVocabularyFiltersPaginator

NewListVocabularyFiltersPaginator returns a new ListVocabularyFiltersPaginator

func (*ListVocabularyFiltersPaginator) HasMorePages

func (p *ListVocabularyFiltersPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListVocabularyFiltersPaginator) NextPage

NextPage retrieves the next ListVocabularyFilters page.

type ListVocabularyFiltersPaginatorOptions

type ListVocabularyFiltersPaginatorOptions struct {
	// The maximum number of filters to return in each page of results. If there are
	// fewer results than the value you specify, only the actual results are returned.
	// If you do not specify a value, the default of 5 is used.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListVocabularyFiltersPaginatorOptions is the paginator options for ListVocabularyFilters

type Options

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// Configures the events that will be sent to the configured logger.
	ClientLogMode aws.ClientLogMode

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The configuration DefaultsMode that the SDK should use when constructing the
	// clients initial default settings.
	DefaultsMode aws.DefaultsMode

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	EndpointResolver EndpointResolver

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// The logger writer interface to write logging messages to.
	Logger logging.Logger

	// The region to send requests to. (Required)
	Region string

	// RetryMaxAttempts specifies the maximum number attempts an API client will call
	// an operation that fails with a retryable error. A value of 0 is ignored, and
	// will not be used to configure the API client created default retryer, or modify
	// per operation call's retry max attempts. When creating a new API Clients this
	// member will only be used if the Retryer Options member is nil. This value will
	// be ignored if Retryer is not nil. If specified in an operation call's functional
	// options with a value that is different than the constructed client's Options,
	// the Client's Retryer will be wrapped to use the operation's specific
	// RetryMaxAttempts value.
	RetryMaxAttempts int

	// RetryMode specifies the retry mode the API client will be created with, if
	// Retryer option is not also specified. When creating a new API Clients this
	// member will only be used if the Retryer Options member is nil. This value will
	// be ignored if Retryer is not nil. Currently does not support per operation call
	// overrides, may in the future.
	RetryMode aws.RetryMode

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer. The kind of
	// default retry created by the API client can be changed with the RetryMode
	// option.
	Retryer aws.Retryer

	// The RuntimeEnvironment configuration, only populated if the DefaultsMode is set
	// to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You
	// should not populate this structure programmatically, or rely on the values here
	// within your applications.
	RuntimeEnvironment aws.RuntimeEnvironment

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient
	// contains filtered or unexported fields
}

func (Options) Copy

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

type ResolveEndpoint

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize

func (*ResolveEndpoint) ID

func (*ResolveEndpoint) ID() string

type StartCallAnalyticsJobInput

type StartCallAnalyticsJobInput struct {

	// The name of the call analytics job. You can't use the string "." or ".." by
	// themselves as the job name. The name must also be unique within an Amazon Web
	// Services account. If you try to create a call analytics job with the same name
	// as a previous call analytics job, you get a ConflictException error.
	//
	// This member is required.
	CallAnalyticsJobName *string

	// The Amazon Resource Name (ARN) of a role that has access to the S3 bucket that
	// contains your input files. Amazon Transcribe assumes this role to read queued
	// audio files. If you have specified an output S3 bucket for your transcription
	// results, this role should have access to the output bucket as well.
	//
	// This member is required.
	DataAccessRoleArn *string

	// Describes the input media file in a transcription request.
	//
	// This member is required.
	Media *types.Media

	// When you start a call analytics job, you must pass an array that maps the agent
	// and the customer to specific audio channels. The values you can assign to a
	// channel are 0 and 1. The agent and the customer must each have their own
	// channel. You can't assign more than one channel to an agent or customer.
	ChannelDefinitions []types.ChannelDefinition

	// The Amazon Resource Name (ARN) of the Amazon Web Services Key Management Service
	// key used to encrypt the output of the call analytics job. The user calling the
	// operation must have permission to use the specified KMS key. You use either of
	// the following to identify an Amazon Web Services KMS key in the current
	// account:
	//
	// * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	// * KMS Key Alias:
	// "alias/ExampleAlias"
	//
	// You can use either of the following to identify a KMS key
	// in the current account or another account:
	//
	// * Amazon Resource Name (ARN) of a
	// KMS key in the current account or another account: "arn:aws:kms:region:account
	// ID:key/1234abcd-12ab-34cd-56ef1234567890ab"
	//
	// * ARN of a KMS Key Alias:
	// "arn:aws:kms:region:accountID:alias/ExampleAlias"
	//
	// If you don't specify an
	// encryption key, the output of the call analytics job is encrypted with the
	// default Amazon S3 key (SSE-S3). If you specify a KMS key to encrypt your output,
	// you must also specify an output location in the OutputLocation parameter.
	OutputEncryptionKMSKeyId *string

	// The Amazon S3 location where the output of the call analytics job is stored. You
	// can provide the following location types to store the output of call analytics
	// job:
	//
	// * s3://DOC-EXAMPLE-BUCKET1 If you specify a bucket, Amazon Transcribe
	// saves the output of the analytics job as a JSON file at the root level of the
	// bucket.
	//
	// * s3://DOC-EXAMPLE-BUCKET1/folder/ f you specify a path, Amazon
	// Transcribe saves the output of the analytics job as
	// s3://DOC-EXAMPLE-BUCKET1/folder/your-transcription-job-name.json. If you specify
	// a folder, you must provide a trailing slash.
	//
	// *
	// s3://DOC-EXAMPLE-BUCKET1/folder/filename.json. If you provide a path that has
	// the filename specified, Amazon Transcribe saves the output of the analytics job
	// as s3://DOC-EXAMPLEBUCKET1/folder/filename.json.
	//
	// You can specify an Amazon Web
	// Services Key Management Service (KMS) key to encrypt the output of our analytics
	// job using the OutputEncryptionKMSKeyId parameter. If you don't specify a KMS
	// key, Amazon Transcribe uses the default Amazon S3 key for server-side encryption
	// of the analytics job output that is placed in your S3 bucket.
	OutputLocation *string

	// A Settings object that provides optional settings for a call analytics job.
	Settings *types.CallAnalyticsJobSettings
	// contains filtered or unexported fields
}

type StartCallAnalyticsJobOutput

type StartCallAnalyticsJobOutput struct {

	// An object containing the details of the asynchronous call analytics job.
	CallAnalyticsJob *types.CallAnalyticsJob

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StartMedicalTranscriptionJobInput

type StartMedicalTranscriptionJobInput struct {

	// The language code for the language spoken in the input media file. US English
	// (en-US) is the valid value for medical transcription jobs. Any other value you
	// enter for language code results in a BadRequestException error.
	//
	// This member is required.
	LanguageCode types.LanguageCode

	// Describes the input media file in a transcription request.
	//
	// This member is required.
	Media *types.Media

	// The name of the medical transcription job. You can't use the strings "." or ".."
	// by themselves as the job name. The name must also be unique within an Amazon Web
	// Services account. If you try to create a medical transcription job with the same
	// name as a previous medical transcription job, you get a ConflictException error.
	//
	// This member is required.
	MedicalTranscriptionJobName *string

	// The Amazon S3 location where the transcription is stored. You must set
	// OutputBucketName for Amazon Transcribe Medical to store the transcription
	// results. Your transcript appears in the S3 location you specify. When you call
	// the GetMedicalTranscriptionJob, the operation returns this location in the
	// TranscriptFileUri field. The S3 bucket must have permissions that allow Amazon
	// Transcribe Medical to put files in the bucket. For more information, see
	// Permissions Required for IAM User Roles
	// (https://docs.aws.amazon.com/transcribe/latest/dg/security_iam_id-based-policy-examples.html#auth-role-iam-user).
	// You can specify an Amazon Web Services Key Management Service (KMS) key to
	// encrypt the output of your transcription using the OutputEncryptionKMSKeyId
	// parameter. If you don't specify a KMS key, Amazon Transcribe Medical uses the
	// default Amazon S3 key for server-side encryption of transcripts that are placed
	// in your S3 bucket.
	//
	// This member is required.
	OutputBucketName *string

	// The medical specialty of any clinician speaking in the input media.
	//
	// This member is required.
	Specialty types.Specialty

	// The type of speech in the input audio. CONVERSATION refers to conversations
	// between two or more speakers, e.g., a conversations between doctors and
	// patients. DICTATION refers to single-speaker dictated speech, such as clinical
	// notes.
	//
	// This member is required.
	Type types.Type

	// You can configure Amazon Transcribe Medical to label content in the
	// transcription output. If you specify PHI, Amazon Transcribe Medical labels the
	// personal health information (PHI) that it identifies in the transcription
	// output.
	ContentIdentificationType types.MedicalContentIdentificationType

	// A map of plain text, non-secret key:value pairs, known as encryption context
	// pairs, that provide an added layer of security for your data.
	KMSEncryptionContext map[string]string

	// The audio format of the input media file.
	MediaFormat types.MediaFormat

	// The sample rate, in Hertz, of the audio track in the input media file. If you do
	// not specify the media sample rate, Amazon Transcribe Medical determines the
	// sample rate. If you specify the sample rate, it must match the rate detected by
	// Amazon Transcribe Medical. In most cases, you should leave the
	// MediaSampleRateHertz field blank and let Amazon Transcribe Medical determine the
	// sample rate.
	MediaSampleRateHertz *int32

	// The Amazon Resource Name (ARN) of the Amazon Web Services Key Management Service
	// (KMS) key used to encrypt the output of the transcription job. The user calling
	// the StartMedicalTranscriptionJob operation must have permission to use the
	// specified KMS key. You use either of the following to identify a KMS key in the
	// current account:
	//
	// * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	// * KMS
	// Key Alias: "alias/ExampleAlias"
	//
	// You can use either of the following to identify
	// a KMS key in the current account or another account:
	//
	// * Amazon Resource Name
	// (ARN) of a KMS key in the current account or another account:
	// "arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	// * ARN
	// of a KMS Key Alias: "arn:aws:kms:region:account ID:alias/ExampleAlias"
	//
	// If you
	// don't specify an encryption key, the output of the medical transcription job is
	// encrypted with the default Amazon S3 key (SSE-S3). If you specify a KMS key to
	// encrypt your output, you must also specify an output location in the
	// OutputBucketName parameter.
	OutputEncryptionKMSKeyId *string

	// You can specify a location in an Amazon S3 bucket to store the output of your
	// medical transcription job. If you don't specify an output key, Amazon Transcribe
	// Medical stores the output of your transcription job in the Amazon S3 bucket you
	// specified. By default, the object key is "your-transcription-job-name.json". You
	// can use output keys to specify the Amazon S3 prefix and file name of the
	// transcription output. For example, specifying the Amazon S3 prefix,
	// "folder1/folder2/", as an output key would lead to the output being stored as
	// "folder1/folder2/your-transcription-job-name.json". If you specify
	// "my-other-job-name.json" as the output key, the object key is changed to
	// "my-other-job-name.json". You can use an output key to change both the prefix
	// and the file name, for example "folder/my-other-job-name.json". If you specify
	// an output key, you must also specify an S3 bucket in the OutputBucketName
	// parameter.
	OutputKey *string

	// Optional settings for the medical transcription job.
	Settings *types.MedicalTranscriptionSetting

	// Add tags to an Amazon Transcribe Medical transcription job.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type StartMedicalTranscriptionJobOutput

type StartMedicalTranscriptionJobOutput struct {

	// A batch job submitted to transcribe medical speech to text.
	MedicalTranscriptionJob *types.MedicalTranscriptionJob

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StartTranscriptionJobInput

type StartTranscriptionJobInput struct {

	// An object that describes the input media for a transcription job.
	//
	// This member is required.
	Media *types.Media

	// The name of the job. You can't use the strings "." or ".." by themselves as the
	// job name. The name must also be unique within an Amazon Web Services account. If
	// you try to create a transcription job with the same name as a previous
	// transcription job, you get a ConflictException error.
	//
	// This member is required.
	TranscriptionJobName *string

	// An object that contains the request parameters for content redaction.
	ContentRedaction *types.ContentRedaction

	// Set this field to true to enable automatic language identification. Automatic
	// language identification is disabled by default. You receive a
	// BadRequestException error if you enter a value for a LanguageCode. You must
	// include either LanguageCode or IdentifyLanguage in your request.
	IdentifyLanguage *bool

	// Provides information about how a transcription job is executed. Use this field
	// to indicate that the job can be queued for deferred execution if the concurrency
	// limit is reached and there are no slots available to immediately run the job.
	JobExecutionSettings *types.JobExecutionSettings

	// A map of plain text, non-secret key:value pairs, known as encryption context
	// pairs, that provide an added layer of security for your data.
	KMSEncryptionContext map[string]string

	// The language code for the language used in the input media file. You must
	// include either LanguageCode or IdentifyLanguage in your request. To transcribe
	// speech in Modern Standard Arabic (ar-SA), your audio or video file must be
	// encoded at a sample rate of 16,000 Hz or higher.
	LanguageCode types.LanguageCode

	// The language identification settings associated with your transcription job.
	// These settings include VocabularyName, VocabularyFilterName, and
	// LanguageModelName.
	LanguageIdSettings map[string]types.LanguageIdSettings

	// An object containing a list of languages that might be present in your
	// collection of audio files. Automatic language identification chooses a language
	// that best matches the source audio from that list. To transcribe speech in
	// Modern Standard Arabic (ar-SA), your audio or video file must be encoded at a
	// sample rate of 16,000 Hz or higher.
	LanguageOptions []types.LanguageCode

	// The format of the input media file.
	MediaFormat types.MediaFormat

	// The sample rate, in Hertz, of the audio track in the input media file. If you do
	// not specify the media sample rate, Amazon Transcribe determines the sample rate.
	// If you specify the sample rate, it must match the sample rate detected by Amazon
	// Transcribe. In most cases, you should leave the MediaSampleRateHertz field blank
	// and let Amazon Transcribe determine the sample rate.
	MediaSampleRateHertz *int32

	// Choose the custom language model you use for your transcription job in this
	// parameter.
	ModelSettings *types.ModelSettings

	// The location where the transcription is stored. If you set the OutputBucketName,
	// Amazon Transcribe puts the transcript in the specified S3 bucket. When you call
	// the GetTranscriptionJob operation, the operation returns this location in the
	// TranscriptFileUri field. If you enable content redaction, the redacted
	// transcript appears in RedactedTranscriptFileUri. If you enable content redaction
	// and choose to output an unredacted transcript, that transcript's location still
	// appears in the TranscriptFileUri. The S3 bucket must have permissions that allow
	// Amazon Transcribe to put files in the bucket. For more information, see
	// Permissions Required for IAM User Roles
	// (https://docs.aws.amazon.com/transcribe/latest/dg/security_iam_id-based-policy-examples.html#auth-role-iam-user).
	// You can specify an Amazon Web Services Key Management Service (KMS) key to
	// encrypt the output of your transcription using the OutputEncryptionKMSKeyId
	// parameter. If you don't specify a KMS key, Amazon Transcribe uses the default
	// Amazon S3 key for server-side encryption of transcripts that are placed in your
	// S3 bucket. If you don't set the OutputBucketName, Amazon Transcribe generates a
	// pre-signed URL, a shareable URL that provides secure access to your
	// transcription, and returns it in the TranscriptFileUri field. Use this URL to
	// download the transcription.
	OutputBucketName *string

	// The Amazon Resource Name (ARN) of the Amazon Web Services Key Management Service
	// (KMS) key used to encrypt the output of the transcription job. The user calling
	// the StartTranscriptionJob operation must have permission to use the specified
	// KMS key. You can use either of the following to identify a KMS key in the
	// current account:
	//
	// * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	// * KMS
	// Key Alias: "alias/ExampleAlias"
	//
	// You can use either of the following to identify
	// a KMS key in the current account or another account:
	//
	// * Amazon Resource Name
	// (ARN) of a KMS Key: "arn:aws:kms:region:account
	// ID:key/1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	// * ARN of a KMS Key Alias:
	// "arn:aws:kms:region:account-ID:alias/ExampleAlias"
	//
	// If you don't specify an
	// encryption key, the output of the transcription job is encrypted with the
	// default Amazon S3 key (SSE-S3). If you specify a KMS key to encrypt your output,
	// you must also specify an output location in the OutputBucketName parameter.
	OutputEncryptionKMSKeyId *string

	// You can specify a location in an Amazon S3 bucket to store the output of your
	// transcription job. If you don't specify an output key, Amazon Transcribe stores
	// the output of your transcription job in the Amazon S3 bucket you specified. By
	// default, the object key is "your-transcription-job-name.json". You can use
	// output keys to specify the Amazon S3 prefix and file name of the transcription
	// output. For example, specifying the Amazon S3 prefix, "folder1/folder2/", as an
	// output key would lead to the output being stored as
	// "folder1/folder2/your-transcription-job-name.json". If you specify
	// "my-other-job-name.json" as the output key, the object key is changed to
	// "my-other-job-name.json". You can use an output key to change both the prefix
	// and the file name, for example "folder/my-other-job-name.json". If you specify
	// an output key, you must also specify an S3 bucket in the OutputBucketName
	// parameter.
	OutputKey *string

	// A Settings object that provides optional settings for a transcription job.
	Settings *types.Settings

	// Add subtitles to your batch transcription job.
	Subtitles *types.Subtitles

	// Add tags to an Amazon Transcribe transcription job.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type StartTranscriptionJobOutput

type StartTranscriptionJobOutput struct {

	// Provides information about your asynchronous transcription job.
	TranscriptionJob *types.TranscriptionJob

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type TagResourceInput

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) of the Amazon Transcribe resource you want to
	// tag. ARNs have the format
	// arn:partition:service:region:account-id:resource-type/resource-id (for example,
	// arn:aws:transcribe:us-east-1:account-id:transcription-job/your-job-name). Valid
	// values for resource-type are: transcription-job, medical-transcription-job,
	// vocabulary, medical-vocabulary, vocabulary-filter, and language-model.
	//
	// This member is required.
	ResourceArn *string

	// The tags you are assigning to a given Amazon Transcribe resource.
	//
	// This member is required.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type TagResourceOutput

type TagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UntagResourceInput

type UntagResourceInput struct {

	// The Amazon Resource Name (ARN) of the Amazon Transcribe resource you want to
	// remove tags from. ARNs have the format
	// arn:partition:service:region:account-id:resource-type/resource-id (for example,
	// arn:aws:transcribe:us-east-1:account-id:transcription-job/your-job-name). Valid
	// values for resource-type are: transcription-job, medical-transcription-job,
	// vocabulary, medical-vocabulary, vocabulary-filter, and language-model.
	//
	// This member is required.
	ResourceArn *string

	// A list of tag keys you want to remove from a specified Amazon Transcribe
	// resource.
	//
	// This member is required.
	TagKeys []string
	// contains filtered or unexported fields
}

type UntagResourceOutput

type UntagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateCallAnalyticsCategoryInput

type UpdateCallAnalyticsCategoryInput struct {

	// The name of the analytics category to update. The name is case sensitive. If you
	// try to update a call analytics category with the same name as a previous
	// category you will receive a ConflictException error.
	//
	// This member is required.
	CategoryName *string

	// The rules used for the updated analytics category. The rules that you provide in
	// this field replace the ones that are currently being used.
	//
	// This member is required.
	Rules []types.Rule
	// contains filtered or unexported fields
}

type UpdateCallAnalyticsCategoryOutput

type UpdateCallAnalyticsCategoryOutput struct {

	// The attributes describing the analytics category. You can see information such
	// as the rules that you've used to update the category and when the category was
	// originally created.
	CategoryProperties *types.CategoryProperties

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateMedicalVocabularyInput

type UpdateMedicalVocabularyInput struct {

	// The language code of the language used for the entries in the updated
	// vocabulary. U.S. English (en-US) is the only valid language code in Amazon
	// Transcribe Medical.
	//
	// This member is required.
	LanguageCode types.LanguageCode

	// The name of the vocabulary to update. The name is case sensitive. If you try to
	// update a vocabulary with the same name as a vocabulary you've already made, you
	// get a ConflictException error.
	//
	// This member is required.
	VocabularyName *string

	// The location in Amazon S3 of the text file that contains your custom vocabulary.
	// The URI must be in the same Amazon Web Services Region as the resource that you
	// are calling. The following is the format for a URI:
	// https://s3.aws-region.amazonaws.com/bucket-name/keyprefix/objectkey For example:
	// https://s3.us-east-1.amazonaws.com/DOC-EXAMPLE-BUCKET/vocab.txt For more
	// information about Amazon S3 object names, see Object Keys
	// (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#object-keys)
	// in the Amazon S3 Developer Guide. For more information about custom vocabularies
	// in Amazon Transcribe Medical, see Medical Custom Vocabularies
	// (https://docs.aws.amazon.com/transcribe/latest/dg/vocabulary-med.html).
	VocabularyFileUri *string
	// contains filtered or unexported fields
}

type UpdateMedicalVocabularyOutput

type UpdateMedicalVocabularyOutput struct {

	// The language code for the language of the text file used to update the custom
	// vocabulary. US English (en-US) is the only language supported in Amazon
	// Transcribe Medical.
	LanguageCode types.LanguageCode

	// The date and time that the vocabulary was updated.
	LastModifiedTime *time.Time

	// The name of the updated vocabulary.
	VocabularyName *string

	// The processing state of the update to the vocabulary. When the VocabularyState
	// field is READY, the vocabulary is ready to be used in a
	// StartMedicalTranscriptionJob request.
	VocabularyState types.VocabularyState

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateVocabularyFilterInput

type UpdateVocabularyFilterInput struct {

	// The name of the vocabulary filter to update. If you try to update a vocabulary
	// filter with the same name as another vocabulary filter, you get a
	// ConflictException error.
	//
	// This member is required.
	VocabularyFilterName *string

	// The Amazon S3 location of a text file used as input to create the vocabulary
	// filter. Only use characters from the character set defined for custom
	// vocabularies. For a list of character sets, see Character Sets for Custom
	// Vocabularies (https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html).
	// The specified file must be less than 50 KB of UTF-8 characters. If you provide
	// the location of a list of words in the VocabularyFilterFileUri parameter, you
	// can't use the Words parameter.
	VocabularyFilterFileUri *string

	// The words to use in the vocabulary filter. Only use characters from the
	// character set defined for custom vocabularies. For a list of character sets, see
	// Character Sets for Custom Vocabularies
	// (https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html). If you provide
	// a list of words in the Words parameter, you can't use the
	// VocabularyFilterFileUri parameter.
	Words []string
	// contains filtered or unexported fields
}

type UpdateVocabularyFilterOutput

type UpdateVocabularyFilterOutput struct {

	// The language code of the words in the vocabulary filter.
	LanguageCode types.LanguageCode

	// The date and time that the vocabulary filter was updated.
	LastModifiedTime *time.Time

	// The name of the updated vocabulary filter.
	VocabularyFilterName *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateVocabularyInput

type UpdateVocabularyInput struct {

	// The language code of the vocabulary entries. For a list of languages and their
	// corresponding language codes, see Supported languages
	// (https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html).
	//
	// This member is required.
	LanguageCode types.LanguageCode

	// The name of the vocabulary to update. The name is case sensitive. If you try to
	// update a vocabulary with the same name as a previous vocabulary you will receive
	// a ConflictException error.
	//
	// This member is required.
	VocabularyName *string

	// An array of strings containing the vocabulary entries.
	Phrases []string

	// The S3 location of the text file that contains the definition of the custom
	// vocabulary. The URI must be in the same region as the API endpoint that you are
	// calling. The general form is:
	// https://s3.aws-region.amazonaws.com/bucket-name/keyprefix/objectkey For example:
	// https://s3.us-east-1.amazonaws.com/DOC-EXAMPLE-BUCKET/vocab.txt For more
	// information about S3 object names, see Object Keys
	// (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#object-keys)
	// in the Amazon S3 Developer Guide. For more information about custom
	// vocabularies, see Custom Vocabularies
	// (https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html).
	VocabularyFileUri *string
	// contains filtered or unexported fields
}

type UpdateVocabularyOutput

type UpdateVocabularyOutput struct {

	// The language code of the vocabulary entries.
	LanguageCode types.LanguageCode

	// The date and time that the vocabulary was updated.
	LastModifiedTime *time.Time

	// The name of the vocabulary that was updated.
	VocabularyName *string

	// The processing state of the vocabulary. When the VocabularyState field contains
	// READY the vocabulary is ready to be used in a StartTranscriptionJob request.
	VocabularyState types.VocabularyState

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Source Files

api_client.go api_op_CreateCallAnalyticsCategory.go api_op_CreateLanguageModel.go api_op_CreateMedicalVocabulary.go api_op_CreateVocabulary.go api_op_CreateVocabularyFilter.go api_op_DeleteCallAnalyticsCategory.go api_op_DeleteCallAnalyticsJob.go api_op_DeleteLanguageModel.go api_op_DeleteMedicalTranscriptionJob.go api_op_DeleteMedicalVocabulary.go api_op_DeleteTranscriptionJob.go api_op_DeleteVocabulary.go api_op_DeleteVocabularyFilter.go api_op_DescribeLanguageModel.go api_op_GetCallAnalyticsCategory.go api_op_GetCallAnalyticsJob.go api_op_GetMedicalTranscriptionJob.go api_op_GetMedicalVocabulary.go api_op_GetTranscriptionJob.go api_op_GetVocabulary.go api_op_GetVocabularyFilter.go api_op_ListCallAnalyticsCategories.go api_op_ListCallAnalyticsJobs.go api_op_ListLanguageModels.go api_op_ListMedicalTranscriptionJobs.go api_op_ListMedicalVocabularies.go api_op_ListTagsForResource.go api_op_ListTranscriptionJobs.go api_op_ListVocabularies.go api_op_ListVocabularyFilters.go api_op_StartCallAnalyticsJob.go api_op_StartMedicalTranscriptionJob.go api_op_StartTranscriptionJob.go api_op_TagResource.go api_op_UntagResource.go api_op_UpdateCallAnalyticsCategory.go api_op_UpdateMedicalVocabulary.go api_op_UpdateVocabulary.go api_op_UpdateVocabularyFilter.go deserializers.go doc.go endpoints.go go_module_metadata.go serializers.go validators.go

Directories

PathSynopsis
internal
types
Version
v1.19.3
Published
May 17, 2022
Platform
js/wasm
Imports
34 packages
Last checked
now

Tools for package owners.