-
Notifications
You must be signed in to change notification settings - Fork 594
/
api_op_StartPiiEntitiesDetectionJob.go
214 lines (185 loc) · 6.94 KB
/
api_op_StartPiiEntitiesDetectionJob.go
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
// 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"
)
// Starts an asynchronous PII entity detection job for a collection of documents.
func (c *Client) StartPiiEntitiesDetectionJob(ctx context.Context, params *StartPiiEntitiesDetectionJobInput, optFns ...func(*Options)) (*StartPiiEntitiesDetectionJobOutput, error) {
if params == nil {
params = &StartPiiEntitiesDetectionJobInput{}
}
result, metadata, err := c.invokeOperation(ctx, "StartPiiEntitiesDetectionJob", params, optFns, c.addOperationStartPiiEntitiesDetectionJobMiddlewares)
if err != nil {
return nil, err
}
out := result.(*StartPiiEntitiesDetectionJobOutput)
out.ResultMetadata = metadata
return out, nil
}
type StartPiiEntitiesDetectionJobInput 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
// The input properties for a PII entities detection job.
//
// This member is required.
InputDataConfig *types.InputDataConfig
// The language of the input documents. Currently, English is the only valid
// language.
//
// This member is required.
LanguageCode types.LanguageCode
// Specifies whether the output provides the locations (offsets) of PII entities
// or a file in which PII entities are redacted.
//
// This member is required.
Mode types.PiiEntitiesDetectionMode
// Provides configuration parameters for the output of PII entity detection jobs.
//
// This member is required.
OutputDataConfig *types.OutputDataConfig
// A unique identifier for the request. If you don't set the client request token,
// Amazon Comprehend generates one.
ClientRequestToken *string
// The identifier of the job.
JobName *string
// Provides configuration parameters for PII entity redaction. This parameter is
// required if you set the Mode parameter to ONLY_REDACTION . In that case, you
// must provide a RedactionConfig definition that includes the PiiEntityTypes
// parameter.
RedactionConfig *types.RedactionConfig
// Tags to associate with the PII entities detection job. A tag is a key-value
// pair that adds 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
noSmithyDocumentSerde
}
type StartPiiEntitiesDetectionJobOutput struct {
// The Amazon Resource Name (ARN) of the PII entity detection job. It is a unique,
// fully qualified identifier for the job. It includes the Amazon Web Services
// account, Amazon Web Services Region, and the job ID. The format of the ARN is as
// follows: arn::comprehend:::pii-entities-detection-job/ The following is an
// example job ARN:
// arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/1234abcd12ab34cd56ef1234567890ab
JobArn *string
// The identifier generated for the job.
JobId *string
// The status of the job.
JobStatus types.JobStatus
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationStartPiiEntitiesDetectionJobMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsAwsjson11_serializeOpStartPiiEntitiesDetectionJob{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpStartPiiEntitiesDetectionJob{}, middleware.After)
if 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 = addHTTPSignerV4Middleware(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); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addIdempotencyToken_opStartPiiEntitiesDetectionJobMiddleware(stack, options); err != nil {
return err
}
if err = addOpStartPiiEntitiesDetectionJobValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opStartPiiEntitiesDetectionJob(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
}
return nil
}
type idempotencyToken_initializeOpStartPiiEntitiesDetectionJob struct {
tokenProvider IdempotencyTokenProvider
}
func (*idempotencyToken_initializeOpStartPiiEntitiesDetectionJob) ID() string {
return "OperationIdempotencyTokenAutoFill"
}
func (m *idempotencyToken_initializeOpStartPiiEntitiesDetectionJob) 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.(*StartPiiEntitiesDetectionJobInput)
if !ok {
return out, metadata, fmt.Errorf("expected middleware input to be of type *StartPiiEntitiesDetectionJobInput ")
}
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_opStartPiiEntitiesDetectionJobMiddleware(stack *middleware.Stack, cfg Options) error {
return stack.Initialize.Add(&idempotencyToken_initializeOpStartPiiEntitiesDetectionJob{tokenProvider: cfg.IdempotencyTokenProvider}, middleware.Before)
}
func newServiceMetadataMiddleware_opStartPiiEntitiesDetectionJob(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "comprehend",
OperationName: "StartPiiEntitiesDetectionJob",
}
}