api_op_BatchDeleteImage.go

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

     1  // Code generated by smithy-go-codegen DO NOT EDIT.
     2  
     3  package ecrpublic
     4  
     5  import (
     6  	"context"
     7  	"errors"
     8  	"fmt"
     9  	"github.com/aws/aws-sdk-go-v2/aws"
    10  	awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
    11  	"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
    12  	internalauth "github.com/aws/aws-sdk-go-v2/internal/auth"
    13  	"github.com/aws/aws-sdk-go-v2/service/ecrpublic/types"
    14  	smithyendpoints "github.com/aws/smithy-go/endpoints"
    15  	"github.com/aws/smithy-go/middleware"
    16  	smithyhttp "github.com/aws/smithy-go/transport/http"
    17  )
    18  
    19  // Deletes a list of specified images that are within a repository in a public
    20  // registry. Images are specified with either an imageTag or imageDigest . You can
    21  // remove a tag from an image by specifying the image's tag in your request. When
    22  // you remove the last tag from an image, the image is deleted from your
    23  // repository. You can completely delete an image (and all of its tags) by
    24  // specifying the digest of the image in your request.
    25  func (c *Client) BatchDeleteImage(ctx context.Context, params *BatchDeleteImageInput, optFns ...func(*Options)) (*BatchDeleteImageOutput, error) {
    26  	if params == nil {
    27  		params = &BatchDeleteImageInput{}
    28  	}
    29  
    30  	result, metadata, err := c.invokeOperation(ctx, "BatchDeleteImage", params, optFns, c.addOperationBatchDeleteImageMiddlewares)
    31  	if err != nil {
    32  		return nil, err
    33  	}
    34  
    35  	out := result.(*BatchDeleteImageOutput)
    36  	out.ResultMetadata = metadata
    37  	return out, nil
    38  }
    39  
    40  type BatchDeleteImageInput struct {
    41  
    42  	// A list of image ID references that correspond to images to delete. The format
    43  	// of the imageIds reference is imageTag=tag or imageDigest=digest .
    44  	//
    45  	// This member is required.
    46  	ImageIds []types.ImageIdentifier
    47  
    48  	// The repository in a public registry that contains the image to delete.
    49  	//
    50  	// This member is required.
    51  	RepositoryName *string
    52  
    53  	// The Amazon Web Services account ID, or registry alias, that's associated with
    54  	// the registry that contains the image to delete. If you do not specify a
    55  	// registry, the default public registry is assumed.
    56  	RegistryId *string
    57  
    58  	noSmithyDocumentSerde
    59  }
    60  
    61  type BatchDeleteImageOutput struct {
    62  
    63  	// Any failures associated with the call.
    64  	Failures []types.ImageFailure
    65  
    66  	// The image IDs of the deleted images.
    67  	ImageIds []types.ImageIdentifier
    68  
    69  	// Metadata pertaining to the operation's result.
    70  	ResultMetadata middleware.Metadata
    71  
    72  	noSmithyDocumentSerde
    73  }
    74  
    75  func (c *Client) addOperationBatchDeleteImageMiddlewares(stack *middleware.Stack, options Options) (err error) {
    76  	err = stack.Serialize.Add(&awsAwsjson11_serializeOpBatchDeleteImage{}, middleware.After)
    77  	if err != nil {
    78  		return err
    79  	}
    80  	err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpBatchDeleteImage{}, middleware.After)
    81  	if err != nil {
    82  		return err
    83  	}
    84  	if err = addlegacyEndpointContextSetter(stack, options); err != nil {
    85  		return err
    86  	}
    87  	if err = addSetLoggerMiddleware(stack, options); err != nil {
    88  		return err
    89  	}
    90  	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
    91  		return err
    92  	}
    93  	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
    94  		return err
    95  	}
    96  	if err = addResolveEndpointMiddleware(stack, options); err != nil {
    97  		return err
    98  	}
    99  	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
   100  		return err
   101  	}
   102  	if err = addRetryMiddlewares(stack, options); err != nil {
   103  		return err
   104  	}
   105  	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
   106  		return err
   107  	}
   108  	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
   109  		return err
   110  	}
   111  	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
   112  		return err
   113  	}
   114  	if err = addClientUserAgent(stack, options); err != nil {
   115  		return err
   116  	}
   117  	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
   118  		return err
   119  	}
   120  	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
   121  		return err
   122  	}
   123  	if err = addBatchDeleteImageResolveEndpointMiddleware(stack, options); err != nil {
   124  		return err
   125  	}
   126  	if err = addOpBatchDeleteImageValidationMiddleware(stack); err != nil {
   127  		return err
   128  	}
   129  	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opBatchDeleteImage(options.Region), middleware.Before); err != nil {
   130  		return err
   131  	}
   132  	if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
   133  		return err
   134  	}
   135  	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
   136  		return err
   137  	}
   138  	if err = addResponseErrorMiddleware(stack); err != nil {
   139  		return err
   140  	}
   141  	if err = addRequestResponseLogging(stack, options); err != nil {
   142  		return err
   143  	}
   144  	if err = addendpointDisableHTTPSMiddleware(stack, options); err != nil {
   145  		return err
   146  	}
   147  	return nil
   148  }
   149  
   150  func newServiceMetadataMiddleware_opBatchDeleteImage(region string) *awsmiddleware.RegisterServiceMetadata {
   151  	return &awsmiddleware.RegisterServiceMetadata{
   152  		Region:        region,
   153  		ServiceID:     ServiceID,
   154  		SigningName:   "ecr-public",
   155  		OperationName: "BatchDeleteImage",
   156  	}
   157  }
   158  
   159  type opBatchDeleteImageResolveEndpointMiddleware struct {
   160  	EndpointResolver EndpointResolverV2
   161  	BuiltInResolver  builtInParameterResolver
   162  }
   163  
   164  func (*opBatchDeleteImageResolveEndpointMiddleware) ID() string {
   165  	return "ResolveEndpointV2"
   166  }
   167  
   168  func (m *opBatchDeleteImageResolveEndpointMiddleware) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) (
   169  	out middleware.SerializeOutput, metadata middleware.Metadata, err error,
   170  ) {
   171  	if awsmiddleware.GetRequiresLegacyEndpoints(ctx) {
   172  		return next.HandleSerialize(ctx, in)
   173  	}
   174  
   175  	req, ok := in.Request.(*smithyhttp.Request)
   176  	if !ok {
   177  		return out, metadata, fmt.Errorf("unknown transport type %T", in.Request)
   178  	}
   179  
   180  	if m.EndpointResolver == nil {
   181  		return out, metadata, fmt.Errorf("expected endpoint resolver to not be nil")
   182  	}
   183  
   184  	params := EndpointParameters{}
   185  
   186  	m.BuiltInResolver.ResolveBuiltIns(&params)
   187  
   188  	var resolvedEndpoint smithyendpoints.Endpoint
   189  	resolvedEndpoint, err = m.EndpointResolver.ResolveEndpoint(ctx, params)
   190  	if err != nil {
   191  		return out, metadata, fmt.Errorf("failed to resolve service endpoint, %w", err)
   192  	}
   193  
   194  	req.URL = &resolvedEndpoint.URI
   195  
   196  	for k := range resolvedEndpoint.Headers {
   197  		req.Header.Set(
   198  			k,
   199  			resolvedEndpoint.Headers.Get(k),
   200  		)
   201  	}
   202  
   203  	authSchemes, err := internalauth.GetAuthenticationSchemes(&resolvedEndpoint.Properties)
   204  	if err != nil {
   205  		var nfe *internalauth.NoAuthenticationSchemesFoundError
   206  		if errors.As(err, &nfe) {
   207  			// if no auth scheme is found, default to sigv4
   208  			signingName := "ecr-public"
   209  			signingRegion := m.BuiltInResolver.(*builtInResolver).Region
   210  			ctx = awsmiddleware.SetSigningName(ctx, signingName)
   211  			ctx = awsmiddleware.SetSigningRegion(ctx, signingRegion)
   212  
   213  		}
   214  		var ue *internalauth.UnSupportedAuthenticationSchemeSpecifiedError
   215  		if errors.As(err, &ue) {
   216  			return out, metadata, fmt.Errorf(
   217  				"This operation requests signer version(s) %v but the client only supports %v",
   218  				ue.UnsupportedSchemes,
   219  				internalauth.SupportedSchemes,
   220  			)
   221  		}
   222  	}
   223  
   224  	for _, authScheme := range authSchemes {
   225  		switch authScheme.(type) {
   226  		case *internalauth.AuthenticationSchemeV4:
   227  			v4Scheme, _ := authScheme.(*internalauth.AuthenticationSchemeV4)
   228  			var signingName, signingRegion string
   229  			if v4Scheme.SigningName == nil {
   230  				signingName = "ecr-public"
   231  			} else {
   232  				signingName = *v4Scheme.SigningName
   233  			}
   234  			if v4Scheme.SigningRegion == nil {
   235  				signingRegion = m.BuiltInResolver.(*builtInResolver).Region
   236  			} else {
   237  				signingRegion = *v4Scheme.SigningRegion
   238  			}
   239  			if v4Scheme.DisableDoubleEncoding != nil {
   240  				// The signer sets an equivalent value at client initialization time.
   241  				// Setting this context value will cause the signer to extract it
   242  				// and override the value set at client initialization time.
   243  				ctx = internalauth.SetDisableDoubleEncoding(ctx, *v4Scheme.DisableDoubleEncoding)
   244  			}
   245  			ctx = awsmiddleware.SetSigningName(ctx, signingName)
   246  			ctx = awsmiddleware.SetSigningRegion(ctx, signingRegion)
   247  			break
   248  		case *internalauth.AuthenticationSchemeV4A:
   249  			v4aScheme, _ := authScheme.(*internalauth.AuthenticationSchemeV4A)
   250  			if v4aScheme.SigningName == nil {
   251  				v4aScheme.SigningName = aws.String("ecr-public")
   252  			}
   253  			if v4aScheme.DisableDoubleEncoding != nil {
   254  				// The signer sets an equivalent value at client initialization time.
   255  				// Setting this context value will cause the signer to extract it
   256  				// and override the value set at client initialization time.
   257  				ctx = internalauth.SetDisableDoubleEncoding(ctx, *v4aScheme.DisableDoubleEncoding)
   258  			}
   259  			ctx = awsmiddleware.SetSigningName(ctx, *v4aScheme.SigningName)
   260  			ctx = awsmiddleware.SetSigningRegion(ctx, v4aScheme.SigningRegionSet[0])
   261  			break
   262  		case *internalauth.AuthenticationSchemeNone:
   263  			break
   264  		}
   265  	}
   266  
   267  	return next.HandleSerialize(ctx, in)
   268  }
   269  
   270  func addBatchDeleteImageResolveEndpointMiddleware(stack *middleware.Stack, options Options) error {
   271  	return stack.Serialize.Insert(&opBatchDeleteImageResolveEndpointMiddleware{
   272  		EndpointResolver: options.EndpointResolverV2,
   273  		BuiltInResolver: &builtInResolver{
   274  			Region:       options.Region,
   275  			UseDualStack: options.EndpointOptions.UseDualStackEndpoint,
   276  			UseFIPS:      options.EndpointOptions.UseFIPSEndpoint,
   277  			Endpoint:     options.BaseEndpoint,
   278  		},
   279  	}, "ResolveEndpoint", middleware.After)
   280  }
   281
View as plain text