// Code generated by smithy-go-codegen DO NOT EDIT. package omics import ( "context" "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/omics/document" "github.com/aws/aws-sdk-go-v2/service/omics/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 information about a workflow run. func (c *Client) GetRun(ctx context.Context, params *GetRunInput, optFns ...func(*Options)) (*GetRunOutput, error) { if params == nil { params = &GetRunInput{} } result, metadata, err := c.invokeOperation(ctx, "GetRun", params, optFns, c.addOperationGetRunMiddlewares) if err != nil { return nil, err } out := result.(*GetRunOutput) out.ResultMetadata = metadata return out, nil } type GetRunInput struct { // The run's ID. // // This member is required. Id *string // The run's export format. Export []types.RunExport noSmithyDocumentSerde } type GetRunOutput struct { // The computational accelerator used to run the workflow. Accelerators types.Accelerators // The run's ARN. Arn *string // When the run was created. CreationTime *time.Time // The run's definition. Definition *string // The run's digest. Digest *string // The run's ID. Id *string // The run's log level. LogLevel types.RunLogLevel // The run's name. Name *string // The run's output URI. OutputUri *string // The run's parameters. Parameters document.Interface // The run's priority. Priority *int32 // The run's resource digests. ResourceDigests map[string]string // The run's service role ARN. RoleArn *string // The run's group ID. RunGroupId *string // The run's ID. RunId *string // When the run started. StartTime *time.Time // Who started the run. StartedBy *string // The run's status. Status types.RunStatus // The run's status message. StatusMessage *string // The run's stop time. StopTime *time.Time // The run's storage capacity in gigabytes. StorageCapacity *int32 // The run's tags. Tags map[string]string // The run's workflow ID. WorkflowId *string // The run's workflow type. WorkflowType types.WorkflowType // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata noSmithyDocumentSerde } func (c *Client) addOperationGetRunMiddlewares(stack *middleware.Stack, options Options) (err error) { err = stack.Serialize.Add(&awsRestjson1_serializeOpGetRun{}, middleware.After) if err != nil { return err } err = stack.Deserialize.Add(&awsRestjson1_deserializeOpGetRun{}, 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 = addEndpointPrefix_opGetRunMiddleware(stack); err != nil { return err } if err = addOpGetRunValidationMiddleware(stack); err != nil { return err } if err = stack.Initialize.Add(newServiceMetadataMiddleware_opGetRun(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 } type endpointPrefix_opGetRunMiddleware struct { } func (*endpointPrefix_opGetRunMiddleware) ID() string { return "EndpointHostPrefix" } func (m *endpointPrefix_opGetRunMiddleware) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( out middleware.SerializeOutput, metadata middleware.Metadata, err error, ) { if smithyhttp.GetHostnameImmutable(ctx) || smithyhttp.IsEndpointHostPrefixDisabled(ctx) { return next.HandleSerialize(ctx, in) } req, ok := in.Request.(*smithyhttp.Request) if !ok { return out, metadata, fmt.Errorf("unknown transport type %T", in.Request) } req.URL.Host = "workflows-" + req.URL.Host return next.HandleSerialize(ctx, in) } func addEndpointPrefix_opGetRunMiddleware(stack *middleware.Stack) error { return stack.Serialize.Insert(&endpointPrefix_opGetRunMiddleware{}, `OperationSerializer`, middleware.After) } // GetRunAPIClient is a client that implements the GetRun operation. type GetRunAPIClient interface { GetRun(context.Context, *GetRunInput, ...func(*Options)) (*GetRunOutput, error) } var _ GetRunAPIClient = (*Client)(nil) // RunRunningWaiterOptions are waiter options for RunRunningWaiter type RunRunningWaiterOptions 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, // RunRunningWaiter will use default minimum delay of 30 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, RunRunningWaiter 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, *GetRunInput, *GetRunOutput, error) (bool, error) } // RunRunningWaiter defines the waiters for RunRunning type RunRunningWaiter struct { client GetRunAPIClient options RunRunningWaiterOptions } // NewRunRunningWaiter constructs a RunRunningWaiter. func NewRunRunningWaiter(client GetRunAPIClient, optFns ...func(*RunRunningWaiterOptions)) *RunRunningWaiter { options := RunRunningWaiterOptions{} options.MinDelay = 30 * time.Second options.MaxDelay = 600 * time.Second options.Retryable = runRunningStateRetryable for _, fn := range optFns { fn(&options) } return &RunRunningWaiter{ client: client, options: options, } } // Wait calls the waiter function for RunRunning waiter. The maxWaitDur is the // maximum wait duration the waiter will wait. The maxWaitDur is required and must // be greater than zero. func (w *RunRunningWaiter) Wait(ctx context.Context, params *GetRunInput, maxWaitDur time.Duration, optFns ...func(*RunRunningWaiterOptions)) error { _, err := w.WaitForOutput(ctx, params, maxWaitDur, optFns...) return err } // WaitForOutput calls the waiter function for RunRunning 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 *RunRunningWaiter) WaitForOutput(ctx context.Context, params *GetRunInput, maxWaitDur time.Duration, optFns ...func(*RunRunningWaiterOptions)) (*GetRunOutput, 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.GetRun(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 RunRunning waiter") } func runRunningStateRetryable(ctx context.Context, input *GetRunInput, output *GetRunOutput, err error) (bool, error) { if err == nil { pathValue, err := jmespath.Search("status", output) if err != nil { return false, fmt.Errorf("error evaluating waiter state: %w", err) } expectedValue := "RUNNING" value, ok := pathValue.(types.RunStatus) if !ok { return false, fmt.Errorf("waiter comparator expected types.RunStatus value, got %T", pathValue) } if string(value) == expectedValue { return false, nil } } if err == nil { pathValue, err := jmespath.Search("status", output) if err != nil { return false, fmt.Errorf("error evaluating waiter state: %w", err) } expectedValue := "PENDING" value, ok := pathValue.(types.RunStatus) if !ok { return false, fmt.Errorf("waiter comparator expected types.RunStatus value, got %T", pathValue) } if string(value) == expectedValue { return true, nil } } if err == nil { pathValue, err := jmespath.Search("status", output) if err != nil { return false, fmt.Errorf("error evaluating waiter state: %w", err) } expectedValue := "STARTING" value, ok := pathValue.(types.RunStatus) if !ok { return false, fmt.Errorf("waiter comparator expected types.RunStatus value, got %T", pathValue) } if string(value) == expectedValue { return true, nil } } if err == nil { pathValue, err := jmespath.Search("status", output) if err != nil { return false, fmt.Errorf("error evaluating waiter state: %w", err) } expectedValue := "FAILED" value, ok := pathValue.(types.RunStatus) if !ok { return false, fmt.Errorf("waiter comparator expected types.RunStatus value, got %T", pathValue) } if string(value) == expectedValue { return false, fmt.Errorf("waiter state transitioned to Failure") } } if err == nil { pathValue, err := jmespath.Search("status", output) if err != nil { return false, fmt.Errorf("error evaluating waiter state: %w", err) } expectedValue := "CANCELLED" value, ok := pathValue.(types.RunStatus) if !ok { return false, fmt.Errorf("waiter comparator expected types.RunStatus value, got %T", pathValue) } if string(value) == expectedValue { return false, fmt.Errorf("waiter state transitioned to Failure") } } return true, nil } // RunCompletedWaiterOptions are waiter options for RunCompletedWaiter type RunCompletedWaiterOptions 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, // RunCompletedWaiter will use default minimum delay of 30 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, RunCompletedWaiter 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, *GetRunInput, *GetRunOutput, error) (bool, error) } // RunCompletedWaiter defines the waiters for RunCompleted type RunCompletedWaiter struct { client GetRunAPIClient options RunCompletedWaiterOptions } // NewRunCompletedWaiter constructs a RunCompletedWaiter. func NewRunCompletedWaiter(client GetRunAPIClient, optFns ...func(*RunCompletedWaiterOptions)) *RunCompletedWaiter { options := RunCompletedWaiterOptions{} options.MinDelay = 30 * time.Second options.MaxDelay = 600 * time.Second options.Retryable = runCompletedStateRetryable for _, fn := range optFns { fn(&options) } return &RunCompletedWaiter{ client: client, options: options, } } // Wait calls the waiter function for RunCompleted waiter. The maxWaitDur is the // maximum wait duration the waiter will wait. The maxWaitDur is required and must // be greater than zero. func (w *RunCompletedWaiter) Wait(ctx context.Context, params *GetRunInput, maxWaitDur time.Duration, optFns ...func(*RunCompletedWaiterOptions)) error { _, err := w.WaitForOutput(ctx, params, maxWaitDur, optFns...) return err } // WaitForOutput calls the waiter function for RunCompleted 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 *RunCompletedWaiter) WaitForOutput(ctx context.Context, params *GetRunInput, maxWaitDur time.Duration, optFns ...func(*RunCompletedWaiterOptions)) (*GetRunOutput, 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.GetRun(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 RunCompleted waiter") } func runCompletedStateRetryable(ctx context.Context, input *GetRunInput, output *GetRunOutput, err error) (bool, error) { if err == nil { pathValue, err := jmespath.Search("status", output) if err != nil { return false, fmt.Errorf("error evaluating waiter state: %w", err) } expectedValue := "COMPLETED" value, ok := pathValue.(types.RunStatus) if !ok { return false, fmt.Errorf("waiter comparator expected types.RunStatus value, got %T", pathValue) } if string(value) == expectedValue { return false, nil } } if err == nil { pathValue, err := jmespath.Search("status", output) if err != nil { return false, fmt.Errorf("error evaluating waiter state: %w", err) } expectedValue := "PENDING" value, ok := pathValue.(types.RunStatus) if !ok { return false, fmt.Errorf("waiter comparator expected types.RunStatus value, got %T", pathValue) } if string(value) == expectedValue { return true, nil } } if err == nil { pathValue, err := jmespath.Search("status", output) if err != nil { return false, fmt.Errorf("error evaluating waiter state: %w", err) } expectedValue := "STARTING" value, ok := pathValue.(types.RunStatus) if !ok { return false, fmt.Errorf("waiter comparator expected types.RunStatus value, got %T", pathValue) } if string(value) == expectedValue { return true, nil } } if err == nil { pathValue, err := jmespath.Search("status", output) if err != nil { return false, fmt.Errorf("error evaluating waiter state: %w", err) } expectedValue := "RUNNING" value, ok := pathValue.(types.RunStatus) if !ok { return false, fmt.Errorf("waiter comparator expected types.RunStatus value, got %T", pathValue) } if string(value) == expectedValue { return true, nil } } if err == nil { pathValue, err := jmespath.Search("status", output) if err != nil { return false, fmt.Errorf("error evaluating waiter state: %w", err) } expectedValue := "STOPPING" value, ok := pathValue.(types.RunStatus) if !ok { return false, fmt.Errorf("waiter comparator expected types.RunStatus value, got %T", pathValue) } if string(value) == expectedValue { return true, nil } } if err == nil { pathValue, err := jmespath.Search("status", output) if err != nil { return false, fmt.Errorf("error evaluating waiter state: %w", err) } expectedValue := "FAILED" value, ok := pathValue.(types.RunStatus) if !ok { return false, fmt.Errorf("waiter comparator expected types.RunStatus value, got %T", pathValue) } if string(value) == expectedValue { return false, fmt.Errorf("waiter state transitioned to Failure") } } return true, nil } func newServiceMetadataMiddleware_opGetRun(region string) *awsmiddleware.RegisterServiceMetadata { return &awsmiddleware.RegisterServiceMetadata{ Region: region, ServiceID: ServiceID, SigningName: "omics", OperationName: "GetRun", } }