File: types.go

package info (click to toggle)
golang-github-aws-aws-sdk-go-v2 1.24.1-2~bpo12%2B1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm-backports
  • size: 554,032 kB
  • sloc: java: 15,941; makefile: 419; sh: 175
file content (478 lines) | stat: -rw-r--r-- 13,655 bytes parent folder | download
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
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
// Code generated by smithy-go-codegen DO NOT EDIT.

package types

import (
	smithydocument "github.com/aws/smithy-go/document"
	"time"
)

// A wrapper object holding the Amazon API Gateway proxy configuration.
type ApiGatewayProxyConfig struct {

	// The resource ID of the API Gateway for the proxy.
	ApiGatewayId *string

	// The type of API Gateway endpoint created.
	EndpointType ApiGatewayEndpointType

	// The Amazon Resource Name (ARN) of the Network Load Balancer configured by the
	// API Gateway proxy.
	NlbArn *string

	// The name of the Network Load Balancer that is configured by the API Gateway
	// proxy.
	NlbName *string

	// The endpoint URL of the API Gateway proxy.
	ProxyUrl *string

	// The name of the API Gateway stage. The name defaults to prod .
	StageName *string

	// The VpcLink ID of the API Gateway proxy.
	VpcLinkId *string

	noSmithyDocumentSerde
}

// A wrapper object holding the Amazon API Gateway endpoint input.
type ApiGatewayProxyInput struct {

	// The type of endpoint to use for the API Gateway proxy. If no value is specified
	// in the request, the value is set to REGIONAL by default. If the value is set to
	// PRIVATE in the request, this creates a private API endpoint that is isolated
	// from the public internet. The private endpoint can only be accessed by using
	// Amazon Virtual Private Cloud (Amazon VPC) interface endpoints for the Amazon API
	// Gateway that has been granted access. For more information about creating a
	// private connection with Refactor Spaces and interface endpoint (Amazon Web
	// Services PrivateLink) availability, see Access Refactor Spaces using an
	// interface endpoint (Amazon Web Services PrivateLink) (https://docs.aws.amazon.com/migrationhub-refactor-spaces/latest/userguide/vpc-interface-endpoints.html)
	// .
	EndpointType ApiGatewayEndpointType

	// The name of the API Gateway stage. The name defaults to prod .
	StageName *string

	noSmithyDocumentSerde
}

// A wrapper object holding the Amazon API Gateway proxy summary.
type ApiGatewayProxySummary struct {

	// The resource ID of the API Gateway for the proxy.
	ApiGatewayId *string

	// The type of API Gateway endpoint created.
	EndpointType ApiGatewayEndpointType

	// The Amazon Resource Name (ARN) of the Network Load Balancer configured by the
	// API Gateway proxy.
	NlbArn *string

	// The name of the Network Load Balancer that is configured by the API Gateway
	// proxy.
	NlbName *string

	// The endpoint URL of the API Gateway proxy.
	ProxyUrl *string

	// The name of the API Gateway stage. The name defaults to prod .
	StageName *string

	// The VpcLink ID of the API Gateway proxy.
	VpcLinkId *string

	noSmithyDocumentSerde
}

// The list of ApplicationSummary objects.
type ApplicationSummary struct {

	// The endpoint URL of the Amazon API Gateway proxy.
	ApiGatewayProxy *ApiGatewayProxySummary

	// The unique identifier of the application.
	ApplicationId *string

	// The Amazon Resource Name (ARN) of the application.
	Arn *string

	// The Amazon Web Services account ID of the application creator.
	CreatedByAccountId *string

	// A timestamp that indicates when the application is created.
	CreatedTime *time.Time

	// The unique identifier of the environment.
	EnvironmentId *string

	// Any error associated with the application resource.
	Error *ErrorResponse

	// A timestamp that indicates when the application was last updated.
	LastUpdatedTime *time.Time

	// The name of the application.
	Name *string

	// The Amazon Web Services account ID of the application owner (which is always
	// the same as the environment owner account ID).
	OwnerAccountId *string

	// The proxy type of the proxy created within the application.
	ProxyType ProxyType

	// The current state of the application.
	State ApplicationState

	// The tags assigned to the application.
	Tags map[string]string

	// The ID of the virtual private cloud (VPC).
	VpcId *string

	noSmithyDocumentSerde
}

// The configuration for the default route type.
type DefaultRouteInput struct {

	// If set to ACTIVE , traffic is forwarded to this route’s service after the route
	// is created.
	ActivationState RouteActivationState

	noSmithyDocumentSerde
}

// The summary information for environments as a response to ListEnvironments .
type EnvironmentSummary struct {

	// The Amazon Resource Name (ARN) of the environment.
	Arn *string

	// A timestamp that indicates when the environment is created.
	CreatedTime *time.Time

	// A description of the environment.
	Description *string

	// The unique identifier of the environment.
	EnvironmentId *string

	// Any error associated with the environment resource.
	Error *ErrorResponse

	// A timestamp that indicates when the environment was last updated.
	LastUpdatedTime *time.Time

	// The name of the environment.
	Name *string

	// The network fabric type of the environment.
	NetworkFabricType NetworkFabricType

	// The Amazon Web Services account ID of the environment owner.
	OwnerAccountId *string

	// The current state of the environment.
	State EnvironmentState

	// The tags assigned to the environment.
	Tags map[string]string

	// The ID of the Transit Gateway set up by the environment.
	TransitGatewayId *string

	noSmithyDocumentSerde
}

// Provides summary information for the EnvironmentVpc resource as a response to
// ListEnvironmentVpc .
type EnvironmentVpc struct {

	// The Amazon Web Services account ID of the virtual private cloud (VPC) owner.
	AccountId *string

	// The list of Amazon Virtual Private Cloud (Amazon VPC) CIDR blocks.
	CidrBlocks []string

	// A timestamp that indicates when the VPC is first added to the environment.
	CreatedTime *time.Time

	// The unique identifier of the environment.
	EnvironmentId *string

	// A timestamp that indicates when the VPC was last updated by the environment.
	LastUpdatedTime *time.Time

	// The ID of the VPC.
	VpcId *string

	// The name of the VPC at the time it is added to the environment.
	VpcName *string

	noSmithyDocumentSerde
}

// Error associated with a resource returned for a Get or List resource response.
type ErrorResponse struct {

	// The Amazon Web Services account ID of the resource owner.
	AccountId *string

	// Additional details about the error.
	AdditionalDetails map[string]string

	// The error code associated with the error.
	Code ErrorCode

	// The message associated with the error.
	Message *string

	// The ID of the resource.
	ResourceIdentifier *string

	// The type of resource.
	ResourceType ErrorResourceType

	noSmithyDocumentSerde
}

// The configuration for the Lambda endpoint type.
type LambdaEndpointConfig struct {

	// The Amazon Resource Name (ARN) of the Lambda endpoint.
	Arn *string

	noSmithyDocumentSerde
}

// The input for the Lambda endpoint type.
type LambdaEndpointInput struct {

	// The Amazon Resource Name (ARN) of the Lambda function or alias.
	//
	// This member is required.
	Arn *string

	noSmithyDocumentSerde
}

// The summary for the Lambda endpoint type.
type LambdaEndpointSummary struct {

	// The Amazon Resource Name (ARN) of the Lambda endpoint.
	Arn *string

	noSmithyDocumentSerde
}

// The summary information for the routes as a response to ListRoutes .
type RouteSummary struct {

	// If set to true , this option appends the source path to the service URL endpoint.
	AppendSourcePath *bool

	// The unique identifier of the application.
	ApplicationId *string

	// The Amazon Resource Name (ARN) of the route.
	Arn *string

	// The Amazon Web Services account ID of the route creator.
	CreatedByAccountId *string

	// A timestamp that indicates when the route is created.
	CreatedTime *time.Time

	// The unique identifier of the environment.
	EnvironmentId *string

	// Any error associated with the route resource.
	Error *ErrorResponse

	// Indicates whether to match all subpaths of the given source path. If this value
	// is false , requests must match the source path exactly before they are forwarded
	// to this route's service.
	IncludeChildPaths *bool

	// A timestamp that indicates when the route was last updated.
	LastUpdatedTime *time.Time

	// A list of HTTP methods to match. An empty list matches all values. If a method
	// is present, only HTTP requests using that method are forwarded to this route’s
	// service.
	Methods []HttpMethod

	// The Amazon Web Services account ID of the route owner.
	OwnerAccountId *string

	// A mapping of Amazon API Gateway path resources to resource IDs.
	PathResourceToId map[string]string

	// The unique identifier of the route.
	RouteId *string

	// The route type of the route.
	RouteType RouteType

	// The unique identifier of the service.
	ServiceId *string

	// This is the path that Refactor Spaces uses to match traffic. Paths must start
	// with / and are relative to the base of the application. To use path parameters
	// in the source path, add a variable in curly braces. For example, the resource
	// path {user} represents a path parameter called 'user'.
	SourcePath *string

	// The current state of the route.
	State RouteState

	// The tags assigned to the route.
	Tags map[string]string

	noSmithyDocumentSerde
}

// A summary for the service as a response to ListServices .
type ServiceSummary struct {

	// The unique identifier of the application.
	ApplicationId *string

	// The Amazon Resource Name (ARN) of the service.
	Arn *string

	// The Amazon Web Services account ID of the service creator.
	CreatedByAccountId *string

	// A timestamp that indicates when the service is created.
	CreatedTime *time.Time

	// A description of the service.
	Description *string

	// The endpoint type of the service.
	EndpointType ServiceEndpointType

	// The unique identifier of the environment.
	EnvironmentId *string

	// Any error associated with the service resource.
	Error *ErrorResponse

	// A summary of the configuration for the Lambda endpoint type.
	LambdaEndpoint *LambdaEndpointSummary

	// A timestamp that indicates when the service was last updated.
	LastUpdatedTime *time.Time

	// The name of the service.
	Name *string

	// The Amazon Web Services account ID of the service owner.
	OwnerAccountId *string

	// The unique identifier of the service.
	ServiceId *string

	// The current state of the service.
	State ServiceState

	// The tags assigned to the service.
	Tags map[string]string

	// The summary of the configuration for the URL endpoint type.
	UrlEndpoint *UrlEndpointSummary

	// The ID of the virtual private cloud (VPC).
	VpcId *string

	noSmithyDocumentSerde
}

// The configuration for the URI path route type.
type UriPathRouteInput struct {

	// If set to ACTIVE , traffic is forwarded to this route’s service after the route
	// is created.
	//
	// This member is required.
	ActivationState RouteActivationState

	// This is the path that Refactor Spaces uses to match traffic. Paths must start
	// with / and are relative to the base of the application. To use path parameters
	// in the source path, add a variable in curly braces. For example, the resource
	// path {user} represents a path parameter called 'user'.
	//
	// This member is required.
	SourcePath *string

	// If set to true , this option appends the source path to the service URL endpoint.
	AppendSourcePath *bool

	// Indicates whether to match all subpaths of the given source path. If this value
	// is false , requests must match the source path exactly before they are forwarded
	// to this route's service.
	IncludeChildPaths *bool

	// A list of HTTP methods to match. An empty list matches all values. If a method
	// is present, only HTTP requests using that method are forwarded to this route’s
	// service.
	Methods []HttpMethod

	noSmithyDocumentSerde
}

// The configuration for the URL endpoint type.
type UrlEndpointConfig struct {

	// The health check URL of the URL endpoint type.
	HealthUrl *string

	// The HTTP URL endpoint.
	Url *string

	noSmithyDocumentSerde
}

// The configuration for the URL endpoint type.
type UrlEndpointInput struct {

	// The URL to route traffic to. The URL must be an rfc3986-formatted URL (https://datatracker.ietf.org/doc/html/rfc3986)
	// . If the host is a domain name, the name must be resolvable over the public
	// internet. If the scheme is https , the top level domain of the host must be
	// listed in the IANA root zone database (https://www.iana.org/domains/root/db) .
	//
	// This member is required.
	Url *string

	// The health check URL of the URL endpoint type. If the URL is a public endpoint,
	// the HealthUrl must also be a public endpoint. If the URL is a private endpoint
	// inside a virtual private cloud (VPC), the health URL must also be a private
	// endpoint, and the host must be the same as the URL.
	HealthUrl *string

	noSmithyDocumentSerde
}

// The summary of the configuration for the URL endpoint type.
type UrlEndpointSummary struct {

	// The health check URL of the URL endpoint type. If the URL is a public endpoint,
	// the HealthUrl must also be a public endpoint. If the URL is a private endpoint
	// inside a virtual private cloud (VPC), the health URL must also be a private
	// endpoint, and the host must be the same as the URL.
	HealthUrl *string

	// The URL to route traffic to. The URL must be an rfc3986-formatted URL (https://datatracker.ietf.org/doc/html/rfc3986)
	// . If the host is a domain name, the name must be resolvable over the public
	// internet. If the scheme is https , the top level domain of the host must be
	// listed in the IANA root zone database (https://www.iana.org/domains/root/db) .
	Url *string

	noSmithyDocumentSerde
}

type noSmithyDocumentSerde = smithydocument.NoSerde