1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package internetmonitor
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/service/internetmonitor/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
"time"
)
// Gets information that Amazon CloudWatch Internet Monitor has created and stored
// about a health event for a specified monitor. This information includes the
// impacted locations, and all the information related to the event, by location.
//
// The information returned includes the impact on performance, availability, and
// round-trip time, information about the network providers (ASNs), the event type,
// and so on.
//
// Information rolled up at the global traffic level is also returned, including
// the impact type and total traffic impact.
func (c *Client) GetHealthEvent(ctx context.Context, params *GetHealthEventInput, optFns ...func(*Options)) (*GetHealthEventOutput, error) {
if params == nil {
params = &GetHealthEventInput{}
}
result, metadata, err := c.invokeOperation(ctx, "GetHealthEvent", params, optFns, c.addOperationGetHealthEventMiddlewares)
if err != nil {
return nil, err
}
out := result.(*GetHealthEventOutput)
out.ResultMetadata = metadata
return out, nil
}
type GetHealthEventInput struct {
// The internally-generated identifier of a health event. Because EventID contains
// the forward slash (“/”) character, you must URL-encode the EventID field in the
// request URL.
//
// This member is required.
EventId *string
// The name of the monitor.
//
// This member is required.
MonitorName *string
// The account ID for an account that you've set up cross-account sharing for in
// Amazon CloudWatch Internet Monitor. You configure cross-account sharing by using
// Amazon CloudWatch Observability Access Manager. For more information, see [Internet Monitor cross-account observability]in
// the Amazon CloudWatch Internet Monitor User Guide.
//
// [Internet Monitor cross-account observability]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cwim-cross-account.html
LinkedAccountId *string
noSmithyDocumentSerde
}
type GetHealthEventOutput struct {
// The Amazon Resource Name (ARN) of the event.
//
// This member is required.
EventArn *string
// The internally-generated identifier of a health event.
//
// This member is required.
EventId *string
// The type of impairment of a specific health event.
//
// This member is required.
ImpactType types.HealthEventImpactType
// The locations affected by a health event.
//
// This member is required.
ImpactedLocations []types.ImpactedLocation
// The time when a health event was last updated or recalculated.
//
// This member is required.
LastUpdatedAt *time.Time
// The time when a health event started.
//
// This member is required.
StartedAt *time.Time
// The status of a health event.
//
// This member is required.
Status types.HealthEventStatus
// The time when a health event was created.
CreatedAt *time.Time
// The time when a health event was resolved. If the health event is still active,
// the end time is not set.
EndedAt *time.Time
// The threshold percentage for a health score that determines, along with other
// configuration information, when Internet Monitor creates a health event when
// there's an internet issue that affects your application end users.
HealthScoreThreshold float64
// The impact on total traffic that a health event has, in increased latency or
// reduced availability. This is the percentage of how much latency has increased
// or availability has decreased during the event, compared to what is typical for
// traffic from this client location to the Amazon Web Services location using this
// client network.
PercentOfTotalTrafficImpacted *float64
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationGetHealthEventMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsRestjson1_serializeOpGetHealthEvent{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpGetHealthEvent{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "GetHealthEvent"); 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 = 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 = addOpGetHealthEventValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opGetHealthEvent(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
}
return nil
}
func newServiceMetadataMiddleware_opGetHealthEvent(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "GetHealthEvent",
}
}
|