/* * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ /* * Do not modify this file. This file is generated from the synthetics-2017-10-11.normal.json service model. */ using System; using System.Threading; using System.Threading.Tasks; using System.Collections.Generic; using Amazon.Runtime; using Amazon.Synthetics.Model; namespace Amazon.Synthetics { /// /// Interface for accessing 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. /// /// public partial interface IAmazonSynthetics : IAmazonService, IDisposable { #if AWS_ASYNC_ENUMERABLES_API /// /// Paginators for the service /// ISyntheticsPaginatorFactory Paginators { get; } #endif #region AssociateResource /// /// Associates a canary with a group. Using groups can help you with managing and automating /// your canaries, and you can also view aggregated run results and statistics for all /// canaries in a group. /// /// /// /// You must run this operation in the Region where the canary exists. /// /// /// Container for the necessary parameters to execute the AssociateResource service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the AssociateResource service method, as returned by Synthetics. /// /// A conflicting operation is already in progress. /// /// /// An unknown internal error occurred. /// /// /// One of the specified resources was not found. /// /// /// The request exceeded a service quota value. /// /// /// A parameter could not be validated. /// /// REST API Reference for AssociateResource Operation Task AssociateResourceAsync(AssociateResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region CreateCanary /// /// 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 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. /// /// /// Container for the necessary parameters to execute the CreateCanary service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the CreateCanary service method, as returned by Synthetics. /// /// An unknown internal error occurred. /// /// /// One of the input resources is larger than is allowed. /// /// /// A parameter could not be validated. /// /// REST API Reference for CreateCanary Operation Task CreateCanaryAsync(CreateCanaryRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region CreateGroup /// /// Creates a group which you can use to associate canaries with each other, including /// cross-Region canaries. Using groups can help you with managing and automating your /// canaries, and you can also view aggregated run results and statistics for all canaries /// in a group. /// /// /// /// Groups are global resources. When you create a group, it is replicated across Amazon /// Web Services Regions, and you can view it and add canaries to it from any Region. /// Although the group ARN format reflects the Region name where it was created, a group /// is not constrained to any Region. This means that you can put canaries from multiple /// Regions into the same group, and then use that group to view and manage all of those /// canaries in a single view. /// /// /// /// Groups are supported in all Regions except the Regions that are disabled by default. /// For more information about these Regions, see Enabling /// a Region. /// /// /// /// Each group can contain as many as 10 canaries. You can have as many as 20 groups in /// your account. Any single canary can be a member of up to 10 groups. /// /// /// Container for the necessary parameters to execute the CreateGroup service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the CreateGroup service method, as returned by Synthetics. /// /// A conflicting operation is already in progress. /// /// /// An unknown internal error occurred. /// /// /// The request exceeded a service quota value. /// /// /// A parameter could not be validated. /// /// REST API Reference for CreateGroup Operation Task CreateGroupAsync(CreateGroupRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DeleteCanary /// /// 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 resources 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 . /// ///
/// /// Before you delete a canary, you might want to use GetCanary 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. /// /// /// Container for the necessary parameters to execute the DeleteCanary service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DeleteCanary service method, as returned by Synthetics. /// /// A conflicting operation is already in progress. /// /// /// An unknown internal error occurred. /// /// /// One of the specified resources was not found. /// /// /// A parameter could not be validated. /// /// REST API Reference for DeleteCanary Operation Task DeleteCanaryAsync(DeleteCanaryRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DeleteGroup /// /// Deletes a group. The group doesn't need to be empty to be deleted. If there are canaries /// in the group, they are not deleted when you delete the group. /// /// /// /// Groups are a global resource that appear in all Regions, but the request to delete /// a group must be made from its home Region. You can find the home Region of a group /// within its ARN. /// /// /// Container for the necessary parameters to execute the DeleteGroup service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DeleteGroup service method, as returned by Synthetics. /// /// A conflicting operation is already in progress. /// /// /// An unknown internal error occurred. /// /// /// One of the specified resources was not found. /// /// /// A parameter could not be validated. /// /// REST API Reference for DeleteGroup Operation Task DeleteGroupAsync(DeleteGroupRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DescribeCanaries /// /// 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. /// /// /// Container for the necessary parameters to execute the DescribeCanaries service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DescribeCanaries service method, as returned by Synthetics. /// /// An unknown internal error occurred. /// /// /// A parameter could not be validated. /// /// REST API Reference for DescribeCanaries Operation Task DescribeCanariesAsync(DescribeCanariesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DescribeCanariesLastRun /// /// Use this operation to see information from the most recent run of each canary that /// you have created. /// /// /// /// 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. /// /// /// Container for the necessary parameters to execute the DescribeCanariesLastRun service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DescribeCanariesLastRun service method, as returned by Synthetics. /// /// An unknown internal error occurred. /// /// /// A parameter could not be validated. /// /// REST API Reference for DescribeCanariesLastRun Operation Task DescribeCanariesLastRunAsync(DescribeCanariesLastRunRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DescribeRuntimeVersions /// /// Returns a list of Synthetics canary runtime versions. For more information, see /// Canary Runtime Versions. /// /// Container for the necessary parameters to execute the DescribeRuntimeVersions service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DescribeRuntimeVersions service method, as returned by Synthetics. /// /// An unknown internal error occurred. /// /// /// A parameter could not be validated. /// /// REST API Reference for DescribeRuntimeVersions Operation Task DescribeRuntimeVersionsAsync(DescribeRuntimeVersionsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DisassociateResource /// /// Removes a canary from a group. You must run this operation in the Region where the /// canary exists. /// /// Container for the necessary parameters to execute the DisassociateResource service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DisassociateResource service method, as returned by Synthetics. /// /// A conflicting operation is already in progress. /// /// /// An unknown internal error occurred. /// /// /// One of the specified resources was not found. /// /// /// A parameter could not be validated. /// /// REST API Reference for DisassociateResource Operation Task DisassociateResourceAsync(DisassociateResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region GetCanary /// /// 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. /// /// Container for the necessary parameters to execute the GetCanary service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GetCanary service method, as returned by Synthetics. /// /// An unknown internal error occurred. /// /// /// A parameter could not be validated. /// /// REST API Reference for GetCanary Operation Task GetCanaryAsync(GetCanaryRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region GetCanaryRuns /// /// Retrieves a list of runs for a specified canary. /// /// Container for the necessary parameters to execute the GetCanaryRuns service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GetCanaryRuns service method, as returned by Synthetics. /// /// An unknown internal error occurred. /// /// /// One of the specified resources was not found. /// /// /// A parameter could not be validated. /// /// REST API Reference for GetCanaryRuns Operation Task GetCanaryRunsAsync(GetCanaryRunsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region GetGroup /// /// Returns information about one group. Groups are a global resource, so you can use /// this operation from any Region. /// /// Container for the necessary parameters to execute the GetGroup service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GetGroup service method, as returned by Synthetics. /// /// A conflicting operation is already in progress. /// /// /// An unknown internal error occurred. /// /// /// One of the specified resources was not found. /// /// /// A parameter could not be validated. /// /// REST API Reference for GetGroup Operation Task GetGroupAsync(GetGroupRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ListAssociatedGroups /// /// Returns a list of the groups that the specified canary is associated with. The canary /// that you specify must be in the current Region. /// /// Container for the necessary parameters to execute the ListAssociatedGroups service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ListAssociatedGroups service method, as returned by Synthetics. /// /// An unknown internal error occurred. /// /// /// One of the specified resources was not found. /// /// /// A parameter could not be validated. /// /// REST API Reference for ListAssociatedGroups Operation Task ListAssociatedGroupsAsync(ListAssociatedGroupsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ListGroupResources /// /// This operation returns a list of the ARNs of the canaries that are associated with /// the specified group. /// /// Container for the necessary parameters to execute the ListGroupResources service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ListGroupResources service method, as returned by Synthetics. /// /// A conflicting operation is already in progress. /// /// /// An unknown internal error occurred. /// /// /// One of the specified resources was not found. /// /// /// A parameter could not be validated. /// /// REST API Reference for ListGroupResources Operation Task ListGroupResourcesAsync(ListGroupResourcesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ListGroups /// /// Returns a list of all groups in the account, displaying their names, unique IDs, and /// ARNs. The groups from all Regions are returned. /// /// Container for the necessary parameters to execute the ListGroups service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ListGroups service method, as returned by Synthetics. /// /// An unknown internal error occurred. /// /// /// A parameter could not be validated. /// /// REST API Reference for ListGroups Operation Task ListGroupsAsync(ListGroupsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ListTagsForResource /// /// Displays the tags associated with a canary or group. /// /// Container for the necessary parameters to execute the ListTagsForResource service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ListTagsForResource service method, as returned by Synthetics. /// /// The request was not valid. /// /// /// A conflicting operation is already in progress. /// /// /// An internal failure occurred. Try the operation again. /// /// /// The specified resource was not found. /// /// /// There were too many simultaneous requests. Try the operation again. /// /// REST API Reference for ListTagsForResource Operation Task ListTagsForResourceAsync(ListTagsForResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region StartCanary /// /// 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. /// /// Container for the necessary parameters to execute the StartCanary service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the StartCanary service method, as returned by Synthetics. /// /// A conflicting operation is already in progress. /// /// /// An unknown internal error occurred. /// /// /// One of the specified resources was not found. /// /// /// A parameter could not be validated. /// /// REST API Reference for StartCanary Operation Task StartCanaryAsync(StartCanaryRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region StopCanary /// /// Stops the canary to prevent all future runs. If the canary is currently running,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. /// /// /// Container for the necessary parameters to execute the StopCanary service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the StopCanary service method, as returned by Synthetics. /// /// A conflicting operation is already in progress. /// /// /// An unknown internal error occurred. /// /// /// One of the specified resources was not found. /// /// /// A parameter could not be validated. /// /// REST API Reference for StopCanary Operation Task StopCanaryAsync(StopCanaryRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region TagResource /// /// Assigns one or more tags (key-value pairs) to the specified canary or group. /// /// /// /// 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 resource that already has tags. /// If you specify a new tag key for the resource, this tag is appended to the list of /// tags associated with the resource. If you specify a tag key that is already associated /// with the resource, 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 or group. /// /// /// Container for the necessary parameters to execute the TagResource service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the TagResource service method, as returned by Synthetics. /// /// The request was not valid. /// /// /// A conflicting operation is already in progress. /// /// /// An internal failure occurred. Try the operation again. /// /// /// The specified resource was not found. /// /// /// There were too many simultaneous requests. Try the operation again. /// /// REST API Reference for TagResource Operation Task TagResourceAsync(TagResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region UntagResource /// /// Removes one or more tags from the specified resource. /// /// Container for the necessary parameters to execute the UntagResource service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the UntagResource service method, as returned by Synthetics. /// /// The request was not valid. /// /// /// A conflicting operation is already in progress. /// /// /// An internal failure occurred. Try the operation again. /// /// /// The specified resource was not found. /// /// /// There were too many simultaneous requests. Try the operation again. /// /// REST API Reference for UntagResource Operation Task UntagResourceAsync(UntagResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region UpdateCanary /// /// Updates the configuration 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. /// /// /// Container for the necessary parameters to execute the UpdateCanary service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the UpdateCanary service method, as returned by Synthetics. /// /// A conflicting operation is already in progress. /// /// /// An unknown internal error occurred. /// /// /// One of the input resources is larger than is allowed. /// /// /// One of the specified resources was not found. /// /// /// A parameter could not be validated. /// /// REST API Reference for UpdateCanary Operation Task UpdateCanaryAsync(UpdateCanaryRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion } }