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 (516 lines) | stat: -rw-r--r-- 16,402 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
// Code generated by smithy-go-codegen DO NOT EDIT.

package types

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

// Contains details about a package version asset.
type AssetSummary struct {

	// The name of the asset.
	//
	// This member is required.
	Name *string

	// The hashes of the asset.
	Hashes map[string]string

	// The size of the asset.
	Size *int64

	noSmithyDocumentSerde
}

// Information about a domain. A domain is a container for repositories. When you
// create a domain, it is empty until you add one or more repositories.
type DomainDescription struct {

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

	// The total size of all assets in the domain.
	AssetSizeBytes int64

	// A timestamp that represents the date and time the domain was created.
	CreatedTime *time.Time

	// The ARN of an Key Management Service (KMS) key associated with a domain.
	EncryptionKey *string

	// The name of the domain.
	Name *string

	// The Amazon Web Services account ID that owns the domain.
	Owner *string

	// The number of repositories in the domain.
	RepositoryCount int32

	// The Amazon Resource Name (ARN) of the Amazon S3 bucket that is used to store
	// package assets in the domain.
	S3BucketArn *string

	// The current status of a domain.
	Status DomainStatus

	noSmithyDocumentSerde
}

// Information about how a package originally entered the CodeArtifact domain. For
// packages published directly to CodeArtifact, the entry point is the repository
// it was published to. For packages ingested from an external repository, the
// entry point is the external connection that it was ingested from. An external
// connection is a CodeArtifact repository that is connected to an external
// repository such as the npm registry or NuGet gallery.
type DomainEntryPoint struct {

	// The name of the external connection that a package was ingested from.
	ExternalConnectionName *string

	// The name of the repository that a package was originally published to.
	RepositoryName *string

	noSmithyDocumentSerde
}

// Information about a domain, including its name, Amazon Resource Name (ARN), and
// status. The ListDomains (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_ListDomains.html)
// operation returns a list of DomainSummary objects.
type DomainSummary struct {

	// The ARN of the domain.
	Arn *string

	// A timestamp that contains the date and time the domain was created.
	CreatedTime *time.Time

	// The key used to encrypt the domain.
	EncryptionKey *string

	// The name of the domain.
	Name *string

	// The 12-digit account number of the Amazon Web Services account that owns the
	// domain. It does not include dashes or spaces.
	Owner *string

	// A string that contains the status of the domain.
	Status DomainStatus

	noSmithyDocumentSerde
}

// Details of the license data.
type LicenseInfo struct {

	// Name of the license.
	Name *string

	// The URL for license data.
	Url *string

	noSmithyDocumentSerde
}

// Details about a package dependency.
type PackageDependency struct {

	// The type of a package dependency. The possible values depend on the package
	// type.
	//   - npm: regular , dev , peer , optional
	//   - maven: optional , parent , compile , runtime , test , system , provided .
	//   Note that parent is not a regular Maven dependency type; instead this is
	//   extracted from the element if one is defined in the package version's POM
	//   file.
	//   - nuget: The dependencyType field is never set for NuGet packages.
	//   - pypi: Requires-Dist
	DependencyType *string

	// The namespace of the package that this package depends on. The package
	// component that specifies its namespace depends on its type. For example:
	//   - The namespace of a Maven package is its groupId .
	//   - The namespace of an npm package is its scope .
	//   - Python and NuGet packages do not contain a corresponding component,
	//   packages of those formats do not have a namespace.
	Namespace *string

	// The name of the package that this package depends on.
	Package *string

	// The required version, or version range, of the package that this package
	// depends on. The version format is specific to the package type. For example, the
	// following are possible valid required versions: 1.2.3 , ^2.3.4 , or 4.x .
	VersionRequirement *string

	noSmithyDocumentSerde
}

// Details about a package.
type PackageDescription struct {

	// A format that specifies the type of the package.
	Format PackageFormat

	// The name of the package.
	Name *string

	// The namespace of the package. The package component that specifies its
	// namespace depends on its type. For example:
	//   - The namespace of a Maven package is its groupId .
	//   - The namespace of an npm package is its scope .
	//   - Python and NuGet packages do not contain a corresponding component,
	//   packages of those formats do not have a namespace.
	//   - The namespace of a generic package is its namespace .
	Namespace *string

	// The package origin configuration for the package.
	OriginConfiguration *PackageOriginConfiguration

	noSmithyDocumentSerde
}

// Details about the package origin configuration of a package.
type PackageOriginConfiguration struct {

	// A PackageOriginRestrictions object that contains information about the upstream
	// and publish package origin configuration for the package.
	Restrictions *PackageOriginRestrictions

	noSmithyDocumentSerde
}

// Details about the origin restrictions set on the package. The package origin
// restrictions determine how new versions of a package can be added to a specific
// repository.
type PackageOriginRestrictions struct {

	// The package origin configuration that determines if new versions of the package
	// can be published directly to the repository.
	//
	// This member is required.
	Publish AllowPublish

	// The package origin configuration that determines if new versions of the package
	// can be added to the repository from an external connection or upstream source.
	//
	// This member is required.
	Upstream AllowUpstream

	noSmithyDocumentSerde
}

// Details about a package, including its format, namespace, and name.
type PackageSummary struct {

	// The format of the package.
	Format PackageFormat

	// The namespace of the package. The package component that specifies its
	// namespace depends on its type. For example:
	//   - The namespace of a Maven package is its groupId .
	//   - The namespace of an npm package is its scope .
	//   - Python and NuGet packages do not contain a corresponding component,
	//   packages of those formats do not have a namespace.
	//   - The namespace of a generic package is its namespace .
	Namespace *string

	// A PackageOriginConfiguration (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageOriginConfiguration.html)
	// object that contains a PackageOriginRestrictions (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageOriginRestrictions.html)
	// object that contains information about the upstream and publish package origin
	// restrictions.
	OriginConfiguration *PackageOriginConfiguration

	// The name of the package.
	Package *string

	noSmithyDocumentSerde
}

// Details about a package version.
type PackageVersionDescription struct {

	// The name of the package that is displayed. The displayName varies depending on
	// the package version's format. For example, if an npm package is named ui , is in
	// the namespace vue , and has the format npm , then the displayName is @vue/ui .
	DisplayName *string

	// The format of the package version.
	Format PackageFormat

	// The homepage associated with the package.
	HomePage *string

	// Information about licenses associated with the package version.
	Licenses []LicenseInfo

	// The namespace of the package version. The package version component that
	// specifies its namespace depends on its type. For example:
	//   - The namespace of a Maven package version is its groupId .
	//   - The namespace of an npm package version is its scope .
	//   - Python and NuGet package versions do not contain a corresponding component,
	//   package versions of those formats do not have a namespace.
	//   - The namespace of a generic package is its namespace .
	Namespace *string

	// A PackageVersionOrigin (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageVersionOrigin.html)
	// object that contains information about how the package version was added to the
	// repository.
	Origin *PackageVersionOrigin

	// The name of the requested package.
	PackageName *string

	// A timestamp that contains the date and time the package version was published.
	PublishedTime *time.Time

	// The revision of the package version.
	Revision *string

	// The repository for the source code in the package version, or the source code
	// used to build it.
	SourceCodeRepository *string

	// A string that contains the status of the package version.
	Status PackageVersionStatus

	// A summary of the package version. The summary is extracted from the package.
	// The information in and detail level of the summary depends on the package
	// version's format.
	Summary *string

	// The version of the package.
	Version *string

	noSmithyDocumentSerde
}

// l An error associated with package.
type PackageVersionError struct {

	// The error code associated with the error. Valid error codes are:
	//   - ALREADY_EXISTS
	//   - MISMATCHED_REVISION
	//   - MISMATCHED_STATUS
	//   - NOT_ALLOWED
	//   - NOT_FOUND
	//   - SKIPPED
	ErrorCode PackageVersionErrorCode

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

	noSmithyDocumentSerde
}

// Information about how a package version was added to a repository.
type PackageVersionOrigin struct {

	// A DomainEntryPoint (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_DomainEntryPoint.html)
	// object that contains information about from which repository or external
	// connection the package version was added to the domain.
	DomainEntryPoint *DomainEntryPoint

	// Describes how the package version was originally added to the domain. An
	// INTERNAL origin type means the package version was published directly to a
	// repository in the domain. An EXTERNAL origin type means the package version was
	// ingested from an external connection.
	OriginType PackageVersionOriginType

	noSmithyDocumentSerde
}

// Details about a package version, including its status, version, and revision.
// The ListPackageVersions (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_ListPackageVersions.html)
// operation returns a list of PackageVersionSummary objects.
type PackageVersionSummary struct {

	// A string that contains the status of the package version. It can be one of the
	// following:
	//
	// This member is required.
	Status PackageVersionStatus

	// Information about a package version.
	//
	// This member is required.
	Version *string

	// A PackageVersionOrigin (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageVersionOrigin.html)
	// object that contains information about how the package version was added to the
	// repository.
	Origin *PackageVersionOrigin

	// The revision associated with a package version.
	Revision *string

	noSmithyDocumentSerde
}

// The details of a repository stored in CodeArtifact. A CodeArtifact repository
// contains a set of package versions, each of which maps to a set of assets.
// Repositories are polyglot—a single repository can contain packages of any
// supported type. Each repository exposes endpoints for fetching and publishing
// packages using tools like the npm CLI, the Maven CLI ( mvn ), and pip . You can
// create up to 100 repositories per Amazon Web Services account.
type RepositoryDescription struct {

	// The 12-digit account number of the Amazon Web Services account that manages the
	// repository.
	AdministratorAccount *string

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

	// A timestamp that represents the date and time the repository was created.
	CreatedTime *time.Time

	// A text description of the repository.
	Description *string

	// The name of the domain that contains the repository.
	DomainName *string

	// The 12-digit account number of the Amazon Web Services account that owns the
	// domain that contains the repository. It does not include dashes or spaces.
	DomainOwner *string

	// An array of external connections associated with the repository.
	ExternalConnections []RepositoryExternalConnectionInfo

	// The name of the repository.
	Name *string

	// A list of upstream repositories to associate with the repository. The order of
	// the upstream repositories in the list determines their priority order when
	// CodeArtifact looks for a requested package version. For more information, see
	// Working with upstream repositories (https://docs.aws.amazon.com/codeartifact/latest/ug/repos-upstream.html)
	// .
	Upstreams []UpstreamRepositoryInfo

	noSmithyDocumentSerde
}

// Contains information about the external connection of a repository.
type RepositoryExternalConnectionInfo struct {

	// The name of the external connection associated with a repository.
	ExternalConnectionName *string

	// The package format associated with a repository's external connection. The
	// valid package formats are:
	//   - npm : A Node Package Manager (npm) package.
	//   - pypi : A Python Package Index (PyPI) package.
	//   - maven : A Maven package that contains compiled code in a distributable
	//   format, such as a JAR file.
	//   - nuget : A NuGet package.
	PackageFormat PackageFormat

	// The status of the external connection of a repository. There is one valid
	// value, Available .
	Status ExternalConnectionStatus

	noSmithyDocumentSerde
}

// Details about a repository, including its Amazon Resource Name (ARN),
// description, and domain information. The ListRepositories (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_ListRepositories.html)
// operation returns a list of RepositorySummary objects.
type RepositorySummary struct {

	// The Amazon Web Services account ID that manages the repository.
	AdministratorAccount *string

	// The ARN of the repository.
	Arn *string

	// A timestamp that represents the date and time the repository was created.
	CreatedTime *time.Time

	// The description of the repository.
	Description *string

	// The name of the domain that contains the repository.
	DomainName *string

	// The 12-digit account number of the Amazon Web Services account that owns the
	// domain. It does not include dashes or spaces.
	DomainOwner *string

	// The name of the repository.
	Name *string

	noSmithyDocumentSerde
}

// An CodeArtifact resource policy that contains a resource ARN, document details,
// and a revision.
type ResourcePolicy struct {

	// The resource policy formatted in JSON.
	Document *string

	// The ARN of the resource associated with the resource policy
	ResourceArn *string

	// The current revision of the resource policy.
	Revision *string

	noSmithyDocumentSerde
}

// Contains the revision and status of a package version.
type SuccessfulPackageVersionInfo struct {

	// The revision of a package version.
	Revision *string

	// The status of a package version.
	Status PackageVersionStatus

	noSmithyDocumentSerde
}

// A tag is a key-value pair that can be used to manage, search for, or filter
// resources in CodeArtifact.
type Tag struct {

	// The tag key.
	//
	// This member is required.
	Key *string

	// The tag value.
	//
	// This member is required.
	Value *string

	noSmithyDocumentSerde
}

// Information about an upstream repository. A list of UpstreamRepository objects
// is an input parameter to CreateRepository (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_CreateRepository.html)
// and UpdateRepository (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_UpdateRepository.html)
// .
type UpstreamRepository struct {

	// The name of an upstream repository.
	//
	// This member is required.
	RepositoryName *string

	noSmithyDocumentSerde
}

// Information about an upstream repository.
type UpstreamRepositoryInfo struct {

	// The name of an upstream repository.
	RepositoryName *string

	noSmithyDocumentSerde
}

type noSmithyDocumentSerde = smithydocument.NoSerde