...

Source file src/github.com/aws/aws-sdk-go-v2/service/ecrpublic/types/types.go

Documentation: github.com/aws/aws-sdk-go-v2/service/ecrpublic/types

     1  // Code generated by smithy-go-codegen DO NOT EDIT.
     2  
     3  package types
     4  
     5  import (
     6  	smithydocument "github.com/aws/smithy-go/document"
     7  	"time"
     8  )
     9  
    10  // An authorization token data object that corresponds to a public registry.
    11  type AuthorizationData struct {
    12  
    13  	// A base64-encoded string that contains authorization data for a public Amazon
    14  	// ECR registry. When the string is decoded, it's presented in the format
    15  	// user:password for public registry authentication using docker login .
    16  	AuthorizationToken *string
    17  
    18  	// The Unix time in seconds and milliseconds when the authorization token expires.
    19  	// Authorization tokens are valid for 12 hours.
    20  	ExpiresAt *time.Time
    21  
    22  	noSmithyDocumentSerde
    23  }
    24  
    25  // An object that represents an Amazon ECR image.
    26  type Image struct {
    27  
    28  	// An object that contains the image tag and image digest associated with an image.
    29  	ImageId *ImageIdentifier
    30  
    31  	// The image manifest that's associated with the image.
    32  	ImageManifest *string
    33  
    34  	// The manifest media type of the image.
    35  	ImageManifestMediaType *string
    36  
    37  	// The Amazon Web Services account ID that's associated with the registry
    38  	// containing the image.
    39  	RegistryId *string
    40  
    41  	// The name of the repository that's associated with the image.
    42  	RepositoryName *string
    43  
    44  	noSmithyDocumentSerde
    45  }
    46  
    47  // An object that describes an image that's returned by a DescribeImages operation.
    48  type ImageDetail struct {
    49  
    50  	// The artifact media type of the image.
    51  	ArtifactMediaType *string
    52  
    53  	// The sha256 digest of the image manifest.
    54  	ImageDigest *string
    55  
    56  	// The media type of the image manifest.
    57  	ImageManifestMediaType *string
    58  
    59  	// The date and time, expressed in standard JavaScript date format, that the
    60  	// current image was pushed to the repository at.
    61  	ImagePushedAt *time.Time
    62  
    63  	// The size, in bytes, of the image in the repository. If the image is a manifest
    64  	// list, this is the max size of all manifests in the list. Beginning with Docker
    65  	// version 1.9, the Docker client compresses image layers before pushing them to a
    66  	// V2 Docker registry. The output of the docker images command shows the
    67  	// uncompressed image size, so it might return a larger image size than the image
    68  	// sizes that are returned by DescribeImages .
    69  	ImageSizeInBytes *int64
    70  
    71  	// The list of tags that's associated with this image.
    72  	ImageTags []string
    73  
    74  	// The Amazon Web Services account ID that's associated with the public registry
    75  	// where this image belongs.
    76  	RegistryId *string
    77  
    78  	// The name of the repository where this image belongs.
    79  	RepositoryName *string
    80  
    81  	noSmithyDocumentSerde
    82  }
    83  
    84  // An object that represents an Amazon ECR image failure.
    85  type ImageFailure struct {
    86  
    87  	// The code that's associated with the failure.
    88  	FailureCode ImageFailureCode
    89  
    90  	// The reason for the failure.
    91  	FailureReason *string
    92  
    93  	// The image ID that's associated with the failure.
    94  	ImageId *ImageIdentifier
    95  
    96  	noSmithyDocumentSerde
    97  }
    98  
    99  // An object with identifying information for an Amazon ECR image.
   100  type ImageIdentifier struct {
   101  
   102  	// The sha256 digest of the image manifest.
   103  	ImageDigest *string
   104  
   105  	// The tag that's used for the image.
   106  	ImageTag *string
   107  
   108  	noSmithyDocumentSerde
   109  }
   110  
   111  // An object that represents the image tag details for an image.
   112  type ImageTagDetail struct {
   113  
   114  	// The time stamp that indicates when the image tag was created.
   115  	CreatedAt *time.Time
   116  
   117  	// An object that describes the details of an image.
   118  	ImageDetail *ReferencedImageDetail
   119  
   120  	// The tag that's associated with the image.
   121  	ImageTag *string
   122  
   123  	noSmithyDocumentSerde
   124  }
   125  
   126  // An object that represents an Amazon ECR image layer.
   127  type Layer struct {
   128  
   129  	// The availability status of the image layer.
   130  	LayerAvailability LayerAvailability
   131  
   132  	// The sha256 digest of the image layer.
   133  	LayerDigest *string
   134  
   135  	// The size, in bytes, of the image layer.
   136  	LayerSize *int64
   137  
   138  	// The media type of the layer, such as
   139  	// application/vnd.docker.image.rootfs.diff.tar.gzip or
   140  	// application/vnd.oci.image.layer.v1.tar+gzip .
   141  	MediaType *string
   142  
   143  	noSmithyDocumentSerde
   144  }
   145  
   146  // An object that represents an Amazon ECR image layer failure.
   147  type LayerFailure struct {
   148  
   149  	// The failure code that's associated with the failure.
   150  	FailureCode LayerFailureCode
   151  
   152  	// The reason for the failure.
   153  	FailureReason *string
   154  
   155  	// The layer digest that's associated with the failure.
   156  	LayerDigest *string
   157  
   158  	noSmithyDocumentSerde
   159  }
   160  
   161  // An object that describes the image tag details that are returned by a
   162  // DescribeImageTags action.
   163  type ReferencedImageDetail struct {
   164  
   165  	// The artifact media type of the image.
   166  	ArtifactMediaType *string
   167  
   168  	// The sha256 digest of the image manifest.
   169  	ImageDigest *string
   170  
   171  	// The media type of the image manifest.
   172  	ImageManifestMediaType *string
   173  
   174  	// The date and time, expressed in standard JavaScript date format, which the
   175  	// current image tag was pushed to the repository at.
   176  	ImagePushedAt *time.Time
   177  
   178  	// The size, in bytes, of the image in the repository. If the image is a manifest
   179  	// list, this is the max size of all manifests in the list. Beginning with Docker
   180  	// version 1.9, the Docker client compresses image layers before pushing them to a
   181  	// V2 Docker registry. The output of the docker images command shows the
   182  	// uncompressed image size, so it might return a larger image size than the image
   183  	// sizes that are returned by DescribeImages .
   184  	ImageSizeInBytes *int64
   185  
   186  	noSmithyDocumentSerde
   187  }
   188  
   189  // The details of a public registry.
   190  type Registry struct {
   191  
   192  	// An array of objects that represents the aliases for a public registry.
   193  	//
   194  	// This member is required.
   195  	Aliases []RegistryAlias
   196  
   197  	// The Amazon Resource Name (ARN) of the public registry.
   198  	//
   199  	// This member is required.
   200  	RegistryArn *string
   201  
   202  	// The Amazon Web Services account ID that's associated with the registry. If you
   203  	// do not specify a registry, the default public registry is assumed.
   204  	//
   205  	// This member is required.
   206  	RegistryId *string
   207  
   208  	// The URI of a public registry. The URI contains a universal prefix and the
   209  	// registry alias.
   210  	//
   211  	// This member is required.
   212  	RegistryUri *string
   213  
   214  	// Indicates whether the account is a verified Amazon Web Services Marketplace
   215  	// vendor. If an account is verified, each public repository receives a verified
   216  	// account badge on the Amazon ECR Public Gallery.
   217  	//
   218  	// This member is required.
   219  	Verified *bool
   220  
   221  	noSmithyDocumentSerde
   222  }
   223  
   224  // An object representing the aliases for a public registry. A public registry is
   225  // given an alias when it's created. However, a custom alias can be set using the
   226  // Amazon ECR console. For more information, see Registries (https://docs.aws.amazon.com/AmazonECR/latest/userguide/Registries.html)
   227  // in the Amazon Elastic Container Registry User Guide.
   228  type RegistryAlias struct {
   229  
   230  	// Indicates whether the registry alias is the default alias for the registry.
   231  	// When the first public repository is created, your public registry is assigned a
   232  	// default registry alias.
   233  	//
   234  	// This member is required.
   235  	DefaultRegistryAlias bool
   236  
   237  	// The name of the registry alias.
   238  	//
   239  	// This member is required.
   240  	Name *string
   241  
   242  	// Indicates whether the registry alias is the primary alias for the registry. If
   243  	// true, the alias is the primary registry alias and is displayed in both the
   244  	// repository URL and the image URI used in the docker pull commands on the Amazon
   245  	// ECR Public Gallery. A registry alias that isn't the primary registry alias can
   246  	// be used in the repository URI in a docker pull command.
   247  	//
   248  	// This member is required.
   249  	PrimaryRegistryAlias bool
   250  
   251  	// The status of the registry alias.
   252  	//
   253  	// This member is required.
   254  	Status RegistryAliasStatus
   255  
   256  	noSmithyDocumentSerde
   257  }
   258  
   259  // The metadata for a public registry.
   260  type RegistryCatalogData struct {
   261  
   262  	// The display name for a public registry. This appears on the Amazon ECR Public
   263  	// Gallery. Only accounts that have the verified account badge can have a registry
   264  	// display name.
   265  	DisplayName *string
   266  
   267  	noSmithyDocumentSerde
   268  }
   269  
   270  // An object representing a repository.
   271  type Repository struct {
   272  
   273  	// The date and time, in JavaScript date format, when the repository was created.
   274  	CreatedAt *time.Time
   275  
   276  	// The Amazon Web Services account ID that's associated with the public registry
   277  	// that contains the repository.
   278  	RegistryId *string
   279  
   280  	// The Amazon Resource Name (ARN) that identifies the repository. The ARN contains
   281  	// the arn:aws:ecr namespace, followed by the region of the repository, Amazon Web
   282  	// Services account ID of the repository owner, repository namespace, and
   283  	// repository name. For example, arn:aws:ecr:region:012345678910:repository/test .
   284  	RepositoryArn *string
   285  
   286  	// The name of the repository.
   287  	RepositoryName *string
   288  
   289  	// The URI for the repository. You can use this URI for container image push and
   290  	// pull operations.
   291  	RepositoryUri *string
   292  
   293  	noSmithyDocumentSerde
   294  }
   295  
   296  // The catalog data for a repository. This data is publicly visible in the Amazon
   297  // ECR Public Gallery.
   298  type RepositoryCatalogData struct {
   299  
   300  	// The longform description of the contents of the repository. This text appears
   301  	// in the repository details on the Amazon ECR Public Gallery.
   302  	AboutText *string
   303  
   304  	// The architecture tags that are associated with the repository. Only supported
   305  	// operating system tags appear publicly in the Amazon ECR Public Gallery. For more
   306  	// information, see RepositoryCatalogDataInput .
   307  	Architectures []string
   308  
   309  	// The short description of the repository.
   310  	Description *string
   311  
   312  	// The URL that contains the logo that's associated with the repository.
   313  	LogoUrl *string
   314  
   315  	// Indicates whether the repository is certified by Amazon Web Services
   316  	// Marketplace.
   317  	MarketplaceCertified *bool
   318  
   319  	// The operating system tags that are associated with the repository. Only
   320  	// supported operating system tags appear publicly in the Amazon ECR Public
   321  	// Gallery. For more information, see RepositoryCatalogDataInput .
   322  	OperatingSystems []string
   323  
   324  	// The longform usage details of the contents of the repository. The usage text
   325  	// provides context for users of the repository.
   326  	UsageText *string
   327  
   328  	noSmithyDocumentSerde
   329  }
   330  
   331  // An object that contains the catalog data for a repository. This data is
   332  // publicly visible in the Amazon ECR Public Gallery.
   333  type RepositoryCatalogDataInput struct {
   334  
   335  	// A detailed description of the contents of the repository. It's publicly visible
   336  	// in the Amazon ECR Public Gallery. The text must be in markdown format.
   337  	AboutText *string
   338  
   339  	// The system architecture that the images in the repository are compatible with.
   340  	// On the Amazon ECR Public Gallery, the following supported architectures appear
   341  	// as badges on the repository and are used as search filters. If an unsupported
   342  	// tag is added to your repository catalog data, it's associated with the
   343  	// repository and can be retrieved using the API but isn't discoverable in the
   344  	// Amazon ECR Public Gallery.
   345  	//   - ARM
   346  	//   - ARM 64
   347  	//   - x86
   348  	//   - x86-64
   349  	Architectures []string
   350  
   351  	// A short description of the contents of the repository. This text appears in
   352  	// both the image details and also when searching for repositories on the Amazon
   353  	// ECR Public Gallery.
   354  	Description *string
   355  
   356  	// The base64-encoded repository logo payload. The repository logo is only
   357  	// publicly visible in the Amazon ECR Public Gallery for verified accounts.
   358  	LogoImageBlob []byte
   359  
   360  	// The operating systems that the images in the repository are compatible with. On
   361  	// the Amazon ECR Public Gallery, the following supported operating systems appear
   362  	// as badges on the repository and are used as search filters. If an unsupported
   363  	// tag is added to your repository catalog data, it's associated with the
   364  	// repository and can be retrieved using the API but isn't discoverable in the
   365  	// Amazon ECR Public Gallery.
   366  	//   - Linux
   367  	//   - Windows
   368  	OperatingSystems []string
   369  
   370  	// Detailed information about how to use the contents of the repository. It's
   371  	// publicly visible in the Amazon ECR Public Gallery. The usage text provides
   372  	// context, support information, and additional usage details for users of the
   373  	// repository. The text must be in markdown format.
   374  	UsageText *string
   375  
   376  	noSmithyDocumentSerde
   377  }
   378  
   379  // The metadata that you apply to a resource to help you categorize and organize
   380  // them. Each tag consists of a key and an optional value. You define both. Tag
   381  // keys can have a maximum character length of 128 characters, and tag values can
   382  // have a maximum length of 256 characters.
   383  type Tag struct {
   384  
   385  	// One part of a key-value pair that make up a tag. A key is a general label that
   386  	// acts like a category for more specific tag values.
   387  	Key *string
   388  
   389  	// The optional part of a key-value pair that make up a tag. A value acts as a
   390  	// descriptor within a tag category (key).
   391  	Value *string
   392  
   393  	noSmithyDocumentSerde
   394  }
   395  
   396  type noSmithyDocumentSerde = smithydocument.NoSerde
   397  

View as plain text