Crate aws_sdk_synthetics

Amazon CloudWatch Synthetics

You can use Amazon CloudWatch Synthetics to continually monitor your services. You can create and manage canaries, which are modular, lightweight scripts that monitor your endpoints and APIs from the outside-in. You can set up your canaries to run 24 hours a day, once per minute. The canaries help you check the availability and latency of your web services and troubleshoot anomalies by investigating load time data, screenshots of the UI, logs, and metrics. The canaries seamlessly integrate with CloudWatch ServiceLens to help you trace the causes of impacted nodes in your applications. For more information, see Using ServiceLens to Monitor the Health of Your Applications in the Amazon CloudWatch User Guide.

Before you create and manage canaries, be aware of the security considerations. For more information, see Security Considerations for Synthetics Canaries.

Crate Organization

The entry point for most customers will be Client. Client exposes one method for each API offered by the service.

Some APIs require complex or nested arguments. These exist in model.

Lastly, errors that can be returned by the service are contained within error. Error defines a meta error encompassing all possible errors that can be returned by the service.

The other modules within this crate are not required for normal usage.

Modules

client

Client and fluent builders for calling the service.

config

Configuration for the service.

endpoint

Endpoint resolution functionality

error

All error types that operations can return. Documentation on these types is copied from the model.

input

Input structures for operations. Documentation on these types is copied from the model.

middleware

Base Middleware Stack

model

Data structures used by operation inputs/outputs. Documentation on these types is copied from the model.

operation

All operations that this crate can perform.

output

Output structures for operations. Documentation on these types is copied from the model.

paginator

Paginators for the service

types

Data primitives referenced by other data types.

Structs

AppName

App name that can be configured with an AWS SDK client to become part of the user agent string.

Client

Client for Synthetics

Config

Service config.

Credentials

AWS SDK Credentials

EndpointDeprecated

API Endpoint

Region

The region to send requests to.

Enums

Error

All possible error types for this service.

Statics

PKG_VERSION

Crate version number.