1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package transcribe
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/transcribe/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
"time"
)
// Updates an existing custom vocabulary with new values. This operation
// overwrites all existing information with your new values; you cannot append new
// terms onto an existing custom vocabulary.
func (c *Client) UpdateVocabulary(ctx context.Context, params *UpdateVocabularyInput, optFns ...func(*Options)) (*UpdateVocabularyOutput, error) {
if params == nil {
params = &UpdateVocabularyInput{}
}
result, metadata, err := c.invokeOperation(ctx, "UpdateVocabulary", params, optFns, c.addOperationUpdateVocabularyMiddlewares)
if err != nil {
return nil, err
}
out := result.(*UpdateVocabularyOutput)
out.ResultMetadata = metadata
return out, nil
}
type UpdateVocabularyInput struct {
// The language code that represents the language of the entries in the custom
// vocabulary you want to update. Each custom vocabulary must contain terms in only
// one language. A custom vocabulary can only be used to transcribe files in the
// same language as the custom vocabulary. For example, if you create a custom
// vocabulary using US English ( en-US ), you can only apply this custom vocabulary
// to files that contain English audio. For a list of supported languages and their
// associated language codes, refer to the Supported languages (https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html)
// table.
//
// This member is required.
LanguageCode types.LanguageCode
// The name of the custom vocabulary you want to update. Custom vocabulary names
// are case sensitive.
//
// This member is required.
VocabularyName *string
// The Amazon Resource Name (ARN) of an IAM role that has permissions to access
// the Amazon S3 bucket that contains your input files (in this case, your custom
// vocabulary). If the role that you specify doesn’t have the appropriate
// permissions to access the specified Amazon S3 location, your request fails. IAM
// role ARNs have the format arn:partition:iam::account:role/role-name-with-path .
// For example: arn:aws:iam::111122223333:role/Admin . For more information, see
// IAM ARNs (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns)
// .
DataAccessRoleArn *string
// Use this parameter if you want to update your custom vocabulary by including
// all desired terms, as comma-separated values, within your request. The other
// option for updating your custom vocabulary is to save your entries in a text
// file and upload them to an Amazon S3 bucket, then specify the location of your
// file using the VocabularyFileUri parameter. Note that if you include Phrases in
// your request, you cannot use VocabularyFileUri ; you must choose one or the
// other. Each language has a character set that contains all allowed characters
// for that specific language. If you use unsupported characters, your custom
// vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies (https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html)
// to get the character set for your language.
Phrases []string
// The Amazon S3 location of the text file that contains your custom vocabulary.
// The URI must be located in the same Amazon Web Services Region as the resource
// you're calling. Here's an example URI path:
// s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt Note that if you include
// VocabularyFileUri in your request, you cannot use the Phrases flag; you must
// choose one or the other.
VocabularyFileUri *string
noSmithyDocumentSerde
}
type UpdateVocabularyOutput struct {
// The language code you selected for your custom vocabulary.
LanguageCode types.LanguageCode
// The date and time the specified custom vocabulary was last updated. Timestamps
// are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example,
// 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.
LastModifiedTime *time.Time
// The name of the updated custom vocabulary.
VocabularyName *string
// The processing state of your custom vocabulary. If the state is READY , you can
// use the custom vocabulary in a StartTranscriptionJob request.
VocabularyState types.VocabularyState
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationUpdateVocabularyMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsAwsjson11_serializeOpUpdateVocabulary{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpUpdateVocabulary{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "UpdateVocabulary"); err != nil {
return fmt.Errorf("add protocol finalizers: %v", err)
}
if err = addlegacyEndpointContextSetter(stack, options); err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack, options); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
return err
}
if err = addOpUpdateVocabularyValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opUpdateVocabulary(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
if err = addDisableHTTPSMiddleware(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opUpdateVocabulary(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "UpdateVocabulary",
}
}
|