1// Code generated by smithy-go-codegen DO NOT EDIT.
2
3package ecrpublic
4
5import (
6	"context"
7	"fmt"
8	awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
9	"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
10	"github.com/aws/aws-sdk-go-v2/service/ecrpublic/types"
11	"github.com/aws/smithy-go/middleware"
12	smithyhttp "github.com/aws/smithy-go/transport/http"
13)
14
15// Returns metadata about the images in a repository in a public registry.
16// Beginning with Docker version 1.9, the Docker client compresses image layers
17// before pushing them to a V2 Docker registry. The output of the docker images
18// command shows the uncompressed image size, so it may return a larger image size
19// than the image sizes returned by DescribeImages.
20func (c *Client) DescribeImages(ctx context.Context, params *DescribeImagesInput, optFns ...func(*Options)) (*DescribeImagesOutput, error) {
21	if params == nil {
22		params = &DescribeImagesInput{}
23	}
24
25	result, metadata, err := c.invokeOperation(ctx, "DescribeImages", params, optFns, c.addOperationDescribeImagesMiddlewares)
26	if err != nil {
27		return nil, err
28	}
29
30	out := result.(*DescribeImagesOutput)
31	out.ResultMetadata = metadata
32	return out, nil
33}
34
35type DescribeImagesInput struct {
36
37	// The repository that contains the images to describe.
38	//
39	// This member is required.
40	RepositoryName *string
41
42	// The list of image IDs for the requested repository.
43	ImageIds []types.ImageIdentifier
44
45	// The maximum number of repository results returned by DescribeImages in paginated
46	// output. When this parameter is used, DescribeImages only returns maxResults
47	// results in a single page along with a nextToken response element. The remaining
48	// results of the initial request can be seen by sending another DescribeImages
49	// request with the returned nextToken value. This value can be between 1 and 1000.
50	// If this parameter is not used, then DescribeImages returns up to 100 results and
51	// a nextToken value, if applicable. This option cannot be used when you specify
52	// images with imageIds.
53	MaxResults *int32
54
55	// The nextToken value returned from a previous paginated DescribeImages request
56	// where maxResults was used and the results exceeded the value of that parameter.
57	// Pagination continues from the end of the previous results that returned the
58	// nextToken value. This value is null when there are no more results to return.
59	// This option cannot be used when you specify images with imageIds.
60	NextToken *string
61
62	// The AWS account ID associated with the public registry that contains the
63	// repository in which to describe images. If you do not specify a registry, the
64	// default public registry is assumed.
65	RegistryId *string
66
67	noSmithyDocumentSerde
68}
69
70type DescribeImagesOutput struct {
71
72	// A list of ImageDetail objects that contain data about the image.
73	ImageDetails []types.ImageDetail
74
75	// The nextToken value to include in a future DescribeImages request. When the
76	// results of a DescribeImages request exceed maxResults, this value can be used to
77	// retrieve the next page of results. This value is null when there are no more
78	// results to return.
79	NextToken *string
80
81	// Metadata pertaining to the operation's result.
82	ResultMetadata middleware.Metadata
83
84	noSmithyDocumentSerde
85}
86
87func (c *Client) addOperationDescribeImagesMiddlewares(stack *middleware.Stack, options Options) (err error) {
88	err = stack.Serialize.Add(&awsAwsjson11_serializeOpDescribeImages{}, middleware.After)
89	if err != nil {
90		return err
91	}
92	err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpDescribeImages{}, middleware.After)
93	if err != nil {
94		return err
95	}
96	if err = addSetLoggerMiddleware(stack, options); err != nil {
97		return err
98	}
99	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
100		return err
101	}
102	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
103		return err
104	}
105	if err = addResolveEndpointMiddleware(stack, options); err != nil {
106		return err
107	}
108	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
109		return err
110	}
111	if err = addRetryMiddlewares(stack, options); err != nil {
112		return err
113	}
114	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
115		return err
116	}
117	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
118		return err
119	}
120	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
121		return err
122	}
123	if err = addClientUserAgent(stack); err != nil {
124		return err
125	}
126	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
127		return err
128	}
129	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
130		return err
131	}
132	if err = addOpDescribeImagesValidationMiddleware(stack); err != nil {
133		return err
134	}
135	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribeImages(options.Region), middleware.Before); err != nil {
136		return err
137	}
138	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
139		return err
140	}
141	if err = addResponseErrorMiddleware(stack); err != nil {
142		return err
143	}
144	if err = addRequestResponseLogging(stack, options); err != nil {
145		return err
146	}
147	return nil
148}
149
150// DescribeImagesAPIClient is a client that implements the DescribeImages
151// operation.
152type DescribeImagesAPIClient interface {
153	DescribeImages(context.Context, *DescribeImagesInput, ...func(*Options)) (*DescribeImagesOutput, error)
154}
155
156var _ DescribeImagesAPIClient = (*Client)(nil)
157
158// DescribeImagesPaginatorOptions is the paginator options for DescribeImages
159type DescribeImagesPaginatorOptions struct {
160	// The maximum number of repository results returned by DescribeImages in paginated
161	// output. When this parameter is used, DescribeImages only returns maxResults
162	// results in a single page along with a nextToken response element. The remaining
163	// results of the initial request can be seen by sending another DescribeImages
164	// request with the returned nextToken value. This value can be between 1 and 1000.
165	// If this parameter is not used, then DescribeImages returns up to 100 results and
166	// a nextToken value, if applicable. This option cannot be used when you specify
167	// images with imageIds.
168	Limit int32
169
170	// Set to true if pagination should stop if the service returns a pagination token
171	// that matches the most recent token provided to the service.
172	StopOnDuplicateToken bool
173}
174
175// DescribeImagesPaginator is a paginator for DescribeImages
176type DescribeImagesPaginator struct {
177	options   DescribeImagesPaginatorOptions
178	client    DescribeImagesAPIClient
179	params    *DescribeImagesInput
180	nextToken *string
181	firstPage bool
182}
183
184// NewDescribeImagesPaginator returns a new DescribeImagesPaginator
185func NewDescribeImagesPaginator(client DescribeImagesAPIClient, params *DescribeImagesInput, optFns ...func(*DescribeImagesPaginatorOptions)) *DescribeImagesPaginator {
186	if params == nil {
187		params = &DescribeImagesInput{}
188	}
189
190	options := DescribeImagesPaginatorOptions{}
191	if params.MaxResults != nil {
192		options.Limit = *params.MaxResults
193	}
194
195	for _, fn := range optFns {
196		fn(&options)
197	}
198
199	return &DescribeImagesPaginator{
200		options:   options,
201		client:    client,
202		params:    params,
203		firstPage: true,
204	}
205}
206
207// HasMorePages returns a boolean indicating whether more pages are available
208func (p *DescribeImagesPaginator) HasMorePages() bool {
209	return p.firstPage || p.nextToken != nil
210}
211
212// NextPage retrieves the next DescribeImages page.
213func (p *DescribeImagesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeImagesOutput, error) {
214	if !p.HasMorePages() {
215		return nil, fmt.Errorf("no more pages available")
216	}
217
218	params := *p.params
219	params.NextToken = p.nextToken
220
221	var limit *int32
222	if p.options.Limit > 0 {
223		limit = &p.options.Limit
224	}
225	params.MaxResults = limit
226
227	result, err := p.client.DescribeImages(ctx, &params, optFns...)
228	if err != nil {
229		return nil, err
230	}
231	p.firstPage = false
232
233	prevToken := p.nextToken
234	p.nextToken = result.NextToken
235
236	if p.options.StopOnDuplicateToken && prevToken != nil && p.nextToken != nil && *prevToken == *p.nextToken {
237		p.nextToken = nil
238	}
239
240	return result, nil
241}
242
243func newServiceMetadataMiddleware_opDescribeImages(region string) *awsmiddleware.RegisterServiceMetadata {
244	return &awsmiddleware.RegisterServiceMetadata{
245		Region:        region,
246		ServiceID:     ServiceID,
247		SigningName:   "ecr-public",
248		OperationName: "DescribeImages",
249	}
250}
251