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 219 220 221 222 223 224 225 226 227 228 229
|
// 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 about a monitor in Amazon CloudWatch Internet Monitor based on
// a monitor name. The information returned includes the Amazon Resource Name
// (ARN), create time, modified time, resources included in the monitor, and status
// information.
func (c *Client) GetMonitor(ctx context.Context, params *GetMonitorInput, optFns ...func(*Options)) (*GetMonitorOutput, error) {
if params == nil {
params = &GetMonitorInput{}
}
result, metadata, err := c.invokeOperation(ctx, "GetMonitor", params, optFns, c.addOperationGetMonitorMiddlewares)
if err != nil {
return nil, err
}
out := result.(*GetMonitorOutput)
out.ResultMetadata = metadata
return out, nil
}
type GetMonitorInput struct {
// 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 GetMonitorOutput struct {
// The time when the monitor was created.
//
// This member is required.
CreatedAt *time.Time
// The last time that the monitor was modified.
//
// This member is required.
ModifiedAt *time.Time
// The Amazon Resource Name (ARN) of the monitor.
//
// This member is required.
MonitorArn *string
// The name of the monitor.
//
// This member is required.
MonitorName *string
// The resources monitored by the monitor. Resources are listed by their Amazon
// Resource Names (ARNs).
//
// This member is required.
Resources []string
// The status of the monitor.
//
// This member is required.
Status types.MonitorConfigState
// The list of health event threshold configurations. The threshold percentage for
// a health score 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.
//
// For more information, see [Change health event thresholds] in the Internet Monitor section of the CloudWatch
// User Guide.
//
// [Change health event thresholds]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-overview.html#IMUpdateThresholdFromOverview
HealthEventsConfig *types.HealthEventsConfig
// Publish internet measurements for Internet Monitor to another location, such as
// an Amazon S3 bucket. The measurements are also published to Amazon CloudWatch
// Logs.
InternetMeasurementsLogDelivery *types.InternetMeasurementsLogDelivery
// The maximum number of city-networks to monitor for your resources. A
// city-network is the location (city) where clients access your application
// resources from and the ASN or network provider, such as an internet service
// provider (ISP), that clients access the resources through. This limit can help
// control billing costs.
//
// To learn more, see [Choosing a city-network maximum value] in the Amazon CloudWatch Internet Monitor section of the
// CloudWatch User Guide.
//
// [Choosing a city-network maximum value]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/IMCityNetworksMaximum.html
MaxCityNetworksToMonitor *int32
// The health of the data processing for the monitor.
ProcessingStatus types.MonitorProcessingStatusCode
// Additional information about the health of the data processing for the monitor.
ProcessingStatusInfo *string
// The tags that have been added to monitor.
Tags map[string]string
// The percentage of the internet-facing traffic for your application to monitor
// with this monitor. If you set a city-networks maximum, that limit overrides the
// traffic percentage that you set.
//
// To learn more, see [Choosing an application traffic percentage to monitor] in the Amazon CloudWatch Internet Monitor section of the
// CloudWatch User Guide.
//
// [Choosing an application traffic percentage to monitor]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/IMTrafficPercentage.html
TrafficPercentageToMonitor *int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationGetMonitorMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsRestjson1_serializeOpGetMonitor{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpGetMonitor{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "GetMonitor"); 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 = addOpGetMonitorValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opGetMonitor(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_opGetMonitor(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "GetMonitor",
}
}
|