transcribeservice

package
v0.6.1-0...-1b08b9c Latest Latest
Warning

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

 Go to latest Published: Apr 1, 2018 License: Apache-2.0 Imports: 7 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 contact 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 (
	// LanguageCodeEnUs is a LanguageCode enum value
	LanguageCodeEnUs = "en-US"

	// LanguageCodeEsUs is a LanguageCode enum value
	LanguageCodeEsUs = "es-US"
)
View Source 
const (
	// MediaFormatMp3 is a MediaFormat enum value
	MediaFormatMp3 = "mp3"

	// MediaFormatMp4 is a MediaFormat enum value
	MediaFormatMp4 = "mp4"

	// MediaFormatWav is a MediaFormat enum value
	MediaFormatWav = "wav"

	// MediaFormatFlac is a MediaFormat enum value
	MediaFormatFlac = "flac"
)
View Source 
const (
	// TranscriptionJobStatusInProgress is a TranscriptionJobStatus enum value
	TranscriptionJobStatusInProgress = "IN_PROGRESS"

	// TranscriptionJobStatusFailed is a TranscriptionJobStatus enum value
	TranscriptionJobStatusFailed = "FAILED"

	// TranscriptionJobStatusCompleted is a TranscriptionJobStatus enum value
	TranscriptionJobStatusCompleted = "COMPLETED"
)
View Source 
const (

	// ErrCodeBadRequestException for service response error code
	// "BadRequestException".
	//
	// There is a problem with one of the input fields. Check the S3 bucket name,
	// make sure that the job name is not a duplicate, and confirm that you are
	// using the correct file format. Then resend your request.
	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 longer than
	// 2 hours. 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 job. Check the job 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 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) GoString 

func (s GetTranscriptionJobInput) GoString() string

GoString returns the string representation

func (*GetTranscriptionJobInput) SetTranscriptionJobName 

func (s *GetTranscriptionJobInput) SetTranscriptionJobName(v string) *GetTranscriptionJobInput

SetTranscriptionJobName sets the TranscriptionJobName field's value.

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) GoString 

func (s GetTranscriptionJobOutput) GoString() string

GoString returns the string representation

func (*GetTranscriptionJobOutput) SetTranscriptionJob 

func (s *GetTranscriptionJobOutput) SetTranscriptionJob(v *TranscriptionJob) *GetTranscriptionJobOutput

SetTranscriptionJob sets the TranscriptionJob field's value.

func (GetTranscriptionJobOutput) String 

func (s GetTranscriptionJobOutput) String() string

String returns the string representation

type ListTranscriptionJobsInput 

type ListTranscriptionJobsInput struct {

	// The maximum number of jobs to return in the response.
	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 is a required field
	Status *string `type:"string" required:"true" enum:"TranscriptionJobStatus"`
	// contains filtered or unexported fields
}

func (ListTranscriptionJobsInput) GoString 

func (s ListTranscriptionJobsInput) GoString() string

GoString returns the string representation

func (*ListTranscriptionJobsInput) SetMaxResults 

func (s *ListTranscriptionJobsInput) SetMaxResults(v int64) *ListTranscriptionJobsInput

SetMaxResults sets the MaxResults field's value.

func (*ListTranscriptionJobsInput) SetNextToken 

func (s *ListTranscriptionJobsInput) SetNextToken(v string) *ListTranscriptionJobsInput

SetNextToken sets the NextToken field's value.

func (*ListTranscriptionJobsInput) SetStatus 

func (s *ListTranscriptionJobsInput) SetStatus(v string) *ListTranscriptionJobsInput

SetStatus sets the Status field's value.

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

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

func (ListTranscriptionJobsOutput) GoString 

func (s ListTranscriptionJobsOutput) GoString() string

GoString returns the string representation

func (*ListTranscriptionJobsOutput) SetNextToken 

func (s *ListTranscriptionJobsOutput) SetNextToken(v string) *ListTranscriptionJobsOutput

SetNextToken sets the NextToken field's value.

func (*ListTranscriptionJobsOutput) SetStatus 

func (s *ListTranscriptionJobsOutput) SetStatus(v string) *ListTranscriptionJobsOutput

SetStatus sets the Status field's value.

func (*ListTranscriptionJobsOutput) SetTranscriptionJobSummaries 

func (s *ListTranscriptionJobsOutput) SetTranscriptionJobSummaries(v []*TranscriptionJobSummary) *ListTranscriptionJobsOutput

SetTranscriptionJobSummaries sets the TranscriptionJobSummaries field's value.

func (ListTranscriptionJobsOutput) String 

func (s ListTranscriptionJobsOutput) String() string

String returns the string representation

type Media 

type Media struct {

	// The S3 location of the input media file. The general form is:
	//
	// https://<aws-region>.amazonaws.com/<bucket-name>/<keyprefix>/<objectkey>
	//
	// For example:
	//
	// https://s3-us-west-2.amazonaws.com/examplebucket/example.mp4
	//
	// https://s3-us-west-2.amazonaws.com/examplebucket/mediadocs/example.mp4
	MediaFileUri *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Describes the input media file in a transcription request.

func (Media) GoString 

func (s Media) GoString() string

GoString returns the string representation

func (*Media) SetMediaFileUri 

func (s *Media) SetMediaFileUri(v string) *Media

SetMediaFileUri sets the MediaFileUri field's value.

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 StartTranscriptionJobInput 

type StartTranscriptionJobInput struct {

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

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

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

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

func (StartTranscriptionJobInput) GoString 

func (s StartTranscriptionJobInput) GoString() string

GoString returns the string representation

func (*StartTranscriptionJobInput) SetLanguageCode 

func (s *StartTranscriptionJobInput) SetLanguageCode(v string) *StartTranscriptionJobInput

SetLanguageCode sets the LanguageCode field's value.

func (*StartTranscriptionJobInput) SetMedia 

func (s *StartTranscriptionJobInput) SetMedia(v *Media) *StartTranscriptionJobInput

SetMedia sets the Media field's value.

func (*StartTranscriptionJobInput) SetMediaFormat 

func (s *StartTranscriptionJobInput) SetMediaFormat(v string) *StartTranscriptionJobInput

SetMediaFormat sets the MediaFormat field's value.

func (*StartTranscriptionJobInput) SetMediaSampleRateHertz 

func (s *StartTranscriptionJobInput) SetMediaSampleRateHertz(v int64) *StartTranscriptionJobInput

SetMediaSampleRateHertz sets the MediaSampleRateHertz field's value.

func (*StartTranscriptionJobInput) SetTranscriptionJobName 

func (s *StartTranscriptionJobInput) SetTranscriptionJobName(v string) *StartTranscriptionJobInput

SetTranscriptionJobName sets the TranscriptionJobName field's value.

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) GoString 

func (s StartTranscriptionJobOutput) GoString() string

GoString returns the string representation

func (*StartTranscriptionJobOutput) SetTranscriptionJob 

func (s *StartTranscriptionJobOutput) SetTranscriptionJob(v *TranscriptionJob) *StartTranscriptionJobOutput

SetTranscriptionJob sets the TranscriptionJob field's value.

func (StartTranscriptionJobOutput) String 

func (s StartTranscriptionJobOutput) String() string

String returns the string representation

type TranscribeService 

type TranscribeService struct {
	*client.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(p client.ConfigProvider, cfgs ...*aws.Config) *TranscribeService

New creates a new instance of the TranscribeService client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example: 

// Create a TranscribeService client from just a session.
svc := transcribeservice.New(mySession)

// Create a TranscribeService client with additional configuration
svc := transcribeservice.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*TranscribeService) GetTranscriptionJob 

func (c *TranscribeService) GetTranscriptionJob(input *GetTranscriptionJobInput) (*GetTranscriptionJobOutput, error)

GetTranscriptionJob API operation for Amazon Transcribe Service.

Returns information about a transcription job. To see the status of the job, check the Status field. If the status is COMPLETE, the job is finished and you can find the results at the location specified in the TranscriptionFileUri field.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Transcribe Service's API operation GetTranscriptionJob for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException" There is a problem with one of the input fields. Check the S3 bucket name, make sure that the job name is not a duplicate, and confirm that you are using the correct file format. Then resend your request.

  • ErrCodeLimitExceededException "LimitExceededException" Either you have sent too many requests or your input file is longer than 2 hours. Wait before you resend your request, or use a smaller file and resend the request.

  • ErrCodeInternalFailureException "InternalFailureException" There was an internal error. Check the error message and try your request again.

  • ErrCodeNotFoundException "NotFoundException" We can't find the requested job. Check the job name and try your request again.

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

func (*TranscribeService) GetTranscriptionJobRequest 

func (c *TranscribeService) GetTranscriptionJobRequest(input *GetTranscriptionJobInput) (req *request.Request, output *GetTranscriptionJobOutput)

GetTranscriptionJobRequest generates a "aws/request.Request" representing the client's request for the GetTranscriptionJob operation. The "output" return value will be populated with the request's response once the request complets successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetTranscriptionJob for more information on using the GetTranscriptionJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetTranscriptionJobRequest method.
req, resp := client.GetTranscriptionJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*TranscribeService) GetTranscriptionJobWithContext 

func (c *TranscribeService) GetTranscriptionJobWithContext(ctx aws.Context, input *GetTranscriptionJobInput, opts ...request.Option) (*GetTranscriptionJobOutput, error)

GetTranscriptionJobWithContext is the same as GetTranscriptionJob with the addition of the ability to pass a context and additional request options.

See GetTranscriptionJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*TranscribeService) ListTranscriptionJobs 

func (c *TranscribeService) ListTranscriptionJobs(input *ListTranscriptionJobsInput) (*ListTranscriptionJobsOutput, error)

ListTranscriptionJobs API operation for Amazon Transcribe Service.

Lists transcription jobs with the specified status.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Transcribe Service's API operation ListTranscriptionJobs for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException" There is a problem with one of the input fields. Check the S3 bucket name, make sure that the job name is not a duplicate, and confirm that you are using the correct file format. Then resend your request.

  • ErrCodeLimitExceededException "LimitExceededException" Either you have sent too many requests or your input file is longer than 2 hours. Wait before you resend your request, or use a smaller file and resend the request.

  • ErrCodeInternalFailureException "InternalFailureException" There was an internal error. Check the error message and try your request again.

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

func (*TranscribeService) ListTranscriptionJobsPages 

func (c *TranscribeService) ListTranscriptionJobsPages(input *ListTranscriptionJobsInput, fn func(*ListTranscriptionJobsOutput, bool) bool) error

ListTranscriptionJobsPages iterates over the pages of a ListTranscriptionJobs operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListTranscriptionJobs method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a ListTranscriptionJobs operation.
pageNum := 0
err := client.ListTranscriptionJobsPages(params,
    func(page *ListTranscriptionJobsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*TranscribeService) ListTranscriptionJobsPagesWithContext 

func (c *TranscribeService) ListTranscriptionJobsPagesWithContext(ctx aws.Context, input *ListTranscriptionJobsInput, fn func(*ListTranscriptionJobsOutput, bool) bool, opts ...request.Option) error

ListTranscriptionJobsPagesWithContext same as ListTranscriptionJobsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*TranscribeService) ListTranscriptionJobsRequest 

func (c *TranscribeService) ListTranscriptionJobsRequest(input *ListTranscriptionJobsInput) (req *request.Request, output *ListTranscriptionJobsOutput)

ListTranscriptionJobsRequest generates a "aws/request.Request" representing the client's request for the ListTranscriptionJobs operation. The "output" return value will be populated with the request's response once the request complets successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTranscriptionJobs for more information on using the ListTranscriptionJobs API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListTranscriptionJobsRequest method.
req, resp := client.ListTranscriptionJobsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*TranscribeService) ListTranscriptionJobsWithContext 

func (c *TranscribeService) ListTranscriptionJobsWithContext(ctx aws.Context, input *ListTranscriptionJobsInput, opts ...request.Option) (*ListTranscriptionJobsOutput, error)

ListTranscriptionJobsWithContext is the same as ListTranscriptionJobs with the addition of the ability to pass a context and additional request options.

See ListTranscriptionJobs for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*TranscribeService) StartTranscriptionJob 

func (c *TranscribeService) StartTranscriptionJob(input *StartTranscriptionJobInput) (*StartTranscriptionJobOutput, error)

StartTranscriptionJob API operation for Amazon Transcribe Service.

Starts an asynchronous job to transcribe speech to text.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Transcribe Service's API operation StartTranscriptionJob for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException" There is a problem with one of the input fields. Check the S3 bucket name, make sure that the job name is not a duplicate, and confirm that you are using the correct file format. Then resend your request.

  • ErrCodeLimitExceededException "LimitExceededException" Either you have sent too many requests or your input file is longer than 2 hours. Wait before you resend your request, or use a smaller file and resend the request.

  • ErrCodeInternalFailureException "InternalFailureException" There was an internal error. Check the error message and try your request again.

  • ErrCodeConflictException "ConflictException" The JobName field is a duplicate of a previously entered job name. Resend your request with a different name.

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

func (*TranscribeService) StartTranscriptionJobRequest 

func (c *TranscribeService) StartTranscriptionJobRequest(input *StartTranscriptionJobInput) (req *request.Request, output *StartTranscriptionJobOutput)

StartTranscriptionJobRequest generates a "aws/request.Request" representing the client's request for the StartTranscriptionJob operation. The "output" return value will be populated with the request's response once the request complets successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartTranscriptionJob for more information on using the StartTranscriptionJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the StartTranscriptionJobRequest method.
req, resp := client.StartTranscriptionJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*TranscribeService) StartTranscriptionJobWithContext 

func (c *TranscribeService) StartTranscriptionJobWithContext(ctx aws.Context, input *StartTranscriptionJobInput, opts ...request.Option) (*StartTranscriptionJobOutput, error)

StartTranscriptionJobWithContext is the same as StartTranscriptionJob with the addition of the ability to pass a context and additional request options.

See StartTranscriptionJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type Transcript 

type Transcript struct {

	// The S3 location where the transcription result is stored. The general form
	// of this Uri is:
	//
	// https://<aws-region>.amazonaws.com/<bucket-name>/<keyprefix>/<objectkey>
	//
	// For example:
	//
	// https://s3-us-west-2.amazonaws.com/examplebucket/example.json
	//
	// https://s3-us-west-2.amazonaws.com/examplebucket/mediadocs/example.json
	TranscriptFileUri *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Describes the output of a transcription job.

func (Transcript) GoString 

func (s Transcript) GoString() string

GoString returns the string representation

func (*Transcript) SetTranscriptFileUri 

func (s *Transcript) SetTranscriptFileUri(v string) *Transcript

SetTranscriptFileUri sets the TranscriptFileUri field's value.

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

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

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

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

	// 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 identifier assigned to the job when it was created.
	TranscriptionJobStatus *string `type:"string" enum:"TranscriptionJobStatus"`
	// contains filtered or unexported fields
}

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

func (TranscriptionJob) GoString 

func (s TranscriptionJob) GoString() string

GoString returns the string representation

func (*TranscriptionJob) SetCompletionTime 

func (s *TranscriptionJob) SetCompletionTime(v time.Time) *TranscriptionJob

SetCompletionTime sets the CompletionTime field's value.

func (*TranscriptionJob) SetCreationTime 

func (s *TranscriptionJob) SetCreationTime(v time.Time) *TranscriptionJob

SetCreationTime sets the CreationTime field's value.

func (*TranscriptionJob) SetFailureReason 

func (s *TranscriptionJob) SetFailureReason(v string) *TranscriptionJob

SetFailureReason sets the FailureReason field's value.

func (*TranscriptionJob) SetLanguageCode 

func (s *TranscriptionJob) SetLanguageCode(v string) *TranscriptionJob

SetLanguageCode sets the LanguageCode field's value.

func (*TranscriptionJob) SetMedia 

func (s *TranscriptionJob) SetMedia(v *Media) *TranscriptionJob

SetMedia sets the Media field's value.

func (*TranscriptionJob) SetMediaFormat 

func (s *TranscriptionJob) SetMediaFormat(v string) *TranscriptionJob

SetMediaFormat sets the MediaFormat field's value.

func (*TranscriptionJob) SetMediaSampleRateHertz 

func (s *TranscriptionJob) SetMediaSampleRateHertz(v int64) *TranscriptionJob

SetMediaSampleRateHertz sets the MediaSampleRateHertz field's value.

func (*TranscriptionJob) SetTranscript 

func (s *TranscriptionJob) SetTranscript(v *Transcript) *TranscriptionJob

SetTranscript sets the Transcript field's value.

func (*TranscriptionJob) SetTranscriptionJobName 

func (s *TranscriptionJob) SetTranscriptionJobName(v string) *TranscriptionJob

SetTranscriptionJobName sets the TranscriptionJobName field's value.

func (*TranscriptionJob) SetTranscriptionJobStatus 

func (s *TranscriptionJob) SetTranscriptionJobStatus(v string) *TranscriptionJob

SetTranscriptionJobStatus sets the TranscriptionJobStatus field's value.

func (TranscriptionJob) String 

func (s TranscriptionJob) String() string

String returns the string representation

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

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

Provides a summary of information about a transcription job.

func (TranscriptionJobSummary) GoString 

func (s TranscriptionJobSummary) GoString() string

GoString returns the string representation

func (*TranscriptionJobSummary) SetCompletionTime 

func (s *TranscriptionJobSummary) SetCompletionTime(v time.Time) *TranscriptionJobSummary

SetCompletionTime sets the CompletionTime field's value.

func (*TranscriptionJobSummary) SetCreationTime 

func (s *TranscriptionJobSummary) SetCreationTime(v time.Time) *TranscriptionJobSummary

SetCreationTime sets the CreationTime field's value.

func (*TranscriptionJobSummary) SetFailureReason 

func (s *TranscriptionJobSummary) SetFailureReason(v string) *TranscriptionJobSummary

SetFailureReason sets the FailureReason field's value.

func (*TranscriptionJobSummary) SetLanguageCode 

func (s *TranscriptionJobSummary) SetLanguageCode(v string) *TranscriptionJobSummary

SetLanguageCode sets the LanguageCode field's value.

func (*TranscriptionJobSummary) SetTranscriptionJobName 

func (s *TranscriptionJobSummary) SetTranscriptionJobName(v string) *TranscriptionJobSummary

SetTranscriptionJobName sets the TranscriptionJobName field's value.

func (*TranscriptionJobSummary) SetTranscriptionJobStatus 

func (s *TranscriptionJobSummary) SetTranscriptionJobStatus(v string) *TranscriptionJobSummary

SetTranscriptionJobStatus sets the TranscriptionJobStatus field's value.

func (TranscriptionJobSummary) String 

func (s TranscriptionJobSummary) String() string

String returns the string representation

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.