api_op_GetHealthCheckStatus.go (4671B)
1 // Code generated by smithy-go-codegen DO NOT EDIT. 2 3 package route53 4 5 import ( 6 "context" 7 "fmt" 8 awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware" 9 "github.com/aws/aws-sdk-go-v2/service/route53/types" 10 "github.com/aws/smithy-go/middleware" 11 smithyhttp "github.com/aws/smithy-go/transport/http" 12 ) 13 14 // Gets status of a specified health check. This API is intended for use during 15 // development to diagnose behavior. It doesn’t support production use-cases with 16 // high query rates that require immediate and actionable responses. 17 func (c *Client) GetHealthCheckStatus(ctx context.Context, params *GetHealthCheckStatusInput, optFns ...func(*Options)) (*GetHealthCheckStatusOutput, error) { 18 if params == nil { 19 params = &GetHealthCheckStatusInput{} 20 } 21 22 result, metadata, err := c.invokeOperation(ctx, "GetHealthCheckStatus", params, optFns, c.addOperationGetHealthCheckStatusMiddlewares) 23 if err != nil { 24 return nil, err 25 } 26 27 out := result.(*GetHealthCheckStatusOutput) 28 out.ResultMetadata = metadata 29 return out, nil 30 } 31 32 // A request to get the status for a health check. 33 type GetHealthCheckStatusInput struct { 34 35 // The ID for the health check that you want the current status for. When you 36 // created the health check, CreateHealthCheck returned the ID in the response, in 37 // the HealthCheckId element. If you want to check the status of a calculated 38 // health check, you must use the Amazon Route 53 console or the CloudWatch 39 // console. You can't use GetHealthCheckStatus to get the status of a calculated 40 // health check. 41 // 42 // This member is required. 43 HealthCheckId *string 44 45 noSmithyDocumentSerde 46 } 47 48 // A complex type that contains the response to a GetHealthCheck request. 49 type GetHealthCheckStatusOutput struct { 50 51 // A list that contains one HealthCheckObservation element for each Amazon Route 52 // 53 health checker that is reporting a status about the health check endpoint. 53 // 54 // This member is required. 55 HealthCheckObservations []types.HealthCheckObservation 56 57 // Metadata pertaining to the operation's result. 58 ResultMetadata middleware.Metadata 59 60 noSmithyDocumentSerde 61 } 62 63 func (c *Client) addOperationGetHealthCheckStatusMiddlewares(stack *middleware.Stack, options Options) (err error) { 64 if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil { 65 return err 66 } 67 err = stack.Serialize.Add(&awsRestxml_serializeOpGetHealthCheckStatus{}, middleware.After) 68 if err != nil { 69 return err 70 } 71 err = stack.Deserialize.Add(&awsRestxml_deserializeOpGetHealthCheckStatus{}, middleware.After) 72 if err != nil { 73 return err 74 } 75 if err := addProtocolFinalizerMiddlewares(stack, options, "GetHealthCheckStatus"); err != nil { 76 return fmt.Errorf("add protocol finalizers: %v", err) 77 } 78 79 if err = addlegacyEndpointContextSetter(stack, options); err != nil { 80 return err 81 } 82 if err = addSetLoggerMiddleware(stack, options); err != nil { 83 return err 84 } 85 if err = addClientRequestID(stack); err != nil { 86 return err 87 } 88 if err = addComputeContentLength(stack); err != nil { 89 return err 90 } 91 if err = addResolveEndpointMiddleware(stack, options); err != nil { 92 return err 93 } 94 if err = addComputePayloadSHA256(stack); err != nil { 95 return err 96 } 97 if err = addRetry(stack, options); err != nil { 98 return err 99 } 100 if err = addRawResponseToMetadata(stack); err != nil { 101 return err 102 } 103 if err = addRecordResponseTiming(stack); err != nil { 104 return err 105 } 106 if err = addClientUserAgent(stack, options); err != nil { 107 return err 108 } 109 if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil { 110 return err 111 } 112 if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil { 113 return err 114 } 115 if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil { 116 return err 117 } 118 if err = addOpGetHealthCheckStatusValidationMiddleware(stack); err != nil { 119 return err 120 } 121 if err = stack.Initialize.Add(newServiceMetadataMiddleware_opGetHealthCheckStatus(options.Region), middleware.Before); err != nil { 122 return err 123 } 124 if err = addRecursionDetection(stack); err != nil { 125 return err 126 } 127 if err = addRequestIDRetrieverMiddleware(stack); err != nil { 128 return err 129 } 130 if err = addResponseErrorMiddleware(stack); err != nil { 131 return err 132 } 133 if err = addRequestResponseLogging(stack, options); err != nil { 134 return err 135 } 136 if err = addDisableHTTPSMiddleware(stack, options); err != nil { 137 return err 138 } 139 return nil 140 } 141 142 func newServiceMetadataMiddleware_opGetHealthCheckStatus(region string) *awsmiddleware.RegisterServiceMetadata { 143 return &awsmiddleware.RegisterServiceMetadata{ 144 Region: region, 145 ServiceID: ServiceID, 146 OperationName: "GetHealthCheckStatus", 147 } 148 }