api_op_GetHealthCheckStatus.go (6089B)
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. 15 // 16 // This API is intended for use during development to diagnose behavior. It 17 // doesn’t support production use-cases with high query rates that require 18 // immediate and actionable responses. 19 func (c *Client) GetHealthCheckStatus(ctx context.Context, params *GetHealthCheckStatusInput, optFns ...func(*Options)) (*GetHealthCheckStatusOutput, error) { 20 if params == nil { 21 params = &GetHealthCheckStatusInput{} 22 } 23 24 result, metadata, err := c.invokeOperation(ctx, "GetHealthCheckStatus", params, optFns, c.addOperationGetHealthCheckStatusMiddlewares) 25 if err != nil { 26 return nil, err 27 } 28 29 out := result.(*GetHealthCheckStatusOutput) 30 out.ResultMetadata = metadata 31 return out, nil 32 } 33 34 // A request to get the status for a health check. 35 type GetHealthCheckStatusInput struct { 36 37 // The ID for the health check that you want the current status for. When you 38 // created the health check, CreateHealthCheck returned the ID in the response, in 39 // the HealthCheckId element. 40 // 41 // If you want to check the status of a calculated health check, you must use the 42 // Amazon Route 53 console or the CloudWatch console. You can't use 43 // GetHealthCheckStatus to get the status of a calculated health check. 44 // 45 // This member is required. 46 HealthCheckId *string 47 48 noSmithyDocumentSerde 49 } 50 51 // A complex type that contains the response to a GetHealthCheck request. 52 type GetHealthCheckStatusOutput struct { 53 54 // A list that contains one HealthCheckObservation element for each Amazon Route 55 // 53 health checker that is reporting a status about the health check endpoint. 56 // 57 // This member is required. 58 HealthCheckObservations []types.HealthCheckObservation 59 60 // Metadata pertaining to the operation's result. 61 ResultMetadata middleware.Metadata 62 63 noSmithyDocumentSerde 64 } 65 66 func (c *Client) addOperationGetHealthCheckStatusMiddlewares(stack *middleware.Stack, options Options) (err error) { 67 if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil { 68 return err 69 } 70 err = stack.Serialize.Add(&awsRestxml_serializeOpGetHealthCheckStatus{}, middleware.After) 71 if err != nil { 72 return err 73 } 74 err = stack.Deserialize.Add(&awsRestxml_deserializeOpGetHealthCheckStatus{}, middleware.After) 75 if err != nil { 76 return err 77 } 78 if err := addProtocolFinalizerMiddlewares(stack, options, "GetHealthCheckStatus"); err != nil { 79 return fmt.Errorf("add protocol finalizers: %v", err) 80 } 81 82 if err = addlegacyEndpointContextSetter(stack, options); err != nil { 83 return err 84 } 85 if err = addSetLoggerMiddleware(stack, options); err != nil { 86 return err 87 } 88 if err = addClientRequestID(stack); err != nil { 89 return err 90 } 91 if err = addComputeContentLength(stack); err != nil { 92 return err 93 } 94 if err = addResolveEndpointMiddleware(stack, options); err != nil { 95 return err 96 } 97 if err = addComputePayloadSHA256(stack); err != nil { 98 return err 99 } 100 if err = addRetry(stack, options); err != nil { 101 return err 102 } 103 if err = addRawResponseToMetadata(stack); err != nil { 104 return err 105 } 106 if err = addRecordResponseTiming(stack); err != nil { 107 return err 108 } 109 if err = addSpanRetryLoop(stack, options); err != nil { 110 return err 111 } 112 if err = addClientUserAgent(stack, options); err != nil { 113 return err 114 } 115 if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil { 116 return err 117 } 118 if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil { 119 return err 120 } 121 if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil { 122 return err 123 } 124 if err = addTimeOffsetBuild(stack, c); err != nil { 125 return err 126 } 127 if err = addUserAgentRetryMode(stack, options); err != nil { 128 return err 129 } 130 if err = addCredentialSource(stack, options); err != nil { 131 return err 132 } 133 if err = addOpGetHealthCheckStatusValidationMiddleware(stack); err != nil { 134 return err 135 } 136 if err = stack.Initialize.Add(newServiceMetadataMiddleware_opGetHealthCheckStatus(options.Region), middleware.Before); err != nil { 137 return err 138 } 139 if err = addRecursionDetection(stack); err != nil { 140 return err 141 } 142 if err = addRequestIDRetrieverMiddleware(stack); err != nil { 143 return err 144 } 145 if err = addResponseErrorMiddleware(stack); err != nil { 146 return err 147 } 148 if err = addRequestResponseLogging(stack, options); err != nil { 149 return err 150 } 151 if err = addDisableHTTPSMiddleware(stack, options); err != nil { 152 return err 153 } 154 if err = addInterceptBeforeRetryLoop(stack, options); err != nil { 155 return err 156 } 157 if err = addInterceptAttempt(stack, options); err != nil { 158 return err 159 } 160 if err = addInterceptExecution(stack, options); err != nil { 161 return err 162 } 163 if err = addInterceptBeforeSerialization(stack, options); err != nil { 164 return err 165 } 166 if err = addInterceptAfterSerialization(stack, options); err != nil { 167 return err 168 } 169 if err = addInterceptBeforeSigning(stack, options); err != nil { 170 return err 171 } 172 if err = addInterceptAfterSigning(stack, options); err != nil { 173 return err 174 } 175 if err = addInterceptTransmit(stack, options); err != nil { 176 return err 177 } 178 if err = addInterceptBeforeDeserialization(stack, options); err != nil { 179 return err 180 } 181 if err = addInterceptAfterDeserialization(stack, options); err != nil { 182 return err 183 } 184 if err = addSpanInitializeStart(stack); err != nil { 185 return err 186 } 187 if err = addSpanInitializeEnd(stack); err != nil { 188 return err 189 } 190 if err = addSpanBuildRequestStart(stack); err != nil { 191 return err 192 } 193 if err = addSpanBuildRequestEnd(stack); err != nil { 194 return err 195 } 196 return nil 197 } 198 199 func newServiceMetadataMiddleware_opGetHealthCheckStatus(region string) *awsmiddleware.RegisterServiceMetadata { 200 return &awsmiddleware.RegisterServiceMetadata{ 201 Region: region, 202 ServiceID: ServiceID, 203 OperationName: "GetHealthCheckStatus", 204 } 205 }