ecr

package module
v0.26.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 30, 2020 License: Apache-2.0 Imports: 26 Imported by: 0

Documentation

Index

Constants

View Source
const ServiceAPIVersion = "2015-09-21"
View Source
const ServiceID = "ECR"

Variables

This section is empty.

Functions

func AddResolveEndpointMiddleware

func AddResolveEndpointMiddleware(stack *middleware.Stack, options ResolveEndpointMiddlewareOptions)

func NewDefaultEndpointResolver

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func RemoveResolveEndpointMiddleware

func RemoveResolveEndpointMiddleware(stack *middleware.Stack) error

Types

type BatchCheckLayerAvailabilityInput

type BatchCheckLayerAvailabilityInput struct {
	// The AWS account ID associated with the registry that contains the image layers
	// to check. If you do not specify a registry, the default registry is assumed.
	RegistryId *string
	// The digests of the image layers to check.
	LayerDigests []*string
	// The name of the repository that is associated with the image layers to check.
	RepositoryName *string
}

type BatchCheckLayerAvailabilityOutput

type BatchCheckLayerAvailabilityOutput struct {
	// Any failures associated with the call.
	Failures []*types.LayerFailure
	// A list of image layer objects corresponding to the image layer references in the
	// request.
	Layers []*types.Layer

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type BatchDeleteImageInput

type BatchDeleteImageInput struct {
	// A list of image ID references that correspond to images to delete. The format of
	// the imageIds reference is imageTag=tag or imageDigest=digest.
	ImageIds []*types.ImageIdentifier
	// The repository that contains the image to delete.
	RepositoryName *string
	// The AWS account ID associated with the registry that contains the image to
	// delete. If you do not specify a registry, the default registry is assumed.
	RegistryId *string
}

Deletes specified images within a specified repository. Images are specified with either the imageTag or imageDigest.

type BatchDeleteImageOutput

type BatchDeleteImageOutput struct {
	// The image IDs of the deleted images.
	ImageIds []*types.ImageIdentifier
	// Any failures associated with the call.
	Failures []*types.ImageFailure

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type BatchGetImageInput

type BatchGetImageInput struct {
	// A list of image ID references that correspond to images to describe. The format
	// of the imageIds reference is imageTag=tag or imageDigest=digest.
	ImageIds []*types.ImageIdentifier
	// The repository that contains the images to describe.
	RepositoryName *string
	// The AWS account ID associated with the registry that contains the images to
	// describe. If you do not specify a registry, the default registry is assumed.
	RegistryId *string
	// The accepted media types for the request. Valid values:
	// application/vnd.docker.distribution.manifest.v1+json |
	// application/vnd.docker.distribution.manifest.v2+json |
	// application/vnd.oci.image.manifest.v1+json
	AcceptedMediaTypes []*string
}

type BatchGetImageOutput

type BatchGetImageOutput struct {
	// Any failures associated with the call.
	Failures []*types.ImageFailure
	// A list of image objects corresponding to the image references in the request.
	Images []*types.Image

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type Client

type Client struct {
	// contains filtered or unexported fields
}

Amazon Elastic Container Registry Amazon Elastic Container Registry (Amazon ECR) is a managed container image registry service. Customers can use the familiar Docker CLI, or their preferred client, to push, pull, and manage images. Amazon ECR provides a secure, scalable, and reliable registry for your Docker or Open Container Initiative (OCI) images. Amazon ECR supports private repositories with resource-based permissions using IAM so that specific users or Amazon EC2 instances can access repositories and images.

func New

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) BatchCheckLayerAvailability

func (c *Client) BatchCheckLayerAvailability(ctx context.Context, params *BatchCheckLayerAvailabilityInput, optFns ...func(*Options)) (*BatchCheckLayerAvailabilityOutput, error)

Checks the availability of one or more image layers in a repository. When an image is pushed to a repository, each image layer is checked to verify if it has been uploaded before. If it has been uploaded, then the image layer is skipped. This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.

func (*Client) BatchDeleteImage

func (c *Client) BatchDeleteImage(ctx context.Context, params *BatchDeleteImageInput, optFns ...func(*Options)) (*BatchDeleteImageOutput, error)

Deletes a list of specified images within a repository. Images are specified with either an imageTag or imageDigest. You can remove a tag from an image by specifying the image's tag in your request. When you remove the last tag from an image, the image is deleted from your repository. You can completely delete an image (and all of its tags) by specifying the image's digest in your request.

func (*Client) BatchGetImage

func (c *Client) BatchGetImage(ctx context.Context, params *BatchGetImageInput, optFns ...func(*Options)) (*BatchGetImageOutput, error)

Gets detailed information for an image. Images are specified with either an imageTag or imageDigest. When an image is pulled, the BatchGetImage API is called once to retrieve the image manifest.

func (*Client) CompleteLayerUpload

func (c *Client) CompleteLayerUpload(ctx context.Context, params *CompleteLayerUploadInput, optFns ...func(*Options)) (*CompleteLayerUploadOutput, error)

Informs Amazon ECR that the image layer upload has completed for a specified registry, repository name, and upload ID. You can optionally provide a sha256 digest of the image layer for data validation purposes. When an image is pushed, the CompleteLayerUpload API is called once per each new image layer to verify that the upload has completed. This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.

func (*Client) CreateRepository

func (c *Client) CreateRepository(ctx context.Context, params *CreateRepositoryInput, optFns ...func(*Options)) (*CreateRepositoryOutput, error)

Creates a repository. For more information, see Amazon ECR Repositories (https://docs.aws.amazon.com/AmazonECR/latest/userguide/Repositories.html) in the Amazon Elastic Container Registry User Guide.

func (*Client) DeleteLifecyclePolicy

func (c *Client) DeleteLifecyclePolicy(ctx context.Context, params *DeleteLifecyclePolicyInput, optFns ...func(*Options)) (*DeleteLifecyclePolicyOutput, error)

Deletes the lifecycle policy associated with the specified repository.

func (*Client) DeleteRepository

func (c *Client) DeleteRepository(ctx context.Context, params *DeleteRepositoryInput, optFns ...func(*Options)) (*DeleteRepositoryOutput, error)

Deletes a repository. If the repository contains images, you must either delete all images in the repository or use the force option to delete the repository.

func (*Client) DeleteRepositoryPolicy

func (c *Client) DeleteRepositoryPolicy(ctx context.Context, params *DeleteRepositoryPolicyInput, optFns ...func(*Options)) (*DeleteRepositoryPolicyOutput, error)

Deletes the repository policy associated with the specified repository.

func (*Client) DescribeImageScanFindings

func (c *Client) DescribeImageScanFindings(ctx context.Context, params *DescribeImageScanFindingsInput, optFns ...func(*Options)) (*DescribeImageScanFindingsOutput, error)

Returns the scan findings for the specified image.

func (*Client) DescribeImages

func (c *Client) DescribeImages(ctx context.Context, params *DescribeImagesInput, optFns ...func(*Options)) (*DescribeImagesOutput, error)

Returns metadata about the images in a repository. Beginning with Docker version 1.9, the Docker client compresses image layers before pushing them to a V2 Docker registry. The output of the docker images command shows the uncompressed image size, so it may return a larger image size than the image sizes returned by DescribeImages ().

func (*Client) DescribeRepositories

func (c *Client) DescribeRepositories(ctx context.Context, params *DescribeRepositoriesInput, optFns ...func(*Options)) (*DescribeRepositoriesOutput, error)

Describes image repositories in a registry.

func (*Client) GetAuthorizationToken

func (c *Client) GetAuthorizationToken(ctx context.Context, params *GetAuthorizationTokenInput, optFns ...func(*Options)) (*GetAuthorizationTokenOutput, error)

Retrieves an authorization token. An authorization token represents your IAM authentication credentials and can be used to access any Amazon ECR registry that your IAM principal has access to. The authorization token is valid for 12 hours. The authorizationToken returned is a base64 encoded string that can be decoded and used in a docker login command to authenticate to a registry. The AWS CLI offers an get-login-password command that simplifies the login process. For more information, see Registry Authentication (https://docs.aws.amazon.com/AmazonECR/latest/userguide/Registries.html#registry_auth) in the Amazon Elastic Container Registry User Guide.

func (*Client) GetDownloadUrlForLayer

func (c *Client) GetDownloadUrlForLayer(ctx context.Context, params *GetDownloadUrlForLayerInput, optFns ...func(*Options)) (*GetDownloadUrlForLayerOutput, error)

Retrieves the pre-signed Amazon S3 download URL corresponding to an image layer. You can only get URLs for image layers that are referenced in an image. When an image is pulled, the GetDownloadUrlForLayer API is called once per image layer that is not already cached. This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.

func (*Client) GetLifecyclePolicy

func (c *Client) GetLifecyclePolicy(ctx context.Context, params *GetLifecyclePolicyInput, optFns ...func(*Options)) (*GetLifecyclePolicyOutput, error)

Retrieves the lifecycle policy for the specified repository.

func (*Client) GetLifecyclePolicyPreview

func (c *Client) GetLifecyclePolicyPreview(ctx context.Context, params *GetLifecyclePolicyPreviewInput, optFns ...func(*Options)) (*GetLifecyclePolicyPreviewOutput, error)

Retrieves the results of the lifecycle policy preview request for the specified repository.

func (*Client) GetRepositoryPolicy

func (c *Client) GetRepositoryPolicy(ctx context.Context, params *GetRepositoryPolicyInput, optFns ...func(*Options)) (*GetRepositoryPolicyOutput, error)

Retrieves the repository policy for the specified repository.

func (*Client) InitiateLayerUpload

func (c *Client) InitiateLayerUpload(ctx context.Context, params *InitiateLayerUploadInput, optFns ...func(*Options)) (*InitiateLayerUploadOutput, error)

Notifies Amazon ECR that you intend to upload an image layer. When an image is pushed, the InitiateLayerUpload API is called once per image layer that has not already been uploaded. Whether or not an image layer has been uploaded is determined by the BatchCheckLayerAvailability API action. This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.

func (*Client) ListImages

func (c *Client) ListImages(ctx context.Context, params *ListImagesInput, optFns ...func(*Options)) (*ListImagesOutput, error)

Lists all the image IDs for the specified repository. You can filter images based on whether or not they are tagged by using the tagStatus filter and specifying either TAGGED, UNTAGGED or ANY. For example, you can filter your results to return only UNTAGGED images and then pipe that result to a BatchDeleteImage () operation to delete them. Or, you can filter your results to return only TAGGED images to list all of the tags in your repository.

func (*Client) ListTagsForResource

func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

List the tags for an Amazon ECR resource.

func (*Client) PutImage

func (c *Client) PutImage(ctx context.Context, params *PutImageInput, optFns ...func(*Options)) (*PutImageOutput, error)

Creates or updates the image manifest and tags associated with an image. When an image is pushed and all new image layers have been uploaded, the PutImage API is called once to create or update the image manifest and the tags associated with the image. <note> <p>This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the <code>docker</code> CLI to pull, tag, and push images.</p> </note>

func (*Client) PutImageScanningConfiguration

func (c *Client) PutImageScanningConfiguration(ctx context.Context, params *PutImageScanningConfigurationInput, optFns ...func(*Options)) (*PutImageScanningConfigurationOutput, error)

Updates the image scanning configuration for the specified repository.

func (*Client) PutImageTagMutability

func (c *Client) PutImageTagMutability(ctx context.Context, params *PutImageTagMutabilityInput, optFns ...func(*Options)) (*PutImageTagMutabilityOutput, error)

Updates the image tag mutability settings for the specified repository. For more information, see Image Tag Mutability (https://docs.aws.amazon.com/AmazonECR/latest/userguide/image-tag-mutability.html) in the Amazon Elastic Container Registry User Guide.

func (*Client) PutLifecyclePolicy

func (c *Client) PutLifecyclePolicy(ctx context.Context, params *PutLifecyclePolicyInput, optFns ...func(*Options)) (*PutLifecyclePolicyOutput, error)

Creates or updates the lifecycle policy for the specified repository. For more information, see Lifecycle Policy Template (https://docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html).

func (*Client) SetRepositoryPolicy

func (c *Client) SetRepositoryPolicy(ctx context.Context, params *SetRepositoryPolicyInput, optFns ...func(*Options)) (*SetRepositoryPolicyOutput, error)

Applies a repository policy to the specified repository to control access permissions. For more information, see Amazon ECR Repository Policies (https://docs.aws.amazon.com/AmazonECR/latest/userguide/repository-policies.html) in the Amazon Elastic Container Registry User Guide.

func (*Client) StartImageScan

func (c *Client) StartImageScan(ctx context.Context, params *StartImageScanInput, optFns ...func(*Options)) (*StartImageScanOutput, error)

Starts an image vulnerability scan. An image scan can only be started once per day on an individual image. This limit includes if an image was scanned on initial push. For more information, see Image Scanning (https://docs.aws.amazon.com/AmazonECR/latest/userguide/image-scanning.html) in the Amazon Elastic Container Registry User Guide.

func (*Client) StartLifecyclePolicyPreview

func (c *Client) StartLifecyclePolicyPreview(ctx context.Context, params *StartLifecyclePolicyPreviewInput, optFns ...func(*Options)) (*StartLifecyclePolicyPreviewOutput, error)

Starts a preview of a lifecycle policy for the specified repository. This allows you to see the results before associating the lifecycle policy with the repository.

func (*Client) TagResource

func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)

Adds specified tags to a resource with the specified ARN. Existing tags on a resource are not changed if they are not specified in the request parameters.

func (*Client) UntagResource

func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)

Deletes specified tags from a resource.

func (*Client) UploadLayerPart

func (c *Client) UploadLayerPart(ctx context.Context, params *UploadLayerPartInput, optFns ...func(*Options)) (*UploadLayerPartOutput, error)

Uploads an image layer part to Amazon ECR. When an image is pushed, each new image layer is uploaded in parts. The maximum size of each image layer part can be 20971520 bytes (or about 20MB). The UploadLayerPart API is called once per each new image layer part. This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.

type CompleteLayerUploadInput

type CompleteLayerUploadInput struct {
	// The name of the repository to associate with the image layer.
	RepositoryName *string
	// The AWS account ID associated with the registry to which to upload layers. If
	// you do not specify a registry, the default registry is assumed.
	RegistryId *string
	// The sha256 digest of the image layer.
	LayerDigests []*string
	// The upload ID from a previous InitiateLayerUpload () operation to associate with
	// the image layer.
	UploadId *string
}

type CompleteLayerUploadOutput

type CompleteLayerUploadOutput struct {
	// The upload ID associated with the layer.
	UploadId *string
	// The repository name associated with the request.
	RepositoryName *string
	// The sha256 digest of the image layer.
	LayerDigest *string
	// The registry ID associated with the request.
	RegistryId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateRepositoryInput

type CreateRepositoryInput struct {
	// The image scanning configuration for the repository. This determines whether
	// images are scanned for known vulnerabilities after being pushed to the
	// repository.
	ImageScanningConfiguration *types.ImageScanningConfiguration
	// The metadata that you apply to the repository to help you categorize and
	// organize them. Each tag consists of a key and an optional value, both of which
	// you define. Tag keys can have a maximum character length of 128 characters, and
	// tag values can have a maximum length of 256 characters.
	Tags []*types.Tag
	// The encryption configuration for the repository. This determines how the
	// contents of your repository are encrypted at rest.
	EncryptionConfiguration *types.EncryptionConfiguration
	// The name to use for the repository. The repository name may be specified on its
	// own (such as nginx-web-app) or it can be prepended with a namespace to group the
	// repository into a category (such as project-a/nginx-web-app).
	RepositoryName *string
	// The tag mutability setting for the repository. If this parameter is omitted, the
	// default setting of MUTABLE will be used which will allow image tags to be
	// overwritten. If IMMUTABLE is specified, all image tags within the repository
	// will be immutable which will prevent them from being overwritten.
	ImageTagMutability types.ImageTagMutability
}

type CreateRepositoryOutput

type CreateRepositoryOutput struct {
	// The repository that was created.
	Repository *types.Repository

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteLifecyclePolicyInput

type DeleteLifecyclePolicyInput struct {
	// The AWS account ID associated with the registry that contains the repository. If
	// you do not specify a registry, the default registry is assumed.
	RegistryId *string
	// The name of the repository.
	RepositoryName *string
}

type DeleteLifecyclePolicyOutput

type DeleteLifecyclePolicyOutput struct {
	// The JSON lifecycle policy text.
	LifecyclePolicyText *string
	// The repository name associated with the request.
	RepositoryName *string
	// The time stamp of the last time that the lifecycle policy was run.
	LastEvaluatedAt *time.Time
	// The registry ID associated with the request.
	RegistryId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteRepositoryInput

type DeleteRepositoryInput struct {
	// The AWS account ID associated with the registry that contains the repository to
	// delete. If you do not specify a registry, the default registry is assumed.
	RegistryId *string
	// The name of the repository to delete.
	RepositoryName *string
	// If a repository contains images, forces the deletion.
	Force *bool
}

type DeleteRepositoryOutput

type DeleteRepositoryOutput struct {
	// The repository that was deleted.
	Repository *types.Repository

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteRepositoryPolicyInput

type DeleteRepositoryPolicyInput struct {
	// The AWS account ID associated with the registry that contains the repository
	// policy to delete. If you do not specify a registry, the default registry is
	// assumed.
	RegistryId *string
	// The name of the repository that is associated with the repository policy to
	// delete.
	RepositoryName *string
}

type DeleteRepositoryPolicyOutput

type DeleteRepositoryPolicyOutput struct {
	// The JSON repository policy that was deleted from the repository.
	PolicyText *string
	// The registry ID associated with the request.
	RegistryId *string
	// The repository name associated with the request.
	RepositoryName *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeImageScanFindingsInput

type DescribeImageScanFindingsInput struct {
	// The maximum number of image scan results returned by DescribeImageScanFindings
	// in paginated output. When this parameter is used, DescribeImageScanFindings only
	// returns maxResults results in a single page along with a nextToken response
	// element. The remaining results of the initial request can be seen by sending
	// another DescribeImageScanFindings request with the returned nextToken value.
	// This value can be between 1 and 1000. If this parameter is not used, then
	// DescribeImageScanFindings returns up to 100 results and a nextToken value, if
	// applicable.
	MaxResults *int32
	// The repository for the image for which to describe the scan findings.
	RepositoryName *string
	// An object with identifying information for an Amazon ECR image.
	ImageId *types.ImageIdentifier
	// The AWS account ID associated with the registry that contains the repository in
	// which to describe the image scan findings for. If you do not specify a registry,
	// the default registry is assumed.
	RegistryId *string
	// The nextToken value returned from a previous paginated DescribeImageScanFindings
	// request where maxResults was used and the results exceeded the value of that
	// parameter. Pagination continues from the end of the previous results that
	// returned the nextToken value. This value is null when there are no more results
	// to return.
	NextToken *string
}

type DescribeImageScanFindingsOutput

type DescribeImageScanFindingsOutput struct {
	// The registry ID associated with the request.
	RegistryId *string
	// The current state of the scan.
	ImageScanStatus *types.ImageScanStatus
	// The repository name associated with the request.
	RepositoryName *string
	// An object with identifying information for an Amazon ECR image.
	ImageId *types.ImageIdentifier
	// The information contained in the image scan findings.
	ImageScanFindings *types.ImageScanFindings
	// The nextToken value to include in a future DescribeImageScanFindings request.
	// When the results of a DescribeImageScanFindings request exceed maxResults, this
	// value can be used to retrieve the next page of results. This value is null when
	// there are no more results to return.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeImagesInput

type DescribeImagesInput struct {
	// The AWS account ID associated with the registry that contains the repository in
	// which to describe images. If you do not specify a registry, the default registry
	// is assumed.
	RegistryId *string
	// The nextToken value returned from a previous paginated DescribeImages request
	// where maxResults was used and the results exceeded the value of that parameter.
	// Pagination continues from the end of the previous results that returned the
	// nextToken value. This value is null when there are no more results to return.
	// This option cannot be used when you specify images with imageIds.
	NextToken *string
	// The maximum number of repository results returned by DescribeImages in paginated
	// output. When this parameter is used, DescribeImages only returns maxResults
	// results in a single page along with a nextToken response element. The remaining
	// results of the initial request can be seen by sending another DescribeImages
	// request with the returned nextToken value. This value can be between 1 and 1000.
	// If this parameter is not used, then DescribeImages returns up to 100 results and
	// a nextToken value, if applicable. This option cannot be used when you specify
	// images with imageIds.
	MaxResults *int32
	// The filter key and value with which to filter your DescribeImages results.
	Filter *types.DescribeImagesFilter
	// The repository that contains the images to describe.
	RepositoryName *string
	// The list of image IDs for the requested repository.
	ImageIds []*types.ImageIdentifier
}

type DescribeImagesOutput

type DescribeImagesOutput struct {
	// A list of ImageDetail () objects that contain data about the image.
	ImageDetails []*types.ImageDetail
	// The nextToken value to include in a future DescribeImages request. When the
	// results of a DescribeImages request exceed maxResults, this value can be used to
	// retrieve the next page of results. This value is null when there are no more
	// results to return.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeRepositoriesInput

type DescribeRepositoriesInput struct {
	// The AWS account ID associated with the registry that contains the repositories
	// to be described. If you do not specify a registry, the default registry is
	// assumed.
	RegistryId *string
	// The nextToken value returned from a previous paginated DescribeRepositories
	// request where maxResults was used and the results exceeded the value of that
	// parameter. Pagination continues from the end of the previous results that
	// returned the nextToken value. This value is null when there are no more results
	// to return. This option cannot be used when you specify repositories with
	// repositoryNames. This token should be treated as an opaque identifier that is
	// only used to retrieve the next items in a list and not for other programmatic
	// purposes.
	NextToken *string
	// A list of repositories to describe. If this parameter is omitted, then all
	// repositories in a registry are described.
	RepositoryNames []*string
	// The maximum number of repository results returned by DescribeRepositories in
	// paginated output. When this parameter is used, DescribeRepositories only returns
	// maxResults results in a single page along with a nextToken response element. The
	// remaining results of the initial request can be seen by sending another
	// DescribeRepositories request with the returned nextToken value. This value can
	// be between 1 and 1000. If this parameter is not used, then DescribeRepositories
	// returns up to 100 results and a nextToken value, if applicable. This option
	// cannot be used when you specify repositories with repositoryNames.
	MaxResults *int32
}

type DescribeRepositoriesOutput

type DescribeRepositoriesOutput struct {
	// A list of repository objects corresponding to valid repositories.
	Repositories []*types.Repository
	// The nextToken value to include in a future DescribeRepositories request. When
	// the results of a DescribeRepositories request exceed maxResults, this value can
	// be used to retrieve the next page of results. This value is null when there are
	// no more results to return.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type EndpointResolver

type EndpointResolver interface {
	ResolveEndpoint(region string, options ResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func WithEndpointResolver

func WithEndpointResolver(awsResolver aws.EndpointResolver, fallbackResolver EndpointResolver) EndpointResolver

WithEndpointResolver returns an EndpointResolver that first delegates endpoint resolution to the awsResolver. If awsResolver returns aws.EndpointNotFoundError error, the resolver will use the the provided fallbackResolver for resolution. awsResolver and fallbackResolver must not be nil

type EndpointResolverFunc

type EndpointResolverFunc func(region string, options ResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options ResolverOptions) (endpoint aws.Endpoint, err error)

type GetAuthorizationTokenInput

type GetAuthorizationTokenInput struct {
	// A list of AWS account IDs that are associated with the registries for which to
	// get AuthorizationData objects. If you do not specify a registry, the default
	// registry is assumed.
	RegistryIds []*string
}

type GetAuthorizationTokenOutput

type GetAuthorizationTokenOutput struct {
	// A list of authorization token data objects that correspond to the registryIds
	// values in the request.
	AuthorizationData []*types.AuthorizationData

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetDownloadUrlForLayerInput

type GetDownloadUrlForLayerInput struct {
	// The AWS account ID associated with the registry that contains the image layer to
	// download. If you do not specify a registry, the default registry is assumed.
	RegistryId *string
	// The digest of the image layer to download.
	LayerDigest *string
	// The name of the repository that is associated with the image layer to download.
	RepositoryName *string
}

type GetDownloadUrlForLayerOutput

type GetDownloadUrlForLayerOutput struct {
	// The digest of the image layer to download.
	LayerDigest *string
	// The pre-signed Amazon S3 download URL for the requested layer.
	DownloadUrl *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetLifecyclePolicyInput

type GetLifecyclePolicyInput struct {
	// The name of the repository.
	RepositoryName *string
	// The AWS account ID associated with the registry that contains the repository. If
	// you do not specify a registry, the default registry is assumed.
	RegistryId *string
}

type GetLifecyclePolicyOutput

type GetLifecyclePolicyOutput struct {
	// The repository name associated with the request.
	RepositoryName *string
	// The JSON lifecycle policy text.
	LifecyclePolicyText *string
	// The time stamp of the last time that the lifecycle policy was run.
	LastEvaluatedAt *time.Time
	// The registry ID associated with the request.
	RegistryId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetLifecyclePolicyPreviewInput

type GetLifecyclePolicyPreviewInput struct {
	// The name of the repository.
	RepositoryName *string
	// The maximum number of repository results returned by
	// GetLifecyclePolicyPreviewRequest in
 paginated output. When this parameter is
	// used, GetLifecyclePolicyPreviewRequest only returns
 maxResults results in a
	// single page along with a nextToken
 response element. The remaining results of
	// the initial request can be seen by sending
 another
	// GetLifecyclePolicyPreviewRequest request with the returned nextToken
 value.
	// This value can be between 1 and 1000. If this
 parameter is not used, then
	// GetLifecyclePolicyPreviewRequest returns up to
 100 results and a nextToken
	// value, if
 applicable. This option cannot be used when you specify images with
	// imageIds.
	MaxResults *int32
	// An optional parameter that filters results based on image tag status and all
	// tags, if tagged.
	Filter *types.LifecyclePolicyPreviewFilter
	// The list of imageIDs to be included.
	ImageIds []*types.ImageIdentifier
	// The nextToken value returned from a previous paginated
	// GetLifecyclePolicyPreviewRequest request where maxResults was used and the
	// results exceeded the value of that parameter. Pagination continues from the end
	// of the
 previous results that returned the nextToken value. This value is
 null
	// when there are no more results to return. This option cannot be used when you
	// specify images with imageIds.
	NextToken *string
	// The AWS account ID associated with the registry that contains the repository. If
	// you do not specify a registry, the default registry is assumed.
	RegistryId *string
}

type GetLifecyclePolicyPreviewOutput

type GetLifecyclePolicyPreviewOutput struct {
	// The results of the lifecycle policy preview request.
	PreviewResults []*types.LifecyclePolicyPreviewResult
	// The repository name associated with the request.
	RepositoryName *string
	// The JSON lifecycle policy text.
	LifecyclePolicyText *string
	// The nextToken value to include in a future GetLifecyclePolicyPreview request.
	// When the results of a GetLifecyclePolicyPreview request exceed maxResults, this
	// value can be used to retrieve the next page of results. This value is null when
	// there are no more results to return.
	NextToken *string
	// The registry ID associated with the request.
	RegistryId *string
	// The status of the lifecycle policy preview request.
	Status types.LifecyclePolicyPreviewStatus
	// The list of images that is returned as a result of the action.
	Summary *types.LifecyclePolicyPreviewSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetRepositoryPolicyInput

type GetRepositoryPolicyInput struct {
	// The AWS account ID associated with the registry that contains the repository. If
	// you do not specify a registry, the default registry is assumed.
	RegistryId *string
	// The name of the repository with the policy to retrieve.
	RepositoryName *string
}

type GetRepositoryPolicyOutput

type GetRepositoryPolicyOutput struct {
	// The registry ID associated with the request.
	RegistryId *string
	// The JSON repository policy text associated with the repository.
	PolicyText *string
	// The repository name associated with the request.
	RepositoryName *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type HTTPClient

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time) error
}

type InitiateLayerUploadInput

type InitiateLayerUploadInput struct {
	// The name of the repository to which you intend to upload layers.
	RepositoryName *string
	// The AWS account ID associated with the registry to which you intend to upload
	// layers. If you do not specify a registry, the default registry is assumed.
	RegistryId *string
}

type InitiateLayerUploadOutput

type InitiateLayerUploadOutput struct {
	// The size, in bytes, that Amazon ECR expects future layer part uploads to be.
	PartSize *int64
	// The upload ID for the layer upload. This parameter is passed to further
	// UploadLayerPart () and CompleteLayerUpload () operations.
	UploadId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListImagesInput

type ListImagesInput struct {
	// The nextToken value returned from a previous paginated ListImages request where
	// maxResults was used and the results exceeded the value of that parameter.
	// Pagination continues from the end of the previous results that returned the
	// nextToken value. This value is null when there are no more results to return.
	// This token should be treated as an opaque identifier that is only used to
	// retrieve the next items in a list and not for other programmatic purposes.
	NextToken *string
	// The maximum number of image results returned by ListImages in paginated output.
	// When this parameter is used, ListImages only returns maxResults results in a
	// single page along with a nextToken response element. The remaining results of
	// the initial request can be seen by sending another ListImages request with the
	// returned nextToken value. This value can be between 1 and 1000. If this
	// parameter is not used, then ListImages returns up to 100 results and a nextToken
	// value, if applicable.
	MaxResults *int32
	// The filter key and value with which to filter your ListImages results.
	Filter *types.ListImagesFilter
	// The repository with image IDs to be listed.
	RepositoryName *string
	// The AWS account ID associated with the registry that contains the repository in
	// which to list images. If you do not specify a registry, the default registry is
	// assumed.
	RegistryId *string
}

type ListImagesOutput

type ListImagesOutput struct {
	// The nextToken value to include in a future ListImages request. When the results
	// of a ListImages request exceed maxResults, this value can be used to retrieve
	// the next page of results. This value is null when there are no more results to
	// return.
	NextToken *string
	// The list of image IDs for the requested repository.
	ImageIds []*types.ImageIdentifier

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListTagsForResourceInput

type ListTagsForResourceInput struct {
	// The Amazon Resource Name (ARN) that identifies the resource for which to list
	// the tags. Currently, the only supported resource is an Amazon ECR repository.
	ResourceArn *string
}

type ListTagsForResourceOutput

type ListTagsForResourceOutput struct {
	// The tags for the resource.
	Tags []*types.Tag

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type Options

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions ResolverOptions

	// The service endpoint resolver.
	EndpointResolver EndpointResolver

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// The region to send requests to. (Required)
	Region string

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer.
	Retryer retry.Retryer

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient
}

func (Options) Copy

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

func (Options) GetCredentials

func (o Options) GetCredentials() aws.CredentialsProvider

func (Options) GetEndpointOptions

func (o Options) GetEndpointOptions() ResolverOptions

func (Options) GetEndpointResolver

func (o Options) GetEndpointResolver() EndpointResolver

func (Options) GetHTTPSignerV4

func (o Options) GetHTTPSignerV4() HTTPSignerV4

func (Options) GetRegion

func (o Options) GetRegion() string

func (Options) GetRetryer

func (o Options) GetRetryer() retry.Retryer

type PutImageInput

type PutImageInput struct {
	// The media type of the image manifest. If you push an image manifest that does
	// not contain the mediaType field, you must specify the imageManifestMediaType in
	// the request.
	ImageManifestMediaType *string
	// The AWS account ID associated with the registry that contains the repository in
	// which to put the image. If you do not specify a registry, the default registry
	// is assumed.
	RegistryId *string
	// The image manifest corresponding to the image to be uploaded.
	ImageManifest *string
	// The name of the repository in which to put the image.
	RepositoryName *string
	// The tag to associate with the image. This parameter is required for images that
	// use the Docker Image Manifest V2 Schema 2 or Open Container Initiative (OCI)
	// formats.
	ImageTag *string
	// The image digest of the image manifest corresponding to the image.
	ImageDigest *string
}

type PutImageOutput

type PutImageOutput struct {
	// Details of the image uploaded.
	Image *types.Image

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type PutImageScanningConfigurationInput

type PutImageScanningConfigurationInput struct {
	// The name of the repository in which to update the image scanning configuration
	// setting.
	RepositoryName *string
	// The image scanning configuration for the repository. This setting determines
	// whether images are scanned for known vulnerabilities after being pushed to the
	// repository.
	ImageScanningConfiguration *types.ImageScanningConfiguration
	// The AWS account ID associated with the registry that contains the repository in
	// which to update the image scanning configuration setting. If you do not specify
	// a registry, the default registry is assumed.
	RegistryId *string
}

type PutImageScanningConfigurationOutput

type PutImageScanningConfigurationOutput struct {
	// The image scanning configuration setting for the repository.
	ImageScanningConfiguration *types.ImageScanningConfiguration
	// The registry ID associated with the request.
	RegistryId *string
	// The repository name associated with the request.
	RepositoryName *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type PutImageTagMutabilityInput

type PutImageTagMutabilityInput struct {
	// The tag mutability setting for the repository. If MUTABLE is specified, image
	// tags can be overwritten. If IMMUTABLE is specified, all image tags within the
	// repository will be immutable which will prevent them from being overwritten.
	ImageTagMutability types.ImageTagMutability
	// The name of the repository in which to update the image tag mutability settings.
	RepositoryName *string
	// The AWS account ID associated with the registry that contains the repository in
	// which to update the image tag mutability settings. If you do not specify a
	// registry, the default registry is assumed.
	RegistryId *string
}

type PutImageTagMutabilityOutput

type PutImageTagMutabilityOutput struct {
	// The image tag mutability setting for the repository.
	ImageTagMutability types.ImageTagMutability
	// The repository name associated with the request.
	RepositoryName *string
	// The registry ID associated with the request.
	RegistryId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type PutLifecyclePolicyInput

type PutLifecyclePolicyInput struct {
	// The name of the repository to receive the policy.
	RepositoryName *string
	// The AWS account ID associated with the registry that contains the repository. If
	// you do
 not specify a registry, the default registry is assumed.
	RegistryId *string
	// The JSON repository policy text to apply to the repository.
	LifecyclePolicyText *string
}

type PutLifecyclePolicyOutput

type PutLifecyclePolicyOutput struct {
	// The repository name associated with the request.
	RepositoryName *string
	// The JSON repository policy text.
	LifecyclePolicyText *string
	// The registry ID associated with the request.
	RegistryId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ResolveEndpoint

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  ResolverOptions
}

func (*ResolveEndpoint) HandleSerialize

func (*ResolveEndpoint) ID

func (*ResolveEndpoint) ID() string

type ResolveEndpointMiddlewareOptions

type ResolveEndpointMiddlewareOptions interface {
	GetEndpointResolver() EndpointResolver
	GetEndpointOptions() ResolverOptions
}

type ResolverOptions

type ResolverOptions = internalendpoints.Options

ResolverOptions is the service endpoint resolver options

type SetRepositoryPolicyInput

type SetRepositoryPolicyInput struct {
	// The JSON repository policy text to apply to the repository. For more
	// information, see Amazon ECR Repository Policies
	// (https://docs.aws.amazon.com/AmazonECR/latest/userguide/repository-policy-examples.html)
	// in the Amazon Elastic Container Registry User Guide.
	PolicyText *string
	// If the policy you are attempting to set on a repository policy would prevent you
	// from setting another policy in the future, you must force the
	// SetRepositoryPolicy () operation. This is intended to prevent accidental
	// repository lock outs.
	Force *bool
	// The name of the repository to receive the policy.
	RepositoryName *string
	// The AWS account ID associated with the registry that contains the repository. If
	// you do not specify a registry, the default registry is assumed.
	RegistryId *string
}

type SetRepositoryPolicyOutput

type SetRepositoryPolicyOutput struct {
	// The repository name associated with the request.
	RepositoryName *string
	// The JSON repository policy text applied to the repository.
	PolicyText *string
	// The registry ID associated with the request.
	RegistryId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type StartImageScanInput

type StartImageScanInput struct {
	// An object with identifying information for an Amazon ECR image.
	ImageId *types.ImageIdentifier
	// The AWS account ID associated with the registry that contains the repository in
	// which to start an image scan request. If you do not specify a registry, the
	// default registry is assumed.
	RegistryId *string
	// The name of the repository that contains the images to scan.
	RepositoryName *string
}

type StartImageScanOutput

type StartImageScanOutput struct {
	// An object with identifying information for an Amazon ECR image.
	ImageId *types.ImageIdentifier
	// The current state of the scan.
	ImageScanStatus *types.ImageScanStatus
	// The registry ID associated with the request.
	RegistryId *string
	// The repository name associated with the request.
	RepositoryName *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type StartLifecyclePolicyPreviewInput

type StartLifecyclePolicyPreviewInput struct {
	// The AWS account ID associated with the registry that contains the repository. If
	// you do not specify a registry, the default registry is assumed.
	RegistryId *string
	// The name of the repository to be evaluated.
	RepositoryName *string
	// The policy to be evaluated against. If you do not specify a policy, the current
	// policy for the repository is used.
	LifecyclePolicyText *string
}

type StartLifecyclePolicyPreviewOutput

type StartLifecyclePolicyPreviewOutput struct {
	// The repository name associated with the request.
	RepositoryName *string
	// The registry ID associated with the request.
	RegistryId *string
	// The status of the lifecycle policy preview request.
	Status types.LifecyclePolicyPreviewStatus
	// The JSON repository policy text.
	LifecyclePolicyText *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type TagResourceInput

type TagResourceInput struct {
	// The tags to add to the resource. A tag is an array of key-value pairs. Tag keys
	// can have a maximum character length of 128 characters, and tag values can have a
	// maximum length of 256 characters.
	Tags []*types.Tag
	// The Amazon Resource Name (ARN) of the the resource to which to add tags.
	// Currently, the only supported resource is an Amazon ECR repository.
	ResourceArn *string
}

type TagResourceOutput

type TagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UntagResourceInput

type UntagResourceInput struct {
	// The keys of the tags to be removed.
	TagKeys []*string
	// The Amazon Resource Name (ARN) of the resource from which to remove tags.
	// Currently, the only supported resource is an Amazon ECR repository.
	ResourceArn *string
}

type UntagResourceOutput

type UntagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UploadLayerPartInput

type UploadLayerPartInput struct {
	// The name of the repository to which you are uploading layer parts.
	RepositoryName *string
	// The position of the first byte of the layer part witin the overall image layer.
	PartFirstByte *int64
	// The position of the last byte of the layer part within the overall image layer.
	PartLastByte *int64
	// The AWS account ID associated with the registry to which you are uploading layer
	// parts. If you do not specify a registry, the default registry is assumed.
	RegistryId *string
	// The upload ID from a previous InitiateLayerUpload () operation to associate with
	// the layer part upload.
	UploadId *string
	// The base64-encoded layer part payload.
	LayerPartBlob []byte
}

type UploadLayerPartOutput

type UploadLayerPartOutput struct {
	// The registry ID associated with the request.
	RegistryId *string
	// The upload ID associated with the request.
	UploadId *string
	// The integer value of the last byte received in the request.
	LastByteReceived *int64
	// The repository name associated with the request.
	RepositoryName *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Directories

Path Synopsis
internal

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL