1// Code generated by smithy-go-codegen DO NOT EDIT.
2
3package ecr
4
5import (
6	"context"
7	awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
8	"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
9	"github.com/aws/aws-sdk-go-v2/service/ecr/types"
10	"github.com/aws/smithy-go/middleware"
11	smithyhttp "github.com/aws/smithy-go/transport/http"
12)
13
14// Starts an image vulnerability scan. An image scan can only be started once per
15// day on an individual image. This limit includes if an image was scanned on
16// initial push. For more information, see Image Scanning
17// (https://docs.aws.amazon.com/AmazonECR/latest/userguide/image-scanning.html) in
18// the Amazon Elastic Container Registry User Guide.
19func (c *Client) StartImageScan(ctx context.Context, params *StartImageScanInput, optFns ...func(*Options)) (*StartImageScanOutput, error) {
20	if params == nil {
21		params = &StartImageScanInput{}
22	}
23
24	result, metadata, err := c.invokeOperation(ctx, "StartImageScan", params, optFns, addOperationStartImageScanMiddlewares)
25	if err != nil {
26		return nil, err
27	}
28
29	out := result.(*StartImageScanOutput)
30	out.ResultMetadata = metadata
31	return out, nil
32}
33
34type StartImageScanInput struct {
35
36	// An object with identifying information for an Amazon ECR image.
37	//
38	// This member is required.
39	ImageId *types.ImageIdentifier
40
41	// The name of the repository that contains the images to scan.
42	//
43	// This member is required.
44	RepositoryName *string
45
46	// The AWS account ID associated with the registry that contains the repository in
47	// which to start an image scan request. If you do not specify a registry, the
48	// default registry is assumed.
49	RegistryId *string
50}
51
52type StartImageScanOutput struct {
53
54	// An object with identifying information for an Amazon ECR image.
55	ImageId *types.ImageIdentifier
56
57	// The current state of the scan.
58	ImageScanStatus *types.ImageScanStatus
59
60	// The registry ID associated with the request.
61	RegistryId *string
62
63	// The repository name associated with the request.
64	RepositoryName *string
65
66	// Metadata pertaining to the operation's result.
67	ResultMetadata middleware.Metadata
68}
69
70func addOperationStartImageScanMiddlewares(stack *middleware.Stack, options Options) (err error) {
71	err = stack.Serialize.Add(&awsAwsjson11_serializeOpStartImageScan{}, middleware.After)
72	if err != nil {
73		return err
74	}
75	err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpStartImageScan{}, middleware.After)
76	if err != nil {
77		return err
78	}
79	if err = addSetLoggerMiddleware(stack, options); err != nil {
80		return err
81	}
82	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
83		return err
84	}
85	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
86		return err
87	}
88	if err = addResolveEndpointMiddleware(stack, options); err != nil {
89		return err
90	}
91	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
92		return err
93	}
94	if err = addRetryMiddlewares(stack, options); err != nil {
95		return err
96	}
97	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
98		return err
99	}
100	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
101		return err
102	}
103	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
104		return err
105	}
106	if err = addClientUserAgent(stack); err != nil {
107		return err
108	}
109	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
110		return err
111	}
112	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
113		return err
114	}
115	if err = addOpStartImageScanValidationMiddleware(stack); err != nil {
116		return err
117	}
118	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opStartImageScan(options.Region), middleware.Before); err != nil {
119		return err
120	}
121	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
122		return err
123	}
124	if err = addResponseErrorMiddleware(stack); err != nil {
125		return err
126	}
127	if err = addRequestResponseLogging(stack, options); err != nil {
128		return err
129	}
130	return nil
131}
132
133func newServiceMetadataMiddleware_opStartImageScan(region string) *awsmiddleware.RegisterServiceMetadata {
134	return &awsmiddleware.RegisterServiceMetadata{
135		Region:        region,
136		ServiceID:     ServiceID,
137		SigningName:   "ecr",
138		OperationName: "StartImageScan",
139	}
140}
141