// Code generated by smithy-go-codegen DO NOT EDIT.

package ec2

import (
	"context"
	"fmt"
	awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
	"github.com/aws/aws-sdk-go-v2/service/ec2/types"
	"github.com/aws/smithy-go/middleware"
	smithyhttp "github.com/aws/smithy-go/transport/http"
)

// Describes your Amazon Web Services resources that are referencing the specified
// images.
//
// For more information, see [Identify your resources referencing specified AMIs] in the Amazon EC2 User Guide.
//
// [Identify your resources referencing specified AMIs]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-ami-references.html
func (c *Client) DescribeImageReferences(ctx context.Context, params *DescribeImageReferencesInput, optFns ...func(*Options)) (*DescribeImageReferencesOutput, error) {
	if params == nil {
		params = &DescribeImageReferencesInput{}
	}

	result, metadata, err := c.invokeOperation(ctx, "DescribeImageReferences", params, optFns, c.addOperationDescribeImageReferencesMiddlewares)
	if err != nil {
		return nil, err
	}

	out := result.(*DescribeImageReferencesOutput)
	out.ResultMetadata = metadata
	return out, nil
}

type DescribeImageReferencesInput struct {

	// The IDs of the images to check for resource references.
	//
	// This member is required.
	ImageIds []string

	// Checks whether you have the required permissions for the action, without
	// actually making the request, and provides an error response. If you have the
	// required permissions, the error response is DryRunOperation . Otherwise, it is
	// UnauthorizedOperation .
	DryRun *bool

	// Specifies whether to check all supported Amazon Web Services resource types for
	// image references. When specified, default values are applied for
	// ResourceTypeOptions . For the default values, see [How AMI reference checks work] in the Amazon EC2 User
	// Guide. If you also specify ResourceTypes with ResourceTypeOptions , your
	// specified values override the default values.
	//
	// Supported resource types: ec2:Instance | ec2:LaunchTemplate | ssm:Parameter |
	// imagebuilder:ImageRecipe | imagebuilder:ContainerRecipe
	//
	// Either IncludeAllResourceTypes or ResourceTypes must be specified.
	//
	// [How AMI reference checks work]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/how-ami-references-works.html
	IncludeAllResourceTypes *bool

	//  The maximum number of items to return for this request. To get the next page
	// of items, make another request with the token returned in the output. For more
	// information, see [Pagination].
	//
	// [Pagination]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination
	MaxResults *int32

	// The token returned from a previous paginated request. Pagination continues from
	// the end of the items returned by the previous request.
	NextToken *string

	// The Amazon Web Services resource types to check for image references.
	//
	// Either IncludeAllResourceTypes or ResourceTypes must be specified.
	ResourceTypes []types.ResourceTypeRequest

	noSmithyDocumentSerde
}

type DescribeImageReferencesOutput struct {

	// The resources that are referencing the specified images.
	ImageReferences []types.ImageReference

	// The token to include in another request to get the next page of items. This
	// value is null when there are no more items to return.
	NextToken *string

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

	noSmithyDocumentSerde
}

func (c *Client) addOperationDescribeImageReferencesMiddlewares(stack *middleware.Stack, options Options) (err error) {
	if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
		return err
	}
	err = stack.Serialize.Add(&awsEc2query_serializeOpDescribeImageReferences{}, middleware.After)
	if err != nil {
		return err
	}
	err = stack.Deserialize.Add(&awsEc2query_deserializeOpDescribeImageReferences{}, middleware.After)
	if err != nil {
		return err
	}
	if err := addProtocolFinalizerMiddlewares(stack, options, "DescribeImageReferences"); err != nil {
		return fmt.Errorf("add protocol finalizers: %v", err)
	}

	if err = addlegacyEndpointContextSetter(stack, options); err != nil {
		return err
	}
	if err = addSetLoggerMiddleware(stack, options); err != nil {
		return err
	}
	if err = addClientRequestID(stack); err != nil {
		return err
	}
	if err = addComputeContentLength(stack); err != nil {
		return err
	}
	if err = addResolveEndpointMiddleware(stack, options); err != nil {
		return err
	}
	if err = addComputePayloadSHA256(stack); err != nil {
		return err
	}
	if err = addRetry(stack, options); err != nil {
		return err
	}
	if err = addRawResponseToMetadata(stack); err != nil {
		return err
	}
	if err = addRecordResponseTiming(stack); err != nil {
		return err
	}
	if err = addSpanRetryLoop(stack, options); err != nil {
		return err
	}
	if err = addClientUserAgent(stack, options); err != nil {
		return err
	}
	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
		return err
	}
	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
		return err
	}
	if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
		return err
	}
	if err = addTimeOffsetBuild(stack, c); err != nil {
		return err
	}
	if err = addUserAgentRetryMode(stack, options); err != nil {
		return err
	}
	if err = addCredentialSource(stack, options); err != nil {
		return err
	}
	if err = addOpDescribeImageReferencesValidationMiddleware(stack); err != nil {
		return err
	}
	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribeImageReferences(options.Region), middleware.Before); err != nil {
		return err
	}
	if err = addRecursionDetection(stack); err != nil {
		return err
	}
	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
		return err
	}
	if err = addResponseErrorMiddleware(stack); err != nil {
		return err
	}
	if err = addRequestResponseLogging(stack, options); err != nil {
		return err
	}
	if err = addDisableHTTPSMiddleware(stack, options); err != nil {
		return err
	}
	if err = addInterceptBeforeRetryLoop(stack, options); err != nil {
		return err
	}
	if err = addInterceptAttempt(stack, options); err != nil {
		return err
	}
	if err = addInterceptExecution(stack, options); err != nil {
		return err
	}
	if err = addInterceptBeforeSerialization(stack, options); err != nil {
		return err
	}
	if err = addInterceptAfterSerialization(stack, options); err != nil {
		return err
	}
	if err = addInterceptBeforeSigning(stack, options); err != nil {
		return err
	}
	if err = addInterceptAfterSigning(stack, options); err != nil {
		return err
	}
	if err = addInterceptTransmit(stack, options); err != nil {
		return err
	}
	if err = addInterceptBeforeDeserialization(stack, options); err != nil {
		return err
	}
	if err = addInterceptAfterDeserialization(stack, options); err != nil {
		return err
	}
	if err = addSpanInitializeStart(stack); err != nil {
		return err
	}
	if err = addSpanInitializeEnd(stack); err != nil {
		return err
	}
	if err = addSpanBuildRequestStart(stack); err != nil {
		return err
	}
	if err = addSpanBuildRequestEnd(stack); err != nil {
		return err
	}
	return nil
}

// DescribeImageReferencesPaginatorOptions is the paginator options for
// DescribeImageReferences
type DescribeImageReferencesPaginatorOptions struct {
	//  The maximum number of items to return for this request. To get the next page
	// of items, make another request with the token returned in the output. For more
	// information, see [Pagination].
	//
	// [Pagination]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination
	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
}

// DescribeImageReferencesPaginator is a paginator for DescribeImageReferences
type DescribeImageReferencesPaginator struct {
	options   DescribeImageReferencesPaginatorOptions
	client    DescribeImageReferencesAPIClient
	params    *DescribeImageReferencesInput
	nextToken *string
	firstPage bool
}

// NewDescribeImageReferencesPaginator returns a new
// DescribeImageReferencesPaginator
func NewDescribeImageReferencesPaginator(client DescribeImageReferencesAPIClient, params *DescribeImageReferencesInput, optFns ...func(*DescribeImageReferencesPaginatorOptions)) *DescribeImageReferencesPaginator {
	if params == nil {
		params = &DescribeImageReferencesInput{}
	}

	options := DescribeImageReferencesPaginatorOptions{}
	if params.MaxResults != nil {
		options.Limit = *params.MaxResults
	}

	for _, fn := range optFns {
		fn(&options)
	}

	return &DescribeImageReferencesPaginator{
		options:   options,
		client:    client,
		params:    params,
		firstPage: true,
		nextToken: params.NextToken,
	}
}

// HasMorePages returns a boolean indicating whether more pages are available
func (p *DescribeImageReferencesPaginator) HasMorePages() bool {
	return p.firstPage || (p.nextToken != nil && len(*p.nextToken) != 0)
}

// NextPage retrieves the next DescribeImageReferences page.
func (p *DescribeImageReferencesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeImageReferencesOutput, error) {
	if !p.HasMorePages() {
		return nil, fmt.Errorf("no more pages available")
	}

	params := *p.params
	params.NextToken = p.nextToken

	var limit *int32
	if p.options.Limit > 0 {
		limit = &p.options.Limit
	}
	params.MaxResults = limit

	optFns = append([]func(*Options){
		addIsPaginatorUserAgent,
	}, optFns...)
	result, err := p.client.DescribeImageReferences(ctx, &params, optFns...)
	if err != nil {
		return nil, err
	}
	p.firstPage = false

	prevToken := p.nextToken
	p.nextToken = result.NextToken

	if p.options.StopOnDuplicateToken &&
		prevToken != nil &&
		p.nextToken != nil &&
		*prevToken == *p.nextToken {
		p.nextToken = nil
	}

	return result, nil
}

// DescribeImageReferencesAPIClient is a client that implements the
// DescribeImageReferences operation.
type DescribeImageReferencesAPIClient interface {
	DescribeImageReferences(context.Context, *DescribeImageReferencesInput, ...func(*Options)) (*DescribeImageReferencesOutput, error)
}

var _ DescribeImageReferencesAPIClient = (*Client)(nil)

func newServiceMetadataMiddleware_opDescribeImageReferences(region string) *awsmiddleware.RegisterServiceMetadata {
	return &awsmiddleware.RegisterServiceMetadata{
		Region:        region,
		ServiceID:     ServiceID,
		OperationName: "DescribeImageReferences",
	}
}
