// Code generated by smithy-go-codegen DO NOT EDIT. package medialive import ( "context" "errors" "fmt" awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware" "github.com/aws/aws-sdk-go-v2/aws/signer/v4" "github.com/aws/aws-sdk-go-v2/service/medialive/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" "github.com/jmespath/go-jmespath" "time" ) // Gets details about a channel func (c *Client) DescribeChannel(ctx context.Context, params *DescribeChannelInput, optFns ...func(*Options)) (*DescribeChannelOutput, error) { if params == nil { params = &DescribeChannelInput{} } result, metadata, err := c.invokeOperation(ctx, "DescribeChannel", params, optFns, c.addOperationDescribeChannelMiddlewares) if err != nil { return nil, err } out := result.(*DescribeChannelOutput) out.ResultMetadata = metadata return out, nil } // Placeholder documentation for DescribeChannelRequest type DescribeChannelInput struct { // channel ID // // This member is required. ChannelId *string noSmithyDocumentSerde } // Placeholder documentation for DescribeChannelResponse type DescribeChannelOutput struct { // The unique arn of the channel. Arn *string // Specification of CDI inputs for this channel CdiInputSpecification *types.CdiInputSpecification // The class for this channel. STANDARD for a channel with two pipelines or // SINGLE_PIPELINE for a channel with one pipeline. ChannelClass types.ChannelClass // A list of destinations of the channel. For UDP outputs, there is one // destination per output. For other types (HLS, for example), there is one // destination per packager. Destinations []types.OutputDestination // The endpoints where outgoing connections initiate from EgressEndpoints []types.ChannelEgressEndpoint // Encoder Settings EncoderSettings *types.EncoderSettings // The unique id of the channel. Id *string // List of input attachments for channel. InputAttachments []types.InputAttachment // Specification of network and file inputs for this channel InputSpecification *types.InputSpecification // The log level being written to CloudWatch Logs. LogLevel types.LogLevel // Maintenance settings for this channel. Maintenance *types.MaintenanceStatus // The name of the channel. (user-mutable) Name *string // Runtime details for the pipelines of a running channel. PipelineDetails []types.PipelineDetail // The number of currently healthy pipelines. PipelinesRunningCount int32 // The Amazon Resource Name (ARN) of the role assumed when running the Channel. RoleArn *string // Placeholder documentation for ChannelState State types.ChannelState // A collection of key-value pairs. Tags map[string]string // Settings for VPC output Vpc *types.VpcOutputSettingsDescription // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata noSmithyDocumentSerde } func (c *Client) addOperationDescribeChannelMiddlewares(stack *middleware.Stack, options Options) (err error) { err = stack.Serialize.Add(&awsRestjson1_serializeOpDescribeChannel{}, middleware.After) if err != nil { return err } err = stack.Deserialize.Add(&awsRestjson1_deserializeOpDescribeChannel{}, middleware.After) if err != nil { return err } if err = addSetLoggerMiddleware(stack, options); err != nil { return err } if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil { return err } if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil { return err } if err = addResolveEndpointMiddleware(stack, options); err != nil { return err } if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil { return err } if err = addRetryMiddlewares(stack, options); err != nil { return err } if err = addHTTPSignerV4Middleware(stack, options); err != nil { return err } if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil { return err } if err = awsmiddleware.AddRecordResponseTiming(stack); 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 = addOpDescribeChannelValidationMiddleware(stack); err != nil { return err } if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribeChannel(options.Region), middleware.Before); err != nil { return err } if err = awsmiddleware.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 } return nil } // DescribeChannelAPIClient is a client that implements the DescribeChannel // operation. type DescribeChannelAPIClient interface { DescribeChannel(context.Context, *DescribeChannelInput, ...func(*Options)) (*DescribeChannelOutput, error) } var _ DescribeChannelAPIClient = (*Client)(nil) // ChannelCreatedWaiterOptions are waiter options for ChannelCreatedWaiter type ChannelCreatedWaiterOptions 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. APIOptions []func(*middleware.Stack) error // MinDelay is the minimum amount of time to delay between retries. If unset, // ChannelCreatedWaiter will use default minimum delay of 3 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, ChannelCreatedWaiter will use default max delay of 120 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, *DescribeChannelInput, *DescribeChannelOutput, error) (bool, error) } // ChannelCreatedWaiter defines the waiters for ChannelCreated type ChannelCreatedWaiter struct { client DescribeChannelAPIClient options ChannelCreatedWaiterOptions } // NewChannelCreatedWaiter constructs a ChannelCreatedWaiter. func NewChannelCreatedWaiter(client DescribeChannelAPIClient, optFns ...func(*ChannelCreatedWaiterOptions)) *ChannelCreatedWaiter { options := ChannelCreatedWaiterOptions{} options.MinDelay = 3 * time.Second options.MaxDelay = 120 * time.Second options.Retryable = channelCreatedStateRetryable for _, fn := range optFns { fn(&options) } return &ChannelCreatedWaiter{ client: client, options: options, } } // Wait calls the waiter function for ChannelCreated waiter. The maxWaitDur is the // maximum wait duration the waiter will wait. The maxWaitDur is required and must // be greater than zero. func (w *ChannelCreatedWaiter) Wait(ctx context.Context, params *DescribeChannelInput, maxWaitDur time.Duration, optFns ...func(*ChannelCreatedWaiterOptions)) error { _, err := w.WaitForOutput(ctx, params, maxWaitDur, optFns...) return err } // WaitForOutput calls the waiter function for ChannelCreated 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 *ChannelCreatedWaiter) WaitForOutput(ctx context.Context, params *DescribeChannelInput, maxWaitDur time.Duration, optFns ...func(*ChannelCreatedWaiterOptions)) (*DescribeChannelOutput, 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 = 120 * 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.DescribeChannel(ctx, params, func(o *Options) { o.APIOptions = append(o.APIOptions, apiOptions...) }) 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 ChannelCreated waiter") } func channelCreatedStateRetryable(ctx context.Context, input *DescribeChannelInput, output *DescribeChannelOutput, err error) (bool, error) { if err == nil { pathValue, err := jmespath.Search("State", output) if err != nil { return false, fmt.Errorf("error evaluating waiter state: %w", err) } expectedValue := "IDLE" value, ok := pathValue.(types.ChannelState) if !ok { return false, fmt.Errorf("waiter comparator expected types.ChannelState value, got %T", pathValue) } if string(value) == expectedValue { return false, nil } } if err == nil { pathValue, err := jmespath.Search("State", output) if err != nil { return false, fmt.Errorf("error evaluating waiter state: %w", err) } expectedValue := "CREATING" value, ok := pathValue.(types.ChannelState) if !ok { return false, fmt.Errorf("waiter comparator expected types.ChannelState value, got %T", pathValue) } if string(value) == expectedValue { return true, nil } } if err != nil { var errorType *types.InternalServerErrorException if errors.As(err, &errorType) { return true, nil } } if err == nil { pathValue, err := jmespath.Search("State", output) if err != nil { return false, fmt.Errorf("error evaluating waiter state: %w", err) } expectedValue := "CREATE_FAILED" value, ok := pathValue.(types.ChannelState) if !ok { return false, fmt.Errorf("waiter comparator expected types.ChannelState value, got %T", pathValue) } if string(value) == expectedValue { return false, fmt.Errorf("waiter state transitioned to Failure") } } return true, nil } // ChannelDeletedWaiterOptions are waiter options for ChannelDeletedWaiter type ChannelDeletedWaiterOptions 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. APIOptions []func(*middleware.Stack) error // MinDelay is the minimum amount of time to delay between retries. If unset, // ChannelDeletedWaiter will use default minimum delay of 5 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, ChannelDeletedWaiter will use default max delay of 120 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, *DescribeChannelInput, *DescribeChannelOutput, error) (bool, error) } // ChannelDeletedWaiter defines the waiters for ChannelDeleted type ChannelDeletedWaiter struct { client DescribeChannelAPIClient options ChannelDeletedWaiterOptions } // NewChannelDeletedWaiter constructs a ChannelDeletedWaiter. func NewChannelDeletedWaiter(client DescribeChannelAPIClient, optFns ...func(*ChannelDeletedWaiterOptions)) *ChannelDeletedWaiter { options := ChannelDeletedWaiterOptions{} options.MinDelay = 5 * time.Second options.MaxDelay = 120 * time.Second options.Retryable = channelDeletedStateRetryable for _, fn := range optFns { fn(&options) } return &ChannelDeletedWaiter{ client: client, options: options, } } // Wait calls the waiter function for ChannelDeleted waiter. The maxWaitDur is the // maximum wait duration the waiter will wait. The maxWaitDur is required and must // be greater than zero. func (w *ChannelDeletedWaiter) Wait(ctx context.Context, params *DescribeChannelInput, maxWaitDur time.Duration, optFns ...func(*ChannelDeletedWaiterOptions)) error { _, err := w.WaitForOutput(ctx, params, maxWaitDur, optFns...) return err } // WaitForOutput calls the waiter function for ChannelDeleted 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 *ChannelDeletedWaiter) WaitForOutput(ctx context.Context, params *DescribeChannelInput, maxWaitDur time.Duration, optFns ...func(*ChannelDeletedWaiterOptions)) (*DescribeChannelOutput, 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 = 120 * 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.DescribeChannel(ctx, params, func(o *Options) { o.APIOptions = append(o.APIOptions, apiOptions...) }) 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 ChannelDeleted waiter") } func channelDeletedStateRetryable(ctx context.Context, input *DescribeChannelInput, output *DescribeChannelOutput, err error) (bool, error) { if err == nil { pathValue, err := jmespath.Search("State", output) if err != nil { return false, fmt.Errorf("error evaluating waiter state: %w", err) } expectedValue := "DELETED" value, ok := pathValue.(types.ChannelState) if !ok { return false, fmt.Errorf("waiter comparator expected types.ChannelState value, got %T", pathValue) } if string(value) == expectedValue { return false, nil } } if err == nil { pathValue, err := jmespath.Search("State", output) if err != nil { return false, fmt.Errorf("error evaluating waiter state: %w", err) } expectedValue := "DELETING" value, ok := pathValue.(types.ChannelState) if !ok { return false, fmt.Errorf("waiter comparator expected types.ChannelState value, got %T", pathValue) } if string(value) == expectedValue { return true, nil } } if err != nil { var errorType *types.InternalServerErrorException if errors.As(err, &errorType) { return true, nil } } return true, nil } // ChannelRunningWaiterOptions are waiter options for ChannelRunningWaiter type ChannelRunningWaiterOptions 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. APIOptions []func(*middleware.Stack) error // MinDelay is the minimum amount of time to delay between retries. If unset, // ChannelRunningWaiter will use default minimum delay of 5 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, ChannelRunningWaiter will use default max delay of 120 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, *DescribeChannelInput, *DescribeChannelOutput, error) (bool, error) } // ChannelRunningWaiter defines the waiters for ChannelRunning type ChannelRunningWaiter struct { client DescribeChannelAPIClient options ChannelRunningWaiterOptions } // NewChannelRunningWaiter constructs a ChannelRunningWaiter. func NewChannelRunningWaiter(client DescribeChannelAPIClient, optFns ...func(*ChannelRunningWaiterOptions)) *ChannelRunningWaiter { options := ChannelRunningWaiterOptions{} options.MinDelay = 5 * time.Second options.MaxDelay = 120 * time.Second options.Retryable = channelRunningStateRetryable for _, fn := range optFns { fn(&options) } return &ChannelRunningWaiter{ client: client, options: options, } } // Wait calls the waiter function for ChannelRunning waiter. The maxWaitDur is the // maximum wait duration the waiter will wait. The maxWaitDur is required and must // be greater than zero. func (w *ChannelRunningWaiter) Wait(ctx context.Context, params *DescribeChannelInput, maxWaitDur time.Duration, optFns ...func(*ChannelRunningWaiterOptions)) error { _, err := w.WaitForOutput(ctx, params, maxWaitDur, optFns...) return err } // WaitForOutput calls the waiter function for ChannelRunning 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 *ChannelRunningWaiter) WaitForOutput(ctx context.Context, params *DescribeChannelInput, maxWaitDur time.Duration, optFns ...func(*ChannelRunningWaiterOptions)) (*DescribeChannelOutput, 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 = 120 * 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.DescribeChannel(ctx, params, func(o *Options) { o.APIOptions = append(o.APIOptions, apiOptions...) }) 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 ChannelRunning waiter") } func channelRunningStateRetryable(ctx context.Context, input *DescribeChannelInput, output *DescribeChannelOutput, err error) (bool, error) { if err == nil { pathValue, err := jmespath.Search("State", output) if err != nil { return false, fmt.Errorf("error evaluating waiter state: %w", err) } expectedValue := "RUNNING" value, ok := pathValue.(types.ChannelState) if !ok { return false, fmt.Errorf("waiter comparator expected types.ChannelState value, got %T", pathValue) } if string(value) == expectedValue { return false, nil } } if err == nil { pathValue, err := jmespath.Search("State", output) if err != nil { return false, fmt.Errorf("error evaluating waiter state: %w", err) } expectedValue := "STARTING" value, ok := pathValue.(types.ChannelState) if !ok { return false, fmt.Errorf("waiter comparator expected types.ChannelState value, got %T", pathValue) } if string(value) == expectedValue { return true, nil } } if err != nil { var errorType *types.InternalServerErrorException if errors.As(err, &errorType) { return true, nil } } return true, nil } // ChannelStoppedWaiterOptions are waiter options for ChannelStoppedWaiter type ChannelStoppedWaiterOptions 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. APIOptions []func(*middleware.Stack) error // MinDelay is the minimum amount of time to delay between retries. If unset, // ChannelStoppedWaiter will use default minimum delay of 5 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, ChannelStoppedWaiter will use default max delay of 120 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, *DescribeChannelInput, *DescribeChannelOutput, error) (bool, error) } // ChannelStoppedWaiter defines the waiters for ChannelStopped type ChannelStoppedWaiter struct { client DescribeChannelAPIClient options ChannelStoppedWaiterOptions } // NewChannelStoppedWaiter constructs a ChannelStoppedWaiter. func NewChannelStoppedWaiter(client DescribeChannelAPIClient, optFns ...func(*ChannelStoppedWaiterOptions)) *ChannelStoppedWaiter { options := ChannelStoppedWaiterOptions{} options.MinDelay = 5 * time.Second options.MaxDelay = 120 * time.Second options.Retryable = channelStoppedStateRetryable for _, fn := range optFns { fn(&options) } return &ChannelStoppedWaiter{ client: client, options: options, } } // Wait calls the waiter function for ChannelStopped waiter. The maxWaitDur is the // maximum wait duration the waiter will wait. The maxWaitDur is required and must // be greater than zero. func (w *ChannelStoppedWaiter) Wait(ctx context.Context, params *DescribeChannelInput, maxWaitDur time.Duration, optFns ...func(*ChannelStoppedWaiterOptions)) error { _, err := w.WaitForOutput(ctx, params, maxWaitDur, optFns...) return err } // WaitForOutput calls the waiter function for ChannelStopped 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 *ChannelStoppedWaiter) WaitForOutput(ctx context.Context, params *DescribeChannelInput, maxWaitDur time.Duration, optFns ...func(*ChannelStoppedWaiterOptions)) (*DescribeChannelOutput, 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 = 120 * 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.DescribeChannel(ctx, params, func(o *Options) { o.APIOptions = append(o.APIOptions, apiOptions...) }) 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 ChannelStopped waiter") } func channelStoppedStateRetryable(ctx context.Context, input *DescribeChannelInput, output *DescribeChannelOutput, err error) (bool, error) { if err == nil { pathValue, err := jmespath.Search("State", output) if err != nil { return false, fmt.Errorf("error evaluating waiter state: %w", err) } expectedValue := "IDLE" value, ok := pathValue.(types.ChannelState) if !ok { return false, fmt.Errorf("waiter comparator expected types.ChannelState value, got %T", pathValue) } if string(value) == expectedValue { return false, nil } } if err == nil { pathValue, err := jmespath.Search("State", output) if err != nil { return false, fmt.Errorf("error evaluating waiter state: %w", err) } expectedValue := "STOPPING" value, ok := pathValue.(types.ChannelState) if !ok { return false, fmt.Errorf("waiter comparator expected types.ChannelState value, got %T", pathValue) } if string(value) == expectedValue { return true, nil } } if err != nil { var errorType *types.InternalServerErrorException if errors.As(err, &errorType) { return true, nil } } return true, nil } func newServiceMetadataMiddleware_opDescribeChannel(region string) *awsmiddleware.RegisterServiceMetadata { return &awsmiddleware.RegisterServiceMetadata{ Region: region, ServiceID: ServiceID, SigningName: "medialive", OperationName: "DescribeChannel", } }