Synthetics

Service object for interacting with AWS Synthetics service.

public struct Synthetics: AWSService

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.

     <p>Before you create and manage canaries, be aware of the security considerations. For more
     information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/servicelens_canaries_security.html">Security
        Considerations for Synthetics Canaries</a>.</p>

Inheritance

AWSService

Initializers

`init(client:region:partition:endpoint:timeout:byteBufferAllocator:options:)`

Initialize the Synthetics client

public init(
        client: AWSClient,
        region: SotoCore.Region? = nil,
        partition: AWSPartition = .aws,
        endpoint: String? = nil,
        timeout: TimeAmount? = nil,
        byteBufferAllocator: ByteBufferAllocator = ByteBufferAllocator(),
        options: AWSServiceConfig.Options = []
    )

Parameters

client: AWSClient used to process requests
region: Region of server you want to communicate with. This will override the partition parameter.
partition: AWS partition where service resides, standard (.aws), china (.awscn), government (.awsusgov).
endpoint: Custom endpoint URL to use instead of standard AWS servers
timeout: Timeout value for HTTP requests

`init(from:patch:)`

Initializer required by AWSService.with(middlewares:timeout:byteBufferAllocator:options). You are not able to use this initializer directly as there are no public initializers for AWSServiceConfig.Patch. Please use AWSService.with(middlewares:timeout:byteBufferAllocator:options) instead.

public init(from: Synthetics, patch: AWSServiceConfig.Patch)

Properties

`client`

Client used for communication with AWS

public let client: AWSClient

`config`

Service configuration

public let config: AWSServiceConfig

Methods

`createCanary(_:logger:on:)`

public func createCanary(_ input: CreateCanaryRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreateCanaryResponse>

Creates a canary. Canaries are scripts that monitor your endpoints and APIs from the outside-in. 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. You can set up a canary to run continuously or just once.

Do not use CreateCanary to modify an existing canary. Use UpdateCanary instead.

To create canaries, you must have the CloudWatchSyntheticsFullAccess policy. If you are creating a new IAM role for the canary, you also need the the iam:CreateRole, iam:CreatePolicy and iam:AttachRolePolicy permissions. For more information, see Necessary Roles and Permissions.

Do not include secrets or proprietary information in your canary names. The canary name makes up part of the Amazon Resource Name (ARN) for the canary, and the ARN is included in outbound calls over the internet. For more information, see Security Considerations for Synthetics Canaries.

`deleteCanary(_:logger:on:)`

public func deleteCanary(_ input: DeleteCanaryRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DeleteCanaryResponse>

Permanently deletes the specified canary.

If you specify DeleteLambda to true, CloudWatch Synthetics also deletes the Lambda functions and layers that are used by the canary.

Other esources used and created by the canary are not automatically deleted. After you delete a canary that you do not intend to use again, you should also delete the following:

The CloudWatch alarms created for this canary. These alarms have a name of Synthetics-SharpDrop-Alarm-MyCanaryName.
Amazon S3 objects and buckets, such as the canary's artifact location.
IAM roles created for the canary. If they were created in the console, these roles have the name role/service-role/CloudWatchSyntheticsRole-MyCanaryName.
CloudWatch Logs log groups created for the canary. These logs groups have the name /aws/lambda/cwsyn-MyCanaryName.

     <p>Before you delete a canary, you might want to use <code>GetCanary</code> to display
     the information about this canary. Make
     note of the information returned by this operation so that you can delete these resources
     after you delete the canary.</p>

`describeCanaries(_:logger:on:)`

public func describeCanaries(_ input: DescribeCanariesRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DescribeCanariesResponse>

This operation returns a list of the canaries in your account, along with full details about each canary.

This operation supports resource-level authorization using an IAM policy and the Names parameter. If you specify the Names parameter, the operation is successful only if you have authorization to view all the canaries that you specify in your request. If you do not have permission to view any of the canaries, the request fails with a 403 response.

You are required to use the Names parameter if you are logged on to a user or role that has an IAM policy that restricts which canaries that you are allowed to view. For more information, see Limiting a user to viewing specific canaries.

`describeCanariesLastRun(_:logger:on:)`

public func describeCanariesLastRun(_ input: DescribeCanariesLastRunRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DescribeCanariesLastRunResponse>

Use this operation to see information from the most recent run of each canary that you have created.

     <p>This operation supports resource-level authorization using an IAM policy and 
     the <code>Names</code> parameter. If you specify the <code>Names</code> parameter, the operation is successful only if you have authorization to view
     all the canaries that you specify in your request. If you do not have permission to view any of 
     the canaries, the request fails with a 403 response.</p>
     <p>You are required to use the <code>Names</code> parameter if you are logged on to a user or role that has an 
     IAM policy that restricts which canaries that you are allowed to view. For more information, 
     see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Restricted.html">
        Limiting a user to viewing specific canaries</a>.</p>

`describeRuntimeVersions(_:logger:on:)`

public func describeRuntimeVersions(_ input: DescribeRuntimeVersionsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DescribeRuntimeVersionsResponse>

Returns a list of Synthetics canary runtime versions. For more information, see Canary Runtime Versions.

`getCanary(_:logger:on:)`

public func getCanary(_ input: GetCanaryRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetCanaryResponse>

Retrieves complete information about one canary. You must specify the name of the canary that you want. To get a list of canaries and their names, use DescribeCanaries.

`getCanaryRuns(_:logger:on:)`

public func getCanaryRuns(_ input: GetCanaryRunsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetCanaryRunsResponse>

Retrieves a list of runs for a specified canary.

`listTagsForResource(_:logger:on:)`

public func listTagsForResource(_ input: ListTagsForResourceRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListTagsForResourceResponse>

Displays the tags associated with a canary.

`startCanary(_:logger:on:)`

public func startCanary(_ input: StartCanaryRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<StartCanaryResponse>

Use this operation to run a canary that has already been created. The frequency of the canary runs is determined by the value of the canary's Schedule. To see a canary's schedule, use GetCanary.

`stopCanary(_:logger:on:)`

public func stopCanary(_ input: StopCanaryRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<StopCanaryResponse>

Stops the canary to prevent all future runs. If the canary is currently running, Synthetics stops waiting for the current run of the specified canary to complete. The run that is in progress completes on its own, publishes metrics, and uploads artifacts, but it is not recorded in Synthetics as a completed run.

You can use StartCanary to start it running again with the canary’s current schedule at any point in the future.

`tagResource(_:logger:on:)`

public func tagResource(_ input: TagResourceRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<TagResourceResponse>

Assigns one or more tags (key-value pairs) to the specified canary.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values.

Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.

You can use the TagResource action with a canary that already has tags. If you specify a new tag key for the alarm, this tag is appended to the list of tags associated with the alarm. If you specify a tag key that is already associated with the alarm, the new tag value that you specify replaces the previous value for that tag.

You can associate as many as 50 tags with a canary.

`untagResource(_:logger:on:)`

public func untagResource(_ input: UntagResourceRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<UntagResourceResponse>

Removes one or more tags from the specified canary.

`updateCanary(_:logger:on:)`

public func updateCanary(_ input: UpdateCanaryRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<UpdateCanaryResponse>

Use this operation to change the settings of a canary that has already been created.

You can't use this operation to update the tags of an existing canary. To change the tags of an existing canary, use TagResource.

`describeCanariesPaginator(_:logger:on:)`

compiler(>=5.5.2) && canImport(_Concurrency)

public func describeCanariesPaginator(
        _ input: DescribeCanariesRequest,
        logger: Logger = AWSClient.loggingDisabled,
        on eventLoop: EventLoop? = nil
    ) -> AWSClient.PaginatorSequence<DescribeCanariesRequest, DescribeCanariesResponse>

This operation returns a list of the canaries in your account, along with full details about each canary.

Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on

`describeCanariesLastRunPaginator(_:logger:on:)`

compiler(>=5.5.2) && canImport(_Concurrency)

Return PaginatorSequence for operation.

public func describeCanariesLastRunPaginator(
        _ input: DescribeCanariesLastRunRequest,
        logger: Logger = AWSClient.loggingDisabled,
        on eventLoop: EventLoop? = nil
    ) -> AWSClient.PaginatorSequence<DescribeCanariesLastRunRequest, DescribeCanariesLastRunResponse>

Use this operation to see information from the most recent run of each canary that you have created.

      <p>This operation supports resource-level authorization using an IAM policy and 
      the <code>Names</code> parameter. If you specify the <code>Names</code> parameter, the operation is successful only if you have authorization to view
      all the canaries that you specify in your request. If you do not have permission to view any of 
      the canaries, the request fails with a 403 response.</p>
      <p>You are required to use the <code>Names</code> parameter if you are logged on to a user or role that has an 
      IAM policy that restricts which canaries that you are allowed to view. For more information, 
      see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Restricted.html">
         Limiting a user to viewing specific canaries</a>.</p>

Parameters

- input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on

`describeRuntimeVersionsPaginator(_:logger:on:)`

compiler(>=5.5.2) && canImport(_Concurrency)

public func describeRuntimeVersionsPaginator(
        _ input: DescribeRuntimeVersionsRequest,
        logger: Logger = AWSClient.loggingDisabled,
        on eventLoop: EventLoop? = nil
    ) -> AWSClient.PaginatorSequence<DescribeRuntimeVersionsRequest, DescribeRuntimeVersionsResponse>

Returns a list of Synthetics canary runtime versions. For more information, see Canary Runtime Versions.

Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on

`getCanaryRunsPaginator(_:logger:on:)`

compiler(>=5.5.2) && canImport(_Concurrency)

public func getCanaryRunsPaginator(
        _ input: GetCanaryRunsRequest,
        logger: Logger = AWSClient.loggingDisabled,
        on eventLoop: EventLoop? = nil
    ) -> AWSClient.PaginatorSequence<GetCanaryRunsRequest, GetCanaryRunsResponse>

Retrieves a list of runs for a specified canary.

Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on

`describeCanariesPaginator(_:_:logger:on:onPage:)`

Provide paginated results to closure onPage for it to combine them into one result. This works in a similar manner to Array.reduce<Result>(_:_:) -> Result.

public func describeCanariesPaginator<Result>(
        _ input: DescribeCanariesRequest,
        _ initialValue: Result,
        logger: Logger = AWSClient.loggingDisabled,
        on eventLoop: EventLoop? = nil,
        onPage: @escaping (Result, DescribeCanariesResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
    ) -> EventLoopFuture<Result>

This operation returns a list of the canaries in your account, along with full details about each canary.

Parameters:

input: Input for request

initialValue: The value to use as the initial accumulating value. initialValue is passed to onPage the first time it is called.

logger: Logger used flot logging

eventLoop: EventLoop to run this process on

onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.

`describeCanariesPaginator(_:logger:on:onPage:)`

Provide paginated results to closure onPage.

public func describeCanariesPaginator(
        _ input: DescribeCanariesRequest,
        logger: Logger = AWSClient.loggingDisabled,
        on eventLoop: EventLoop? = nil,
        onPage: @escaping (DescribeCanariesResponse, EventLoop) -> EventLoopFuture<Bool>
    ) -> EventLoopFuture<Void>

Parameters

input: Input for request
logger: Logger used flot logging
eventLoop: EventLoop to run this process on
onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.

`describeCanariesLastRunPaginator(_:_:logger:on:onPage:)`

Provide paginated results to closure onPage for it to combine them into one result. This works in a similar manner to Array.reduce<Result>(_:_:) -> Result.

public func describeCanariesLastRunPaginator<Result>(
        _ input: DescribeCanariesLastRunRequest,
        _ initialValue: Result,
        logger: Logger = AWSClient.loggingDisabled,
        on eventLoop: EventLoop? = nil,
        onPage: @escaping (Result, DescribeCanariesLastRunResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
    ) -> EventLoopFuture<Result>

Use this operation to see information from the most recent run of each canary that you have created.

      <p>This operation supports resource-level authorization using an IAM policy and 
      the <code>Names</code> parameter. If you specify the <code>Names</code> parameter, the operation is successful only if you have authorization to view
      all the canaries that you specify in your request. If you do not have permission to view any of 
      the canaries, the request fails with a 403 response.</p>
      <p>You are required to use the <code>Names</code> parameter if you are logged on to a user or role that has an 
      IAM policy that restricts which canaries that you are allowed to view. For more information, 
      see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Restricted.html">
         Limiting a user to viewing specific canaries</a>.</p>

Parameters:

input: Input for request

initialValue: The value to use as the initial accumulating value. initialValue is passed to onPage the first time it is called.

logger: Logger used flot logging

eventLoop: EventLoop to run this process on

onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.

`describeCanariesLastRunPaginator(_:logger:on:onPage:)`

Provide paginated results to closure onPage.

public func describeCanariesLastRunPaginator(
        _ input: DescribeCanariesLastRunRequest,
        logger: Logger = AWSClient.loggingDisabled,
        on eventLoop: EventLoop? = nil,
        onPage: @escaping (DescribeCanariesLastRunResponse, EventLoop) -> EventLoopFuture<Bool>
    ) -> EventLoopFuture<Void>

Parameters

input: Input for request
logger: Logger used flot logging
eventLoop: EventLoop to run this process on
onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.

`describeRuntimeVersionsPaginator(_:_:logger:on:onPage:)`

Provide paginated results to closure onPage for it to combine them into one result. This works in a similar manner to Array.reduce<Result>(_:_:) -> Result.

public func describeRuntimeVersionsPaginator<Result>(
        _ input: DescribeRuntimeVersionsRequest,
        _ initialValue: Result,
        logger: Logger = AWSClient.loggingDisabled,
        on eventLoop: EventLoop? = nil,
        onPage: @escaping (Result, DescribeRuntimeVersionsResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
    ) -> EventLoopFuture<Result>

Returns a list of Synthetics canary runtime versions. For more information, see Canary Runtime Versions.

Parameters:

input: Input for request

initialValue: The value to use as the initial accumulating value. initialValue is passed to onPage the first time it is called.

logger: Logger used flot logging

eventLoop: EventLoop to run this process on

onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.

`describeRuntimeVersionsPaginator(_:logger:on:onPage:)`

Provide paginated results to closure onPage.

public func describeRuntimeVersionsPaginator(
        _ input: DescribeRuntimeVersionsRequest,
        logger: Logger = AWSClient.loggingDisabled,
        on eventLoop: EventLoop? = nil,
        onPage: @escaping (DescribeRuntimeVersionsResponse, EventLoop) -> EventLoopFuture<Bool>
    ) -> EventLoopFuture<Void>

Parameters

input: Input for request
logger: Logger used flot logging
eventLoop: EventLoop to run this process on
onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.

`getCanaryRunsPaginator(_:_:logger:on:onPage:)`

Provide paginated results to closure onPage for it to combine them into one result. This works in a similar manner to Array.reduce<Result>(_:_:) -> Result.

public func getCanaryRunsPaginator<Result>(
        _ input: GetCanaryRunsRequest,
        _ initialValue: Result,
        logger: Logger = AWSClient.loggingDisabled,
        on eventLoop: EventLoop? = nil,
        onPage: @escaping (Result, GetCanaryRunsResponse, EventLoop) -> EventLoopFuture<(Bool, Result)>
    ) -> EventLoopFuture<Result>

Retrieves a list of runs for a specified canary.

Parameters:

input: Input for request

initialValue: The value to use as the initial accumulating value. initialValue is passed to onPage the first time it is called.

logger: Logger used flot logging

eventLoop: EventLoop to run this process on

onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.

`getCanaryRunsPaginator(_:logger:on:onPage:)`

Provide paginated results to closure onPage.

public func getCanaryRunsPaginator(
        _ input: GetCanaryRunsRequest,
        logger: Logger = AWSClient.loggingDisabled,
        on eventLoop: EventLoop? = nil,
        onPage: @escaping (GetCanaryRunsResponse, EventLoop) -> EventLoopFuture<Bool>
    ) -> EventLoopFuture<Void>

Parameters

input: Input for request
logger: Logger used flot logging
eventLoop: EventLoop to run this process on
onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.