MonitorSummary - Network Synthetic Monitor
ContentsSee Also
Services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the AWS European Sovereign Cloud Region, see the AWS European Sovereign Cloud User Guide.

MonitorSummary

Displays summary information about a monitor.

Contents

monitorArn

The ARN of the monitor.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 512.

Pattern: arn:.*

Required: Yes

monitorName

The name of the monitor.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 200.

Pattern: [a-zA-Z0-9_-]+

Required: Yes

state

The state of the monitor.

Type: String

Valid Values: PENDING | ACTIVE | INACTIVE | ERROR | DELETING

Required: Yes

aggregationPeriod

The time, in seconds, that metrics are collected and sent to Network Synthetic Monitor. Valid values are either 30 or 60.

Type: Long

Valid Range: Minimum value of 30.

Required: No

tags

The list of key-value pairs assigned to the monitor.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 200 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: