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 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package comprehend
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/comprehend/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Creates an entity recognizer using submitted files. After your
// CreateEntityRecognizer request is submitted, you can check job status using the
// DescribeEntityRecognizer API.
func (c *Client) CreateEntityRecognizer(ctx context.Context, params *CreateEntityRecognizerInput, optFns ...func(*Options)) (*CreateEntityRecognizerOutput, error) {
if params == nil {
params = &CreateEntityRecognizerInput{}
}
result, metadata, err := c.invokeOperation(ctx, "CreateEntityRecognizer", params, optFns, c.addOperationCreateEntityRecognizerMiddlewares)
if err != nil {
return nil, err
}
out := result.(*CreateEntityRecognizerOutput)
out.ResultMetadata = metadata
return out, nil
}
type CreateEntityRecognizerInput struct {
// The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend
// read access to your input data.
//
// This member is required.
DataAccessRoleArn *string
// Specifies the format and location of the input data. The S3 bucket containing
// the input data must be located in the same Region as the entity recognizer being
// created.
//
// This member is required.
InputDataConfig *types.EntityRecognizerInputDataConfig
// You can specify any of the following languages: English ("en"), Spanish ("es"),
// French ("fr"), Italian ("it"), German ("de"), or Portuguese ("pt"). If you plan
// to use this entity recognizer with PDF, Word, or image input files, you must
// specify English as the language. All training documents must be in the same
// language.
//
// This member is required.
LanguageCode types.LanguageCode
// The name given to the newly created recognizer. Recognizer names can be a
// maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores
// (_) are allowed. The name must be unique in the account/Region.
//
// This member is required.
RecognizerName *string
// A unique identifier for the request. If you don't set the client request token,
// Amazon Comprehend generates one.
ClientRequestToken *string
// ID for the KMS key that Amazon Comprehend uses to encrypt trained custom
// models. The ModelKmsKeyId can be either of the following formats:
// - KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
// - Amazon Resource Name (ARN) of a KMS Key:
// "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
ModelKmsKeyId *string
// The JSON resource-based policy to attach to your custom entity recognizer
// model. You can use this policy to allow another Amazon Web Services account to
// import your custom model. Provide your JSON as a UTF-8 encoded string without
// line breaks. To provide valid JSON for your policy, enclose the attribute names
// and values in double quotes. If the JSON body is also enclosed in double quotes,
// then you must escape the double quotes that are inside the policy:
// "{\"attribute\": \"value\", \"attribute\": [\"value\"]}" To avoid escaping
// quotes, you can use single quotes to enclose the policy and double quotes to
// enclose the JSON names and values: '{"attribute": "value", "attribute":
// ["value"]}'
ModelPolicy *string
// Tags to associate with the entity recognizer. A tag is a key-value pair that
// adds as a metadata to a resource used by Amazon Comprehend. For example, a tag
// with "Sales" as the key might be added to a resource to indicate its use by the
// sales department.
Tags []types.Tag
// The version name given to the newly created recognizer. Version names can be a
// maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores
// (_) are allowed. The version name must be unique among all models with the same
// recognizer name in the account/Region.
VersionName *string
// ID for the Amazon Web Services Key Management Service (KMS) key that Amazon
// Comprehend uses to encrypt data on the storage volume attached to the ML compute
// instance(s) that process the analysis job. The VolumeKmsKeyId can be either of
// the following formats:
// - KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
// - Amazon Resource Name (ARN) of a KMS Key:
// "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
VolumeKmsKeyId *string
// Configuration parameters for an optional private Virtual Private Cloud (VPC)
// containing the resources you are using for your custom entity recognizer. For
// more information, see Amazon VPC (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html)
// .
VpcConfig *types.VpcConfig
noSmithyDocumentSerde
}
type CreateEntityRecognizerOutput struct {
// The Amazon Resource Name (ARN) that identifies the entity recognizer.
EntityRecognizerArn *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationCreateEntityRecognizerMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsAwsjson11_serializeOpCreateEntityRecognizer{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpCreateEntityRecognizer{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "CreateEntityRecognizer"); 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 = addIdempotencyToken_opCreateEntityRecognizerMiddleware(stack, options); err != nil {
return err
}
if err = addOpCreateEntityRecognizerValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opCreateEntityRecognizer(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
}
type idempotencyToken_initializeOpCreateEntityRecognizer struct {
tokenProvider IdempotencyTokenProvider
}
func (*idempotencyToken_initializeOpCreateEntityRecognizer) ID() string {
return "OperationIdempotencyTokenAutoFill"
}
func (m *idempotencyToken_initializeOpCreateEntityRecognizer) HandleInitialize(ctx context.Context, in middleware.InitializeInput, next middleware.InitializeHandler) (
out middleware.InitializeOutput, metadata middleware.Metadata, err error,
) {
if m.tokenProvider == nil {
return next.HandleInitialize(ctx, in)
}
input, ok := in.Parameters.(*CreateEntityRecognizerInput)
if !ok {
return out, metadata, fmt.Errorf("expected middleware input to be of type *CreateEntityRecognizerInput ")
}
if input.ClientRequestToken == nil {
t, err := m.tokenProvider.GetIdempotencyToken()
if err != nil {
return out, metadata, err
}
input.ClientRequestToken = &t
}
return next.HandleInitialize(ctx, in)
}
func addIdempotencyToken_opCreateEntityRecognizerMiddleware(stack *middleware.Stack, cfg Options) error {
return stack.Initialize.Add(&idempotencyToken_initializeOpCreateEntityRecognizer{tokenProvider: cfg.IdempotencyTokenProvider}, middleware.Before)
}
func newServiceMetadataMiddleware_opCreateEntityRecognizer(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "CreateEntityRecognizer",
}
}
|