service/cloudfront/api_op_GetInvalidationForDistributionTenant.go

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

package cloudfront

import (
	"context"
	"fmt"
	awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
	"github.com/aws/aws-sdk-go-v2/service/cloudfront/types"
	"github.com/aws/smithy-go/middleware"
	smithytime "github.com/aws/smithy-go/time"
	smithyhttp "github.com/aws/smithy-go/transport/http"
	smithywaiter "github.com/aws/smithy-go/waiter"
	"time"
)

// Gets information about a specific invalidation for a distribution tenant.
func (c *Client) GetInvalidationForDistributionTenant(ctx context.Context, params *GetInvalidationForDistributionTenantInput, optFns ...func(*Options)) (*GetInvalidationForDistributionTenantOutput, error) {
	if params == nil {
		params = &GetInvalidationForDistributionTenantInput{}
	}

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

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

type GetInvalidationForDistributionTenantInput struct {

	// The ID of the distribution tenant.
	//
	// This member is required.
	DistributionTenantId *string

	// The ID of the invalidation to retrieve.
	//
	// This member is required.
	Id *string

	noSmithyDocumentSerde
}

type GetInvalidationForDistributionTenantOutput struct {

	// An invalidation.
	Invalidation *types.Invalidation

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

	noSmithyDocumentSerde
}

func (c *Client) addOperationGetInvalidationForDistributionTenantMiddlewares(stack *middleware.Stack, options Options) (err error) {
	if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
		return err
	}
	err = stack.Serialize.Add(&awsRestxml_serializeOpGetInvalidationForDistributionTenant{}, middleware.After)
	if err != nil {
		return err
	}
	err = stack.Deserialize.Add(&awsRestxml_deserializeOpGetInvalidationForDistributionTenant{}, middleware.After)
	if err != nil {
		return err
	}
	if err := addProtocolFinalizerMiddlewares(stack, options, "GetInvalidationForDistributionTenant"); 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 = addOpGetInvalidationForDistributionTenantValidationMiddleware(stack); err != nil {
		return err
	}
	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opGetInvalidationForDistributionTenant(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 = 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
}

// InvalidationForDistributionTenantCompletedWaiterOptions are waiter options for
// InvalidationForDistributionTenantCompletedWaiter
type InvalidationForDistributionTenantCompletedWaiterOptions 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.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// InvalidationForDistributionTenantCompletedWaiter will use default minimum delay
	// of 20 seconds. Note that MinDelay must resolve to a value lesser than or equal
	// to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, InvalidationForDistributionTenantCompletedWaiter will use default
	// max delay of 600 seconds. Note that MaxDelay must resolve to value greater than
	// or equal to the MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state.
	//
	// By default service-modeled logic will populate this option. This option can
	// thus be used to define a custom waiter state with fall-back to service-modeled
	// waiter state mutators.The function returns an error in case of a failure state.
	// In case of retry state, this function returns a bool value of true and nil
	// error, while in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *GetInvalidationForDistributionTenantInput, *GetInvalidationForDistributionTenantOutput, error) (bool, error)
}

// InvalidationForDistributionTenantCompletedWaiter defines the waiters for
// InvalidationForDistributionTenantCompleted
type InvalidationForDistributionTenantCompletedWaiter struct {
	client GetInvalidationForDistributionTenantAPIClient

	options InvalidationForDistributionTenantCompletedWaiterOptions
}

// NewInvalidationForDistributionTenantCompletedWaiter constructs a
// InvalidationForDistributionTenantCompletedWaiter.
func NewInvalidationForDistributionTenantCompletedWaiter(client GetInvalidationForDistributionTenantAPIClient, optFns ...func(*InvalidationForDistributionTenantCompletedWaiterOptions)) *InvalidationForDistributionTenantCompletedWaiter {
	options := InvalidationForDistributionTenantCompletedWaiterOptions{}
	options.MinDelay = 20 * time.Second
	options.MaxDelay = 600 * time.Second
	options.Retryable = invalidationForDistributionTenantCompletedStateRetryable

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

// Wait calls the waiter function for InvalidationForDistributionTenantCompleted
// waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The
// maxWaitDur is required and must be greater than zero.
func (w *InvalidationForDistributionTenantCompletedWaiter) Wait(ctx context.Context, params *GetInvalidationForDistributionTenantInput, maxWaitDur time.Duration, optFns ...func(*InvalidationForDistributionTenantCompletedWaiterOptions)) error {
	_, err := w.WaitForOutput(ctx, params, maxWaitDur, optFns...)
	return err
}

// WaitForOutput calls the waiter function for
// InvalidationForDistributionTenantCompleted waiter and returns the output of the
// successful operation. The maxWaitDur is the maximum wait duration the waiter
// will wait. The maxWaitDur is required and must be greater than zero.
func (w *InvalidationForDistributionTenantCompletedWaiter) WaitForOutput(ctx context.Context, params *GetInvalidationForDistributionTenantInput, maxWaitDur time.Duration, optFns ...func(*InvalidationForDistributionTenantCompletedWaiterOptions)) (*GetInvalidationForDistributionTenantOutput, error) {
	if maxWaitDur <= 0 {
		return nil, fmt.Errorf("maximum wait time for waiter must be greater than zero")
	}

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

	if options.MaxDelay <= 0 {
		options.MaxDelay = 600 * time.Second
	}

	if options.MinDelay > options.MaxDelay {
		return nil, fmt.Errorf("minimum waiter delay %v must be lesser than or equal to maximum waiter delay of %v.", options.MinDelay, options.MaxDelay)
	}

	ctx, cancelFn := context.WithTimeout(ctx, maxWaitDur)
	defer cancelFn()

	logger := smithywaiter.Logger{}
	remainingTime := maxWaitDur

	var attempt int64
	for {

		attempt++
		apiOptions := options.APIOptions
		start := time.Now()

		if options.LogWaitAttempts {
			logger.Attempt = attempt
			apiOptions = append([]func(*middleware.Stack) error{}, options.APIOptions...)
			apiOptions = append(apiOptions, logger.AddLogger)
		}

		out, err := w.client.GetInvalidationForDistributionTenant(ctx, params, func(o *Options) {
			baseOpts := []func(*Options){
				addIsWaiterUserAgent,
			}
			o.APIOptions = append(o.APIOptions, apiOptions...)
			for _, opt := range baseOpts {
				opt(o)
			}
			for _, opt := range options.ClientOptions {
				opt(o)
			}
		})

		retryable, err := options.Retryable(ctx, params, out, err)
		if err != nil {
			return nil, err
		}
		if !retryable {
			return out, nil
		}

		remainingTime -= time.Since(start)
		if remainingTime < options.MinDelay || remainingTime <= 0 {
			break
		}

		// compute exponential backoff between waiter retries
		delay, err := smithywaiter.ComputeDelay(
			attempt, options.MinDelay, options.MaxDelay, remainingTime,
		)
		if err != nil {
			return nil, fmt.Errorf("error computing waiter delay, %w", err)
		}

		remainingTime -= delay
		// sleep for the delay amount before invoking a request
		if err := smithytime.SleepWithContext(ctx, delay); err != nil {
			return nil, fmt.Errorf("request cancelled while waiting, %w", err)
		}
	}
	return nil, fmt.Errorf("exceeded max wait time for InvalidationForDistributionTenantCompleted waiter")
}

func invalidationForDistributionTenantCompletedStateRetryable(ctx context.Context, input *GetInvalidationForDistributionTenantInput, output *GetInvalidationForDistributionTenantOutput, err error) (bool, error) {

	if err == nil {
		v1 := output.Invalidation
		var v2 *string
		if v1 != nil {
			v3 := v1.Status
			v2 = v3
		}
		expectedValue := "Completed"
		var pathValue string
		if v2 != nil {
			pathValue = string(*v2)
		}
		if pathValue == expectedValue {
			return false, nil
		}
	}

	if err != nil {
		return false, err
	}
	return true, nil
}

// GetInvalidationForDistributionTenantAPIClient is a client that implements the
// GetInvalidationForDistributionTenant operation.
type GetInvalidationForDistributionTenantAPIClient interface {
	GetInvalidationForDistributionTenant(context.Context, *GetInvalidationForDistributionTenantInput, ...func(*Options)) (*GetInvalidationForDistributionTenantOutput, error)
}

var _ GetInvalidationForDistributionTenantAPIClient = (*Client)(nil)

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