transcribe

package
v0.23.3 Latest Latest
Warning

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

 Go to latest Published: Jun 25, 2020 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Overview

Package transcribe provides the client and types for making API requests to Amazon Transcribe Service.

Operations and objects for transcribing speech to text.

See https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26 for more information on this service.

See transcribe package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/transcribe/

Using the Client

To use Amazon Transcribe Service with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the Amazon Transcribe Service client for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/transcribe/#New

Index

Constants

View Source 
const (
	ServiceName = "Amazon Transcribe Service" // Service's name
	ServiceID   = "Transcribe"                // Service's identifier
	EndpointsID = "transcribe"                // Service's Endpoint identifier
)
View Source 
const (

	// ErrCodeBadRequestException for service response error code
	// "BadRequestException".
	//
	// Your request didn't pass one or more validation tests. For example, if the
	// transcription you're trying to delete doesn't exist or if it is in a non-terminal
	// state (for example, it's "in progress"). See the exception Message field
	// for more information.
	ErrCodeBadRequestException = "BadRequestException"

	// ErrCodeConflictException for service response error code
	// "ConflictException".
	//
	// The resource name already exists.
	ErrCodeConflictException = "ConflictException"

	// ErrCodeInternalFailureException for service response error code
	// "InternalFailureException".
	//
	// There was an internal error. Check the error message and try your request
	// again.
	ErrCodeInternalFailureException = "InternalFailureException"

	// ErrCodeLimitExceededException for service response error code
	// "LimitExceededException".
	//
	// Either you have sent too many requests or your input file is too long. Wait
	// before you resend your request, or use a smaller file and resend the request.
	ErrCodeLimitExceededException = "LimitExceededException"

	// ErrCodeNotFoundException for service response error code
	// "NotFoundException".
	//
	// We can't find the requested resource. Check the name and try your request
	// again.
	ErrCodeNotFoundException = "NotFoundException"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Client 

type Client struct {
	*aws.Client
}

Client provides the API operation methods for making requests to Amazon Transcribe Service. See this package's package overview docs for details on the service.

The client's methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New 

func New(config aws.Config) *Client

New creates a new instance of the client from the provided Config.

Example: 

// Create a client from just a config.
svc := transcribe.New(myConfig)

func (*Client) CreateMedicalVocabularyRequest 

func (c *Client) CreateMedicalVocabularyRequest(input *CreateMedicalVocabularyInput) CreateMedicalVocabularyRequest

CreateMedicalVocabularyRequest returns a request value for making API operation for Amazon Transcribe Service.

Creates a new custom vocabulary that you can use to change how Amazon Transcribe Medical transcribes your audio file. 

// Example sending a request using CreateMedicalVocabularyRequest.
req := client.CreateMedicalVocabularyRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/CreateMedicalVocabulary

func (*Client) CreateVocabularyFilterRequest 

func (c *Client) CreateVocabularyFilterRequest(input *CreateVocabularyFilterInput) CreateVocabularyFilterRequest

CreateVocabularyFilterRequest returns a request value for making API operation for Amazon Transcribe Service.

Creates a new vocabulary filter that you can use to filter words, such as profane words, from the output of a transcription job. 

// Example sending a request using CreateVocabularyFilterRequest.
req := client.CreateVocabularyFilterRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/CreateVocabularyFilter

func (*Client) CreateVocabularyRequest 

func (c *Client) CreateVocabularyRequest(input *CreateVocabularyInput) CreateVocabularyRequest

CreateVocabularyRequest returns a request value for making API operation for Amazon Transcribe Service.

Creates a new custom vocabulary that you can use to change the way Amazon Transcribe handles transcription of an audio file. 

// Example sending a request using CreateVocabularyRequest.
req := client.CreateVocabularyRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/CreateVocabulary

func (*Client) DeleteMedicalTranscriptionJobRequest 

func (c *Client) DeleteMedicalTranscriptionJobRequest(input *DeleteMedicalTranscriptionJobInput) DeleteMedicalTranscriptionJobRequest

DeleteMedicalTranscriptionJobRequest returns a request value for making API operation for Amazon Transcribe Service.

Deletes a transcription job generated by Amazon Transcribe Medical and any related information. 

// Example sending a request using DeleteMedicalTranscriptionJobRequest.
req := client.DeleteMedicalTranscriptionJobRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/DeleteMedicalTranscriptionJob

func (*Client) DeleteMedicalVocabularyRequest 

func (c *Client) DeleteMedicalVocabularyRequest(input *DeleteMedicalVocabularyInput) DeleteMedicalVocabularyRequest

DeleteMedicalVocabularyRequest returns a request value for making API operation for Amazon Transcribe Service.

Deletes a vocabulary from Amazon Transcribe Medical. 

// Example sending a request using DeleteMedicalVocabularyRequest.
req := client.DeleteMedicalVocabularyRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/DeleteMedicalVocabulary

func (*Client) DeleteTranscriptionJobRequest 

func (c *Client) DeleteTranscriptionJobRequest(input *DeleteTranscriptionJobInput) DeleteTranscriptionJobRequest

DeleteTranscriptionJobRequest returns a request value for making API operation for Amazon Transcribe Service.

Deletes a previously submitted transcription job along with any other generated results such as the transcription, models, and so on. 

// Example sending a request using DeleteTranscriptionJobRequest.
req := client.DeleteTranscriptionJobRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/DeleteTranscriptionJob

func (*Client) DeleteVocabularyFilterRequest 

func (c *Client) DeleteVocabularyFilterRequest(input *DeleteVocabularyFilterInput) DeleteVocabularyFilterRequest

DeleteVocabularyFilterRequest returns a request value for making API operation for Amazon Transcribe Service.

Removes a vocabulary filter. 

// Example sending a request using DeleteVocabularyFilterRequest.
req := client.DeleteVocabularyFilterRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/DeleteVocabularyFilter

func (*Client) DeleteVocabularyRequest 

func (c *Client) DeleteVocabularyRequest(input *DeleteVocabularyInput) DeleteVocabularyRequest

DeleteVocabularyRequest returns a request value for making API operation for Amazon Transcribe Service.

Deletes a vocabulary from Amazon Transcribe. 

// Example sending a request using DeleteVocabularyRequest.
req := client.DeleteVocabularyRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/DeleteVocabulary

func (*Client) GetMedicalTranscriptionJobRequest 

func (c *Client) GetMedicalTranscriptionJobRequest(input *GetMedicalTranscriptionJobInput) GetMedicalTranscriptionJobRequest

GetMedicalTranscriptionJobRequest returns a request value for making API operation for Amazon Transcribe Service.

Returns information about a transcription job from Amazon Transcribe Medical. To see the status of the job, check the TranscriptionJobStatus field. If the status is COMPLETED, the job is finished. You find the results of the completed job in the TranscriptFileUri field. 

// Example sending a request using GetMedicalTranscriptionJobRequest.
req := client.GetMedicalTranscriptionJobRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/GetMedicalTranscriptionJob

func (*Client) GetMedicalVocabularyRequest 

func (c *Client) GetMedicalVocabularyRequest(input *GetMedicalVocabularyInput) GetMedicalVocabularyRequest

GetMedicalVocabularyRequest returns a request value for making API operation for Amazon Transcribe Service.

Retrieve information about a medical vocabulary. 

// Example sending a request using GetMedicalVocabularyRequest.
req := client.GetMedicalVocabularyRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/GetMedicalVocabulary

func (*Client) GetTranscriptionJobRequest 

func (c *Client) GetTranscriptionJobRequest(input *GetTranscriptionJobInput) GetTranscriptionJobRequest

GetTranscriptionJobRequest returns a request value for making API operation for Amazon Transcribe Service.

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. 

// Example sending a request using GetTranscriptionJobRequest.
req := client.GetTranscriptionJobRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/GetTranscriptionJob

func (*Client) GetVocabularyFilterRequest 

func (c *Client) GetVocabularyFilterRequest(input *GetVocabularyFilterInput) GetVocabularyFilterRequest

GetVocabularyFilterRequest returns a request value for making API operation for Amazon Transcribe Service.

Returns information about a vocabulary filter. 

// Example sending a request using GetVocabularyFilterRequest.
req := client.GetVocabularyFilterRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/GetVocabularyFilter

func (*Client) GetVocabularyRequest 

func (c *Client) GetVocabularyRequest(input *GetVocabularyInput) GetVocabularyRequest

GetVocabularyRequest returns a request value for making API operation for Amazon Transcribe Service.

Gets information about a vocabulary. 

// Example sending a request using GetVocabularyRequest.
req := client.GetVocabularyRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/GetVocabulary

func (*Client) ListMedicalTranscriptionJobsRequest 

func (c *Client) ListMedicalTranscriptionJobsRequest(input *ListMedicalTranscriptionJobsInput) ListMedicalTranscriptionJobsRequest

ListMedicalTranscriptionJobsRequest returns a request value for making API operation for Amazon Transcribe Service.

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

// Example sending a request using ListMedicalTranscriptionJobsRequest.
req := client.ListMedicalTranscriptionJobsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ListMedicalTranscriptionJobs

func (*Client) ListMedicalVocabulariesRequest 

func (c *Client) ListMedicalVocabulariesRequest(input *ListMedicalVocabulariesInput) ListMedicalVocabulariesRequest

ListMedicalVocabulariesRequest returns a request value for making API operation for Amazon Transcribe Service.

Returns a list of vocabularies that match the specified criteria. You get the entire list of vocabularies if you don't enter a value in any of the request parameters. 

// Example sending a request using ListMedicalVocabulariesRequest.
req := client.ListMedicalVocabulariesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ListMedicalVocabularies

func (*Client) ListTranscriptionJobsRequest 

func (c *Client) ListTranscriptionJobsRequest(input *ListTranscriptionJobsInput) ListTranscriptionJobsRequest

ListTranscriptionJobsRequest returns a request value for making API operation for Amazon Transcribe Service.

Lists transcription jobs with the specified status. 

// Example sending a request using ListTranscriptionJobsRequest.
req := client.ListTranscriptionJobsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ListTranscriptionJobs

func (*Client) ListVocabulariesRequest 

func (c *Client) ListVocabulariesRequest(input *ListVocabulariesInput) ListVocabulariesRequest

ListVocabulariesRequest returns a request value for making API operation for Amazon Transcribe Service.

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

// Example sending a request using ListVocabulariesRequest.
req := client.ListVocabulariesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ListVocabularies

func (*Client) ListVocabularyFiltersRequest 

func (c *Client) ListVocabularyFiltersRequest(input *ListVocabularyFiltersInput) ListVocabularyFiltersRequest

ListVocabularyFiltersRequest returns a request value for making API operation for Amazon Transcribe Service.

Gets information about vocabulary filters. 

// Example sending a request using ListVocabularyFiltersRequest.
req := client.ListVocabularyFiltersRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ListVocabularyFilters

func (*Client) StartMedicalTranscriptionJobRequest 

func (c *Client) StartMedicalTranscriptionJobRequest(input *StartMedicalTranscriptionJobInput) StartMedicalTranscriptionJobRequest

StartMedicalTranscriptionJobRequest returns a request value for making API operation for Amazon Transcribe Service.

Start a batch job to transcribe medical speech to text. 

// Example sending a request using StartMedicalTranscriptionJobRequest.
req := client.StartMedicalTranscriptionJobRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/StartMedicalTranscriptionJob

func (*Client) StartTranscriptionJobRequest 

func (c *Client) StartTranscriptionJobRequest(input *StartTranscriptionJobInput) StartTranscriptionJobRequest

StartTranscriptionJobRequest returns a request value for making API operation for Amazon Transcribe Service.

Starts an asynchronous job to transcribe speech to text. 

// Example sending a request using StartTranscriptionJobRequest.
req := client.StartTranscriptionJobRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/StartTranscriptionJob

func (*Client) UpdateMedicalVocabularyRequest 

func (c *Client) UpdateMedicalVocabularyRequest(input *UpdateMedicalVocabularyInput) UpdateMedicalVocabularyRequest

UpdateMedicalVocabularyRequest returns a request value for making API operation for Amazon Transcribe Service.

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

// Example sending a request using UpdateMedicalVocabularyRequest.
req := client.UpdateMedicalVocabularyRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/UpdateMedicalVocabulary

func (*Client) UpdateVocabularyFilterRequest 

func (c *Client) UpdateVocabularyFilterRequest(input *UpdateVocabularyFilterInput) UpdateVocabularyFilterRequest

UpdateVocabularyFilterRequest returns a request value for making API operation for Amazon Transcribe Service.

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

// Example sending a request using UpdateVocabularyFilterRequest.
req := client.UpdateVocabularyFilterRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/UpdateVocabularyFilter

func (*Client) UpdateVocabularyRequest 

func (c *Client) UpdateVocabularyRequest(input *UpdateVocabularyInput) UpdateVocabularyRequest

UpdateVocabularyRequest returns a request value for making API operation for Amazon Transcribe Service.

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. 

// Example sending a request using UpdateVocabularyRequest.
req := client.UpdateVocabularyRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/UpdateVocabulary

type ContentRedaction 

type ContentRedaction struct {

	// The output transcript file stored in either the default S3 bucket or in a
	// bucket you specify.
	//
	// When you choose redacted Amazon Transcribe outputs only the redacted transcript.
	//
	// When you choose redacted_and_unredacted Amazon Transcribe outputs both the
	// redacted and unredacted transcripts.
	//
	// RedactionOutput is a required field
	RedactionOutput RedactionOutput `type:"string" required:"true" enum:"true"`

	// Request parameter that defines the entities to be redacted. The only accepted
	// value is PII.
	//
	// RedactionType is a required field
	RedactionType RedactionType `type:"string" required:"true" enum:"true"`
	// contains filtered or unexported fields
}

Settings for content redaction within a transcription job.

func (ContentRedaction) String 

func (s ContentRedaction) String() string

String returns the string representation

func (*ContentRedaction) Validate 

func (s *ContentRedaction) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateMedicalVocabularyInput 

type CreateMedicalVocabularyInput struct {

	// The language code used for the entries within your custom vocabulary. The
	// language code of your custom vocabulary must match the language code of your
	// transcription job. US English (en-US) is the only language code available
	// for Amazon Transcribe Medical.
	//
	// LanguageCode is a required field
	LanguageCode LanguageCode `type:"string" required:"true" enum:"true"`

	// The Amazon S3 location of the text file you use to define your custom vocabulary.
	// The URI must be in the same AWS region as the API endpoint you're calling.
	// Enter information about your VocabularyFileUri in the following format:
	//
	// https://s3.<aws-region>.amazonaws.com/<bucket-name>/<keyprefix>/<objectkey>
	//
	// This is an example of a vocabulary file uri location in Amazon S3:
	//
	// https://s3.us-east-1.amazonaws.com/AWSDOC-EXAMPLE-BUCKET/vocab.txt
	//
	// For more information about S3 object names, see Object Keys (http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#object-keys)
	// in the Amazon S3 Developer Guide.
	//
	// For more information about custom vocabularies, see Medical Custom Vocabularies
	// (http://docs.aws.amazon.com/transcribe/latest/dg/how-it-works.html#how-vocabulary-med).
	//
	// VocabularyFileUri is a required field
	VocabularyFileUri *string `min:"1" type:"string" required:"true"`

	// The name of the custom vocabulary. This case-sensitive name must be unique
	// within an AWS account. If you try to create a vocabulary with the same name
	// as a previous vocabulary you will receive a ConflictException error.
	//
	// VocabularyName is a required field
	VocabularyName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateMedicalVocabularyInput) String 

func (s CreateMedicalVocabularyInput) String() string

String returns the string representation

func (*CreateMedicalVocabularyInput) Validate 

func (s *CreateMedicalVocabularyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateMedicalVocabularyOutput 

type CreateMedicalVocabularyOutput struct {

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

	// The language code you chose to describe the entries in your custom vocabulary.
	// US English (en-US) is the only valid language code for Amazon Transcribe
	// Medical.
	LanguageCode LanguageCode `type:"string" enum:"true"`

	// The date and time you created the vocabulary.
	LastModifiedTime *time.Time `type:"timestamp"`

	// The name of the vocabulary. The name must be unique within an AWS account.
	// It is also case-sensitive.
	VocabularyName *string `min:"1" type:"string"`

	// The processing state of your custom vocabulary in Amazon Transcribe Medical.
	// If the state is READY you can use the vocabulary in a StartMedicalTranscriptionJob
	// request.
	VocabularyState VocabularyState `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

func (CreateMedicalVocabularyOutput) String 

func (s CreateMedicalVocabularyOutput) String() string

String returns the string representation

type CreateMedicalVocabularyRequest 

type CreateMedicalVocabularyRequest struct {
	*aws.Request
	Input *CreateMedicalVocabularyInput
	Copy  func(*CreateMedicalVocabularyInput) CreateMedicalVocabularyRequest
}

CreateMedicalVocabularyRequest is the request type for the CreateMedicalVocabulary API operation.

func (CreateMedicalVocabularyRequest) Send 

func (r CreateMedicalVocabularyRequest) Send(ctx context.Context) (*CreateMedicalVocabularyResponse, error)

Send marshals and sends the CreateMedicalVocabulary API request.

type CreateMedicalVocabularyResponse 

type CreateMedicalVocabularyResponse struct {
	*CreateMedicalVocabularyOutput
	// contains filtered or unexported fields
}

CreateMedicalVocabularyResponse is the response type for the CreateMedicalVocabulary API operation.

func (*CreateMedicalVocabularyResponse) SDKResponseMetdata 

func (r *CreateMedicalVocabularyResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateMedicalVocabulary request.

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.
	//
	// LanguageCode is a required field
	LanguageCode LanguageCode `type:"string" required:"true" enum:"true"`

	// 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/how-vocabulary.html#charsets).
	//
	// 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 `min:"1" type:"string"`

	// The vocabulary filter name. The name must be unique within the account that
	// contains it.If you try to create a vocabulary filter with the same name as
	// a previous vocabulary filter you will receive a ConflictException error.
	//
	// VocabularyFilterName is a required field
	VocabularyFilterName *string `min:"1" type:"string" required:"true"`

	// 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/how-vocabulary.html#charsets).
	//
	// If you provide a list of words in the Words parameter, you can't use the
	// VocabularyFilterFileUri parameter.
	Words []string `min:"1" type:"list"`
	// contains filtered or unexported fields
}

func (CreateVocabularyFilterInput) String 

func (s CreateVocabularyFilterInput) String() string

String returns the string representation

func (*CreateVocabularyFilterInput) Validate 

func (s *CreateVocabularyFilterInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateVocabularyFilterOutput 

type CreateVocabularyFilterOutput struct {

	// The language code of the words in the collection.
	LanguageCode LanguageCode `type:"string" enum:"true"`

	// The date and time that the vocabulary filter was modified.
	LastModifiedTime *time.Time `type:"timestamp"`

	// The name of the vocabulary filter.
	VocabularyFilterName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (CreateVocabularyFilterOutput) String 

func (s CreateVocabularyFilterOutput) String() string

String returns the string representation

type CreateVocabularyFilterRequest 

type CreateVocabularyFilterRequest struct {
	*aws.Request
	Input *CreateVocabularyFilterInput
	Copy  func(*CreateVocabularyFilterInput) CreateVocabularyFilterRequest
}

CreateVocabularyFilterRequest is the request type for the CreateVocabularyFilter API operation.

func (CreateVocabularyFilterRequest) Send 

func (r CreateVocabularyFilterRequest) Send(ctx context.Context) (*CreateVocabularyFilterResponse, error)

Send marshals and sends the CreateVocabularyFilter API request.

type CreateVocabularyFilterResponse 

type CreateVocabularyFilterResponse struct {
	*CreateVocabularyFilterOutput
	// contains filtered or unexported fields
}

CreateVocabularyFilterResponse is the response type for the CreateVocabularyFilter API operation.

func (*CreateVocabularyFilterResponse) SDKResponseMetdata 

func (r *CreateVocabularyFilterResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateVocabularyFilter request.

type CreateVocabularyInput 

type CreateVocabularyInput struct {

	// The language code of the vocabulary entries.
	//
	// LanguageCode is a required field
	LanguageCode LanguageCode `type:"string" required:"true" enum:"true"`

	// An array of strings that contains the vocabulary entries.
	Phrases []string `type:"list"`

	// 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
	//
	// For more information about S3 object names, see Object Keys (http://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 (http://docs.aws.amazon.com/transcribe/latest/dg/how-it-works.html#how-vocabulary).
	VocabularyFileUri *string `min:"1" type:"string"`

	// The name of the vocabulary. The name must be unique within an AWS account.
	// The name is case-sensitive. If you try to create a vocabulary with the same
	// name as a previous vocabulary you will receive a ConflictException error.
	//
	// VocabularyName is a required field
	VocabularyName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateVocabularyInput) String 

func (s CreateVocabularyInput) String() string

String returns the string representation

func (*CreateVocabularyInput) Validate 

func (s *CreateVocabularyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateVocabularyOutput 

type CreateVocabularyOutput struct {

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

	// The language code of the vocabulary entries.
	LanguageCode LanguageCode `type:"string" enum:"true"`

	// The date and time that the vocabulary was created.
	LastModifiedTime *time.Time `type:"timestamp"`

	// The name of the vocabulary.
	VocabularyName *string `min:"1" type:"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 VocabularyState `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

func (CreateVocabularyOutput) String 

func (s CreateVocabularyOutput) String() string

String returns the string representation

type CreateVocabularyRequest 

type CreateVocabularyRequest struct {
	*aws.Request
	Input *CreateVocabularyInput
	Copy  func(*CreateVocabularyInput) CreateVocabularyRequest
}

CreateVocabularyRequest is the request type for the CreateVocabulary API operation.

func (CreateVocabularyRequest) Send 

func (r CreateVocabularyRequest) Send(ctx context.Context) (*CreateVocabularyResponse, error)

Send marshals and sends the CreateVocabulary API request.

type CreateVocabularyResponse 

type CreateVocabularyResponse struct {
	*CreateVocabularyOutput
	// contains filtered or unexported fields
}

CreateVocabularyResponse is the response type for the CreateVocabulary API operation.

func (*CreateVocabularyResponse) SDKResponseMetdata 

func (r *CreateVocabularyResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateVocabulary request.

type DeleteMedicalTranscriptionJobInput 

type DeleteMedicalTranscriptionJobInput struct {

	// The name you provide to the DeleteMedicalTranscriptionJob object to delete
	// a transcription job.
	//
	// MedicalTranscriptionJobName is a required field
	MedicalTranscriptionJobName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteMedicalTranscriptionJobInput) String 

func (s DeleteMedicalTranscriptionJobInput) String() string

String returns the string representation

func (*DeleteMedicalTranscriptionJobInput) Validate 

func (s *DeleteMedicalTranscriptionJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteMedicalTranscriptionJobOutput 

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

func (DeleteMedicalTranscriptionJobOutput) String 

func (s DeleteMedicalTranscriptionJobOutput) String() string

String returns the string representation

type DeleteMedicalTranscriptionJobRequest 

type DeleteMedicalTranscriptionJobRequest struct {
	*aws.Request
	Input *DeleteMedicalTranscriptionJobInput
	Copy  func(*DeleteMedicalTranscriptionJobInput) DeleteMedicalTranscriptionJobRequest
}

DeleteMedicalTranscriptionJobRequest is the request type for the DeleteMedicalTranscriptionJob API operation.

func (DeleteMedicalTranscriptionJobRequest) Send 

func (r DeleteMedicalTranscriptionJobRequest) Send(ctx context.Context) (*DeleteMedicalTranscriptionJobResponse, error)

Send marshals and sends the DeleteMedicalTranscriptionJob API request.

type DeleteMedicalTranscriptionJobResponse 

type DeleteMedicalTranscriptionJobResponse struct {
	*DeleteMedicalTranscriptionJobOutput
	// contains filtered or unexported fields
}

DeleteMedicalTranscriptionJobResponse is the response type for the DeleteMedicalTranscriptionJob API operation.

func (*DeleteMedicalTranscriptionJobResponse) SDKResponseMetdata 

func (r *DeleteMedicalTranscriptionJobResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteMedicalTranscriptionJob request.

type DeleteMedicalVocabularyInput 

type DeleteMedicalVocabularyInput struct {

	// The name of the vocabulary you are choosing to delete.
	//
	// VocabularyName is a required field
	VocabularyName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteMedicalVocabularyInput) String 

func (s DeleteMedicalVocabularyInput) String() string

String returns the string representation

func (*DeleteMedicalVocabularyInput) Validate 

func (s *DeleteMedicalVocabularyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteMedicalVocabularyOutput 

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

func (DeleteMedicalVocabularyOutput) String 

func (s DeleteMedicalVocabularyOutput) String() string

String returns the string representation

type DeleteMedicalVocabularyRequest 

type DeleteMedicalVocabularyRequest struct {
	*aws.Request
	Input *DeleteMedicalVocabularyInput
	Copy  func(*DeleteMedicalVocabularyInput) DeleteMedicalVocabularyRequest
}

DeleteMedicalVocabularyRequest is the request type for the DeleteMedicalVocabulary API operation.

func (DeleteMedicalVocabularyRequest) Send 

func (r DeleteMedicalVocabularyRequest) Send(ctx context.Context) (*DeleteMedicalVocabularyResponse, error)

Send marshals and sends the DeleteMedicalVocabulary API request.

type DeleteMedicalVocabularyResponse 

type DeleteMedicalVocabularyResponse struct {
	*DeleteMedicalVocabularyOutput
	// contains filtered or unexported fields
}

DeleteMedicalVocabularyResponse is the response type for the DeleteMedicalVocabulary API operation.

func (*DeleteMedicalVocabularyResponse) SDKResponseMetdata 

func (r *DeleteMedicalVocabularyResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteMedicalVocabulary request.

type DeleteTranscriptionJobInput 

type DeleteTranscriptionJobInput struct {

	// The name of the transcription job to be deleted.
	//
	// TranscriptionJobName is a required field
	TranscriptionJobName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteTranscriptionJobInput) String 

func (s DeleteTranscriptionJobInput) String() string

String returns the string representation

func (*DeleteTranscriptionJobInput) Validate 

func (s *DeleteTranscriptionJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteTranscriptionJobOutput 

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

func (DeleteTranscriptionJobOutput) String 

func (s DeleteTranscriptionJobOutput) String() string

String returns the string representation

type DeleteTranscriptionJobRequest 

type DeleteTranscriptionJobRequest struct {
	*aws.Request
	Input *DeleteTranscriptionJobInput
	Copy  func(*DeleteTranscriptionJobInput) DeleteTranscriptionJobRequest
}

DeleteTranscriptionJobRequest is the request type for the DeleteTranscriptionJob API operation.

func (DeleteTranscriptionJobRequest) Send 

func (r DeleteTranscriptionJobRequest) Send(ctx context.Context) (*DeleteTranscriptionJobResponse, error)

Send marshals and sends the DeleteTranscriptionJob API request.

type DeleteTranscriptionJobResponse 

type DeleteTranscriptionJobResponse struct {
	*DeleteTranscriptionJobOutput
	// contains filtered or unexported fields
}

DeleteTranscriptionJobResponse is the response type for the DeleteTranscriptionJob API operation.

func (*DeleteTranscriptionJobResponse) SDKResponseMetdata 

func (r *DeleteTranscriptionJobResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteTranscriptionJob request.

type DeleteVocabularyFilterInput 

type DeleteVocabularyFilterInput struct {

	// The name of the vocabulary filter to remove.
	//
	// VocabularyFilterName is a required field
	VocabularyFilterName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteVocabularyFilterInput) String 

func (s DeleteVocabularyFilterInput) String() string

String returns the string representation

func (*DeleteVocabularyFilterInput) Validate 

func (s *DeleteVocabularyFilterInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteVocabularyFilterOutput 

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

func (DeleteVocabularyFilterOutput) String 

func (s DeleteVocabularyFilterOutput) String() string

String returns the string representation

type DeleteVocabularyFilterRequest 

type DeleteVocabularyFilterRequest struct {
	*aws.Request
	Input *DeleteVocabularyFilterInput
	Copy  func(*DeleteVocabularyFilterInput) DeleteVocabularyFilterRequest
}

DeleteVocabularyFilterRequest is the request type for the DeleteVocabularyFilter API operation.

func (DeleteVocabularyFilterRequest) Send 

func (r DeleteVocabularyFilterRequest) Send(ctx context.Context) (*DeleteVocabularyFilterResponse, error)

Send marshals and sends the DeleteVocabularyFilter API request.

type DeleteVocabularyFilterResponse 

type DeleteVocabularyFilterResponse struct {
	*DeleteVocabularyFilterOutput
	// contains filtered or unexported fields
}

DeleteVocabularyFilterResponse is the response type for the DeleteVocabularyFilter API operation.

func (*DeleteVocabularyFilterResponse) SDKResponseMetdata 

func (r *DeleteVocabularyFilterResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteVocabularyFilter request.

type DeleteVocabularyInput 

type DeleteVocabularyInput struct {

	// The name of the vocabulary to delete.
	//
	// VocabularyName is a required field
	VocabularyName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteVocabularyInput) String 

func (s DeleteVocabularyInput) String() string

String returns the string representation

func (*DeleteVocabularyInput) Validate 

func (s *DeleteVocabularyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteVocabularyOutput 

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

func (DeleteVocabularyOutput) String 

func (s DeleteVocabularyOutput) String() string

String returns the string representation

type DeleteVocabularyRequest 

type DeleteVocabularyRequest struct {
	*aws.Request
	Input *DeleteVocabularyInput
	Copy  func(*DeleteVocabularyInput) DeleteVocabularyRequest
}

DeleteVocabularyRequest is the request type for the DeleteVocabulary API operation.

func (DeleteVocabularyRequest) Send 

func (r DeleteVocabularyRequest) Send(ctx context.Context) (*DeleteVocabularyResponse, error)

Send marshals and sends the DeleteVocabulary API request.

type DeleteVocabularyResponse 

type DeleteVocabularyResponse struct {
	*DeleteVocabularyOutput
	// contains filtered or unexported fields
}

DeleteVocabularyResponse is the response type for the DeleteVocabulary API operation.

func (*DeleteVocabularyResponse) SDKResponseMetdata 

func (r *DeleteVocabularyResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteVocabulary request.

type GetMedicalTranscriptionJobInput 

type GetMedicalTranscriptionJobInput struct {

	// The name of the medical transcription job.
	//
	// MedicalTranscriptionJobName is a required field
	MedicalTranscriptionJobName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetMedicalTranscriptionJobInput) String 

func (s GetMedicalTranscriptionJobInput) String() string

String returns the string representation

func (*GetMedicalTranscriptionJobInput) Validate 

func (s *GetMedicalTranscriptionJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetMedicalTranscriptionJobOutput 

type GetMedicalTranscriptionJobOutput struct {

	// An object that contains the results of the medical transcription job.
	MedicalTranscriptionJob *MedicalTranscriptionJob `type:"structure"`
	// contains filtered or unexported fields
}

func (GetMedicalTranscriptionJobOutput) String 

func (s GetMedicalTranscriptionJobOutput) String() string

String returns the string representation

type GetMedicalTranscriptionJobRequest 

type GetMedicalTranscriptionJobRequest struct {
	*aws.Request
	Input *GetMedicalTranscriptionJobInput
	Copy  func(*GetMedicalTranscriptionJobInput) GetMedicalTranscriptionJobRequest
}

GetMedicalTranscriptionJobRequest is the request type for the GetMedicalTranscriptionJob API operation.

func (GetMedicalTranscriptionJobRequest) Send 

func (r GetMedicalTranscriptionJobRequest) Send(ctx context.Context) (*GetMedicalTranscriptionJobResponse, error)

Send marshals and sends the GetMedicalTranscriptionJob API request.

type GetMedicalTranscriptionJobResponse 

type GetMedicalTranscriptionJobResponse struct {
	*GetMedicalTranscriptionJobOutput
	// contains filtered or unexported fields
}

GetMedicalTranscriptionJobResponse is the response type for the GetMedicalTranscriptionJob API operation.

func (*GetMedicalTranscriptionJobResponse) SDKResponseMetdata 

func (r *GetMedicalTranscriptionJobResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetMedicalTranscriptionJob request.

type GetMedicalVocabularyInput 

type GetMedicalVocabularyInput struct {

	// The name of the vocabulary you are trying to get information about. The value
	// you enter for this request is case-sensitive.
	//
	// VocabularyName is a required field
	VocabularyName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetMedicalVocabularyInput) String 

func (s GetMedicalVocabularyInput) String() string

String returns the string representation

func (*GetMedicalVocabularyInput) Validate 

func (s *GetMedicalVocabularyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetMedicalVocabularyOutput 

type GetMedicalVocabularyOutput struct {

	// The Amazon S3 location where the vocabulary is stored. Use this URI to get
	// the contents of the vocabulary. You can download your vocabulary from the
	// URI for a limited time.
	DownloadUri *string `min:"1" type:"string"`

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

	// The valid language code returned for your vocabulary entries.
	LanguageCode LanguageCode `type:"string" enum:"true"`

	// The date and time the vocabulary was last modified with a text file different
	// from what was previously used.
	LastModifiedTime *time.Time `type:"timestamp"`

	// The valid name that Amazon Transcribe Medical returns.
	VocabularyName *string `min:"1" type:"string"`

	// The processing state of the vocabulary.
	VocabularyState VocabularyState `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

func (GetMedicalVocabularyOutput) String 

func (s GetMedicalVocabularyOutput) String() string

String returns the string representation

type GetMedicalVocabularyRequest 

type GetMedicalVocabularyRequest struct {
	*aws.Request
	Input *GetMedicalVocabularyInput
	Copy  func(*GetMedicalVocabularyInput) GetMedicalVocabularyRequest
}

GetMedicalVocabularyRequest is the request type for the GetMedicalVocabulary API operation.

func (GetMedicalVocabularyRequest) Send 

func (r GetMedicalVocabularyRequest) Send(ctx context.Context) (*GetMedicalVocabularyResponse, error)

Send marshals and sends the GetMedicalVocabulary API request.

type GetMedicalVocabularyResponse 

type GetMedicalVocabularyResponse struct {
	*GetMedicalVocabularyOutput
	// contains filtered or unexported fields
}

GetMedicalVocabularyResponse is the response type for the GetMedicalVocabulary API operation.

func (*GetMedicalVocabularyResponse) SDKResponseMetdata 

func (r *GetMedicalVocabularyResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetMedicalVocabulary request.

type GetTranscriptionJobInput 

type GetTranscriptionJobInput struct {

	// The name of the job.
	//
	// TranscriptionJobName is a required field
	TranscriptionJobName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetTranscriptionJobInput) String 

func (s GetTranscriptionJobInput) String() string

String returns the string representation

func (*GetTranscriptionJobInput) Validate 

func (s *GetTranscriptionJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetTranscriptionJobOutput 

type GetTranscriptionJobOutput struct {

	// An object that contains the results of the transcription job.
	TranscriptionJob *TranscriptionJob `type:"structure"`
	// contains filtered or unexported fields
}

func (GetTranscriptionJobOutput) String 

func (s GetTranscriptionJobOutput) String() string

String returns the string representation

type GetTranscriptionJobRequest 

type GetTranscriptionJobRequest struct {
	*aws.Request
	Input *GetTranscriptionJobInput
	Copy  func(*GetTranscriptionJobInput) GetTranscriptionJobRequest
}

GetTranscriptionJobRequest is the request type for the GetTranscriptionJob API operation.

func (GetTranscriptionJobRequest) Send 

func (r GetTranscriptionJobRequest) Send(ctx context.Context) (*GetTranscriptionJobResponse, error)

Send marshals and sends the GetTranscriptionJob API request.

type GetTranscriptionJobResponse 

type GetTranscriptionJobResponse struct {
	*GetTranscriptionJobOutput
	// contains filtered or unexported fields
}

GetTranscriptionJobResponse is the response type for the GetTranscriptionJob API operation.

func (*GetTranscriptionJobResponse) SDKResponseMetdata 

func (r *GetTranscriptionJobResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetTranscriptionJob request.

type GetVocabularyFilterInput 

type GetVocabularyFilterInput struct {

	// The name of the vocabulary filter for which to return information.
	//
	// VocabularyFilterName is a required field
	VocabularyFilterName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetVocabularyFilterInput) String 

func (s GetVocabularyFilterInput) String() string

String returns the string representation

func (*GetVocabularyFilterInput) Validate 

func (s *GetVocabularyFilterInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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 `min:"1" type:"string"`

	// The language code of the words in the vocabulary filter.
	LanguageCode LanguageCode `type:"string" enum:"true"`

	// The date and time that the contents of the vocabulary filter were updated.
	LastModifiedTime *time.Time `type:"timestamp"`

	// The name of the vocabulary filter.
	VocabularyFilterName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (GetVocabularyFilterOutput) String 

func (s GetVocabularyFilterOutput) String() string

String returns the string representation

type GetVocabularyFilterRequest 

type GetVocabularyFilterRequest struct {
	*aws.Request
	Input *GetVocabularyFilterInput
	Copy  func(*GetVocabularyFilterInput) GetVocabularyFilterRequest
}

GetVocabularyFilterRequest is the request type for the GetVocabularyFilter API operation.

func (GetVocabularyFilterRequest) Send 

func (r GetVocabularyFilterRequest) Send(ctx context.Context) (*GetVocabularyFilterResponse, error)

Send marshals and sends the GetVocabularyFilter API request.

type GetVocabularyFilterResponse 

type GetVocabularyFilterResponse struct {
	*GetVocabularyFilterOutput
	// contains filtered or unexported fields
}

GetVocabularyFilterResponse is the response type for the GetVocabularyFilter API operation.

func (*GetVocabularyFilterResponse) SDKResponseMetdata 

func (r *GetVocabularyFilterResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetVocabularyFilter request.

type GetVocabularyInput 

type GetVocabularyInput struct {

	// The name of the vocabulary to return information about. The name is case-sensitive.
	//
	// VocabularyName is a required field
	VocabularyName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetVocabularyInput) String 

func (s GetVocabularyInput) String() string

String returns the string representation

func (*GetVocabularyInput) Validate 

func (s *GetVocabularyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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 `min:"1" type:"string"`

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

	// The language code of the vocabulary entries.
	LanguageCode LanguageCode `type:"string" enum:"true"`

	// The date and time that the vocabulary was last modified.
	LastModifiedTime *time.Time `type:"timestamp"`

	// The name of the vocabulary to return.
	VocabularyName *string `min:"1" type:"string"`

	// The processing state of the vocabulary.
	VocabularyState VocabularyState `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

func (GetVocabularyOutput) String 

func (s GetVocabularyOutput) String() string

String returns the string representation

type GetVocabularyRequest 

type GetVocabularyRequest struct {
	*aws.Request
	Input *GetVocabularyInput
	Copy  func(*GetVocabularyInput) GetVocabularyRequest
}

GetVocabularyRequest is the request type for the GetVocabulary API operation.

func (GetVocabularyRequest) Send 

func (r GetVocabularyRequest) Send(ctx context.Context) (*GetVocabularyResponse, error)

Send marshals and sends the GetVocabulary API request.

type GetVocabularyResponse 

type GetVocabularyResponse struct {
	*GetVocabularyOutput
	// contains filtered or unexported fields
}

GetVocabularyResponse is the response type for the GetVocabulary API operation.

func (*GetVocabularyResponse) SDKResponseMetdata 

func (r *GetVocabularyResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetVocabulary request.

type JobExecutionSettings 

type JobExecutionSettings struct {

	// Indicates whether a job should be queued by Amazon Transcribe when the concurrent
	// execution limit is exceeded. When the AllowDeferredExecution field is true,
	// jobs are queued and executed when the number of executing jobs falls below
	// the concurrent execution limit. If the field is false, Amazon Transcribe
	// returns a LimitExceededException exception.
	//
	// If you specify the AllowDeferredExecution field, you must specify the DataAccessRoleArn
	// field.
	AllowDeferredExecution *bool `type:"boolean"`

	// The Amazon Resource Name (ARN) of a role that has access to the S3 bucket
	// that contains the input files. Amazon Transcribe assumes this role to read
	// queued media files. If you have specified an output S3 bucket for the transcription
	// results, this role should have access to the output bucket as well.
	//
	// If you specify the AllowDeferredExecution field, you must specify the DataAccessRoleArn
	// field.
	DataAccessRoleArn *string `type:"string"`
	// contains filtered or unexported fields
}

Provides information about when a transcription job should be executed.

func (JobExecutionSettings) String 

func (s JobExecutionSettings) String() string

String returns the string representation

type LanguageCode 

type LanguageCode string
const (
	LanguageCodeEnUs LanguageCode = "en-US"
	LanguageCodeEsUs LanguageCode = "es-US"
	LanguageCodeEnAu LanguageCode = "en-AU"
	LanguageCodeFrCa LanguageCode = "fr-CA"
	LanguageCodeEnGb LanguageCode = "en-GB"
	LanguageCodeDeDe LanguageCode = "de-DE"
	LanguageCodePtBr LanguageCode = "pt-BR"
	LanguageCodeFrFr LanguageCode = "fr-FR"
	LanguageCodeItIt LanguageCode = "it-IT"
	LanguageCodeKoKr LanguageCode = "ko-KR"
	LanguageCodeEsEs LanguageCode = "es-ES"
	LanguageCodeEnIn LanguageCode = "en-IN"
	LanguageCodeHiIn LanguageCode = "hi-IN"
	LanguageCodeArSa LanguageCode = "ar-SA"
	LanguageCodeRuRu LanguageCode = "ru-RU"
	LanguageCodeZhCn LanguageCode = "zh-CN"
	LanguageCodeNlNl LanguageCode = "nl-NL"
	LanguageCodeIdId LanguageCode = "id-ID"
	LanguageCodeTaIn LanguageCode = "ta-IN"
	LanguageCodeFaIr LanguageCode = "fa-IR"
	LanguageCodeEnIe LanguageCode = "en-IE"
	LanguageCodeEnAb LanguageCode = "en-AB"
	LanguageCodeEnWl LanguageCode = "en-WL"
	LanguageCodePtPt LanguageCode = "pt-PT"
	LanguageCodeTeIn LanguageCode = "te-IN"
	LanguageCodeTrTr LanguageCode = "tr-TR"
	LanguageCodeDeCh LanguageCode = "de-CH"
	LanguageCodeHeIl LanguageCode = "he-IL"
	LanguageCodeMsMy LanguageCode = "ms-MY"
	LanguageCodeJaJp LanguageCode = "ja-JP"
	LanguageCodeArAe LanguageCode = "ar-AE"
)

Enum values for LanguageCode

func (LanguageCode) MarshalValue 

func (enum LanguageCode) MarshalValue() (string, error)

func (LanguageCode) MarshalValueBuf 

func (enum LanguageCode) MarshalValueBuf(b []byte) ([]byte, error)

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 `min:"1" type:"string"`

	// The maximum number of medical transcription jobs to return in the response.
	// IF there are fewer results in the list, this response contains only the actual
	// results.
	MaxResults *int64 `min:"1" type:"integer"`

	// If you a receive a truncated result in the previous request of ListMedicalTranscriptionJobs,
	// include NextToken to fetch the next set of jobs.
	NextToken *string `type:"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 TranscriptionJobStatus `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

func (ListMedicalTranscriptionJobsInput) String 

func (s ListMedicalTranscriptionJobsInput) String() string

String returns the string representation

func (*ListMedicalTranscriptionJobsInput) Validate 

func (s *ListMedicalTranscriptionJobsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListMedicalTranscriptionJobsOutput 

type ListMedicalTranscriptionJobsOutput struct {

	// A list of objects containing summary information for a transcription job.
	MedicalTranscriptionJobSummaries []MedicalTranscriptionJobSummary `type:"list"`

	// 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 `type:"string"`

	// The requested status of the medical transcription jobs returned.
	Status TranscriptionJobStatus `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

func (ListMedicalTranscriptionJobsOutput) String 

func (s ListMedicalTranscriptionJobsOutput) String() string

String returns the string representation

type ListMedicalTranscriptionJobsPaginator 

type ListMedicalTranscriptionJobsPaginator struct {
	aws.Pager
}

ListMedicalTranscriptionJobsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListMedicalTranscriptionJobsPaginator 

func NewListMedicalTranscriptionJobsPaginator(req ListMedicalTranscriptionJobsRequest) ListMedicalTranscriptionJobsPaginator

NewListMedicalTranscriptionJobsRequestPaginator returns a paginator for ListMedicalTranscriptionJobs. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.ListMedicalTranscriptionJobsRequest(input)
p := transcribe.NewListMedicalTranscriptionJobsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListMedicalTranscriptionJobsPaginator) CurrentPage 

func (p *ListMedicalTranscriptionJobsPaginator) CurrentPage() *ListMedicalTranscriptionJobsOutput

type ListMedicalTranscriptionJobsRequest 

type ListMedicalTranscriptionJobsRequest struct {
	*aws.Request
	Input *ListMedicalTranscriptionJobsInput
	Copy  func(*ListMedicalTranscriptionJobsInput) ListMedicalTranscriptionJobsRequest
}

ListMedicalTranscriptionJobsRequest is the request type for the ListMedicalTranscriptionJobs API operation.

func (ListMedicalTranscriptionJobsRequest) Send 

func (r ListMedicalTranscriptionJobsRequest) Send(ctx context.Context) (*ListMedicalTranscriptionJobsResponse, error)

Send marshals and sends the ListMedicalTranscriptionJobs API request.

type ListMedicalTranscriptionJobsResponse 

type ListMedicalTranscriptionJobsResponse struct {
	*ListMedicalTranscriptionJobsOutput
	// contains filtered or unexported fields
}

ListMedicalTranscriptionJobsResponse is the response type for the ListMedicalTranscriptionJobs API operation.

func (*ListMedicalTranscriptionJobsResponse) SDKResponseMetdata 

func (r *ListMedicalTranscriptionJobsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListMedicalTranscriptionJobs request.

type ListMedicalVocabulariesInput 

type ListMedicalVocabulariesInput struct {

	// The maximum number of vocabularies to return in the response.
	MaxResults *int64 `min:"1" type:"integer"`

	// Returns vocabularies in the list whose name contains the specified string.
	// The search is case-insensitive, ListMedicalVocabularies returns both "vocabularyname"
	// and "VocabularyName" in the response list.
	NameContains *string `min:"1" type:"string"`

	// If the result of your previous request to ListMedicalVocabularies was truncated,
	// include the NextToken to fetch the next set of jobs.
	NextToken *string `type:"string"`

	// When specified, only returns vocabularies with the VocabularyState equal
	// to the specified vocabulary state.
	StateEquals VocabularyState `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

func (ListMedicalVocabulariesInput) String 

func (s ListMedicalVocabulariesInput) String() string

String returns the string representation

func (*ListMedicalVocabulariesInput) Validate 

func (s *ListMedicalVocabulariesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListMedicalVocabulariesOutput 

type ListMedicalVocabulariesOutput struct {

	// The ListMedicalVocabularies operation returns a page of vocabularies 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 Medical
	// returns the NextPage token. Include the token in the next request to the
	// ListMedicalVocabularies operation to return the next page of jobs.
	NextToken *string `type:"string"`

	// The requested vocabulary state.
	Status VocabularyState `type:"string" enum:"true"`

	// A list of objects that describe the vocabularies that match the search criteria
	// in the request.
	Vocabularies []VocabularyInfo `type:"list"`
	// contains filtered or unexported fields
}

func (ListMedicalVocabulariesOutput) String 

func (s ListMedicalVocabulariesOutput) String() string

String returns the string representation

type ListMedicalVocabulariesPaginator 

type ListMedicalVocabulariesPaginator struct {
	aws.Pager
}

ListMedicalVocabulariesPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListMedicalVocabulariesPaginator 

func NewListMedicalVocabulariesPaginator(req ListMedicalVocabulariesRequest) ListMedicalVocabulariesPaginator

NewListMedicalVocabulariesRequestPaginator returns a paginator for ListMedicalVocabularies. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.ListMedicalVocabulariesRequest(input)
p := transcribe.NewListMedicalVocabulariesRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListMedicalVocabulariesPaginator) CurrentPage 

func (p *ListMedicalVocabulariesPaginator) CurrentPage() *ListMedicalVocabulariesOutput

type ListMedicalVocabulariesRequest 

type ListMedicalVocabulariesRequest struct {
	*aws.Request
	Input *ListMedicalVocabulariesInput
	Copy  func(*ListMedicalVocabulariesInput) ListMedicalVocabulariesRequest
}

ListMedicalVocabulariesRequest is the request type for the ListMedicalVocabularies API operation.

func (ListMedicalVocabulariesRequest) Send 

func (r ListMedicalVocabulariesRequest) Send(ctx context.Context) (*ListMedicalVocabulariesResponse, error)

Send marshals and sends the ListMedicalVocabularies API request.

type ListMedicalVocabulariesResponse 

type ListMedicalVocabulariesResponse struct {
	*ListMedicalVocabulariesOutput
	// contains filtered or unexported fields
}

ListMedicalVocabulariesResponse is the response type for the ListMedicalVocabularies API operation.

func (*ListMedicalVocabulariesResponse) SDKResponseMetdata 

func (r *ListMedicalVocabulariesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListMedicalVocabularies request.

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 `min:"1" type:"string"`

	// The maximum number of jobs to return in the response. If there are fewer
	// results in the list, this response contains only the actual results.
	MaxResults *int64 `min:"1" type:"integer"`

	// If the result of the previous request to ListTranscriptionJobs was truncated,
	// include the NextToken to fetch the next set of jobs.
	NextToken *string `type:"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 TranscriptionJobStatus `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

func (ListTranscriptionJobsInput) String 

func (s ListTranscriptionJobsInput) String() string

String returns the string representation

func (*ListTranscriptionJobsInput) Validate 

func (s *ListTranscriptionJobsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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 `type:"string"`

	// The requested status of the jobs returned.
	Status TranscriptionJobStatus `type:"string" enum:"true"`

	// A list of objects containing summary information for a transcription job.
	TranscriptionJobSummaries []TranscriptionJobSummary `type:"list"`
	// contains filtered or unexported fields
}

func (ListTranscriptionJobsOutput) String 

func (s ListTranscriptionJobsOutput) String() string

String returns the string representation

type ListTranscriptionJobsPaginator 

type ListTranscriptionJobsPaginator struct {
	aws.Pager
}

ListTranscriptionJobsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListTranscriptionJobsPaginator 

func NewListTranscriptionJobsPaginator(req ListTranscriptionJobsRequest) ListTranscriptionJobsPaginator

NewListTranscriptionJobsRequestPaginator returns a paginator for ListTranscriptionJobs. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.ListTranscriptionJobsRequest(input)
p := transcribe.NewListTranscriptionJobsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListTranscriptionJobsPaginator) CurrentPage 

func (p *ListTranscriptionJobsPaginator) CurrentPage() *ListTranscriptionJobsOutput

type ListTranscriptionJobsRequest 

type ListTranscriptionJobsRequest struct {
	*aws.Request
	Input *ListTranscriptionJobsInput
	Copy  func(*ListTranscriptionJobsInput) ListTranscriptionJobsRequest
}

ListTranscriptionJobsRequest is the request type for the ListTranscriptionJobs API operation.

func (ListTranscriptionJobsRequest) Send 

func (r ListTranscriptionJobsRequest) Send(ctx context.Context) (*ListTranscriptionJobsResponse, error)

Send marshals and sends the ListTranscriptionJobs API request.

type ListTranscriptionJobsResponse 

type ListTranscriptionJobsResponse struct {
	*ListTranscriptionJobsOutput
	// contains filtered or unexported fields
}

ListTranscriptionJobsResponse is the response type for the ListTranscriptionJobs API operation.

func (*ListTranscriptionJobsResponse) SDKResponseMetdata 

func (r *ListTranscriptionJobsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListTranscriptionJobs request.

type ListVocabulariesInput 

type ListVocabulariesInput struct {

	// The maximum number of vocabularies to return in the response. If there are
	// fewer results in the list, this response contains only the actual results.
	MaxResults *int64 `min:"1" type:"integer"`

	// When specified, the vocabularies returned in the list are limited to vocabularies
	// whose name contains the specified string. The search is case-insensitive,
	// ListVocabularies returns both "vocabularyname" and "VocabularyName" in the
	// response list.
	NameContains *string `min:"1" type:"string"`

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

	// When specified, only returns vocabularies with the VocabularyState field
	// equal to the specified state.
	StateEquals VocabularyState `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

func (ListVocabulariesInput) String 

func (s ListVocabulariesInput) String() string

String returns the string representation

func (*ListVocabulariesInput) Validate 

func (s *ListVocabulariesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListVocabulariesOutput 

type ListVocabulariesOutput struct {

	// The ListVocabularies operation returns a page of vocabularies 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 ListVocabularies
	// operation to return in the next page of jobs.
	NextToken *string `type:"string"`

	// The requested vocabulary state.
	Status VocabularyState `type:"string" enum:"true"`

	// A list of objects that describe the vocabularies that match the search criteria
	// in the request.
	Vocabularies []VocabularyInfo `type:"list"`
	// contains filtered or unexported fields
}

func (ListVocabulariesOutput) String 

func (s ListVocabulariesOutput) String() string

String returns the string representation

type ListVocabulariesPaginator 

type ListVocabulariesPaginator struct {
	aws.Pager
}

ListVocabulariesPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListVocabulariesPaginator 

func NewListVocabulariesPaginator(req ListVocabulariesRequest) ListVocabulariesPaginator

NewListVocabulariesRequestPaginator returns a paginator for ListVocabularies. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.ListVocabulariesRequest(input)
p := transcribe.NewListVocabulariesRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListVocabulariesPaginator) CurrentPage 

func (p *ListVocabulariesPaginator) CurrentPage() *ListVocabulariesOutput

type ListVocabulariesRequest 

type ListVocabulariesRequest struct {
	*aws.Request
	Input *ListVocabulariesInput
	Copy  func(*ListVocabulariesInput) ListVocabulariesRequest
}

ListVocabulariesRequest is the request type for the ListVocabularies API operation.

func (ListVocabulariesRequest) Send 

func (r ListVocabulariesRequest) Send(ctx context.Context) (*ListVocabulariesResponse, error)

Send marshals and sends the ListVocabularies API request.

type ListVocabulariesResponse 

type ListVocabulariesResponse struct {
	*ListVocabulariesOutput
	// contains filtered or unexported fields
}

ListVocabulariesResponse is the response type for the ListVocabularies API operation.

func (*ListVocabulariesResponse) SDKResponseMetdata 

func (r *ListVocabulariesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListVocabularies request.

type ListVocabularyFiltersInput 

type ListVocabularyFiltersInput struct {

	// The maximum number of filters to return in the response. If there are fewer
	// results in the list, this response contains only the actual results.
	MaxResults *int64 `min:"1" type:"integer"`

	// Filters the response so that it only contains vocabulary filters whose name
	// contains the specified string.
	NameContains *string `min:"1" type:"string"`

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

func (ListVocabularyFiltersInput) String 

func (s ListVocabularyFiltersInput) String() string

String returns the string representation

func (*ListVocabularyFiltersInput) Validate 

func (s *ListVocabularyFiltersInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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 `type:"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 []VocabularyFilterInfo `type:"list"`
	// contains filtered or unexported fields
}

func (ListVocabularyFiltersOutput) String 

func (s ListVocabularyFiltersOutput) String() string

String returns the string representation

type ListVocabularyFiltersPaginator 

type ListVocabularyFiltersPaginator struct {
	aws.Pager
}

ListVocabularyFiltersPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListVocabularyFiltersPaginator 

func NewListVocabularyFiltersPaginator(req ListVocabularyFiltersRequest) ListVocabularyFiltersPaginator

NewListVocabularyFiltersRequestPaginator returns a paginator for ListVocabularyFilters. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.ListVocabularyFiltersRequest(input)
p := transcribe.NewListVocabularyFiltersRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListVocabularyFiltersPaginator) CurrentPage 

func (p *ListVocabularyFiltersPaginator) CurrentPage() *ListVocabularyFiltersOutput

type ListVocabularyFiltersRequest 

type ListVocabularyFiltersRequest struct {
	*aws.Request
	Input *ListVocabularyFiltersInput
	Copy  func(*ListVocabularyFiltersInput) ListVocabularyFiltersRequest
}

ListVocabularyFiltersRequest is the request type for the ListVocabularyFilters API operation.

func (ListVocabularyFiltersRequest) Send 

func (r ListVocabularyFiltersRequest) Send(ctx context.Context) (*ListVocabularyFiltersResponse, error)

Send marshals and sends the ListVocabularyFilters API request.

type ListVocabularyFiltersResponse 

type ListVocabularyFiltersResponse struct {
	*ListVocabularyFiltersOutput
	// contains filtered or unexported fields
}

ListVocabularyFiltersResponse is the response type for the ListVocabularyFilters API operation.

func (*ListVocabularyFiltersResponse) SDKResponseMetdata 

func (r *ListVocabularyFiltersResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListVocabularyFilters request.

type Media 

type Media struct {

	// The S3 object location of the input media file. The URI must be in the same
	// region as the API endpoint that you are calling. The general form is:
	//
	// For example:
	//
	// For more information about S3 object names, see Object Keys (http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#object-keys)
	// in the Amazon S3 Developer Guide.
	MediaFileUri *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Describes the input media file in a transcription request.

func (Media) String 

func (s Media) String() string

String returns the string representation

func (*Media) Validate 

func (s *Media) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type MediaFormat 

type MediaFormat string
const (
	MediaFormatMp3  MediaFormat = "mp3"
	MediaFormatMp4  MediaFormat = "mp4"
	MediaFormatWav  MediaFormat = "wav"
	MediaFormatFlac MediaFormat = "flac"
)

Enum values for MediaFormat

func (MediaFormat) MarshalValue 

func (enum MediaFormat) MarshalValue() (string, error)

func (MediaFormat) MarshalValueBuf 

func (enum MediaFormat) MarshalValueBuf(b []byte) ([]byte, error)

type MedicalTranscript 

type MedicalTranscript struct {

	// The S3 object location of the medical transcript.
	//
	// Use this URI to access the medical transcript. This URI points to the S3
	// bucket you created to store the medical transcript.
	TranscriptFileUri *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Identifies the location of a medical transcript.

func (MedicalTranscript) String 

func (s MedicalTranscript) String() string

String returns the string representation

type MedicalTranscriptionJob 

type MedicalTranscriptionJob struct {

	// A timestamp that shows when the job was completed.
	CompletionTime *time.Time `type:"timestamp"`

	// A timestamp that shows when the job was created.
	CreationTime *time.Time `type:"timestamp"`

	// If the TranscriptionJobStatus field is FAILED, this field contains information
	// about why the job failed.
	//
	// The FailureReason field contains one of the following values:
	//
	//    * Unsupported media format- The media format specified in the MediaFormat
	//    field of the request isn't valid. See the description of the MediaFormat
	//    field for a list of valid values.
	//
	//    * The media format provided does not match the detected media format-
	//    The media format of the audio file doesn't match the format specified
	//    in the MediaFormat field in the request. Check the media format of your
	//    media file and make sure the two values match.
	//
	//    * Invalid sample rate for audio file- The sample rate specified in the
	//    MediaSampleRateHertz of the request isn't valid. The sample rate must
	//    be between 8000 and 48000 Hertz.
	//
	//    * The sample rate provided does not match the detected sample rate- The
	//    sample rate in the audio file doesn't match the sample rate specified
	//    in the MediaSampleRateHertz field in the request. Check the sample rate
	//    of your media file and make sure that the two values match.
	//
	//    * Invalid file size: file size too large- The size of your audio file
	//    is larger than what Amazon Transcribe Medical can process. For more information,
	//    see Guidlines and Quotas (https://docs.aws.amazon.com/transcribe/latest/dg/limits-guidelines.html#limits)
	//    in the Amazon Transcribe Medical Guide
	//
	//    * Invalid number of channels: number of channels too large- Your audio
	//    contains more channels than Amazon Transcribe Medical is configured to
	//    process. To request additional channels, see Amazon Transcribe Medical
	//    Endpoints and Quotas (https://docs.aws.amazon.com/general/latest/gr/transcribe-medical.html)
	//    in the Amazon Web Services General Reference
	FailureReason *string `type:"string"`

	// The language code for the language spoken in the source audio file. US English
	// (en-US) is the only supported language for medical transcriptions. Any other
	// value you enter for language code results in a BadRequestException error.
	LanguageCode LanguageCode `type:"string" enum:"true"`

	// Describes the input media file in a transcription request.
	Media *Media `type:"structure"`

	// The format of the input media file.
	MediaFormat MediaFormat `type:"string" enum:"true"`

	// The sample rate, in Hertz, of the source audio containing medical information.
	//
	// If you don't specify the sample rate, Amazon Transcribe Medical determines
	// it for you. If you choose to specify the sample rate, it must match the rate
	// detected by Amazon Transcribe Medical. In most cases, you should leave the
	// MediaSampleHertz blank and let Amazon Transcribe Medical determine the sample
	// rate.
	MediaSampleRateHertz *int64 `min:"8000" type:"integer"`

	// The name for a given medical transcription job.
	MedicalTranscriptionJobName *string `min:"1" type:"string"`

	// Object that contains object.
	Settings *MedicalTranscriptionSetting `type:"structure"`

	// The medical specialty of any clinicians providing a dictation or having a
	// conversation. PRIMARYCARE is the only available setting for this object.
	// This specialty enables you to generate transcriptions for the following medical
	// fields:
	//
	//    * Family Medicine
	Specialty Specialty `type:"string" enum:"true"`

	// A timestamp that shows when the job started processing.
	StartTime *time.Time `type:"timestamp"`

	// An object that contains the MedicalTranscript. The MedicalTranscript contains
	// the TranscriptFileUri.
	Transcript *MedicalTranscript `type:"structure"`

	// The completion status of a medical transcription job.
	TranscriptionJobStatus TranscriptionJobStatus `type:"string" enum:"true"`

	// The type of speech in the transcription job. CONVERSATION is generally used
	// for patient-physician dialogues. DICTATION is the setting for physicians
	// speaking their notes after seeing a patient. For more information, see how-it-works-med
	Type Type `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

The data structure that containts the information for a medical transcription job.

func (MedicalTranscriptionJob) String 

func (s MedicalTranscriptionJob) String() string

String returns the string representation

type MedicalTranscriptionJobSummary 

type MedicalTranscriptionJobSummary struct {

	// A timestamp that shows when the job was completed.
	CompletionTime *time.Time `type:"timestamp"`

	// A timestamp that shows when the medical transcription job was created.
	CreationTime *time.Time `type:"timestamp"`

	// If the TranscriptionJobStatus field is FAILED, a description of the error.
	FailureReason *string `type:"string"`

	// The language of the transcript in the source audio file.
	LanguageCode LanguageCode `type:"string" enum:"true"`

	// The name of a medical transcription job.
	MedicalTranscriptionJobName *string `min:"1" type:"string"`

	// Indicates the location of the transcription job's output.
	//
	// The CUSTOMER_BUCKET is the S3 location provided in the OutputBucketName field
	// when the
	OutputLocationType OutputLocationType `type:"string" enum:"true"`

	// The medical specialty of the transcription job. Primary care is the only
	// valid value.
	Specialty Specialty `type:"string" enum:"true"`

	// A timestamp that shows when the job began processing.
	StartTime *time.Time `type:"timestamp"`

	// The status of the medical transcription job.
	TranscriptionJobStatus TranscriptionJobStatus `type:"string" enum:"true"`

	// The speech of the clinician in the input audio.
	Type Type `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

Provides summary information about a transcription job.

func (MedicalTranscriptionJobSummary) String 

func (s MedicalTranscriptionJobSummary) String() string

String returns the string representation

type MedicalTranscriptionSetting 

type MedicalTranscriptionSetting struct {

	// Instructs Amazon Transcribe Medical to process each audio channel separately
	// and then merge the transcription output of each channel into a single transcription.
	//
	// Amazon Transcribe Medical also produces a transcription of each item detected
	// on an audio channel, including the start time and end time of the item and
	// alternative transcriptions of item. The alternative transcriptions also come
	// with confidence scores provided by Amazon Transcribe Medical.
	//
	// You can't set both ShowSpeakerLabels and ChannelIdentification in the same
	// request. If you set both, your request returns a BadRequestException
	ChannelIdentification *bool `type:"boolean"`

	// The maximum number of alternatives that you tell the service to return. If
	// you specify the MaxAlternatives field, you must set the ShowAlternatives
	// field to true.
	MaxAlternatives *int64 `min:"2" type:"integer"`

	// The maximum number of speakers to identify in the input audio. If there are
	// more speakers in the audio than this number, multiple speakers are identified
	// as a single speaker. If you specify the MaxSpeakerLabels field, you must
	// set the ShowSpeakerLabels field to true.
	MaxSpeakerLabels *int64 `min:"2" type:"integer"`

	// Determines whether alternative transcripts are generated along with the transcript
	// that has the highest confidence. If you set ShowAlternatives field to true,
	// you must also set the maximum number of alternatives to return in the MaxAlternatives
	// field.
	ShowAlternatives *bool `type:"boolean"`

	// Determines whether the transcription job uses speaker recognition to identify
	// different speakers in the input audio. Speaker recongition labels individual
	// speakers in the audio file. If you set the ShowSpeakerLabels field to true,
	// you must also set the maximum number of speaker labels in the MaxSpeakerLabels
	// field.
	//
	// You can't set both ShowSpeakerLabels and ChannelIdentification in the same
	// request. If you set both, your request returns a BadRequestException.
	ShowSpeakerLabels *bool `type:"boolean"`

	// The name of the vocabulary to use when processing a medical transcription
	// job.
	VocabularyName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Optional settings for the StartMedicalTranscriptionJob operation.

func (MedicalTranscriptionSetting) String 

func (s MedicalTranscriptionSetting) String() string

String returns the string representation

func (*MedicalTranscriptionSetting) Validate 

func (s *MedicalTranscriptionSetting) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type OutputLocationType 

type OutputLocationType string
const (
	OutputLocationTypeCustomerBucket OutputLocationType = "CUSTOMER_BUCKET"
	OutputLocationTypeServiceBucket  OutputLocationType = "SERVICE_BUCKET"
)

Enum values for OutputLocationType

func (OutputLocationType) MarshalValue 

func (enum OutputLocationType) MarshalValue() (string, error)

func (OutputLocationType) MarshalValueBuf 

func (enum OutputLocationType) MarshalValueBuf(b []byte) ([]byte, error)

type RedactionOutput 

type RedactionOutput string
const (
	RedactionOutputRedacted              RedactionOutput = "redacted"
	RedactionOutputRedactedAndUnredacted RedactionOutput = "redacted_and_unredacted"
)

Enum values for RedactionOutput

func (RedactionOutput) MarshalValue 

func (enum RedactionOutput) MarshalValue() (string, error)

func (RedactionOutput) MarshalValueBuf 

func (enum RedactionOutput) MarshalValueBuf(b []byte) ([]byte, error)

type RedactionType 

type RedactionType string
const (
	RedactionTypePii RedactionType = "PII"
)

Enum values for RedactionType

func (RedactionType) MarshalValue 

func (enum RedactionType) MarshalValue() (string, error)

func (RedactionType) MarshalValueBuf 

func (enum RedactionType) MarshalValueBuf(b []byte) ([]byte, error)

type Settings 

type Settings struct {

	// Instructs Amazon Transcribe to process each audio channel separately and
	// then merge the transcription output of each channel into a single transcription.
	//
	// Amazon Transcribe also produces a transcription of each item detected on
	// an audio channel, including the start time and end time of the item and alternative
	// transcriptions of the item including the confidence that Amazon Transcribe
	// has in the transcription.
	//
	// You can't set both ShowSpeakerLabels and ChannelIdentification in the same
	// request. If you set both, your request returns a BadRequestException.
	ChannelIdentification *bool `type:"boolean"`

	// The number of alternative transcriptions that the service should return.
	// If you specify the MaxAlternatives field, you must set the ShowAlternatives
	// field to true.
	MaxAlternatives *int64 `min:"2" type:"integer"`

	// The maximum number of speakers to identify in the input audio. If there are
	// more speakers in the audio than this number, multiple speakers are identified
	// as a single speaker. If you specify the MaxSpeakerLabels field, you must
	// set the ShowSpeakerLabels field to true.
	MaxSpeakerLabels *int64 `min:"2" type:"integer"`

	// Determines whether the transcription contains alternative transcriptions.
	// If you set the ShowAlternatives field to true, you must also set the maximum
	// number of alternatives to return in the MaxAlternatives field.
	ShowAlternatives *bool `type:"boolean"`

	// Determines whether the transcription job uses speaker recognition to identify
	// different speakers in the input audio. Speaker recognition labels individual
	// speakers in the audio file. If you set the ShowSpeakerLabels field to true,
	// you must also set the maximum number of speaker labels MaxSpeakerLabels field.
	//
	// You can't set both ShowSpeakerLabels and ChannelIdentification in the same
	// request. If you set both, your request returns a BadRequestException.
	ShowSpeakerLabels *bool `type:"boolean"`

	// Set to mask to remove filtered text from the transcript and replace it with
	// three asterisks ("***") as placeholder text. Set to remove to remove filtered
	// text from the transcript without using placeholder text.
	VocabularyFilterMethod VocabularyFilterMethod `type:"string" enum:"true"`

	// The name of the vocabulary filter to use when transcribing the audio. The
	// filter that you specify must have the same language code as the transcription
	// job.
	VocabularyFilterName *string `min:"1" type:"string"`

	// The name of a vocabulary to use when processing the transcription job.
	VocabularyName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Provides optional settings for the StartTranscriptionJob operation.

func (Settings) String 

func (s Settings) String() string

String returns the string representation

func (*Settings) Validate 

func (s *Settings) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Specialty 

type Specialty string
const (
	SpecialtyPrimarycare Specialty = "PRIMARYCARE"
)

Enum values for Specialty

func (Specialty) MarshalValue 

func (enum Specialty) MarshalValue() (string, error)

func (Specialty) MarshalValueBuf 

func (enum Specialty) MarshalValueBuf(b []byte) ([]byte, error)

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.
	//
	// LanguageCode is a required field
	LanguageCode LanguageCode `type:"string" required:"true" enum:"true"`

	// Describes the input media file in a transcription request.
	//
	// Media is a required field
	Media *Media `type:"structure" required:"true"`

	// The audio format of the input media file.
	MediaFormat MediaFormat `type:"string" enum:"true"`

	// 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 *int64 `min:"8000" type:"integer"`

	// 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 AWS account. If you try to create a medical transcription job with the
	// same name as a previous medical transcription job you will receive a ConflictException
	// error.
	//
	// MedicalTranscriptionJobName is a required field
	MedicalTranscriptionJobName *string `min:"1" type:"string" required:"true"`

	// 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 AWS 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.
	//
	// OutputBucketName is a required field
	OutputBucketName *string `type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the AWS 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 `min:"1" type:"string"`

	// Optional settings for the medical transcription job.
	Settings *MedicalTranscriptionSetting `type:"structure"`

	// The medical specialty of any clinician speaking in the input media.
	//
	// Specialty is a required field
	Specialty Specialty `type:"string" required:"true" enum:"true"`

	// 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, e.g., for clinical notes.
	//
	// Type is a required field
	Type Type `type:"string" required:"true" enum:"true"`
	// contains filtered or unexported fields
}

func (StartMedicalTranscriptionJobInput) String 

func (s StartMedicalTranscriptionJobInput) String() string

String returns the string representation

func (*StartMedicalTranscriptionJobInput) Validate 

func (s *StartMedicalTranscriptionJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartMedicalTranscriptionJobOutput 

type StartMedicalTranscriptionJobOutput struct {

	// A batch job submitted to transcribe medical speech to text.
	MedicalTranscriptionJob *MedicalTranscriptionJob `type:"structure"`
	// contains filtered or unexported fields
}

func (StartMedicalTranscriptionJobOutput) String 

func (s StartMedicalTranscriptionJobOutput) String() string

String returns the string representation

type StartMedicalTranscriptionJobRequest 

type StartMedicalTranscriptionJobRequest struct {
	*aws.Request
	Input *StartMedicalTranscriptionJobInput
	Copy  func(*StartMedicalTranscriptionJobInput) StartMedicalTranscriptionJobRequest
}

StartMedicalTranscriptionJobRequest is the request type for the StartMedicalTranscriptionJob API operation.

func (StartMedicalTranscriptionJobRequest) Send 

func (r StartMedicalTranscriptionJobRequest) Send(ctx context.Context) (*StartMedicalTranscriptionJobResponse, error)

Send marshals and sends the StartMedicalTranscriptionJob API request.

type StartMedicalTranscriptionJobResponse 

type StartMedicalTranscriptionJobResponse struct {
	*StartMedicalTranscriptionJobOutput
	// contains filtered or unexported fields
}

StartMedicalTranscriptionJobResponse is the response type for the StartMedicalTranscriptionJob API operation.

func (*StartMedicalTranscriptionJobResponse) SDKResponseMetdata 

func (r *StartMedicalTranscriptionJobResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the StartMedicalTranscriptionJob request.

type StartTranscriptionJobInput 

type StartTranscriptionJobInput struct {

	// An object that contains the request parameters for content redaction.
	ContentRedaction *ContentRedaction `type:"structure"`

	// 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 *JobExecutionSettings `type:"structure"`

	// The language code for the language used in the input media file.
	//
	// LanguageCode is a required field
	LanguageCode LanguageCode `type:"string" required:"true" enum:"true"`

	// An object that describes the input media for a transcription job.
	//
	// Media is a required field
	Media *Media `type:"structure" required:"true"`

	// The format of the input media file.
	MediaFormat MediaFormat `type:"string" enum:"true"`

	// 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 *int64 `min:"8000" type:"integer"`

	// 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 AWS 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 `type:"string"`

	// The Amazon Resource Name (ARN) of the AWS 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 `min:"1" type:"string"`

	// A Settings object that provides optional settings for a transcription job.
	Settings *Settings `type:"structure"`

	// The name of the job. Note that you can't use the strings "." or ".." by themselves
	// as the job name. The name must also be unique within an AWS account. If you
	// try to create a transcription job with the same name as a previous transcription
	// job you will receive a ConflictException error.
	//
	// TranscriptionJobName is a required field
	TranscriptionJobName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StartTranscriptionJobInput) String 

func (s StartTranscriptionJobInput) String() string

String returns the string representation

func (*StartTranscriptionJobInput) Validate 

func (s *StartTranscriptionJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartTranscriptionJobOutput 

type StartTranscriptionJobOutput struct {

	// An object containing details of the asynchronous transcription job.
	TranscriptionJob *TranscriptionJob `type:"structure"`
	// contains filtered or unexported fields
}

func (StartTranscriptionJobOutput) String 

func (s StartTranscriptionJobOutput) String() string

String returns the string representation

type StartTranscriptionJobRequest 

type StartTranscriptionJobRequest struct {
	*aws.Request
	Input *StartTranscriptionJobInput
	Copy  func(*StartTranscriptionJobInput) StartTranscriptionJobRequest
}

StartTranscriptionJobRequest is the request type for the StartTranscriptionJob API operation.

func (StartTranscriptionJobRequest) Send 

func (r StartTranscriptionJobRequest) Send(ctx context.Context) (*StartTranscriptionJobResponse, error)

Send marshals and sends the StartTranscriptionJob API request.

type StartTranscriptionJobResponse 

type StartTranscriptionJobResponse struct {
	*StartTranscriptionJobOutput
	// contains filtered or unexported fields
}

StartTranscriptionJobResponse is the response type for the StartTranscriptionJob API operation.

func (*StartTranscriptionJobResponse) SDKResponseMetdata 

func (r *StartTranscriptionJobResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the StartTranscriptionJob request.

type Transcript 

type Transcript struct {

	// The S3 object location of the redacted transcript.
	//
	// Use this URI to access the redacated transcript. If you specified an S3 bucket
	// in the OutputBucketName field when you created the job, this is the URI of
	// that bucket. If you chose to store the transcript in Amazon Transcribe, this
	// is a shareable URL that provides secure access to that location.
	RedactedTranscriptFileUri *string `min:"1" type:"string"`

	// The S3 object location of the the transcript.
	//
	// Use this URI to access the transcript. If you specified an S3 bucket in the
	// OutputBucketName field when you created the job, this is the URI of that
	// bucket. If you chose to store the transcript in Amazon Transcribe, this is
	// a shareable URL that provides secure access to that location.
	TranscriptFileUri *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Identifies the location of a transcription.

func (Transcript) String 

func (s Transcript) String() string

String returns the string representation

type TranscriptionJob 

type TranscriptionJob struct {

	// A timestamp that shows when the job was completed.
	CompletionTime *time.Time `type:"timestamp"`

	// An object that describes content redaction settings for the transcription
	// job.
	ContentRedaction *ContentRedaction `type:"structure"`

	// A timestamp that shows when the job was created.
	CreationTime *time.Time `type:"timestamp"`

	// If the TranscriptionJobStatus field is FAILED, this field contains information
	// about why the job failed.
	//
	// The FailureReason field can contain one of the following values:
	//
	//    * Unsupported media format - The media format specified in the MediaFormat
	//    field of the request isn't valid. See the description of the MediaFormat
	//    field for a list of valid values.
	//
	//    * The media format provided does not match the detected media format -
	//    The media format of the audio file doesn't match the format specified
	//    in the MediaFormat field in the request. Check the media format of your
	//    media file and make sure that the two values match.
	//
	//    * Invalid sample rate for audio file - The sample rate specified in the
	//    MediaSampleRateHertz of the request isn't valid. The sample rate must
	//    be between 8000 and 48000 Hertz.
	//
	//    * The sample rate provided does not match the detected sample rate - The
	//    sample rate in the audio file doesn't match the sample rate specified
	//    in the MediaSampleRateHertz field in the request. Check the sample rate
	//    of your media file and make sure that the two values match.
	//
	//    * Invalid file size: file size too large - The size of your audio file
	//    is larger than Amazon Transcribe can process. For more information, see
	//    Limits (https://docs.aws.amazon.com/transcribe/latest/dg/limits-guidelines.html#limits)
	//    in the Amazon Transcribe Developer Guide.
	//
	//    * Invalid number of channels: number of channels too large - Your audio
	//    contains more channels than Amazon Transcribe is configured to process.
	//    To request additional channels, see Amazon Transcribe Limits (https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits-amazon-transcribe)
	//    in the Amazon Web Services General Reference.
	FailureReason *string `type:"string"`

	// Provides information about how a transcription job is executed.
	JobExecutionSettings *JobExecutionSettings `type:"structure"`

	// The language code for the input speech.
	LanguageCode LanguageCode `type:"string" enum:"true"`

	// An object that describes the input media for the transcription job.
	Media *Media `type:"structure"`

	// The format of the input media file.
	MediaFormat MediaFormat `type:"string" enum:"true"`

	// The sample rate, in Hertz, of the audio track in the input media file.
	MediaSampleRateHertz *int64 `min:"8000" type:"integer"`

	// Optional settings for the transcription job. Use these settings to turn on
	// speaker recognition, to set the maximum number of speakers that should be
	// identified and to specify a custom vocabulary to use when processing the
	// transcription job.
	Settings *Settings `type:"structure"`

	// A timestamp that shows with the job was started processing.
	StartTime *time.Time `type:"timestamp"`

	// An object that describes the output of the transcription job.
	Transcript *Transcript `type:"structure"`

	// The name of the transcription job.
	TranscriptionJobName *string `min:"1" type:"string"`

	// The status of the transcription job.
	TranscriptionJobStatus TranscriptionJobStatus `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

Describes an asynchronous transcription job that was created with the StartTranscriptionJob operation.

func (TranscriptionJob) String 

func (s TranscriptionJob) String() string

String returns the string representation

type TranscriptionJobStatus 

type TranscriptionJobStatus string
const (
	TranscriptionJobStatusQueued     TranscriptionJobStatus = "QUEUED"
	TranscriptionJobStatusInProgress TranscriptionJobStatus = "IN_PROGRESS"
	TranscriptionJobStatusFailed     TranscriptionJobStatus = "FAILED"
	TranscriptionJobStatusCompleted  TranscriptionJobStatus = "COMPLETED"
)

Enum values for TranscriptionJobStatus

func (TranscriptionJobStatus) MarshalValue 

func (enum TranscriptionJobStatus) MarshalValue() (string, error)

func (TranscriptionJobStatus) MarshalValueBuf 

func (enum TranscriptionJobStatus) MarshalValueBuf(b []byte) ([]byte, error)

type TranscriptionJobSummary 

type TranscriptionJobSummary struct {

	// A timestamp that shows when the job was completed.
	CompletionTime *time.Time `type:"timestamp"`

	// The content redaction settings of the transcription job.
	ContentRedaction *ContentRedaction `type:"structure"`

	// A timestamp that shows when the job was created.
	CreationTime *time.Time `type:"timestamp"`

	// If the TranscriptionJobStatus field is FAILED, a description of the error.
	FailureReason *string `type:"string"`

	// The language code for the input speech.
	LanguageCode LanguageCode `type:"string" enum:"true"`

	// Indicates the location of the output of the transcription job.
	//
	// If the value is CUSTOMER_BUCKET then the location is the S3 bucket specified
	// in the outputBucketName field when the transcription job was started with
	// the StartTranscriptionJob operation.
	//
	// If the value is SERVICE_BUCKET then the output is stored by Amazon Transcribe
	// and can be retrieved using the URI in the GetTranscriptionJob response's
	// TranscriptFileUri field.
	OutputLocationType OutputLocationType `type:"string" enum:"true"`

	// A timestamp that shows when the job started processing.
	StartTime *time.Time `type:"timestamp"`

	// The name of the transcription job.
	TranscriptionJobName *string `min:"1" type:"string"`

	// The status of the transcription job. When the status is COMPLETED, use the
	// GetTranscriptionJob operation to get the results of the transcription.
	TranscriptionJobStatus TranscriptionJobStatus `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

Provides a summary of information about a transcription job.

func (TranscriptionJobSummary) String 

func (s TranscriptionJobSummary) String() string

String returns the string representation

type Type 

type Type string
const (
	TypeConversation Type = "CONVERSATION"
	TypeDictation    Type = "DICTATION"
)

Enum values for Type

func (Type) MarshalValue 

func (enum Type) MarshalValue() (string, error)

func (Type) MarshalValueBuf 

func (enum Type) MarshalValueBuf(b []byte) ([]byte, error)

type UpdateMedicalVocabularyInput 

type UpdateMedicalVocabularyInput struct {

	// The language code of the entries in the updated vocabulary. US English (en-US)
	// is the only valid language code in Amazon Transcribe Medical.
	//
	// LanguageCode is a required field
	LanguageCode LanguageCode `type:"string" required:"true" enum:"true"`

	// The Amazon S3 location of the text file containing the definition of the
	// custom vocabulary. The URI must be in the same AWS region as the API endpoint
	// you are calling. You can see the fields you need to enter for you Amazon
	// S3 location in the example URI here:
	//
	// https://s3.<aws-region>.amazonaws.com/<bucket-name>/<keyprefix>/<objectkey>
	//
	// For example:
	//
	// https://s3.us-east-1.amazonaws.com/AWSDOC-EXAMPLE-BUCKET/vocab.txt
	//
	// For more information about S3 object names, see Object Keys (http://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 (http://docs.aws.amazon.com/transcribe/latest/dg/how-it-works.html#how-vocabulary).
	VocabularyFileUri *string `min:"1" type:"string"`

	// 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.
	//
	// VocabularyName is a required field
	VocabularyName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateMedicalVocabularyInput) String 

func (s UpdateMedicalVocabularyInput) String() string

String returns the string representation

func (*UpdateMedicalVocabularyInput) Validate 

func (s *UpdateMedicalVocabularyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateMedicalVocabularyOutput 

type UpdateMedicalVocabularyOutput struct {

	// The language code for the text file used to update the custom vocabulary.
	// US English (en-US) is the only language supported in Amazon Transcribe Medical.
	LanguageCode LanguageCode `type:"string" enum:"true"`

	// The date and time the vocabulary was updated.
	LastModifiedTime *time.Time `type:"timestamp"`

	// The name of the updated vocabulary.
	VocabularyName *string `min:"1" type:"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 VocabularyState `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

func (UpdateMedicalVocabularyOutput) String 

func (s UpdateMedicalVocabularyOutput) String() string

String returns the string representation

type UpdateMedicalVocabularyRequest 

type UpdateMedicalVocabularyRequest struct {
	*aws.Request
	Input *UpdateMedicalVocabularyInput
	Copy  func(*UpdateMedicalVocabularyInput) UpdateMedicalVocabularyRequest
}

UpdateMedicalVocabularyRequest is the request type for the UpdateMedicalVocabulary API operation.

func (UpdateMedicalVocabularyRequest) Send 

func (r UpdateMedicalVocabularyRequest) Send(ctx context.Context) (*UpdateMedicalVocabularyResponse, error)

Send marshals and sends the UpdateMedicalVocabulary API request.

type UpdateMedicalVocabularyResponse 

type UpdateMedicalVocabularyResponse struct {
	*UpdateMedicalVocabularyOutput
	// contains filtered or unexported fields
}

UpdateMedicalVocabularyResponse is the response type for the UpdateMedicalVocabulary API operation.

func (*UpdateMedicalVocabularyResponse) SDKResponseMetdata 

func (r *UpdateMedicalVocabularyResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateMedicalVocabulary request.

type UpdateVocabularyFilterInput 

type UpdateVocabularyFilterInput struct {

	// 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/how-vocabulary.html#charsets).
	//
	// 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 `min:"1" type:"string"`

	// The name of the vocabulary filter to update. If you try to update a vocabulary
	// filter with the same name as a previous vocabulary filter you will receive
	// a ConflictException error.
	//
	// VocabularyFilterName is a required field
	VocabularyFilterName *string `min:"1" type:"string" required:"true"`

	// 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/how-vocabulary.html#charsets).
	//
	// If you provide a list of words in the Words parameter, you can't use the
	// VocabularyFilterFileUri parameter.
	Words []string `min:"1" type:"list"`
	// contains filtered or unexported fields
}

func (UpdateVocabularyFilterInput) String 

func (s UpdateVocabularyFilterInput) String() string

String returns the string representation

func (*UpdateVocabularyFilterInput) Validate 

func (s *UpdateVocabularyFilterInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateVocabularyFilterOutput 

type UpdateVocabularyFilterOutput struct {

	// The language code of the words in the vocabulary filter.
	LanguageCode LanguageCode `type:"string" enum:"true"`

	// The date and time that the vocabulary filter was updated.
	LastModifiedTime *time.Time `type:"timestamp"`

	// The name of the updated vocabulary filter.
	VocabularyFilterName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateVocabularyFilterOutput) String 

func (s UpdateVocabularyFilterOutput) String() string

String returns the string representation

type UpdateVocabularyFilterRequest 

type UpdateVocabularyFilterRequest struct {
	*aws.Request
	Input *UpdateVocabularyFilterInput
	Copy  func(*UpdateVocabularyFilterInput) UpdateVocabularyFilterRequest
}

UpdateVocabularyFilterRequest is the request type for the UpdateVocabularyFilter API operation.

func (UpdateVocabularyFilterRequest) Send 

func (r UpdateVocabularyFilterRequest) Send(ctx context.Context) (*UpdateVocabularyFilterResponse, error)

Send marshals and sends the UpdateVocabularyFilter API request.

type UpdateVocabularyFilterResponse 

type UpdateVocabularyFilterResponse struct {
	*UpdateVocabularyFilterOutput
	// contains filtered or unexported fields
}

UpdateVocabularyFilterResponse is the response type for the UpdateVocabularyFilter API operation.

func (*UpdateVocabularyFilterResponse) SDKResponseMetdata 

func (r *UpdateVocabularyFilterResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateVocabularyFilter request.

type UpdateVocabularyInput 

type UpdateVocabularyInput struct {

	// The language code of the vocabulary entries.
	//
	// LanguageCode is a required field
	LanguageCode LanguageCode `type:"string" required:"true" enum:"true"`

	// An array of strings containing the vocabulary entries.
	Phrases []string `type:"list"`

	// 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
	//
	// For example:
	//
	// For more information about S3 object names, see Object Keys (http://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 (http://docs.aws.amazon.com/transcribe/latest/dg/how-it-works.html#how-vocabulary).
	VocabularyFileUri *string `min:"1" type:"string"`

	// 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.
	//
	// VocabularyName is a required field
	VocabularyName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateVocabularyInput) String 

func (s UpdateVocabularyInput) String() string

String returns the string representation

func (*UpdateVocabularyInput) Validate 

func (s *UpdateVocabularyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateVocabularyOutput 

type UpdateVocabularyOutput struct {

	// The language code of the vocabulary entries.
	LanguageCode LanguageCode `type:"string" enum:"true"`

	// The date and time that the vocabulary was updated.
	LastModifiedTime *time.Time `type:"timestamp"`

	// The name of the vocabulary that was updated.
	VocabularyName *string `min:"1" type:"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 VocabularyState `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

func (UpdateVocabularyOutput) String 

func (s UpdateVocabularyOutput) String() string

String returns the string representation

type UpdateVocabularyRequest 

type UpdateVocabularyRequest struct {
	*aws.Request
	Input *UpdateVocabularyInput
	Copy  func(*UpdateVocabularyInput) UpdateVocabularyRequest
}

UpdateVocabularyRequest is the request type for the UpdateVocabulary API operation.

func (UpdateVocabularyRequest) Send 

func (r UpdateVocabularyRequest) Send(ctx context.Context) (*UpdateVocabularyResponse, error)

Send marshals and sends the UpdateVocabulary API request.

type UpdateVocabularyResponse 

type UpdateVocabularyResponse struct {
	*UpdateVocabularyOutput
	// contains filtered or unexported fields
}

UpdateVocabularyResponse is the response type for the UpdateVocabulary API operation.

func (*UpdateVocabularyResponse) SDKResponseMetdata 

func (r *UpdateVocabularyResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateVocabulary request.

type VocabularyFilterInfo 

type VocabularyFilterInfo struct {

	// The language code of the words in the vocabulary filter.
	LanguageCode LanguageCode `type:"string" enum:"true"`

	// The date and time that the vocabulary was last updated.
	LastModifiedTime *time.Time `type:"timestamp"`

	// The name of the vocabulary filter. The name must be unique in the account
	// that holds the filter.
	VocabularyFilterName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Provides information about a vocabulary filter.

func (VocabularyFilterInfo) String 

func (s VocabularyFilterInfo) String() string

String returns the string representation

type VocabularyFilterMethod 

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

Enum values for VocabularyFilterMethod

func (VocabularyFilterMethod) MarshalValue 

func (enum VocabularyFilterMethod) MarshalValue() (string, error)

func (VocabularyFilterMethod) MarshalValueBuf 

func (enum VocabularyFilterMethod) MarshalValueBuf(b []byte) ([]byte, error)

type VocabularyInfo 

type VocabularyInfo struct {

	// The language code of the vocabulary entries.
	LanguageCode LanguageCode `type:"string" enum:"true"`

	// The date and time that the vocabulary was last modified.
	LastModifiedTime *time.Time `type:"timestamp"`

	// The name of the vocabulary.
	VocabularyName *string `min:"1" type:"string"`

	// The processing state of the vocabulary. If the state is READY you can use
	// the vocabulary in a StartTranscriptionJob request.
	VocabularyState VocabularyState `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

Provides information about a custom vocabulary.

func (VocabularyInfo) String 

func (s VocabularyInfo) String() string

String returns the string representation

type VocabularyState 

type VocabularyState string
const (
	VocabularyStatePending VocabularyState = "PENDING"
	VocabularyStateReady   VocabularyState = "READY"
	VocabularyStateFailed  VocabularyState = "FAILED"
)

Enum values for VocabularyState

func (VocabularyState) MarshalValue 

func (enum VocabularyState) MarshalValue() (string, error)

func (VocabularyState) MarshalValueBuf 

func (enum VocabularyState) MarshalValueBuf(b []byte) ([]byte, error)

Source Files

View all Source files

Directories

Path Synopsis
Package transcribeiface provides an interface to enable mocking the Amazon Transcribe Service service client for testing your code.
 Package transcribeiface provides an interface to enable mocking the Amazon Transcribe Service service client for testing your code.

Jump to

Keyboard shortcuts

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