Documentation ¶
Overview ¶
Package ecrpublic provides the API client, operations, and parameter types for Amazon Elastic Container Registry Public.
Amazon Elastic Container Registry Public ¶
Amazon Elastic Container Registry Public (Amazon ECR Public) is a managed container image registry service. Amazon ECR provides both public and private registries to host your container images. You can use the Docker CLI or your 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 public repositories with this API. For information about the Amazon ECR API for private repositories, see Amazon Elastic Container Registry API Reference.
Index ¶
- Constants
- func NewDefaultEndpointResolver() *internalendpoints.Resolver
- func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
- func WithEndpointResolver(v EndpointResolver) func(*Options)deprecated
- func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)
- func WithSigV4SigningName(name string) func(*Options)
- func WithSigV4SigningRegion(region string) func(*Options)
- type AuthResolverParameters
- type AuthSchemeResolver
- type BatchCheckLayerAvailabilityInput
- type BatchCheckLayerAvailabilityOutput
- type BatchDeleteImageInput
- type BatchDeleteImageOutput
- type Client
- func (c *Client) BatchCheckLayerAvailability(ctx context.Context, params *BatchCheckLayerAvailabilityInput, ...) (*BatchCheckLayerAvailabilityOutput, error)
- func (c *Client) BatchDeleteImage(ctx context.Context, params *BatchDeleteImageInput, optFns ...func(*Options)) (*BatchDeleteImageOutput, error)
- func (c *Client) CompleteLayerUpload(ctx context.Context, params *CompleteLayerUploadInput, ...) (*CompleteLayerUploadOutput, error)
- func (c *Client) CreateRepository(ctx context.Context, params *CreateRepositoryInput, optFns ...func(*Options)) (*CreateRepositoryOutput, error)
- func (c *Client) DeleteRepository(ctx context.Context, params *DeleteRepositoryInput, optFns ...func(*Options)) (*DeleteRepositoryOutput, error)
- func (c *Client) DeleteRepositoryPolicy(ctx context.Context, params *DeleteRepositoryPolicyInput, ...) (*DeleteRepositoryPolicyOutput, error)
- func (c *Client) DescribeImageTags(ctx context.Context, params *DescribeImageTagsInput, optFns ...func(*Options)) (*DescribeImageTagsOutput, error)
- func (c *Client) DescribeImages(ctx context.Context, params *DescribeImagesInput, optFns ...func(*Options)) (*DescribeImagesOutput, error)
- func (c *Client) DescribeRegistries(ctx context.Context, params *DescribeRegistriesInput, optFns ...func(*Options)) (*DescribeRegistriesOutput, error)
- func (c *Client) DescribeRepositories(ctx context.Context, params *DescribeRepositoriesInput, ...) (*DescribeRepositoriesOutput, error)
- func (c *Client) GetAuthorizationToken(ctx context.Context, params *GetAuthorizationTokenInput, ...) (*GetAuthorizationTokenOutput, error)
- func (c *Client) GetRegistryCatalogData(ctx context.Context, params *GetRegistryCatalogDataInput, ...) (*GetRegistryCatalogDataOutput, error)
- func (c *Client) GetRepositoryCatalogData(ctx context.Context, params *GetRepositoryCatalogDataInput, ...) (*GetRepositoryCatalogDataOutput, error)
- func (c *Client) GetRepositoryPolicy(ctx context.Context, params *GetRepositoryPolicyInput, ...) (*GetRepositoryPolicyOutput, error)
- func (c *Client) InitiateLayerUpload(ctx context.Context, params *InitiateLayerUploadInput, ...) (*InitiateLayerUploadOutput, error)
- func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, ...) (*ListTagsForResourceOutput, error)
- func (c *Client) Options() Options
- func (c *Client) PutImage(ctx context.Context, params *PutImageInput, optFns ...func(*Options)) (*PutImageOutput, error)
- func (c *Client) PutRegistryCatalogData(ctx context.Context, params *PutRegistryCatalogDataInput, ...) (*PutRegistryCatalogDataOutput, error)
- func (c *Client) PutRepositoryCatalogData(ctx context.Context, params *PutRepositoryCatalogDataInput, ...) (*PutRepositoryCatalogDataOutput, error)
- func (c *Client) SetRepositoryPolicy(ctx context.Context, params *SetRepositoryPolicyInput, ...) (*SetRepositoryPolicyOutput, error)
- func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
- func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)
- func (c *Client) UploadLayerPart(ctx context.Context, params *UploadLayerPartInput, optFns ...func(*Options)) (*UploadLayerPartOutput, error)
- type CompleteLayerUploadInput
- type CompleteLayerUploadOutput
- type CreateRepositoryInput
- type CreateRepositoryOutput
- type DeleteRepositoryInput
- type DeleteRepositoryOutput
- type DeleteRepositoryPolicyInput
- type DeleteRepositoryPolicyOutput
- type DescribeImageTagsAPIClient
- type DescribeImageTagsInput
- type DescribeImageTagsOutput
- type DescribeImageTagsPaginator
- type DescribeImageTagsPaginatorOptions
- type DescribeImagesAPIClient
- type DescribeImagesInput
- type DescribeImagesOutput
- type DescribeImagesPaginator
- type DescribeImagesPaginatorOptions
- type DescribeRegistriesAPIClient
- type DescribeRegistriesInput
- type DescribeRegistriesOutput
- type DescribeRegistriesPaginator
- type DescribeRegistriesPaginatorOptions
- type DescribeRepositoriesAPIClient
- type DescribeRepositoriesInput
- type DescribeRepositoriesOutput
- type DescribeRepositoriesPaginator
- type DescribeRepositoriesPaginatorOptions
- type EndpointParameters
- type EndpointResolver
- type EndpointResolverFunc
- type EndpointResolverOptions
- type EndpointResolverV2
- type GetAuthorizationTokenInput
- type GetAuthorizationTokenOutput
- type GetRegistryCatalogDataInput
- type GetRegistryCatalogDataOutput
- type GetRepositoryCatalogDataInput
- type GetRepositoryCatalogDataOutput
- type GetRepositoryPolicyInput
- type GetRepositoryPolicyOutput
- type HTTPClient
- type HTTPSignerV4
- type InitiateLayerUploadInput
- type InitiateLayerUploadOutput
- type ListTagsForResourceInput
- type ListTagsForResourceOutput
- type Options
- type PutImageInput
- type PutImageOutput
- type PutRegistryCatalogDataInput
- type PutRegistryCatalogDataOutput
- type PutRepositoryCatalogDataInput
- type PutRepositoryCatalogDataOutput
- type ResolveEndpoint
- type SetRepositoryPolicyInput
- type SetRepositoryPolicyOutput
- type TagResourceInput
- type TagResourceOutput
- type UntagResourceInput
- type UntagResourceOutput
- type UploadLayerPartInput
- type UploadLayerPartOutput
Constants ¶
const ServiceAPIVersion = "2020-10-30"
const ServiceID = "ECR PUBLIC"
Variables ¶
This section is empty.
Functions ¶
func NewDefaultEndpointResolver ¶
func NewDefaultEndpointResolver() *internalendpoints.Resolver
NewDefaultEndpointResolver constructs a new service endpoint resolver
func WithAPIOptions ¶ added in v1.0.0
func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
WithAPIOptions returns a functional option for setting the Client's APIOptions option.
func WithEndpointResolver
deprecated
func WithEndpointResolver(v EndpointResolver) func(*Options)
Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint.
To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.
func WithEndpointResolverV2 ¶ added in v1.17.0
func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)
WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.
func WithSigV4SigningName ¶ added in v1.20.2
WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.
This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.
func WithSigV4SigningRegion ¶ added in v1.20.2
WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.
This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.
Types ¶
type AuthResolverParameters ¶ added in v1.20.2
type AuthResolverParameters struct { // The name of the operation being invoked. Operation string // The region in which the operation is being invoked. Region string }
AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.
type AuthSchemeResolver ¶ added in v1.20.2
type AuthSchemeResolver interface {
ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}
AuthSchemeResolver returns a set of possible authentication options for an operation.
type BatchCheckLayerAvailabilityInput ¶
type BatchCheckLayerAvailabilityInput struct { // The digests of the image layers to check. // // This member is required. LayerDigests []string // The name of the repository that's associated with the image layers to check. // // This member is required. RepositoryName *string // The Amazon Web Services account ID, or registry alias, associated with the // public registry that contains the image layers to check. If you do not specify a // registry, the default public registry is assumed. RegistryId *string // contains filtered or unexported fields }
type BatchCheckLayerAvailabilityOutput ¶
type BatchCheckLayerAvailabilityOutput struct { // Any failures associated with the call. Failures []types.LayerFailure // A list of image layer objects that correspond to the image layer references in // the request. Layers []types.Layer // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
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 . // // This member is required. ImageIds []types.ImageIdentifier // The repository in a public registry that contains the image to delete. // // This member is required. RepositoryName *string // The Amazon Web Services account ID, or registry alias, that's associated with // the registry that contains the image to delete. If you do not specify a // registry, the default public registry is assumed. RegistryId *string // contains filtered or unexported fields }
type BatchDeleteImageOutput ¶
type BatchDeleteImageOutput struct { // Any failures associated with the call. Failures []types.ImageFailure // The image IDs of the deleted images. ImageIds []types.ImageIdentifier // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client provides the API client to make operations call for Amazon Elastic Container Registry Public.
func New ¶
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 ¶
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 that are within a repository in a public registry. 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 that are within a repository in a public registry. 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 digest of the image in your request.
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 is complete for a specified public 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 for each new image layer to verify that the upload is complete.
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 in a public registry. For more information, see Amazon ECR repositories in the Amazon Elastic Container Registry User Guide.
func (*Client) DeleteRepository ¶
func (c *Client) DeleteRepository(ctx context.Context, params *DeleteRepositoryInput, optFns ...func(*Options)) (*DeleteRepositoryOutput, error)
Deletes a repository in a public registry. If the repository contains images, you must either manually delete all images in the repository or use the force option. This option deletes all images on your behalf before deleting the repository.
func (*Client) DeleteRepositoryPolicy ¶
func (c *Client) DeleteRepositoryPolicy(ctx context.Context, params *DeleteRepositoryPolicyInput, optFns ...func(*Options)) (*DeleteRepositoryPolicyOutput, error)
Deletes the repository policy that's associated with the specified repository.
func (*Client) DescribeImageTags ¶
func (c *Client) DescribeImageTags(ctx context.Context, params *DescribeImageTagsInput, optFns ...func(*Options)) (*DescribeImageTagsOutput, error)
Returns the image tag details for a repository in a public registry.
func (*Client) DescribeImages ¶
func (c *Client) DescribeImages(ctx context.Context, params *DescribeImagesInput, optFns ...func(*Options)) (*DescribeImagesOutput, error)
Returns metadata that's related to the images in a repository in a public registry.
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. Therefore, it might return a larger image size than the image sizes that are returned by DescribeImages.
func (*Client) DescribeRegistries ¶
func (c *Client) DescribeRegistries(ctx context.Context, params *DescribeRegistriesInput, optFns ...func(*Options)) (*DescribeRegistriesOutput, error)
Returns details for a public registry.
func (*Client) DescribeRepositories ¶
func (c *Client) DescribeRepositories(ctx context.Context, params *DescribeRepositoriesInput, optFns ...func(*Options)) (*DescribeRepositoriesOutput, error)
Describes repositories that are in a public 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. You can use it to access any Amazon ECR registry that your IAM principal has access to. The authorization token is valid for 12 hours. This API requires the ecr-public:GetAuthorizationToken and sts:GetServiceBearerToken permissions.
func (*Client) GetRegistryCatalogData ¶
func (c *Client) GetRegistryCatalogData(ctx context.Context, params *GetRegistryCatalogDataInput, optFns ...func(*Options)) (*GetRegistryCatalogDataOutput, error)
Retrieves catalog metadata for a public registry.
func (*Client) GetRepositoryCatalogData ¶
func (c *Client) GetRepositoryCatalogData(ctx context.Context, params *GetRepositoryCatalogDataInput, optFns ...func(*Options)) (*GetRepositoryCatalogDataOutput, error)
Retrieve catalog metadata for a repository in a public registry. This metadata is displayed publicly in the Amazon ECR Public Gallery.
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 for each image layer that hasn't already been uploaded. Whether an image layer uploads 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) ListTagsForResource ¶ added in v1.2.0
func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)
List the tags for an Amazon ECR Public resource.
func (*Client) Options ¶ added in v1.21.0
Options returns a copy of the client configuration.
Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.
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 that are 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 that are associated with the image.
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) PutRegistryCatalogData ¶
func (c *Client) PutRegistryCatalogData(ctx context.Context, params *PutRegistryCatalogDataInput, optFns ...func(*Options)) (*PutRegistryCatalogDataOutput, error)
Create or update the catalog data for a public registry.
func (*Client) PutRepositoryCatalogData ¶
func (c *Client) PutRepositoryCatalogData(ctx context.Context, params *PutRepositoryCatalogDataInput, optFns ...func(*Options)) (*PutRepositoryCatalogDataOutput, error)
Creates or updates the catalog data for a repository in a public registry.
func (*Client) SetRepositoryPolicy ¶
func (c *Client) SetRepositoryPolicy(ctx context.Context, params *SetRepositoryPolicyInput, optFns ...func(*Options)) (*SetRepositoryPolicyOutput, error)
Applies a repository policy to the specified public repository to control access permissions. For more information, see Amazon ECR Repository Policiesin the Amazon Elastic Container Registry User Guide.
func (*Client) TagResource ¶ added in v1.2.0
func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
Associates the specified tags to a resource with the specified resourceArn . If existing tags on a resource aren't specified in the request parameters, they aren't changed. When a resource is deleted, the tags associated with that resource are also deleted.
func (*Client) UntagResource ¶ added in v1.2.0
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 (about 20MB). The UploadLayerPart API is called once for 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 sha256 digest of the image layer. // // This member is required. LayerDigests []string // The name of the repository in a public registry to associate with the image // layer. // // This member is required. RepositoryName *string // The upload ID from a previous InitiateLayerUpload operation to associate with the image layer. // // This member is required. UploadId *string // The Amazon Web Services account ID, or registry alias, associated with the // registry where layers are uploaded. If you do not specify a registry, the // default public registry is assumed. RegistryId *string // contains filtered or unexported fields }
type CompleteLayerUploadOutput ¶
type CompleteLayerUploadOutput struct { // The sha256 digest of the image layer. LayerDigest *string // The public registry ID that's associated with the request. RegistryId *string // The repository name that's associated with the request. RepositoryName *string // The upload ID that's associated with the layer. UploadId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateRepositoryInput ¶
type CreateRepositoryInput struct { // The name to use for the repository. This appears publicly in the Amazon ECR // Public Gallery. The repository name can be specified on its own (for example // nginx-web-app ) or prepended with a namespace to group the repository into a // category (for example project-a/nginx-web-app ). // // This member is required. RepositoryName *string // The details about the repository that are publicly visible in the Amazon ECR // Public Gallery. CatalogData *types.RepositoryCatalogDataInput // The metadata that you apply to each repository to help categorize and organize // your repositories. Each tag consists of a key and an optional value. You define // both of them. 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 // contains filtered or unexported fields }
type CreateRepositoryOutput ¶
type CreateRepositoryOutput struct { // The catalog data for a repository. This data is publicly visible in the Amazon // ECR Public Gallery. CatalogData *types.RepositoryCatalogData // The repository that was created. Repository *types.Repository // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteRepositoryInput ¶
type DeleteRepositoryInput struct { // The name of the repository to delete. // // This member is required. RepositoryName *string // The force option can be used to delete a repository that contains images. If // the force option is not used, the repository must be empty prior to deletion. Force bool // The Amazon Web Services account ID that's associated with the public registry // that contains the repository to delete. If you do not specify a registry, the // default public registry is assumed. RegistryId *string // contains filtered or unexported fields }
type DeleteRepositoryOutput ¶
type DeleteRepositoryOutput struct { // The repository that was deleted. Repository *types.Repository // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteRepositoryPolicyInput ¶
type DeleteRepositoryPolicyInput struct { // The name of the repository that's associated with the repository policy to // delete. // // This member is required. RepositoryName *string // The Amazon Web Services account ID that's associated with the public registry // that contains the repository policy to delete. If you do not specify a registry, // the default public registry is assumed. RegistryId *string // contains filtered or unexported fields }
type DeleteRepositoryPolicyOutput ¶
type DeleteRepositoryPolicyOutput struct { // The JSON repository policy that was deleted from the repository. PolicyText *string // The registry ID that's associated with the request. RegistryId *string // The repository name that's associated with the request. RepositoryName *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeImageTagsAPIClient ¶
type DescribeImageTagsAPIClient interface {
DescribeImageTags(context.Context, *DescribeImageTagsInput, ...func(*Options)) (*DescribeImageTagsOutput, error)
}
DescribeImageTagsAPIClient is a client that implements the DescribeImageTags operation.
type DescribeImageTagsInput ¶
type DescribeImageTagsInput struct { // The name of the repository that contains the image tag details to describe. // // This member is required. RepositoryName *string // The maximum number of repository results that's returned by DescribeImageTags // in paginated output. When this parameter is used, DescribeImageTags only // returns maxResults results in a single page along with a nextToken response // element. You can see the remaining results of the initial request by sending // another DescribeImageTags request with the returned nextToken value. This value // can be between 1 and 1000. If this parameter isn't used, then DescribeImageTags // returns up to 100 results and a nextToken value, if applicable. If you specify // images with imageIds , you can't use this option. MaxResults *int32 // The nextToken value that's returned from a previous paginated DescribeImageTags // 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. If there are no more results to return, this // value is null . If you specify images with imageIds , you can't use this option. NextToken *string // The Amazon Web Services account ID that's associated with the public registry // that contains the repository where images are described. If you do not specify a // registry, the default public registry is assumed. RegistryId *string // contains filtered or unexported fields }
type DescribeImageTagsOutput ¶
type DescribeImageTagsOutput struct { // The image tag details for the images in the requested repository. ImageTagDetails []types.ImageTagDetail // The nextToken value to include in a future DescribeImageTags request. When the // results of a DescribeImageTags request exceed maxResults , you can use this // value to retrieve the next page of results. If there are no more results to // return, this value is null . NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeImageTagsPaginator ¶
type DescribeImageTagsPaginator struct {
// contains filtered or unexported fields
}
DescribeImageTagsPaginator is a paginator for DescribeImageTags
func NewDescribeImageTagsPaginator ¶
func NewDescribeImageTagsPaginator(client DescribeImageTagsAPIClient, params *DescribeImageTagsInput, optFns ...func(*DescribeImageTagsPaginatorOptions)) *DescribeImageTagsPaginator
NewDescribeImageTagsPaginator returns a new DescribeImageTagsPaginator
func (*DescribeImageTagsPaginator) HasMorePages ¶
func (p *DescribeImageTagsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeImageTagsPaginator) NextPage ¶
func (p *DescribeImageTagsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeImageTagsOutput, error)
NextPage retrieves the next DescribeImageTags page.
type DescribeImageTagsPaginatorOptions ¶
type DescribeImageTagsPaginatorOptions struct { // The maximum number of repository results that's returned by DescribeImageTags // in paginated output. When this parameter is used, DescribeImageTags only // returns maxResults results in a single page along with a nextToken response // element. You can see the remaining results of the initial request by sending // another DescribeImageTags request with the returned nextToken value. This value // can be between 1 and 1000. If this parameter isn't used, then DescribeImageTags // returns up to 100 results and a nextToken value, if applicable. If you specify // images with imageIds , you can't use this option. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeImageTagsPaginatorOptions is the paginator options for DescribeImageTags
type DescribeImagesAPIClient ¶
type DescribeImagesAPIClient interface {
DescribeImages(context.Context, *DescribeImagesInput, ...func(*Options)) (*DescribeImagesOutput, error)
}
DescribeImagesAPIClient is a client that implements the DescribeImages operation.
type DescribeImagesInput ¶
type DescribeImagesInput struct { // The repository that contains the images to describe. // // This member is required. RepositoryName *string // The list of image IDs for the requested repository. ImageIds []types.ImageIdentifier // The maximum number of repository results that's 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. // You can see the remaining results of the initial request by sending another // DescribeImages request with the returned nextToken value. This value can be // between 1 and 1000. If this parameter isn't used, then DescribeImages returns // up to 100 results and a nextToken value, if applicable. If you specify images // with imageIds , you can't use this option. MaxResults *int32 // The nextToken value that's 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. If there are no more results to return, this // value is null . If you specify images with imageIds , you can't use this option. NextToken *string // The Amazon Web Services account ID that's associated with the public registry // that contains the repository where images are described. If you do not specify a // registry, the default public registry is assumed. RegistryId *string // contains filtered or unexported fields }
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 , you can use this value // to retrieve the next page of results. If there are no more results to return, // this value is null . NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeImagesPaginator ¶
type DescribeImagesPaginator struct {
// contains filtered or unexported fields
}
DescribeImagesPaginator is a paginator for DescribeImages
func NewDescribeImagesPaginator ¶
func NewDescribeImagesPaginator(client DescribeImagesAPIClient, params *DescribeImagesInput, optFns ...func(*DescribeImagesPaginatorOptions)) *DescribeImagesPaginator
NewDescribeImagesPaginator returns a new DescribeImagesPaginator
func (*DescribeImagesPaginator) HasMorePages ¶
func (p *DescribeImagesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeImagesPaginator) NextPage ¶
func (p *DescribeImagesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeImagesOutput, error)
NextPage retrieves the next DescribeImages page.
type DescribeImagesPaginatorOptions ¶
type DescribeImagesPaginatorOptions struct { // The maximum number of repository results that's 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. // You can see the remaining results of the initial request by sending another // DescribeImages request with the returned nextToken value. This value can be // between 1 and 1000. If this parameter isn't used, then DescribeImages returns // up to 100 results and a nextToken value, if applicable. If you specify images // with imageIds , you can't use this option. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeImagesPaginatorOptions is the paginator options for DescribeImages
type DescribeRegistriesAPIClient ¶
type DescribeRegistriesAPIClient interface {
DescribeRegistries(context.Context, *DescribeRegistriesInput, ...func(*Options)) (*DescribeRegistriesOutput, error)
}
DescribeRegistriesAPIClient is a client that implements the DescribeRegistries operation.
type DescribeRegistriesInput ¶
type DescribeRegistriesInput struct { // The maximum number of repository results that's returned by DescribeRegistries // in paginated output. When this parameter is used, DescribeRegistries 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 DescribeRegistries request with the returned nextToken value. This // value can be between 1 and 1000. If this parameter isn't used, then // DescribeRegistries returns up to 100 results and a nextToken value, if // applicable. MaxResults *int32 // The nextToken value that's returned from a previous paginated DescribeRegistries // 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. If there are no more results to return, this // value is null . // // 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 // contains filtered or unexported fields }
type DescribeRegistriesOutput ¶
type DescribeRegistriesOutput struct { // An object that contains the details for a public registry. // // This member is required. Registries []types.Registry // The nextToken value to include in a future DescribeRepositories request. If the // results of a DescribeRepositories request exceed maxResults , you can use this // value to retrieve the next page of results. If there are no more results, this // value is null . NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeRegistriesPaginator ¶
type DescribeRegistriesPaginator struct {
// contains filtered or unexported fields
}
DescribeRegistriesPaginator is a paginator for DescribeRegistries
func NewDescribeRegistriesPaginator ¶
func NewDescribeRegistriesPaginator(client DescribeRegistriesAPIClient, params *DescribeRegistriesInput, optFns ...func(*DescribeRegistriesPaginatorOptions)) *DescribeRegistriesPaginator
NewDescribeRegistriesPaginator returns a new DescribeRegistriesPaginator
func (*DescribeRegistriesPaginator) HasMorePages ¶
func (p *DescribeRegistriesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeRegistriesPaginator) NextPage ¶
func (p *DescribeRegistriesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeRegistriesOutput, error)
NextPage retrieves the next DescribeRegistries page.
type DescribeRegistriesPaginatorOptions ¶
type DescribeRegistriesPaginatorOptions struct { // The maximum number of repository results that's returned by DescribeRegistries // in paginated output. When this parameter is used, DescribeRegistries 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 DescribeRegistries request with the returned nextToken value. This // value can be between 1 and 1000. If this parameter isn't used, then // DescribeRegistries returns up to 100 results and a nextToken value, if // applicable. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeRegistriesPaginatorOptions is the paginator options for DescribeRegistries
type DescribeRepositoriesAPIClient ¶
type DescribeRepositoriesAPIClient interface {
DescribeRepositories(context.Context, *DescribeRepositoriesInput, ...func(*Options)) (*DescribeRepositoriesOutput, error)
}
DescribeRepositoriesAPIClient is a client that implements the DescribeRepositories operation.
type DescribeRepositoriesInput ¶
type DescribeRepositoriesInput struct { // The maximum number of repository results that's 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. You can see the remaining results of the initial request by sending // another DescribeRepositories request with the returned nextToken value. This // value can be between 1 and 1000. If this parameter isn't used, then // DescribeRepositories returns up to 100 results and a nextToken value, if // applicable. If you specify repositories with repositoryNames , you can't use // this option. MaxResults *int32 // The nextToken value that's 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. If there are no more results to // return, this value is null . If you specify repositories with repositoryNames , // you can't use this option. // // 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 Amazon Web Services account ID that's associated with the registry that // contains the repositories to be described. If you do not specify a registry, the // default public registry is assumed. RegistryId *string // A list of repositories to describe. If this parameter is omitted, then all // repositories in a registry are described. RepositoryNames []string // contains filtered or unexported fields }
type DescribeRepositoriesOutput ¶
type DescribeRepositoriesOutput struct { // 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. If there are no more results to // return, this value is null . NextToken *string // A list of repository objects corresponding to valid repositories. Repositories []types.Repository // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeRepositoriesPaginator ¶
type DescribeRepositoriesPaginator struct {
// contains filtered or unexported fields
}
DescribeRepositoriesPaginator is a paginator for DescribeRepositories
func NewDescribeRepositoriesPaginator ¶
func NewDescribeRepositoriesPaginator(client DescribeRepositoriesAPIClient, params *DescribeRepositoriesInput, optFns ...func(*DescribeRepositoriesPaginatorOptions)) *DescribeRepositoriesPaginator
NewDescribeRepositoriesPaginator returns a new DescribeRepositoriesPaginator
func (*DescribeRepositoriesPaginator) HasMorePages ¶
func (p *DescribeRepositoriesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeRepositoriesPaginator) NextPage ¶
func (p *DescribeRepositoriesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeRepositoriesOutput, error)
NextPage retrieves the next DescribeRepositories page.
type DescribeRepositoriesPaginatorOptions ¶
type DescribeRepositoriesPaginatorOptions struct { // The maximum number of repository results that's 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. You can see the remaining results of the initial request by sending // another DescribeRepositories request with the returned nextToken value. This // value can be between 1 and 1000. If this parameter isn't used, then // DescribeRepositories returns up to 100 results and a nextToken value, if // applicable. If you specify repositories with repositoryNames , you can't use // this option. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeRepositoriesPaginatorOptions is the paginator options for DescribeRepositories
type EndpointParameters ¶ added in v1.17.0
type EndpointParameters struct { // The AWS region used to dispatch the request. // // Parameter is // required. // // AWS::Region Region *string // When true, use the dual-stack endpoint. If the configured endpoint does not // support dual-stack, dispatching the request MAY return an error. // // Defaults to // false if no value is provided. // // AWS::UseDualStack UseDualStack *bool // When true, send this request to the FIPS-compliant regional endpoint. If the // configured endpoint does not have a FIPS compliant endpoint, dispatching the // request will return an error. // // Defaults to false if no value is // provided. // // AWS::UseFIPS UseFIPS *bool // Override the endpoint used to send this request // // Parameter is // required. // // SDK::Endpoint Endpoint *string }
EndpointParameters provides the parameters that influence how endpoints are resolved.
func (EndpointParameters) ValidateRequired ¶ added in v1.17.0
func (p EndpointParameters) ValidateRequired() error
ValidateRequired validates required parameters are set.
func (EndpointParameters) WithDefaults ¶ added in v1.17.0
func (p EndpointParameters) WithDefaults() EndpointParameters
WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.
type EndpointResolver ¶
type EndpointResolver interface {
ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}
EndpointResolver interface for resolving service endpoints.
func EndpointResolverFromURL ¶ added in v1.1.0
func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver
EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.
type EndpointResolverFunc ¶
type EndpointResolverFunc func(region string, options EndpointResolverOptions) (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 EndpointResolverOptions) (endpoint aws.Endpoint, err error)
type EndpointResolverOptions ¶
type EndpointResolverOptions = internalendpoints.Options
EndpointResolverOptions is the service endpoint resolver options
type EndpointResolverV2 ¶ added in v1.17.0
type EndpointResolverV2 interface { // ResolveEndpoint attempts to resolve the endpoint with the provided options, // returning the endpoint if found. Otherwise an error is returned. ResolveEndpoint(ctx context.Context, params EndpointParameters) ( smithyendpoints.Endpoint, error, ) }
EndpointResolverV2 provides the interface for resolving service endpoints.
func NewDefaultEndpointResolverV2 ¶ added in v1.17.0
func NewDefaultEndpointResolverV2() EndpointResolverV2
type GetAuthorizationTokenInput ¶
type GetAuthorizationTokenInput struct {
// contains filtered or unexported fields
}
type GetAuthorizationTokenOutput ¶
type GetAuthorizationTokenOutput struct { // An authorization token data object that corresponds to a public registry. AuthorizationData *types.AuthorizationData // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetRegistryCatalogDataInput ¶
type GetRegistryCatalogDataInput struct {
// contains filtered or unexported fields
}
type GetRegistryCatalogDataOutput ¶
type GetRegistryCatalogDataOutput struct { // The catalog metadata for the public registry. // // This member is required. RegistryCatalogData *types.RegistryCatalogData // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetRepositoryCatalogDataInput ¶
type GetRepositoryCatalogDataInput struct { // The name of the repository to retrieve the catalog metadata for. // // This member is required. RepositoryName *string // The Amazon Web Services account ID that's associated with the registry that // contains the repositories to be described. If you do not specify a registry, the // default public registry is assumed. RegistryId *string // contains filtered or unexported fields }
type GetRepositoryCatalogDataOutput ¶
type GetRepositoryCatalogDataOutput struct { // The catalog metadata for the repository. CatalogData *types.RepositoryCatalogData // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetRepositoryPolicyInput ¶
type GetRepositoryPolicyInput struct { // The name of the repository with the policy to retrieve. // // This member is required. RepositoryName *string // The Amazon Web Services account ID that's associated with the public registry // that contains the repository. If you do not specify a registry, the default // public registry is assumed. RegistryId *string // contains filtered or unexported fields }
type GetRepositoryPolicyOutput ¶
type GetRepositoryPolicyOutput struct { // The repository policy text that's associated with the repository. The policy // text will be in JSON format. PolicyText *string // The registry ID that's associated with the request. RegistryId *string // The repository name that's associated with the request. RepositoryName *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type HTTPSignerV4 ¶
type InitiateLayerUploadInput ¶
type InitiateLayerUploadInput struct { // The name of the repository that you want to upload layers to. // // This member is required. RepositoryName *string // The Amazon Web Services account ID, or registry alias, that's associated with // the registry to which you intend to upload layers. If you do not specify a // registry, the default public registry is assumed. RegistryId *string // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
type ListTagsForResourceInput ¶ added in v1.2.0
type ListTagsForResourceInput struct { // The Amazon Resource Name (ARN) that identifies the resource to list the tags // for. Currently, the supported resource is an Amazon ECR Public repository. // // This member is required. ResourceArn *string // contains filtered or unexported fields }
type ListTagsForResourceOutput ¶ added in v1.2.0
type ListTagsForResourceOutput struct { // The tags for the resource. Tags []types.Tag // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
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 optional application specific identifier appended to the User-Agent header. AppID string // This endpoint will be given as input to an EndpointResolverV2. It is used for // providing a custom base endpoint that is subject to modifications by the // processing EndpointResolverV2. BaseEndpoint *string // Configures the events that will be sent to the configured logger. ClientLogMode aws.ClientLogMode // The credentials object to use when signing requests. Credentials aws.CredentialsProvider // The configuration DefaultsMode that the SDK should use when constructing the // clients initial default settings. DefaultsMode aws.DefaultsMode // The endpoint options to be used when attempting to resolve an endpoint. EndpointOptions EndpointResolverOptions // The service endpoint resolver. // // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and // BaseEndpoint. // // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be // used over the deprecated EndpointResolver. EndpointResolverV2 EndpointResolverV2 // Signature Version 4 (SigV4) Signer HTTPSignerV4 HTTPSignerV4 // The logger writer interface to write logging messages to. Logger logging.Logger // The client meter provider. MeterProvider metrics.MeterProvider // The region to send requests to. (Required) Region string // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify // per operation call's retry max attempts. // // If specified in an operation call's functional options with a value that is // different than the constructed client's Options, the Client's Retryer will be // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if // Retryer option is not also specified. // // When creating a new API Clients this member will only be used if the Retryer // Options member is nil. This value will be ignored if Retryer is not nil. // // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable // failures. When nil the API client will use a default retryer. The kind of // default retry created by the API client can be changed with the RetryMode // option. Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment // The client tracer provider. TracerProvider tracing.TracerProvider // The HTTP client to invoke API calls with. Defaults to client's default HTTP // implementation if nil. HTTPClient HTTPClient // The auth scheme resolver which determines how to authenticate for each // operation. AuthSchemeResolver AuthSchemeResolver // The list of auth schemes supported by the client. AuthSchemes []smithyhttp.AuthScheme // contains filtered or unexported fields }
func (Options) GetIdentityResolver ¶ added in v1.20.2
func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver
type PutImageInput ¶
type PutImageInput struct { // The image manifest that corresponds to the image to be uploaded. // // This member is required. ImageManifest *string // The name of the repository where the image is put. // // This member is required. RepositoryName *string // The image digest of the image manifest that corresponds to the image. ImageDigest *string // The media type of the image manifest. If you push an image manifest that // doesn't contain the mediaType field, you must specify the imageManifestMediaType // in the request. ImageManifestMediaType *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 Amazon Web Services account ID, or registry alias, that's associated with // the public registry that contains the repository where the image is put. If you // do not specify a registry, the default public registry is assumed. RegistryId *string // contains filtered or unexported fields }
type PutImageOutput ¶
type PutImageOutput struct { // Details of the image uploaded. Image *types.Image // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type PutRegistryCatalogDataInput ¶
type PutRegistryCatalogDataInput struct { // The display name for a public registry. The display name is shown as the // repository author in the Amazon ECR Public Gallery. // // The registry display name is only publicly visible in the Amazon ECR Public // Gallery for verified accounts. DisplayName *string // contains filtered or unexported fields }
type PutRegistryCatalogDataOutput ¶
type PutRegistryCatalogDataOutput struct { // The catalog data for the public registry. // // This member is required. RegistryCatalogData *types.RegistryCatalogData // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type PutRepositoryCatalogDataInput ¶
type PutRepositoryCatalogDataInput struct { // An object containing the catalog data for a repository. This data is publicly // visible in the Amazon ECR Public Gallery. // // This member is required. CatalogData *types.RepositoryCatalogDataInput // The name of the repository to create or update the catalog data for. // // This member is required. RepositoryName *string // The Amazon Web Services account ID that's associated with the public registry // the repository is in. If you do not specify a registry, the default public // registry is assumed. RegistryId *string // contains filtered or unexported fields }
type PutRepositoryCatalogDataOutput ¶
type PutRepositoryCatalogDataOutput struct { // The catalog data for the repository. CatalogData *types.RepositoryCatalogData // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ResolveEndpoint ¶
type ResolveEndpoint struct { Resolver EndpointResolver Options EndpointResolverOptions }
func (*ResolveEndpoint) HandleSerialize ¶
func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( out middleware.SerializeOutput, metadata middleware.Metadata, err error, )
func (*ResolveEndpoint) ID ¶
func (*ResolveEndpoint) ID() string
type SetRepositoryPolicyInput ¶
type SetRepositoryPolicyInput struct { // The JSON repository policy text to apply to the repository. For more // information, see [Amazon ECR Repository Policies]in the Amazon Elastic Container Registry User Guide. // // [Amazon ECR Repository Policies]: https://docs.aws.amazon.com/AmazonECR/latest/userguide/repository-policy-examples.html // // This member is required. PolicyText *string // The name of the repository to receive the policy. // // This member is required. RepositoryName *string // If the policy that you want to set on a repository policy would prevent you // from setting another policy in the future, you must force the SetRepositoryPolicyoperation. This // prevents accidental repository lockouts. Force bool // The Amazon Web Services account ID that's associated with the registry that // contains the repository. If you do not specify a registry, the default public // registry is assumed. RegistryId *string // contains filtered or unexported fields }
type SetRepositoryPolicyOutput ¶
type SetRepositoryPolicyOutput struct { // The JSON repository policy text that's applied to the repository. PolicyText *string // The registry ID that's associated with the request. RegistryId *string // The repository name that's associated with the request. RepositoryName *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type TagResourceInput ¶ added in v1.2.0
type TagResourceInput struct { // The Amazon Resource Name (ARN) of the resource to add tags to. Currently, the // supported resource is an Amazon ECR Public repository. // // This member is required. ResourceArn *string // 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. // // This member is required. Tags []types.Tag // contains filtered or unexported fields }
type TagResourceOutput ¶ added in v1.2.0
type TagResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UntagResourceInput ¶ added in v1.2.0
type UntagResourceInput struct { // The Amazon Resource Name (ARN) of the resource to delete tags from. Currently, // the supported resource is an Amazon ECR Public repository. // // This member is required. ResourceArn *string // The keys of the tags to be removed. // // This member is required. TagKeys []string // contains filtered or unexported fields }
type UntagResourceOutput ¶ added in v1.2.0
type UntagResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UploadLayerPartInput ¶
type UploadLayerPartInput struct { // The base64-encoded layer part payload. // // This member is required. LayerPartBlob []byte // The position of the first byte of the layer part witin the overall image layer. // // This member is required. PartFirstByte *int64 // The position of the last byte of the layer part within the overall image layer. // // This member is required. PartLastByte *int64 // The name of the repository that you're uploading layer parts to. // // This member is required. RepositoryName *string // The upload ID from a previous InitiateLayerUpload operation to associate with the layer part // upload. // // This member is required. UploadId *string // The Amazon Web Services account ID, or registry alias, that's associated with // the registry that you're uploading layer parts to. If you do not specify a // registry, the default public registry is assumed. RegistryId *string // contains filtered or unexported fields }
type UploadLayerPartOutput ¶
type UploadLayerPartOutput struct { // The integer value of the last byte that's received in the request. LastByteReceived *int64 // The registry ID that's associated with the request. RegistryId *string // The repository name that's associated with the request. RepositoryName *string // The upload ID that's associated with the request. UploadId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Source Files ¶
- api_client.go
- api_op_BatchCheckLayerAvailability.go
- api_op_BatchDeleteImage.go
- api_op_CompleteLayerUpload.go
- api_op_CreateRepository.go
- api_op_DeleteRepository.go
- api_op_DeleteRepositoryPolicy.go
- api_op_DescribeImageTags.go
- api_op_DescribeImages.go
- api_op_DescribeRegistries.go
- api_op_DescribeRepositories.go
- api_op_GetAuthorizationToken.go
- api_op_GetRegistryCatalogData.go
- api_op_GetRepositoryCatalogData.go
- api_op_GetRepositoryPolicy.go
- api_op_InitiateLayerUpload.go
- api_op_ListTagsForResource.go
- api_op_PutImage.go
- api_op_PutRegistryCatalogData.go
- api_op_PutRepositoryCatalogData.go
- api_op_SetRepositoryPolicy.go
- api_op_TagResource.go
- api_op_UntagResource.go
- api_op_UploadLayerPart.go
- auth.go
- deserializers.go
- doc.go
- endpoints.go
- go_module_metadata.go
- options.go
- serializers.go
- validators.go