transcribeservice

package
v2.0.0-preview.4+incom... Latest Latest
Warning

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

 Go to latest Published: May 26, 2018 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Overview

Package transcribeservice 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 transcribeservice package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/transcribeservice/

Using the Client

To 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 TranscribeService for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/transcribeservice/#New

Index

Constants

View Source 
const (

	// ErrCodeBadRequestException for service response error code
	// "BadRequestException".
	//
	// Your request didn't pass one or more validation tests. For example, a name
	// already exists when createing a resource or a name may not exist when getting
	// a transcription job or custom vocabulary. See the exception Message field
	// for more information.
	ErrCodeBadRequestException = "BadRequestException"

	// ErrCodeConflictException for service response error code
	// "ConflictException".
	//
	// The JobName field is a duplicate of a previously entered job name. Resend
	// your request with a different name.
	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 transcription job or custom vocabulary. Check
	// the name and try your request again.
	ErrCodeNotFoundException = "NotFoundException"
)
View Source 
const (
	ServiceName = "transcribe" // Service endpoint prefix API calls made to.
	EndpointsID = ServiceName  // Service ID for Regions and Endpoints metadata.
)

Service information constants

Variables

This section is empty.

Functions

This section is empty.

Types

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 is a required field
	Phrases []string `type:"list" required:"true"`

	// The name of the vocabulary. The name must be unique within an AWS account.
	// The name is case-sensitive.
	//
	// VocabularyName is a required field
	VocabularyName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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

func (CreateVocabularyInput) GoString 

func (s CreateVocabularyInput) GoString() string

GoString returns the string representation

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" timestampFormat:"unix"`

	// 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
}

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

func (CreateVocabularyOutput) GoString 

func (s CreateVocabularyOutput) GoString() string

GoString returns the string representation

func (CreateVocabularyOutput) SDKResponseMetadata 

func (s CreateVocabularyOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

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 a API request type for the CreateVocabulary API operation.

func (CreateVocabularyRequest) Send 

func (r CreateVocabularyRequest) Send() (*CreateVocabularyOutput, error)

Send marshals and sends the CreateVocabulary API 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
}

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

func (DeleteVocabularyInput) GoString 

func (s DeleteVocabularyInput) GoString() string

GoString returns the string representation

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
}

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

func (DeleteVocabularyOutput) GoString 

func (s DeleteVocabularyOutput) GoString() string

GoString returns the string representation

func (DeleteVocabularyOutput) SDKResponseMetadata 

func (s DeleteVocabularyOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

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 a API request type for the DeleteVocabulary API operation.

func (DeleteVocabularyRequest) Send 

func (r DeleteVocabularyRequest) Send() (*DeleteVocabularyOutput, error)

Send marshals and sends the DeleteVocabulary API 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
}

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

func (GetTranscriptionJobInput) GoString 

func (s GetTranscriptionJobInput) GoString() string

GoString returns the string representation

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
}

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

func (GetTranscriptionJobOutput) GoString 

func (s GetTranscriptionJobOutput) GoString() string

GoString returns the string representation

func (GetTranscriptionJobOutput) SDKResponseMetadata 

func (s GetTranscriptionJobOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

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 a API request type for the GetTranscriptionJob API operation.

func (GetTranscriptionJobRequest) Send 

func (r GetTranscriptionJobRequest) Send() (*GetTranscriptionJobOutput, error)

Send marshals and sends the GetTranscriptionJob API 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
}

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

func (GetVocabularyInput) GoString 

func (s GetVocabularyInput) GoString() string

GoString returns the string representation

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" timestampFormat:"unix"`

	// 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
}

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

func (GetVocabularyOutput) GoString 

func (s GetVocabularyOutput) GoString() string

GoString returns the string representation

func (GetVocabularyOutput) SDKResponseMetadata 

func (s GetVocabularyOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

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 a API request type for the GetVocabulary API operation.

func (GetVocabularyRequest) Send 

func (r GetVocabularyRequest) Send() (*GetVocabularyOutput, error)

Send marshals and sends the GetVocabulary API request.

type LanguageCode 

type LanguageCode string
const (
	LanguageCodeEnUs LanguageCode = "en-US"
	LanguageCodeEsUs LanguageCode = "es-US"
)

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 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.
	Status TranscriptionJobStatus `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

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

func (ListTranscriptionJobsInput) GoString 

func (s ListTranscriptionJobsInput) GoString() string

GoString returns the string representation

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
}

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

func (ListTranscriptionJobsOutput) GoString 

func (s ListTranscriptionJobsOutput) GoString() string

GoString returns the string representation

func (ListTranscriptionJobsOutput) SDKResponseMetadata 

func (s ListTranscriptionJobsOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (ListTranscriptionJobsOutput) String 

func (s ListTranscriptionJobsOutput) String() string

String returns the string representation

type ListTranscriptionJobsPager 

type ListTranscriptionJobsPager struct {
	aws.Pager
}

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

func (*ListTranscriptionJobsPager) CurrentPage 

func (p *ListTranscriptionJobsPager) CurrentPage() *ListTranscriptionJobsOutput

type ListTranscriptionJobsRequest 

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

ListTranscriptionJobsRequest is a API request type for the ListTranscriptionJobs API operation.

func (*ListTranscriptionJobsRequest) Paginate 

func (p *ListTranscriptionJobsRequest) Paginate(opts ...aws.Option) ListTranscriptionJobsPager

Paginate pages iterates over the pages of a ListTranscriptionJobsRequest operation, calling the Next method for each page. Using the paginators Next method will depict whether or not there are more pages.

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

   // Example iterating over at most 3 pages of a ListTranscriptionJobs operation.
		req := client.ListTranscriptionJobsRequest(input)
		p := req.Paginate()
		for p.Next() {
			page := p.CurrentPage()
		}

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

func (ListTranscriptionJobsRequest) Send 

func (r ListTranscriptionJobsRequest) Send() (*ListTranscriptionJobsOutput, error)

Send marshals and sends the ListTranscriptionJobs API 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 will return 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
}

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

func (ListVocabulariesInput) GoString 

func (s ListVocabulariesInput) GoString() string

GoString returns the string representation

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 TranscriptionJobStatus `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
}

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

func (ListVocabulariesOutput) GoString 

func (s ListVocabulariesOutput) GoString() string

GoString returns the string representation

func (ListVocabulariesOutput) SDKResponseMetadata 

func (s ListVocabulariesOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (ListVocabulariesOutput) String 

func (s ListVocabulariesOutput) String() string

String returns the string representation

type ListVocabulariesPager 

type ListVocabulariesPager struct {
	aws.Pager
}

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

func (*ListVocabulariesPager) CurrentPage 

func (p *ListVocabulariesPager) CurrentPage() *ListVocabulariesOutput

type ListVocabulariesRequest 

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

ListVocabulariesRequest is a API request type for the ListVocabularies API operation.

func (*ListVocabulariesRequest) Paginate 

func (p *ListVocabulariesRequest) Paginate(opts ...aws.Option) ListVocabulariesPager

Paginate pages iterates over the pages of a ListVocabulariesRequest operation, calling the Next method for each page. Using the paginators Next method will depict whether or not there are more pages.

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

   // Example iterating over at most 3 pages of a ListVocabularies operation.
		req := client.ListVocabulariesRequest(input)
		p := req.Paginate()
		for p.Next() {
			page := p.CurrentPage()
		}

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

func (ListVocabulariesRequest) Send 

func (r ListVocabulariesRequest) Send() (*ListVocabulariesOutput, error)

Send marshals and sends the ListVocabularies API request.

type Media 

type Media struct {

	// The S3 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:
	//
	// https://<aws-region>.amazonaws.com/<bucket-name>/<keyprefix>/<objectkey>
	//
	// For example:
	//
	// https://s3-us-east-1.amazonaws.com/examplebucket/example.mp4
	//
	// https://s3-us-east-1.amazonaws.com/examplebucket/mediadocs/example.mp4
	//
	// 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/Media

func (Media) GoString 

func (s Media) GoString() string

GoString returns the string representation

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 Settings 

type Settings struct {

	// The maximum number of speakers to identify in the input audio. If there are
	// more speakers in the audio than this number, multiple speakers will be 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 job should use speaker recognition to
	// identify different speakers in the input audio. If you set the ShowSpeakerLabels
	// field to true, you must also set the maximum number of speaker labels MaxSpeakerLabels
	// field.
	ShowSpeakerLabels *bool `type:"boolean"`

	// 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/Settings

func (Settings) GoString 

func (s Settings) GoString() string

GoString returns the string representation

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 StartTranscriptionJobInput 

type StartTranscriptionJobInput struct {

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

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

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

	// The name of the job. The name must be unique within an AWS account.
	//
	// TranscriptionJobName is a required field
	TranscriptionJobName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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

func (StartTranscriptionJobInput) GoString 

func (s StartTranscriptionJobInput) GoString() string

GoString returns the string representation

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
}

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

func (StartTranscriptionJobOutput) GoString 

func (s StartTranscriptionJobOutput) GoString() string

GoString returns the string representation

func (StartTranscriptionJobOutput) SDKResponseMetadata 

func (s StartTranscriptionJobOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

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 a API request type for the StartTranscriptionJob API operation.

func (StartTranscriptionJobRequest) Send 

func (r StartTranscriptionJobRequest) Send() (*StartTranscriptionJobOutput, error)

Send marshals and sends the StartTranscriptionJob API request.

type TranscribeService 

type TranscribeService struct {
	*aws.Client
}

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

TranscribeService 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) *TranscribeService

New creates a new instance of the TranscribeService client with a config.

Example: 

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

func (*TranscribeService) CreateVocabularyRequest 

func (c *TranscribeService) 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 the CreateVocabularyRequest method.
req := client.CreateVocabularyRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

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

func (*TranscribeService) DeleteVocabularyRequest 

func (c *TranscribeService) 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 the DeleteVocabularyRequest method.
req := client.DeleteVocabularyRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

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

func (*TranscribeService) GetTranscriptionJobRequest 

func (c *TranscribeService) 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 TranscriptionFileUri field. 

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

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

func (*TranscribeService) GetVocabularyRequest 

func (c *TranscribeService) 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 the GetVocabularyRequest method.
req := client.GetVocabularyRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

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

func (*TranscribeService) ListTranscriptionJobsRequest 

func (c *TranscribeService) 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 the ListTranscriptionJobsRequest method.
req := client.ListTranscriptionJobsRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

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

func (*TranscribeService) ListVocabulariesRequest 

func (c *TranscribeService) 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 the ListVocabulariesRequest method.
req := client.ListVocabulariesRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

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

func (*TranscribeService) StartTranscriptionJobRequest 

func (c *TranscribeService) 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 the StartTranscriptionJobRequest method.
req := client.StartTranscriptionJobRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

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

func (*TranscribeService) UpdateVocabularyRequest 

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

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

Updates an existing vocabulary with new values. 

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

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

type Transcript 

type Transcript struct {

	// The S3 location where the transcription result is stored. Use this URI to
	// access the results of the transcription job.
	TranscriptFileUri *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Describes the output of a transcription job. Please also see https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/Transcript

func (Transcript) GoString 

func (s Transcript) GoString() string

GoString returns the string representation

func (Transcript) String 

func (s Transcript) String() string

String returns the string representation

type TranscriptionJob 

type TranscriptionJob struct {

	// Timestamp of the date and time that the job completed.
	CompletionTime *time.Time `type:"timestamp" timestampFormat:"unix"`

	// Timestamp of the date and time that the job was created.
	CreationTime *time.Time `type:"timestamp" timestampFormat:"unix"`

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

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

	// An object that describes the input media for a 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.
	Settings *Settings `type:"structure"`

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

	// A name to identify 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/TranscriptionJob

func (TranscriptionJob) GoString 

func (s TranscriptionJob) GoString() string

GoString returns the string representation

func (TranscriptionJob) String 

func (s TranscriptionJob) String() string

String returns the string representation

type TranscriptionJobStatus 

type TranscriptionJobStatus string
const (
	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 {

	// Timestamp of the date and time that the job completed.
	CompletionTime *time.Time `type:"timestamp" timestampFormat:"unix"`

	// Timestamp of the date and time that the job was created.
	CreationTime *time.Time `type:"timestamp" timestampFormat:"unix"`

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

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

	// The name assigned to the transcription job when it was created.
	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. Please also see https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/TranscriptionJobSummary

func (TranscriptionJobSummary) GoString 

func (s TranscriptionJobSummary) GoString() string

GoString returns the string representation

func (TranscriptionJobSummary) String 

func (s TranscriptionJobSummary) String() string

String returns the string representation

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 is a required field
	Phrases []string `type:"list" required:"true"`

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

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

func (UpdateVocabularyInput) GoString 

func (s UpdateVocabularyInput) GoString() string

GoString returns the string representation

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" timestampFormat:"unix"`

	// 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
}

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

func (UpdateVocabularyOutput) GoString 

func (s UpdateVocabularyOutput) GoString() string

GoString returns the string representation

func (UpdateVocabularyOutput) SDKResponseMetadata 

func (s UpdateVocabularyOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

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 a API request type for the UpdateVocabulary API operation.

func (UpdateVocabularyRequest) Send 

func (r UpdateVocabularyRequest) Send() (*UpdateVocabularyOutput, error)

Send marshals and sends the UpdateVocabulary API request.

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" timestampFormat:"unix"`

	// 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/VocabularyInfo

func (VocabularyInfo) GoString 

func (s VocabularyInfo) GoString() string

GoString returns the string representation

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 transcribeserviceiface provides an interface to enable mocking the Amazon Transcribe Service service client for testing your code.
 Package transcribeserviceiface 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.