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
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package kendra
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/kendra/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Maps users to their groups so that you only need to provide the user ID when
// you issue the query. You can also map sub groups to groups. For example, the
// group "Company Intellectual Property Teams" includes sub groups "Research" and
// "Engineering". These sub groups include their own list of users or people who
// work in these teams. Only users who work in research and engineering, and
// therefore belong in the intellectual property group, can see top-secret company
// documents in their search results. This is useful for user context filtering,
// where search results are filtered based on the user or their group access to
// documents. For more information, see Filtering on user context (https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html)
// . If more than five PUT actions for a group are currently processing, a
// validation exception is thrown.
func (c *Client) PutPrincipalMapping(ctx context.Context, params *PutPrincipalMappingInput, optFns ...func(*Options)) (*PutPrincipalMappingOutput, error) {
if params == nil {
params = &PutPrincipalMappingInput{}
}
result, metadata, err := c.invokeOperation(ctx, "PutPrincipalMapping", params, optFns, c.addOperationPutPrincipalMappingMiddlewares)
if err != nil {
return nil, err
}
out := result.(*PutPrincipalMappingOutput)
out.ResultMetadata = metadata
return out, nil
}
type PutPrincipalMappingInput struct {
// The identifier of the group you want to map its users to.
//
// This member is required.
GroupId *string
// The list that contains your users or sub groups that belong the same group. For
// example, the group "Company" includes the user "CEO" and the sub groups
// "Research", "Engineering", and "Sales and Marketing". If you have more than 1000
// users and/or sub groups for a single group, you need to provide the path to the
// S3 file that lists your users and sub groups for a group. Your sub groups can
// contain more than 1000 users, but the list of sub groups that belong to a group
// (and/or users) must be no more than 1000.
//
// This member is required.
GroupMembers *types.GroupMembers
// The identifier of the index you want to map users to their groups.
//
// This member is required.
IndexId *string
// The identifier of the data source you want to map users to their groups. This
// is useful if a group is tied to multiple data sources, but you only want the
// group to access documents of a certain data source. For example, the groups
// "Research", "Engineering", and "Sales and Marketing" are all tied to the
// company's documents stored in the data sources Confluence and Salesforce.
// However, "Sales and Marketing" team only needs access to customer-related
// documents stored in Salesforce.
DataSourceId *string
// The timestamp identifier you specify to ensure Amazon Kendra does not override
// the latest PUT action with previous actions. The highest number ID, which is
// the ordering ID, is the latest action you want to process and apply on top of
// other actions with lower number IDs. This prevents previous actions with lower
// number IDs from possibly overriding the latest action. The ordering ID can be
// the Unix time of the last update you made to a group members list. You would
// then provide this list when calling PutPrincipalMapping . This ensures your PUT
// action for that updated group with the latest members list doesn't get
// overwritten by earlier PUT actions for the same group which are yet to be
// processed. The default ordering ID is the current Unix time in milliseconds that
// the action was received by Amazon Kendra.
OrderingId *int64
// The Amazon Resource Name (ARN) of a role that has access to the S3 file that
// contains your list of users or sub groups that belong to a group. For more
// information, see IAM roles for Amazon Kendra (https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)
// .
RoleArn *string
noSmithyDocumentSerde
}
type PutPrincipalMappingOutput struct {
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationPutPrincipalMappingMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsAwsjson11_serializeOpPutPrincipalMapping{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpPutPrincipalMapping{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "PutPrincipalMapping"); 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 = addOpPutPrincipalMappingValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opPutPrincipalMapping(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_opPutPrincipalMapping(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "PutPrincipalMapping",
}
}
|
