/*
* 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.Collections.Generic;
using System.Net;
using Amazon.Synthetics.Model;
using Amazon.Synthetics.Model.Internal.MarshallTransformations;
using Amazon.Synthetics.Internal;
using Amazon.Runtime;
using Amazon.Runtime.Internal;
using Amazon.Runtime.Internal.Auth;
using Amazon.Runtime.Internal.Transform;
namespace Amazon.Synthetics
{
///
/// Implementation 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 class AmazonSyntheticsClient : AmazonServiceClient, IAmazonSynthetics
{
private static IServiceMetadata serviceMetadata = new AmazonSyntheticsMetadata();
#if BCL45 || AWS_ASYNC_ENUMERABLES_API
private ISyntheticsPaginatorFactory _paginators;
///
/// Paginators for the service
///
public ISyntheticsPaginatorFactory Paginators
{
get
{
if (this._paginators == null)
{
this._paginators = new SyntheticsPaginatorFactory(this);
}
return this._paginators;
}
}
#endif
#region Constructors
///
/// Constructs AmazonSyntheticsClient with the credentials loaded from the application's
/// default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.
///
/// Example App.config with credentials set.
///
/// <?xml version="1.0" encoding="utf-8" ?>
/// <configuration>
/// <appSettings>
/// <add key="AWSProfileName" value="AWS Default"/>
/// </appSettings>
/// </configuration>
///
///
///
public AmazonSyntheticsClient()
: base(FallbackCredentialsFactory.GetCredentials(), new AmazonSyntheticsConfig()) { }
///
/// Constructs AmazonSyntheticsClient with the credentials loaded from the application's
/// default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.
///
/// Example App.config with credentials set.
///
/// <?xml version="1.0" encoding="utf-8" ?>
/// <configuration>
/// <appSettings>
/// <add key="AWSProfileName" value="AWS Default"/>
/// </appSettings>
/// </configuration>
///
///
///
/// The region to connect.
public AmazonSyntheticsClient(RegionEndpoint region)
: base(FallbackCredentialsFactory.GetCredentials(), new AmazonSyntheticsConfig{RegionEndpoint = region}) { }
///
/// Constructs AmazonSyntheticsClient with the credentials loaded from the application's
/// default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.
///
/// Example App.config with credentials set.
///
/// <?xml version="1.0" encoding="utf-8" ?>
/// <configuration>
/// <appSettings>
/// <add key="AWSProfileName" value="AWS Default"/>
/// </appSettings>
/// </configuration>
///
///
///
/// The AmazonSyntheticsClient Configuration Object
public AmazonSyntheticsClient(AmazonSyntheticsConfig config)
: base(FallbackCredentialsFactory.GetCredentials(config), config){}
///
/// Constructs AmazonSyntheticsClient with AWS Credentials
///
/// AWS Credentials
public AmazonSyntheticsClient(AWSCredentials credentials)
: this(credentials, new AmazonSyntheticsConfig())
{
}
///
/// Constructs AmazonSyntheticsClient with AWS Credentials
///
/// AWS Credentials
/// The region to connect.
public AmazonSyntheticsClient(AWSCredentials credentials, RegionEndpoint region)
: this(credentials, new AmazonSyntheticsConfig{RegionEndpoint = region})
{
}
///
/// Constructs AmazonSyntheticsClient with AWS Credentials and an
/// AmazonSyntheticsClient Configuration object.
///
/// AWS Credentials
/// The AmazonSyntheticsClient Configuration Object
public AmazonSyntheticsClient(AWSCredentials credentials, AmazonSyntheticsConfig clientConfig)
: base(credentials, clientConfig)
{
}
///
/// Constructs AmazonSyntheticsClient with AWS Access Key ID and AWS Secret Key
///
/// AWS Access Key ID
/// AWS Secret Access Key
public AmazonSyntheticsClient(string awsAccessKeyId, string awsSecretAccessKey)
: this(awsAccessKeyId, awsSecretAccessKey, new AmazonSyntheticsConfig())
{
}
///
/// Constructs AmazonSyntheticsClient with AWS Access Key ID and AWS Secret Key
///
/// AWS Access Key ID
/// AWS Secret Access Key
/// The region to connect.
public AmazonSyntheticsClient(string awsAccessKeyId, string awsSecretAccessKey, RegionEndpoint region)
: this(awsAccessKeyId, awsSecretAccessKey, new AmazonSyntheticsConfig() {RegionEndpoint=region})
{
}
///
/// Constructs AmazonSyntheticsClient with AWS Access Key ID, AWS Secret Key and an
/// AmazonSyntheticsClient Configuration object.
///
/// AWS Access Key ID
/// AWS Secret Access Key
/// The AmazonSyntheticsClient Configuration Object
public AmazonSyntheticsClient(string awsAccessKeyId, string awsSecretAccessKey, AmazonSyntheticsConfig clientConfig)
: base(awsAccessKeyId, awsSecretAccessKey, clientConfig)
{
}
///
/// Constructs AmazonSyntheticsClient with AWS Access Key ID and AWS Secret Key
///
/// AWS Access Key ID
/// AWS Secret Access Key
/// AWS Session Token
public AmazonSyntheticsClient(string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken)
: this(awsAccessKeyId, awsSecretAccessKey, awsSessionToken, new AmazonSyntheticsConfig())
{
}
///
/// Constructs AmazonSyntheticsClient with AWS Access Key ID and AWS Secret Key
///
/// AWS Access Key ID
/// AWS Secret Access Key
/// AWS Session Token
/// The region to connect.
public AmazonSyntheticsClient(string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, RegionEndpoint region)
: this(awsAccessKeyId, awsSecretAccessKey, awsSessionToken, new AmazonSyntheticsConfig{RegionEndpoint = region})
{
}
///
/// Constructs AmazonSyntheticsClient with AWS Access Key ID, AWS Secret Key and an
/// AmazonSyntheticsClient Configuration object.
///
/// AWS Access Key ID
/// AWS Secret Access Key
/// AWS Session Token
/// The AmazonSyntheticsClient Configuration Object
public AmazonSyntheticsClient(string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, AmazonSyntheticsConfig clientConfig)
: base(awsAccessKeyId, awsSecretAccessKey, awsSessionToken, clientConfig)
{
}
#endregion
#region Overrides
///
/// Creates the signer for the service.
///
protected override AbstractAWSSigner CreateSigner()
{
return new AWS4Signer();
}
///
/// Customize the pipeline
///
///
protected override void CustomizeRuntimePipeline(RuntimePipeline pipeline)
{
pipeline.RemoveHandler();
pipeline.AddHandlerAfter(new AmazonSyntheticsEndpointResolver());
}
///
/// Capture metadata for the service.
///
protected override IServiceMetadata ServiceMetadata
{
get
{
return serviceMetadata;
}
}
#endregion
#region Dispose
///
/// Disposes the service client.
///
protected override void Dispose(bool disposing)
{
base.Dispose(disposing);
}
#endregion
#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.
///
/// 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
public virtual AssociateResourceResponse AssociateResource(AssociateResourceRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = AssociateResourceRequestMarshaller.Instance;
options.ResponseUnmarshaller = AssociateResourceResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the AssociateResource operation.
///
///
/// Container for the necessary parameters to execute the AssociateResource operation on AmazonSyntheticsClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndAssociateResource
/// operation.
/// REST API Reference for AssociateResource Operation
public virtual IAsyncResult BeginAssociateResource(AssociateResourceRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = AssociateResourceRequestMarshaller.Instance;
options.ResponseUnmarshaller = AssociateResourceResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the AssociateResource operation.
///
///
/// The IAsyncResult returned by the call to BeginAssociateResource.
///
/// Returns a AssociateResourceResult from Synthetics.
/// REST API Reference for AssociateResource Operation
public virtual AssociateResourceResponse EndAssociateResource(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#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.
///
/// 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
public virtual CreateCanaryResponse CreateCanary(CreateCanaryRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = CreateCanaryRequestMarshaller.Instance;
options.ResponseUnmarshaller = CreateCanaryResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the CreateCanary operation.
///
///
/// Container for the necessary parameters to execute the CreateCanary operation on AmazonSyntheticsClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateCanary
/// operation.
/// REST API Reference for CreateCanary Operation
public virtual IAsyncResult BeginCreateCanary(CreateCanaryRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = CreateCanaryRequestMarshaller.Instance;
options.ResponseUnmarshaller = CreateCanaryResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the CreateCanary operation.
///
///
/// The IAsyncResult returned by the call to BeginCreateCanary.
///
/// Returns a CreateCanaryResult from Synthetics.
/// REST API Reference for CreateCanary Operation
public virtual CreateCanaryResponse EndCreateCanary(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#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.
///
/// 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
public virtual CreateGroupResponse CreateGroup(CreateGroupRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = CreateGroupRequestMarshaller.Instance;
options.ResponseUnmarshaller = CreateGroupResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the CreateGroup operation.
///
///
/// Container for the necessary parameters to execute the CreateGroup operation on AmazonSyntheticsClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateGroup
/// operation.
/// REST API Reference for CreateGroup Operation
public virtual IAsyncResult BeginCreateGroup(CreateGroupRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = CreateGroupRequestMarshaller.Instance;
options.ResponseUnmarshaller = CreateGroupResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the CreateGroup operation.
///
///
/// The IAsyncResult returned by the call to BeginCreateGroup.
///
/// Returns a CreateGroupResult from Synthetics.
/// REST API Reference for CreateGroup Operation
public virtual CreateGroupResponse EndCreateGroup(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#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.
///
/// 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
public virtual DeleteCanaryResponse DeleteCanary(DeleteCanaryRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteCanaryRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteCanaryResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the DeleteCanary operation.
///
///
/// Container for the necessary parameters to execute the DeleteCanary operation on AmazonSyntheticsClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteCanary
/// operation.
/// REST API Reference for DeleteCanary Operation
public virtual IAsyncResult BeginDeleteCanary(DeleteCanaryRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteCanaryRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteCanaryResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the DeleteCanary operation.
///
///
/// The IAsyncResult returned by the call to BeginDeleteCanary.
///
/// Returns a DeleteCanaryResult from Synthetics.
/// REST API Reference for DeleteCanary Operation
public virtual DeleteCanaryResponse EndDeleteCanary(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#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.
///
/// 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
public virtual DeleteGroupResponse DeleteGroup(DeleteGroupRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteGroupRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteGroupResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the DeleteGroup operation.
///
///
/// Container for the necessary parameters to execute the DeleteGroup operation on AmazonSyntheticsClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteGroup
/// operation.
/// REST API Reference for DeleteGroup Operation
public virtual IAsyncResult BeginDeleteGroup(DeleteGroupRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteGroupRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteGroupResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the DeleteGroup operation.
///
///
/// The IAsyncResult returned by the call to BeginDeleteGroup.
///
/// Returns a DeleteGroupResult from Synthetics.
/// REST API Reference for DeleteGroup Operation
public virtual DeleteGroupResponse EndDeleteGroup(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#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.
///
/// 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
public virtual DescribeCanariesResponse DescribeCanaries(DescribeCanariesRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeCanariesRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeCanariesResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the DescribeCanaries operation.
///
///
/// Container for the necessary parameters to execute the DescribeCanaries operation on AmazonSyntheticsClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeCanaries
/// operation.
/// REST API Reference for DescribeCanaries Operation
public virtual IAsyncResult BeginDescribeCanaries(DescribeCanariesRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeCanariesRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeCanariesResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the DescribeCanaries operation.
///
///
/// The IAsyncResult returned by the call to BeginDescribeCanaries.
///
/// Returns a DescribeCanariesResult from Synthetics.
/// REST API Reference for DescribeCanaries Operation
public virtual DescribeCanariesResponse EndDescribeCanaries(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#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.
///
/// 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
public virtual DescribeCanariesLastRunResponse DescribeCanariesLastRun(DescribeCanariesLastRunRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeCanariesLastRunRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeCanariesLastRunResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the DescribeCanariesLastRun operation.
///
///
/// Container for the necessary parameters to execute the DescribeCanariesLastRun operation on AmazonSyntheticsClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeCanariesLastRun
/// operation.
/// REST API Reference for DescribeCanariesLastRun Operation
public virtual IAsyncResult BeginDescribeCanariesLastRun(DescribeCanariesLastRunRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeCanariesLastRunRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeCanariesLastRunResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the DescribeCanariesLastRun operation.
///
///
/// The IAsyncResult returned by the call to BeginDescribeCanariesLastRun.
///
/// Returns a DescribeCanariesLastRunResult from Synthetics.
/// REST API Reference for DescribeCanariesLastRun Operation
public virtual DescribeCanariesLastRunResponse EndDescribeCanariesLastRun(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#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.
///
/// 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
public virtual DescribeRuntimeVersionsResponse DescribeRuntimeVersions(DescribeRuntimeVersionsRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeRuntimeVersionsRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeRuntimeVersionsResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the DescribeRuntimeVersions operation.
///
///
/// Container for the necessary parameters to execute the DescribeRuntimeVersions operation on AmazonSyntheticsClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeRuntimeVersions
/// operation.
/// REST API Reference for DescribeRuntimeVersions Operation
public virtual IAsyncResult BeginDescribeRuntimeVersions(DescribeRuntimeVersionsRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeRuntimeVersionsRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeRuntimeVersionsResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the DescribeRuntimeVersions operation.
///
///
/// The IAsyncResult returned by the call to BeginDescribeRuntimeVersions.
///
/// Returns a DescribeRuntimeVersionsResult from Synthetics.
/// REST API Reference for DescribeRuntimeVersions Operation
public virtual DescribeRuntimeVersionsResponse EndDescribeRuntimeVersions(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#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.
///
/// 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
public virtual DisassociateResourceResponse DisassociateResource(DisassociateResourceRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DisassociateResourceRequestMarshaller.Instance;
options.ResponseUnmarshaller = DisassociateResourceResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the DisassociateResource operation.
///
///
/// Container for the necessary parameters to execute the DisassociateResource operation on AmazonSyntheticsClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDisassociateResource
/// operation.
/// REST API Reference for DisassociateResource Operation
public virtual IAsyncResult BeginDisassociateResource(DisassociateResourceRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = DisassociateResourceRequestMarshaller.Instance;
options.ResponseUnmarshaller = DisassociateResourceResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the DisassociateResource operation.
///
///
/// The IAsyncResult returned by the call to BeginDisassociateResource.
///
/// Returns a DisassociateResourceResult from Synthetics.
/// REST API Reference for DisassociateResource Operation
public virtual DisassociateResourceResponse EndDisassociateResource(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#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.
///
/// 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
public virtual GetCanaryResponse GetCanary(GetCanaryRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetCanaryRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetCanaryResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the GetCanary operation.
///
///
/// Container for the necessary parameters to execute the GetCanary operation on AmazonSyntheticsClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetCanary
/// operation.
/// REST API Reference for GetCanary Operation
public virtual IAsyncResult BeginGetCanary(GetCanaryRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetCanaryRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetCanaryResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the GetCanary operation.
///
///
/// The IAsyncResult returned by the call to BeginGetCanary.
///
/// Returns a GetCanaryResult from Synthetics.
/// REST API Reference for GetCanary Operation
public virtual GetCanaryResponse EndGetCanary(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#endregion
#region GetCanaryRuns
///
/// Retrieves a list of runs for a specified canary.
///
/// Container for the necessary parameters to execute the GetCanaryRuns service method.
///
/// 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
public virtual GetCanaryRunsResponse GetCanaryRuns(GetCanaryRunsRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetCanaryRunsRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetCanaryRunsResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the GetCanaryRuns operation.
///
///
/// Container for the necessary parameters to execute the GetCanaryRuns operation on AmazonSyntheticsClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetCanaryRuns
/// operation.
/// REST API Reference for GetCanaryRuns Operation
public virtual IAsyncResult BeginGetCanaryRuns(GetCanaryRunsRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetCanaryRunsRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetCanaryRunsResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the GetCanaryRuns operation.
///
///
/// The IAsyncResult returned by the call to BeginGetCanaryRuns.
///
/// Returns a GetCanaryRunsResult from Synthetics.
/// REST API Reference for GetCanaryRuns Operation
public virtual GetCanaryRunsResponse EndGetCanaryRuns(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#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.
///
/// 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
public virtual GetGroupResponse GetGroup(GetGroupRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetGroupRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetGroupResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the GetGroup operation.
///
///
/// Container for the necessary parameters to execute the GetGroup operation on AmazonSyntheticsClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetGroup
/// operation.
/// REST API Reference for GetGroup Operation
public virtual IAsyncResult BeginGetGroup(GetGroupRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetGroupRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetGroupResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the GetGroup operation.
///
///
/// The IAsyncResult returned by the call to BeginGetGroup.
///
/// Returns a GetGroupResult from Synthetics.
/// REST API Reference for GetGroup Operation
public virtual GetGroupResponse EndGetGroup(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#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.
///
/// 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
public virtual ListAssociatedGroupsResponse ListAssociatedGroups(ListAssociatedGroupsRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListAssociatedGroupsRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListAssociatedGroupsResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the ListAssociatedGroups operation.
///
///
/// Container for the necessary parameters to execute the ListAssociatedGroups operation on AmazonSyntheticsClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListAssociatedGroups
/// operation.
/// REST API Reference for ListAssociatedGroups Operation
public virtual IAsyncResult BeginListAssociatedGroups(ListAssociatedGroupsRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListAssociatedGroupsRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListAssociatedGroupsResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the ListAssociatedGroups operation.
///
///
/// The IAsyncResult returned by the call to BeginListAssociatedGroups.
///
/// Returns a ListAssociatedGroupsResult from Synthetics.
/// REST API Reference for ListAssociatedGroups Operation
public virtual ListAssociatedGroupsResponse EndListAssociatedGroups(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#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.
///
/// 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
public virtual ListGroupResourcesResponse ListGroupResources(ListGroupResourcesRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListGroupResourcesRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListGroupResourcesResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the ListGroupResources operation.
///
///
/// Container for the necessary parameters to execute the ListGroupResources operation on AmazonSyntheticsClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListGroupResources
/// operation.
/// REST API Reference for ListGroupResources Operation
public virtual IAsyncResult BeginListGroupResources(ListGroupResourcesRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListGroupResourcesRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListGroupResourcesResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the ListGroupResources operation.
///
///
/// The IAsyncResult returned by the call to BeginListGroupResources.
///
/// Returns a ListGroupResourcesResult from Synthetics.
/// REST API Reference for ListGroupResources Operation
public virtual ListGroupResourcesResponse EndListGroupResources(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#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.
///
/// 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
public virtual ListGroupsResponse ListGroups(ListGroupsRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListGroupsRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListGroupsResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the ListGroups operation.
///
///
/// Container for the necessary parameters to execute the ListGroups operation on AmazonSyntheticsClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListGroups
/// operation.
/// REST API Reference for ListGroups Operation
public virtual IAsyncResult BeginListGroups(ListGroupsRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListGroupsRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListGroupsResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the ListGroups operation.
///
///
/// The IAsyncResult returned by the call to BeginListGroups.
///
/// Returns a ListGroupsResult from Synthetics.
/// REST API Reference for ListGroups Operation
public virtual ListGroupsResponse EndListGroups(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#endregion
#region ListTagsForResource
///
/// Displays the tags associated with a canary or group.
///
/// Container for the necessary parameters to execute the ListTagsForResource service method.
///
/// 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
public virtual ListTagsForResourceResponse ListTagsForResource(ListTagsForResourceRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListTagsForResourceRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListTagsForResourceResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the ListTagsForResource operation.
///
///
/// Container for the necessary parameters to execute the ListTagsForResource operation on AmazonSyntheticsClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListTagsForResource
/// operation.
/// REST API Reference for ListTagsForResource Operation
public virtual IAsyncResult BeginListTagsForResource(ListTagsForResourceRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListTagsForResourceRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListTagsForResourceResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the ListTagsForResource operation.
///
///
/// The IAsyncResult returned by the call to BeginListTagsForResource.
///
/// Returns a ListTagsForResourceResult from Synthetics.
/// REST API Reference for ListTagsForResource Operation
public virtual ListTagsForResourceResponse EndListTagsForResource(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#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.
///
/// 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
public virtual StartCanaryResponse StartCanary(StartCanaryRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = StartCanaryRequestMarshaller.Instance;
options.ResponseUnmarshaller = StartCanaryResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the StartCanary operation.
///
///
/// Container for the necessary parameters to execute the StartCanary operation on AmazonSyntheticsClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndStartCanary
/// operation.
/// REST API Reference for StartCanary Operation
public virtual IAsyncResult BeginStartCanary(StartCanaryRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = StartCanaryRequestMarshaller.Instance;
options.ResponseUnmarshaller = StartCanaryResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the StartCanary operation.
///
///
/// The IAsyncResult returned by the call to BeginStartCanary.
///
/// Returns a StartCanaryResult from Synthetics.
/// REST API Reference for StartCanary Operation
public virtual StartCanaryResponse EndStartCanary(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#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.
///
/// 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
public virtual StopCanaryResponse StopCanary(StopCanaryRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = StopCanaryRequestMarshaller.Instance;
options.ResponseUnmarshaller = StopCanaryResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the StopCanary operation.
///
///
/// Container for the necessary parameters to execute the StopCanary operation on AmazonSyntheticsClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndStopCanary
/// operation.
/// REST API Reference for StopCanary Operation
public virtual IAsyncResult BeginStopCanary(StopCanaryRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = StopCanaryRequestMarshaller.Instance;
options.ResponseUnmarshaller = StopCanaryResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the StopCanary operation.
///
///
/// The IAsyncResult returned by the call to BeginStopCanary.
///
/// Returns a StopCanaryResult from Synthetics.
/// REST API Reference for StopCanary Operation
public virtual StopCanaryResponse EndStopCanary(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#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.
///
/// 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
public virtual TagResourceResponse TagResource(TagResourceRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = TagResourceRequestMarshaller.Instance;
options.ResponseUnmarshaller = TagResourceResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the TagResource operation.
///
///
/// Container for the necessary parameters to execute the TagResource operation on AmazonSyntheticsClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndTagResource
/// operation.
/// REST API Reference for TagResource Operation
public virtual IAsyncResult BeginTagResource(TagResourceRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = TagResourceRequestMarshaller.Instance;
options.ResponseUnmarshaller = TagResourceResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the TagResource operation.
///
///
/// The IAsyncResult returned by the call to BeginTagResource.
///
/// Returns a TagResourceResult from Synthetics.
/// REST API Reference for TagResource Operation
public virtual TagResourceResponse EndTagResource(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#endregion
#region UntagResource
///
/// Removes one or more tags from the specified resource.
///
/// Container for the necessary parameters to execute the UntagResource service method.
///
/// 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
public virtual UntagResourceResponse UntagResource(UntagResourceRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = UntagResourceRequestMarshaller.Instance;
options.ResponseUnmarshaller = UntagResourceResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the UntagResource operation.
///
///
/// Container for the necessary parameters to execute the UntagResource operation on AmazonSyntheticsClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUntagResource
/// operation.
/// REST API Reference for UntagResource Operation
public virtual IAsyncResult BeginUntagResource(UntagResourceRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = UntagResourceRequestMarshaller.Instance;
options.ResponseUnmarshaller = UntagResourceResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the UntagResource operation.
///
///
/// The IAsyncResult returned by the call to BeginUntagResource.
///
/// Returns a UntagResourceResult from Synthetics.
/// REST API Reference for UntagResource Operation
public virtual UntagResourceResponse EndUntagResource(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#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.
///
/// 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
public virtual UpdateCanaryResponse UpdateCanary(UpdateCanaryRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = UpdateCanaryRequestMarshaller.Instance;
options.ResponseUnmarshaller = UpdateCanaryResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the UpdateCanary operation.
///
///
/// Container for the necessary parameters to execute the UpdateCanary operation on AmazonSyntheticsClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateCanary
/// operation.
/// REST API Reference for UpdateCanary Operation
public virtual IAsyncResult BeginUpdateCanary(UpdateCanaryRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = UpdateCanaryRequestMarshaller.Instance;
options.ResponseUnmarshaller = UpdateCanaryResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the UpdateCanary operation.
///
///
/// The IAsyncResult returned by the call to BeginUpdateCanary.
///
/// Returns a UpdateCanaryResult from Synthetics.
/// REST API Reference for UpdateCanary Operation
public virtual UpdateCanaryResponse EndUpdateCanary(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#endregion
}
}