File: types.go

package info (click to toggle)
golang-github-aws-aws-sdk-go-v2 1.17.1-3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 384,244 kB
  • sloc: java: 13,538; makefile: 400; sh: 137
file content (755 lines) | stat: -rw-r--r-- 17,373 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
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
// Code generated by smithy-go-codegen DO NOT EDIT.

package types

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

// Information for one billing record.
type BillingRecord struct {

	// The date that the operation was billed, in Unix format.
	BillDate *time.Time

	// The name of the domain that the billing record applies to. If the domain name
	// contains characters other than a-z, 0-9, and - (hyphen), such as an
	// internationalized domain name, then this value is in Punycode. For more
	// information, see DNS Domain Name Format
	// (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DomainNameFormat.html)
	// in the Amazon Route 53 Developer Guide.
	DomainName *string

	// The ID of the invoice that is associated with the billing record.
	InvoiceId *string

	// The operation that you were charged for.
	Operation OperationType

	// The price that you were charged for the operation, in US dollars. Example value:
	// 12.0
	Price float64

	noSmithyDocumentSerde
}

// ContactDetail includes the following elements.
type ContactDetail struct {

	// First line of the contact's address.
	AddressLine1 *string

	// Second line of contact's address, if any.
	AddressLine2 *string

	// The city of the contact's address.
	City *string

	// Indicates whether the contact is a person, company, association, or public
	// organization. Note the following:
	//
	// * If you specify a value other than PERSON,
	// you must also specify a value for OrganizationName.
	//
	// * For some TLDs, the
	// privacy protection available depends on the value that you specify for Contact
	// Type. For the privacy protection settings for your TLD, see Domains that You Can
	// Register with Amazon Route 53
	// (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/registrar-tld-list.html)
	// in the Amazon Route 53 Developer Guide
	//
	// * For .es domains, the value of
	// ContactType must be PERSON for all three contacts.
	ContactType ContactType

	// Code for the country of the contact's address.
	CountryCode CountryCode

	// Email address of the contact.
	Email *string

	// A list of name-value pairs for parameters required by certain top-level domains.
	ExtraParams []ExtraParam

	// Fax number of the contact. Constraints: Phone number must be specified in the
	// format "+[country dialing code].[number including any area code]". For example,
	// a US phone number might appear as "+1.1234567890".
	Fax *string

	// First name of contact.
	FirstName *string

	// Last name of contact.
	LastName *string

	// Name of the organization for contact types other than PERSON.
	OrganizationName *string

	// The phone number of the contact. Constraints: Phone number must be specified in
	// the format "+[country dialing code].[number including any area code>]". For
	// example, a US phone number might appear as "+1.1234567890".
	PhoneNumber *string

	// The state or province of the contact's city.
	State *string

	// The zip or postal code of the contact's address.
	ZipCode *string

	noSmithyDocumentSerde
}

// Information about the domain price associated with a TLD.
type DomainPrice struct {

	// The price for changing domain ownership.
	ChangeOwnershipPrice *PriceWithCurrency

	// The name of the TLD for which the prices apply.
	Name *string

	// The price for domain registration with Route 53.
	RegistrationPrice *PriceWithCurrency

	// The price for renewing domain registration with Route 53.
	RenewalPrice *PriceWithCurrency

	// The price for restoring the domain with Route 53.
	RestorationPrice *PriceWithCurrency

	// The price for transferring the domain registration to Route 53.
	TransferPrice *PriceWithCurrency

	noSmithyDocumentSerde
}

// Information about one suggested domain name.
type DomainSuggestion struct {

	// Whether the domain name is available for registering. You can register only the
	// domains that are designated as AVAILABLE. Valid values: AVAILABLE The domain
	// name is available. AVAILABLE_RESERVED The domain name is reserved under specific
	// conditions. AVAILABLE_PREORDER The domain name is available and can be
	// preordered. DONT_KNOW The TLD registry didn't reply with a definitive answer
	// about whether the domain name is available. Route 53 can return this response
	// for a variety of reasons, for example, the registry is performing maintenance.
	// Try again later. PENDING The TLD registry didn't return a response in the
	// expected amount of time. When the response is delayed, it usually takes just a
	// few extra seconds. You can resubmit the request immediately. RESERVED The domain
	// name has been reserved for another person or organization. UNAVAILABLE The
	// domain name is not available. UNAVAILABLE_PREMIUM The domain name is not
	// available. UNAVAILABLE_RESTRICTED The domain name is forbidden.
	Availability *string

	// A suggested domain name.
	DomainName *string

	noSmithyDocumentSerde
}

// Summary information about one domain.
type DomainSummary struct {

	// The name of the domain that the summary information applies to.
	//
	// This member is required.
	DomainName *string

	// Indicates whether the domain is automatically renewed upon expiration.
	AutoRenew *bool

	// Expiration date of the domain in Unix time format and Coordinated Universal Time
	// (UTC).
	Expiry *time.Time

	// Indicates whether a domain is locked from unauthorized transfer to another
	// party.
	TransferLock *bool

	noSmithyDocumentSerde
}

// A complex type that contains information about whether the specified domain can
// be transferred to Route 53.
type DomainTransferability struct {

	// Whether the domain name can be transferred to Route 53. You can transfer only
	// domains that have a value of TRANSFERABLE for Transferable. Valid values:
	// TRANSFERABLE The domain name can be transferred to Route 53. UNTRANSFERRABLE The
	// domain name can't be transferred to Route 53. DONT_KNOW Reserved for future use.
	Transferable Transferable

	noSmithyDocumentSerde
}

// ExtraParam includes the following elements.
type ExtraParam struct {

	// The name of an additional parameter that is required by a top-level domain. Here
	// are the top-level domains that require additional parameters and the names of
	// the parameters that they require: .com.au and .net.au
	//
	// * AU_ID_NUMBER
	//
	// *
	// AU_ID_TYPE Valid values include the following:
	//
	// * ABN (Australian business
	// number)
	//
	// * ACN (Australian company number)
	//
	// * TM (Trademark number)
	//
	// .ca
	//
	// *
	// BRAND_NUMBER
	//
	// * CA_BUSINESS_ENTITY_TYPE Valid values include the following:
	//
	// *
	// BANK (Bank)
	//
	// * COMMERCIAL_COMPANY (Commercial company)
	//
	// * COMPANY (Company)
	//
	// *
	// COOPERATION (Cooperation)
	//
	// * COOPERATIVE (Cooperative)
	//
	// * COOPRIX (Cooprix)
	//
	// *
	// CORP (Corporation)
	//
	// * CREDIT_UNION (Credit union)
	//
	// * FOMIA (Federation of mutual
	// insurance associations)
	//
	// * INC (Incorporated)
	//
	// * LTD (Limited)
	//
	// * LTEE
	// (Limitée)
	//
	// * LLC (Limited liability corporation)
	//
	// * LLP (Limited liability
	// partnership)
	//
	// * LTE (Lte.)
	//
	// * MBA (Mutual benefit association)
	//
	// * MIC (Mutual
	// insurance company)
	//
	// * NFP (Not-for-profit corporation)
	//
	// * SA (S.A.)
	//
	// *
	// SAVINGS_COMPANY (Savings company)
	//
	// * SAVINGS_UNION (Savings union)
	//
	// * SARL
	// (Société à responsabilité limitée)
	//
	// * TRUST (Trust)
	//
	// * ULC (Unlimited liability
	// corporation)
	//
	// * CA_LEGAL_TYPE When ContactType is PERSON, valid values include
	// the following:
	//
	// * ABO (Aboriginal Peoples indigenous to Canada)
	//
	// * CCT (Canadian
	// citizen)
	//
	// * LGR (Legal Representative of a Canadian Citizen or Permanent
	// Resident)
	//
	// * RES (Permanent resident of Canada)
	//
	// When ContactType is a value
	// other than PERSON, valid values include the following:
	//
	// * ASS (Canadian
	// unincorporated association)
	//
	// * CCO (Canadian corporation)
	//
	// * EDU (Canadian
	// educational institution)
	//
	// * GOV (Government or government entity in Canada)
	//
	// *
	// HOP (Canadian Hospital)
	//
	// * INB (Indian Band recognized by the Indian Act of
	// Canada)
	//
	// * LAM (Canadian Library, Archive, or Museum)
	//
	// * MAJ (Her/His Majesty
	// the Queen/King)
	//
	// * OMK (Official mark registered in Canada)
	//
	// * PLT (Canadian
	// Political Party)
	//
	// * PRT (Partnership Registered in Canada)
	//
	// * TDM (Trademark
	// registered in Canada)
	//
	// * TRD (Canadian Trade Union)
	//
	// * TRS (Trust established in
	// Canada)
	//
	// .es
	//
	// * ES_IDENTIFICATION The value of ES_IDENTIFICATION depends on the
	// following values:
	//
	// * The value of ES_LEGAL_FORM
	//
	// * The value of
	// ES_IDENTIFICATION_TYPE
	//
	// If ES_LEGAL_FORM is any value other than INDIVIDUAL:
	//
	// *
	// Specify 1 letter + 8 numbers (CIF [Certificado de Identificación Fiscal])
	//
	// *
	// Example: B12345678
	//
	// If ES_LEGAL_FORM is INDIVIDUAL, the value that you specify
	// for ES_IDENTIFICATION depends on the value of ES_IDENTIFICATION_TYPE:
	//
	// * If
	// ES_IDENTIFICATION_TYPE is DNI_AND_NIF (for Spanish contacts):
	//
	// * Specify 8
	// numbers + 1 letter (DNI [Documento Nacional de Identidad], NIF [Número de
	// Identificación Fiscal])
	//
	// * Example: 12345678M
	//
	// * If ES_IDENTIFICATION_TYPE is
	// NIE (for foreigners with legal residence):
	//
	// * Specify 1 letter + 7 numbers + 1
	// letter ( NIE [Número de Identidad de Extranjero])
	//
	// * Example: Y1234567X
	//
	// * If
	// ES_IDENTIFICATION_TYPE is OTHER (for contacts outside of Spain):
	//
	// * Specify a
	// passport number, drivers license number, or national identity card number
	//
	// *
	// ES_IDENTIFICATION_TYPE Valid values include the following:
	//
	// * DNI_AND_NIF (For
	// Spanish contacts)
	//
	// * NIE (For foreigners with legal residence)
	//
	// * OTHER (For
	// contacts outside of Spain)
	//
	// * ES_LEGAL_FORM Valid values include the
	// following:
	//
	// * ASSOCIATION
	//
	// * CENTRAL_GOVERNMENT_BODY
	//
	// * CIVIL_SOCIETY
	//
	// *
	// COMMUNITY_OF_OWNERS
	//
	// * COMMUNITY_PROPERTY
	//
	// * CONSULATE
	//
	// * COOPERATIVE
	//
	// *
	// DESIGNATION_OF_ORIGIN_SUPERVISORY_COUNCIL
	//
	// * ECONOMIC_INTEREST_GROUP
	//
	// *
	// EMBASSY
	//
	// * ENTITY_MANAGING_NATURAL_AREAS
	//
	// * FARM_PARTNERSHIP
	//
	// * FOUNDATION
	//
	// *
	// GENERAL_AND_LIMITED_PARTNERSHIP
	//
	// * GENERAL_PARTNERSHIP
	//
	// * INDIVIDUAL
	//
	// *
	// LIMITED_COMPANY
	//
	// * LOCAL_AUTHORITY
	//
	// * LOCAL_PUBLIC_ENTITY
	//
	// *
	// MUTUAL_INSURANCE_COMPANY
	//
	// * NATIONAL_PUBLIC_ENTITY
	//
	// *
	// ORDER_OR_RELIGIOUS_INSTITUTION
	//
	// * OTHERS (Only for contacts outside of Spain)
	//
	// *
	// POLITICAL_PARTY
	//
	// * PROFESSIONAL_ASSOCIATION
	//
	// * PUBLIC_LAW_ASSOCIATION
	//
	// *
	// PUBLIC_LIMITED_COMPANY
	//
	// * REGIONAL_GOVERNMENT_BODY
	//
	// * REGIONAL_PUBLIC_ENTITY
	//
	// *
	// SAVINGS_BANK
	//
	// * SPANISH_OFFICE
	//
	// * SPORTS_ASSOCIATION
	//
	// * SPORTS_FEDERATION
	//
	// *
	// SPORTS_LIMITED_COMPANY
	//
	// * TEMPORARY_ALLIANCE_OF_ENTERPRISES
	//
	// * TRADE_UNION
	//
	// *
	// WORKER_OWNED_COMPANY
	//
	// * WORKER_OWNED_LIMITED_COMPANY
	//
	// .eu
	//
	// *
	// EU_COUNTRY_OF_CITIZENSHIP
	//
	// .fi
	//
	// * BIRTH_DATE_IN_YYYY_MM_DD
	//
	// *
	// FI_BUSINESS_NUMBER
	//
	// * FI_ID_NUMBER
	//
	// * FI_NATIONALITY Valid values include the
	// following:
	//
	// * FINNISH
	//
	// * NOT_FINNISH
	//
	// * FI_ORGANIZATION_TYPE Valid values
	// include the following:
	//
	// * COMPANY
	//
	// * CORPORATION
	//
	// * GOVERNMENT
	//
	// * INSTITUTION
	//
	// *
	// POLITICAL_PARTY
	//
	// * PUBLIC_COMMUNITY
	//
	// * TOWNSHIP
	//
	// .fr
	//
	// * BIRTH_CITY
	//
	// *
	// BIRTH_COUNTRY
	//
	// * BIRTH_DATE_IN_YYYY_MM_DD
	//
	// * BIRTH_DEPARTMENT: Specify the INSEE
	// code that corresponds with the department where the contact was born. If the
	// contact was born somewhere other than France or its overseas departments,
	// specify 99. For more information, including a list of departments and the
	// corresponding INSEE numbers, see the Wikipedia entry Departments of France
	// (https://en.wikipedia.org/wiki/Departments_of_France).
	//
	// * BRAND_NUMBER
	//
	// .it
	//
	// *
	// IT_NATIONALITY
	//
	// * IT_PIN
	//
	// * IT_REGISTRANT_ENTITY_TYPE Valid values include the
	// following:
	//
	// * FOREIGNERS
	//
	// * FREELANCE_WORKERS (Freelance workers and
	// professionals)
	//
	// * ITALIAN_COMPANIES (Italian companies and one-person
	// companies)
	//
	// * NON_PROFIT_ORGANIZATIONS
	//
	// * OTHER_SUBJECTS
	//
	// *
	// PUBLIC_ORGANIZATIONS
	//
	// .ru
	//
	// * BIRTH_DATE_IN_YYYY_MM_DD
	//
	// *
	// RU_PASSPORT_DATA
	//
	// .se
	//
	// * BIRTH_COUNTRY
	//
	// * SE_ID_NUMBER
	//
	// .sg
	//
	// *
	// SG_ID_NUMBER
	//
	// .co.uk, .me.uk, and .org.uk
	//
	// * UK_CONTACT_TYPE Valid values
	// include the following:
	//
	// * CRC (UK Corporation by Royal Charter)
	//
	// * FCORP (Non-UK
	// Corporation)
	//
	// * FIND (Non-UK Individual, representing self)
	//
	// * FOTHER (Non-UK
	// Entity that does not fit into any other category)
	//
	// * GOV (UK Government Body)
	//
	// *
	// IND (UK Individual (representing self))
	//
	// * IP (UK Industrial/Provident
	// Registered Company)
	//
	// * LLP (UK Limited Liability Partnership)
	//
	// * LTD (UK Limited
	// Company)
	//
	// * OTHER (UK Entity that does not fit into any other category)
	//
	// * PLC
	// (UK Public Limited Company)
	//
	// * PTNR (UK Partnership)
	//
	// * RCHAR (UK Registered
	// Charity)
	//
	// * SCH (UK School)
	//
	// * STAT (UK Statutory Body)
	//
	// * STRA (UK Sole
	// Trader)
	//
	// * UK_COMPANY_NUMBER
	//
	// In addition, many TLDs require a VAT_NUMBER.
	//
	// This member is required.
	Name ExtraParamName

	// The value that corresponds with the name of an extra parameter.
	//
	// This member is required.
	Value *string

	noSmithyDocumentSerde
}

// Information for the filtering of a list of domains returned by ListDomains
// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains__ListDomains.html).
type FilterCondition struct {

	// Name of the field which should be used for filtering the list of domains.
	//
	// This member is required.
	Name ListDomainsAttributeName

	// The operator values for filtering domain names. The values can be:
	//
	// * LE: Less
	// than, or equal to
	//
	// * GE: Greater than, or equal to
	//
	// * BEGINS_WITH: Begins with
	//
	// This member is required.
	Operator Operator

	// An array of strings presenting values to compare. Only 1 item in the list is
	// currently supported.
	//
	// This member is required.
	Values []string

	noSmithyDocumentSerde
}

// Nameserver includes the following elements.
type Nameserver struct {

	// The fully qualified host name of the name server. Constraint: Maximum 255
	// characters
	//
	// This member is required.
	Name *string

	// Glue IP address of a name server entry. Glue IP addresses are required only when
	// the name of the name server is a subdomain of the domain. For example, if your
	// domain is example.com and the name server for the domain is ns.example.com, you
	// need to specify the IP address for ns.example.com. Constraints: The list can
	// contain only one IPv4 and one IPv6 address.
	GlueIps []string

	noSmithyDocumentSerde
}

// OperationSummary includes the following elements.
type OperationSummary struct {

	// Identifier returned to track the requested action.
	//
	// This member is required.
	OperationId *string

	// The current status of the requested operation in the system.
	//
	// This member is required.
	Status OperationStatus

	// The date when the request was submitted.
	//
	// This member is required.
	SubmittedDate *time.Time

	// Type of the action requested.
	//
	// This member is required.
	Type OperationType

	noSmithyDocumentSerde
}

// Currency-specific price information.
type PriceWithCurrency struct {

	// The currency specifier.
	//
	// This member is required.
	Currency *string

	// The price of a domain, in a specific currency.
	//
	// This member is required.
	Price float64

	noSmithyDocumentSerde
}

// Information for sorting a list of domains.
type SortCondition struct {

	// Field to be used for sorting the list of domains. It can be either the name or
	// the expiration for a domain. Note that if filterCondition is used in the same
	// ListDomains
	// (https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains__ListDomains.html)
	// call, the field used for sorting has to be the same as the field used for
	// filtering.
	//
	// This member is required.
	Name ListDomainsAttributeName

	// The sort order for a list of domains. Either ascending (ASC) or descending
	// (DES).
	//
	// This member is required.
	SortOrder SortOrder

	noSmithyDocumentSerde
}

// Each tag includes the following elements.
type Tag struct {

	// The key (name) of a tag. Valid values: A-Z, a-z, 0-9, space, ".:/=+\-@"
	// Constraints: Each key can be 1-128 characters long.
	Key *string

	// The value of a tag. Valid values: A-Z, a-z, 0-9, space, ".:/=+\-@" Constraints:
	// Each value can be 0-256 characters long.
	Value *string

	noSmithyDocumentSerde
}

type noSmithyDocumentSerde = smithydocument.NoSerde