-
Notifications
You must be signed in to change notification settings - Fork 598
/
api_op_UpdateAccess.go
247 lines (224 loc) · 9.08 KB
/
api_op_UpdateAccess.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
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
// Code generated by smithy-go-codegen DO NOT EDIT.
package transfer
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/service/transfer/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Allows you to update parameters for the access specified in the ServerID and
// ExternalID parameters.
func (c *Client) UpdateAccess(ctx context.Context, params *UpdateAccessInput, optFns ...func(*Options)) (*UpdateAccessOutput, error) {
if params == nil {
params = &UpdateAccessInput{}
}
result, metadata, err := c.invokeOperation(ctx, "UpdateAccess", params, optFns, c.addOperationUpdateAccessMiddlewares)
if err != nil {
return nil, err
}
out := result.(*UpdateAccessOutput)
out.ResultMetadata = metadata
return out, nil
}
type UpdateAccessInput struct {
// A unique identifier that is required to identify specific groups within your
// directory. The users of the group that you associate have access to your Amazon
// S3 or Amazon EFS resources over the enabled protocols using Transfer Family. If
// you know the group name, you can view the SID values by running the following
// command using Windows PowerShell.
//
// Get-ADGroup -Filter {samAccountName -like "YourGroupName*"} -Properties * |
// Select SamAccountName,ObjectSid
//
// In that command, replace YourGroupName with the name of your Active Directory
// group.
//
// The regular expression used to validate this parameter is a string of
// characters consisting of uppercase and lowercase alphanumeric characters with no
// spaces. You can also include underscores or any of the following characters:
// =,.@:/-
//
// This member is required.
ExternalId *string
// A system-assigned unique identifier for a server instance. This is the specific
// server that you added your user to.
//
// This member is required.
ServerId *string
// The landing directory (folder) for a user when they log in to the server using
// the client.
//
// A HomeDirectory example is /bucket_name/home/mydirectory .
//
// The HomeDirectory parameter is only used if HomeDirectoryType is set to PATH .
HomeDirectory *string
// Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and
// keys should be visible to your user and how you want to make them visible. You
// must specify the Entry and Target pair, where Entry shows how the path is made
// visible and Target is the actual Amazon S3 or Amazon EFS path. If you only
// specify a target, it is displayed as is. You also must ensure that your Identity
// and Access Management (IAM) role provides access to paths in Target . This value
// can be set only when HomeDirectoryType is set to LOGICAL.
//
// The following is an Entry and Target pair example.
//
// [ { "Entry": "/directory1", "Target": "/bucket_name/home/mydirectory" } ]
//
// In most cases, you can use this value instead of the session policy to lock
// down your user to the designated home directory (" chroot "). To do this, you
// can set Entry to / and set Target to the HomeDirectory parameter value.
//
// The following is an Entry and Target pair example for chroot .
//
// [ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ]
HomeDirectoryMappings []types.HomeDirectoryMapEntry
// The type of landing directory (folder) that you want your users' home directory
// to be when they log in to the server. If you set it to PATH , the user will see
// the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer
// protocol clients. If you set it to LOGICAL , you need to provide mappings in the
// HomeDirectoryMappings for how you want to make Amazon S3 or Amazon EFS paths
// visible to your users.
//
// If HomeDirectoryType is LOGICAL , you must provide mappings, using the
// HomeDirectoryMappings parameter. If, on the other hand, HomeDirectoryType is
// PATH , you provide an absolute path using the HomeDirectory parameter. You
// cannot have both HomeDirectory and HomeDirectoryMappings in your template.
HomeDirectoryType types.HomeDirectoryType
// A session policy for your user so that you can use the same Identity and Access
// Management (IAM) role across multiple users. This policy scopes down a user's
// access to portions of their Amazon S3 bucket. Variables that you can use inside
// this policy include ${Transfer:UserName} , ${Transfer:HomeDirectory} , and
// ${Transfer:HomeBucket} .
//
// This policy applies only when the domain of ServerId is Amazon S3. Amazon EFS
// does not use session policies.
//
// For session policies, Transfer Family stores the policy as a JSON blob, instead
// of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON
// blob and pass it in the Policy argument.
//
// For an example of a session policy, see [Example session policy].
//
// For more information, see [AssumeRole] in the Amazon Web ServicesSecurity Token Service API
// Reference.
//
// [Example session policy]: https://docs.aws.amazon.com/transfer/latest/userguide/session-policy.html
// [AssumeRole]: https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html
Policy *string
// The full POSIX identity, including user ID ( Uid ), group ID ( Gid ), and any
// secondary groups IDs ( SecondaryGids ), that controls your users' access to your
// Amazon EFS file systems. The POSIX permissions that are set on files and
// directories in your file system determine the level of access your users get
// when transferring files into and out of your Amazon EFS file systems.
PosixProfile *types.PosixProfile
// The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role
// that controls your users' access to your Amazon S3 bucket or Amazon EFS file
// system. The policies attached to this role determine the level of access that
// you want to provide your users when transferring files into and out of your
// Amazon S3 bucket or Amazon EFS file system. The IAM role should also contain a
// trust relationship that allows the server to access your resources when
// servicing your users' transfer requests.
Role *string
noSmithyDocumentSerde
}
type UpdateAccessOutput struct {
// The external identifier of the group whose users have access to your Amazon S3
// or Amazon EFS resources over the enabled protocols using Amazon Web
// ServicesTransfer Family.
//
// This member is required.
ExternalId *string
// The identifier of the server that the user is attached to.
//
// This member is required.
ServerId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationUpdateAccessMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsAwsjson11_serializeOpUpdateAccess{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpUpdateAccess{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "UpdateAccess"); 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 = addClientRequestID(stack); err != nil {
return err
}
if err = addComputeContentLength(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = addComputePayloadSHA256(stack); err != nil {
return err
}
if err = addRetry(stack, options); err != nil {
return err
}
if err = addRawResponseToMetadata(stack); err != nil {
return err
}
if err = 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 = addOpUpdateAccessValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opUpdateAccess(options.Region), middleware.Before); err != nil {
return err
}
if err = 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_opUpdateAccess(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "UpdateAccess",
}
}