/* * 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 scheduler-2021-06-30.normal.json service model. */ using System; using System.Collections.Generic; using Amazon.Runtime; using Amazon.Scheduler.Model; namespace Amazon.Scheduler { /// /// Interface for accessing Scheduler /// /// Amazon EventBridge Scheduler is a serverless scheduler that allows you to create, /// run, and manage tasks from one central, managed service. EventBridge Scheduler delivers /// your tasks reliably, with built-in mechanisms that adjust your schedules based on /// the availability of downstream targets. The following reference lists the available /// API actions, and data types for EventBridge Scheduler. /// public partial interface IAmazonScheduler : IAmazonService, IDisposable { #if BCL45 || AWS_ASYNC_ENUMERABLES_API /// /// Paginators for the service /// ISchedulerPaginatorFactory Paginators { get; } #endif #region CreateSchedule /// /// Creates the specified schedule. /// /// Container for the necessary parameters to execute the CreateSchedule service method. /// /// The response from the CreateSchedule service method, as returned by Scheduler. /// /// Updating or deleting the resource can cause an inconsistent state. /// /// /// Unexpected error encountered while processing the request. /// /// /// The request references a resource which does not exist. /// /// /// The request exceeds a service quota. /// /// /// The request was denied due to request throttling. /// /// /// The input fails to satisfy the constraints specified by an AWS service. /// /// REST API Reference for CreateSchedule Operation CreateScheduleResponse CreateSchedule(CreateScheduleRequest request); /// /// Initiates the asynchronous execution of the CreateSchedule operation. /// /// /// Container for the necessary parameters to execute the CreateSchedule operation on AmazonSchedulerClient. /// 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 EndCreateSchedule /// operation. /// REST API Reference for CreateSchedule Operation IAsyncResult BeginCreateSchedule(CreateScheduleRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the CreateSchedule operation. /// /// /// The IAsyncResult returned by the call to BeginCreateSchedule. /// /// Returns a CreateScheduleResult from Scheduler. /// REST API Reference for CreateSchedule Operation CreateScheduleResponse EndCreateSchedule(IAsyncResult asyncResult); #endregion #region CreateScheduleGroup /// /// Creates the specified schedule group. /// /// Container for the necessary parameters to execute the CreateScheduleGroup service method. /// /// The response from the CreateScheduleGroup service method, as returned by Scheduler. /// /// Updating or deleting the resource can cause an inconsistent state. /// /// /// Unexpected error encountered while processing the request. /// /// /// The request exceeds a service quota. /// /// /// The request was denied due to request throttling. /// /// /// The input fails to satisfy the constraints specified by an AWS service. /// /// REST API Reference for CreateScheduleGroup Operation CreateScheduleGroupResponse CreateScheduleGroup(CreateScheduleGroupRequest request); /// /// Initiates the asynchronous execution of the CreateScheduleGroup operation. /// /// /// Container for the necessary parameters to execute the CreateScheduleGroup operation on AmazonSchedulerClient. /// 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 EndCreateScheduleGroup /// operation. /// REST API Reference for CreateScheduleGroup Operation IAsyncResult BeginCreateScheduleGroup(CreateScheduleGroupRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the CreateScheduleGroup operation. /// /// /// The IAsyncResult returned by the call to BeginCreateScheduleGroup. /// /// Returns a CreateScheduleGroupResult from Scheduler. /// REST API Reference for CreateScheduleGroup Operation CreateScheduleGroupResponse EndCreateScheduleGroup(IAsyncResult asyncResult); #endregion #region DeleteSchedule /// /// Deletes the specified schedule. /// /// Container for the necessary parameters to execute the DeleteSchedule service method. /// /// The response from the DeleteSchedule service method, as returned by Scheduler. /// /// Updating or deleting the resource can cause an inconsistent state. /// /// /// Unexpected error encountered while processing the request. /// /// /// The request references a resource which does not exist. /// /// /// The request was denied due to request throttling. /// /// /// The input fails to satisfy the constraints specified by an AWS service. /// /// REST API Reference for DeleteSchedule Operation DeleteScheduleResponse DeleteSchedule(DeleteScheduleRequest request); /// /// Initiates the asynchronous execution of the DeleteSchedule operation. /// /// /// Container for the necessary parameters to execute the DeleteSchedule operation on AmazonSchedulerClient. /// 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 EndDeleteSchedule /// operation. /// REST API Reference for DeleteSchedule Operation IAsyncResult BeginDeleteSchedule(DeleteScheduleRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the DeleteSchedule operation. /// /// /// The IAsyncResult returned by the call to BeginDeleteSchedule. /// /// Returns a DeleteScheduleResult from Scheduler. /// REST API Reference for DeleteSchedule Operation DeleteScheduleResponse EndDeleteSchedule(IAsyncResult asyncResult); #endregion #region DeleteScheduleGroup /// /// Deletes the specified schedule group. Deleting a schedule group results in EventBridge /// Scheduler deleting all schedules associated with the group. When you delete a group, /// it remains in a DELETING state until all of its associated schedules /// are deleted. Schedules associated with the group that are set to run while the schedule /// group is in the process of being deleted might continue to invoke their targets until /// the schedule group and its associated schedules are deleted. /// /// /// /// This operation is eventually consistent. /// /// /// /// Container for the necessary parameters to execute the DeleteScheduleGroup service method. /// /// The response from the DeleteScheduleGroup service method, as returned by Scheduler. /// /// Updating or deleting the resource can cause an inconsistent state. /// /// /// Unexpected error encountered while processing the request. /// /// /// The request references a resource which does not exist. /// /// /// The request was denied due to request throttling. /// /// /// The input fails to satisfy the constraints specified by an AWS service. /// /// REST API Reference for DeleteScheduleGroup Operation DeleteScheduleGroupResponse DeleteScheduleGroup(DeleteScheduleGroupRequest request); /// /// Initiates the asynchronous execution of the DeleteScheduleGroup operation. /// /// /// Container for the necessary parameters to execute the DeleteScheduleGroup operation on AmazonSchedulerClient. /// 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 EndDeleteScheduleGroup /// operation. /// REST API Reference for DeleteScheduleGroup Operation IAsyncResult BeginDeleteScheduleGroup(DeleteScheduleGroupRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the DeleteScheduleGroup operation. /// /// /// The IAsyncResult returned by the call to BeginDeleteScheduleGroup. /// /// Returns a DeleteScheduleGroupResult from Scheduler. /// REST API Reference for DeleteScheduleGroup Operation DeleteScheduleGroupResponse EndDeleteScheduleGroup(IAsyncResult asyncResult); #endregion #region GetSchedule /// /// Retrieves the specified schedule. /// /// Container for the necessary parameters to execute the GetSchedule service method. /// /// The response from the GetSchedule service method, as returned by Scheduler. /// /// Unexpected error encountered while processing the request. /// /// /// The request references a resource which does not exist. /// /// /// The request was denied due to request throttling. /// /// /// The input fails to satisfy the constraints specified by an AWS service. /// /// REST API Reference for GetSchedule Operation GetScheduleResponse GetSchedule(GetScheduleRequest request); /// /// Initiates the asynchronous execution of the GetSchedule operation. /// /// /// Container for the necessary parameters to execute the GetSchedule operation on AmazonSchedulerClient. /// 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 EndGetSchedule /// operation. /// REST API Reference for GetSchedule Operation IAsyncResult BeginGetSchedule(GetScheduleRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the GetSchedule operation. /// /// /// The IAsyncResult returned by the call to BeginGetSchedule. /// /// Returns a GetScheduleResult from Scheduler. /// REST API Reference for GetSchedule Operation GetScheduleResponse EndGetSchedule(IAsyncResult asyncResult); #endregion #region GetScheduleGroup /// /// Retrieves the specified schedule group. /// /// Container for the necessary parameters to execute the GetScheduleGroup service method. /// /// The response from the GetScheduleGroup service method, as returned by Scheduler. /// /// Unexpected error encountered while processing the request. /// /// /// The request references a resource which does not exist. /// /// /// The request was denied due to request throttling. /// /// /// The input fails to satisfy the constraints specified by an AWS service. /// /// REST API Reference for GetScheduleGroup Operation GetScheduleGroupResponse GetScheduleGroup(GetScheduleGroupRequest request); /// /// Initiates the asynchronous execution of the GetScheduleGroup operation. /// /// /// Container for the necessary parameters to execute the GetScheduleGroup operation on AmazonSchedulerClient. /// 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 EndGetScheduleGroup /// operation. /// REST API Reference for GetScheduleGroup Operation IAsyncResult BeginGetScheduleGroup(GetScheduleGroupRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the GetScheduleGroup operation. /// /// /// The IAsyncResult returned by the call to BeginGetScheduleGroup. /// /// Returns a GetScheduleGroupResult from Scheduler. /// REST API Reference for GetScheduleGroup Operation GetScheduleGroupResponse EndGetScheduleGroup(IAsyncResult asyncResult); #endregion #region ListScheduleGroups /// /// Returns a paginated list of your schedule groups. /// /// Container for the necessary parameters to execute the ListScheduleGroups service method. /// /// The response from the ListScheduleGroups service method, as returned by Scheduler. /// /// Unexpected error encountered while processing the request. /// /// /// The request was denied due to request throttling. /// /// /// The input fails to satisfy the constraints specified by an AWS service. /// /// REST API Reference for ListScheduleGroups Operation ListScheduleGroupsResponse ListScheduleGroups(ListScheduleGroupsRequest request); /// /// Initiates the asynchronous execution of the ListScheduleGroups operation. /// /// /// Container for the necessary parameters to execute the ListScheduleGroups operation on AmazonSchedulerClient. /// 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 EndListScheduleGroups /// operation. /// REST API Reference for ListScheduleGroups Operation IAsyncResult BeginListScheduleGroups(ListScheduleGroupsRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the ListScheduleGroups operation. /// /// /// The IAsyncResult returned by the call to BeginListScheduleGroups. /// /// Returns a ListScheduleGroupsResult from Scheduler. /// REST API Reference for ListScheduleGroups Operation ListScheduleGroupsResponse EndListScheduleGroups(IAsyncResult asyncResult); #endregion #region ListSchedules /// /// Returns a paginated list of your EventBridge Scheduler schedules. /// /// Container for the necessary parameters to execute the ListSchedules service method. /// /// The response from the ListSchedules service method, as returned by Scheduler. /// /// Unexpected error encountered while processing the request. /// /// /// The request references a resource which does not exist. /// /// /// The request was denied due to request throttling. /// /// /// The input fails to satisfy the constraints specified by an AWS service. /// /// REST API Reference for ListSchedules Operation ListSchedulesResponse ListSchedules(ListSchedulesRequest request); /// /// Initiates the asynchronous execution of the ListSchedules operation. /// /// /// Container for the necessary parameters to execute the ListSchedules operation on AmazonSchedulerClient. /// 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 EndListSchedules /// operation. /// REST API Reference for ListSchedules Operation IAsyncResult BeginListSchedules(ListSchedulesRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the ListSchedules operation. /// /// /// The IAsyncResult returned by the call to BeginListSchedules. /// /// Returns a ListSchedulesResult from Scheduler. /// REST API Reference for ListSchedules Operation ListSchedulesResponse EndListSchedules(IAsyncResult asyncResult); #endregion #region ListTagsForResource /// /// Lists the tags associated with the Scheduler resource. /// /// Container for the necessary parameters to execute the ListTagsForResource service method. /// /// The response from the ListTagsForResource service method, as returned by Scheduler. /// /// Unexpected error encountered while processing the request. /// /// /// The request references a resource which does not exist. /// /// /// The request was denied due to request throttling. /// /// /// The input fails to satisfy the constraints specified by an AWS service. /// /// REST API Reference for ListTagsForResource Operation ListTagsForResourceResponse ListTagsForResource(ListTagsForResourceRequest request); /// /// Initiates the asynchronous execution of the ListTagsForResource operation. /// /// /// Container for the necessary parameters to execute the ListTagsForResource operation on AmazonSchedulerClient. /// 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 IAsyncResult BeginListTagsForResource(ListTagsForResourceRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the ListTagsForResource operation. /// /// /// The IAsyncResult returned by the call to BeginListTagsForResource. /// /// Returns a ListTagsForResourceResult from Scheduler. /// REST API Reference for ListTagsForResource Operation ListTagsForResourceResponse EndListTagsForResource(IAsyncResult asyncResult); #endregion #region TagResource /// /// Assigns one or more tags (key-value pairs) to the specified EventBridge Scheduler /// resource. You can only assign tags to schedule groups. /// /// Container for the necessary parameters to execute the TagResource service method. /// /// The response from the TagResource service method, as returned by Scheduler. /// /// Updating or deleting the resource can cause an inconsistent state. /// /// /// Unexpected error encountered while processing the request. /// /// /// The request references a resource which does not exist. /// /// /// The request was denied due to request throttling. /// /// /// The input fails to satisfy the constraints specified by an AWS service. /// /// REST API Reference for TagResource Operation TagResourceResponse TagResource(TagResourceRequest request); /// /// Initiates the asynchronous execution of the TagResource operation. /// /// /// Container for the necessary parameters to execute the TagResource operation on AmazonSchedulerClient. /// 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 IAsyncResult BeginTagResource(TagResourceRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the TagResource operation. /// /// /// The IAsyncResult returned by the call to BeginTagResource. /// /// Returns a TagResourceResult from Scheduler. /// REST API Reference for TagResource Operation TagResourceResponse EndTagResource(IAsyncResult asyncResult); #endregion #region UntagResource /// /// Removes one or more tags from the specified EventBridge Scheduler schedule group. /// /// Container for the necessary parameters to execute the UntagResource service method. /// /// The response from the UntagResource service method, as returned by Scheduler. /// /// Updating or deleting the resource can cause an inconsistent state. /// /// /// Unexpected error encountered while processing the request. /// /// /// The request references a resource which does not exist. /// /// /// The request was denied due to request throttling. /// /// /// The input fails to satisfy the constraints specified by an AWS service. /// /// REST API Reference for UntagResource Operation UntagResourceResponse UntagResource(UntagResourceRequest request); /// /// Initiates the asynchronous execution of the UntagResource operation. /// /// /// Container for the necessary parameters to execute the UntagResource operation on AmazonSchedulerClient. /// 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 IAsyncResult BeginUntagResource(UntagResourceRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the UntagResource operation. /// /// /// The IAsyncResult returned by the call to BeginUntagResource. /// /// Returns a UntagResourceResult from Scheduler. /// REST API Reference for UntagResource Operation UntagResourceResponse EndUntagResource(IAsyncResult asyncResult); #endregion #region UpdateSchedule /// /// Updates the specified schedule. When you call UpdateSchedule, EventBridge /// Scheduler uses all values, including empty values, specified in the request and overrides /// the existing schedule. This is by design. This means that if you do not set an optional /// field in your request, that field will be set to its system-default value after the /// update. /// /// /// /// Before calling this operation, we recommend that you call the GetSchedule /// API operation and make a note of all optional parameters for your UpdateSchedule /// call. /// /// /// Container for the necessary parameters to execute the UpdateSchedule service method. /// /// The response from the UpdateSchedule service method, as returned by Scheduler. /// /// Updating or deleting the resource can cause an inconsistent state. /// /// /// Unexpected error encountered while processing the request. /// /// /// The request references a resource which does not exist. /// /// /// The request was denied due to request throttling. /// /// /// The input fails to satisfy the constraints specified by an AWS service. /// /// REST API Reference for UpdateSchedule Operation UpdateScheduleResponse UpdateSchedule(UpdateScheduleRequest request); /// /// Initiates the asynchronous execution of the UpdateSchedule operation. /// /// /// Container for the necessary parameters to execute the UpdateSchedule operation on AmazonSchedulerClient. /// 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 EndUpdateSchedule /// operation. /// REST API Reference for UpdateSchedule Operation IAsyncResult BeginUpdateSchedule(UpdateScheduleRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the UpdateSchedule operation. /// /// /// The IAsyncResult returned by the call to BeginUpdateSchedule. /// /// Returns a UpdateScheduleResult from Scheduler. /// REST API Reference for UpdateSchedule Operation UpdateScheduleResponse EndUpdateSchedule(IAsyncResult asyncResult); #endregion } }