();
var paginateSchedules = schedulerClient.Paginators.ListSchedules(
new ListSchedulesRequest());
Console.WriteLine(
$"Hello AWS Scheduler! Let's list schedules in your account.");
// Get the entire list using the paginator.
await foreach (var schedule in paginateSchedules.Schedules)
{
results.Add(schedule);
}
Console.WriteLine($"\tTotal of {results.Count} schedule(s) available.");
results.ForEach(s => Console.WriteLine($"\tSchedule: {s.Name}"));
}
}
```
+ 如需 API 詳細資訊，請參閱《適用於 .NET 的 AWS SDK API 參考》**中的 [ListSchedules](https://docs.aws.amazon.com/goto/DotNetSDKV3/scheduler-2021-06-30/ListSchedules)。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/scheduler#code-examples)中設定和執行。
```
import software.amazon.awssdk.services.scheduler.SchedulerAsyncClient;
import software.amazon.awssdk.services.scheduler.model.ListSchedulesRequest;
import software.amazon.awssdk.services.scheduler.model.ScheduleSummary;
import software.amazon.awssdk.services.scheduler.paginators.ListSchedulesPublisher;
import java.util.ArrayList;
import java.util.List;
import java.util.concurrent.CompletableFuture;
public class HelloScheduler {
public static void main(String [] args) {
listSchedulesAsync();
}
/**
* Lists all the schedules available.
*
* This method uses the {@link SchedulerAsyncClient} to make an asynchronous request to
* list all the schedules available. The method uses the {@link ListSchedulesPublisher}
* to fetch the schedules in a paginated manner, and then processes the responses
* asynchronously.
*/
public static void listSchedulesAsync() {
SchedulerAsyncClient schedulerAsyncClient = SchedulerAsyncClient.create();
// Build the request to list schedules
ListSchedulesRequest listSchedulesRequest = ListSchedulesRequest.builder().build();
// Use the paginator to fetch all schedules asynchronously.
ListSchedulesPublisher paginator = schedulerAsyncClient.listSchedulesPaginator(listSchedulesRequest);
List results = new ArrayList<>();
// Subscribe to the paginator to process the response asynchronously
CompletableFuture future = paginator.subscribe(response -> {
response.schedules().forEach(schedule -> {
results.add(schedule);
System.out.printf("Schedule: %s%n", schedule.name());
});
});
// Wait for the asynchronous operation to complete.
future.join();
// After all schedules are fetched, print the total count.
System.out.printf("Total of %d schedule(s) available.%n", results.size());
}
}
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Java 2.x API 參考》**中的 [ListSchedules](https://docs.aws.amazon.com/goto/SdkForJavaV2/scheduler-2021-06-30/ListSchedules)。
------
#### [ Python ]
**適用於 Python 的 SDK (Boto3)**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/scheduler#code-examples)中設定和執行。
```
import boto3
def hello_scheduler(scheduler_client):
"""
Use the AWS SDK for Python (Boto3) to create an Amazon EventBridge Scheduler
client and list the schedules in your account.
This example uses the default settings specified in your shared credentials
and config files.
:param scheduler_client: A Boto3 Amazon EventBridge Scheduler Client object. This object wraps
the low-level Amazon EventBridge Scheduler service API.
"""
print("Hello, Amazon EventBridge Scheduler! Let's list some of your schedules:\n")
paginator = scheduler_client.get_paginator("list_schedules")
page_iterator = paginator.paginate(PaginationConfig={"MaxItems": 10})
schedule_names: [str] = []
for page in page_iterator:
for schedule in page["Schedules"]:
schedule_names.append(schedule["Name"])
print(f"{len(schedule_names)} schedule(s) retrieved.")
for schedule_name in schedule_names:
print(f"\t{schedule_name}")
if __name__ == "__main__":
hello_scheduler(boto3.client("scheduler"))
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Python (Boto3) API 參考》**中的 [ListSchedules](https://docs.aws.amazon.com/goto/boto3/scheduler-2021-06-30/ListSchedules)。
------
# 使用 AWS SDKs的 EventBridge 排程器動作
下列程式碼範例示範如何使用 AWS SDKs 執行個別 EventBridge 排程器動作。每個範例均包含 GitHub 的連結，您可以在連結中找到設定和執行程式碼的相關說明。
這些摘錄會呼叫 EventBridge 排程器 API，是必須在內容中執行之大型程式的程式碼摘錄。您可以在 [使用 AWS SDKs EventBridge 排程器案例](scheduler_code_examples_scenarios.md) 中查看內容中的動作。
下列範例僅包含最常使用的動作。如需完整清單，請參閱《[Amazon EventBridge 排程器 API 參考](https://docs.aws.amazon.com/scheduler/latest/apireference/Welcome.html)》。
**Topics**
+ [`CreateSchedule`](scheduler_example_scheduler_CreateSchedule_section.md)
+ [`CreateScheduleGroup`](scheduler_example_scheduler_CreateScheduleGroup_section.md)
+ [`DeleteSchedule`](scheduler_example_scheduler_DeleteSchedule_section.md)
+ [`DeleteScheduleGroup`](scheduler_example_scheduler_DeleteScheduleGroup_section.md)
# `CreateSchedule` 搭配 AWS SDK 使用
下列程式碼範例示範如何使用 `CreateSchedule`。
動作範例是大型程式的程式碼摘錄，必須在內容中執行。您可以在下列程式碼範例的內容中看到此動作：
+ [排程事件](scheduler_example_scheduler_ScheduledEventsScenario_section.md)
------
#### [ .NET ]
**適用於 .NET 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/EventBridge Scheduler#code-examples)中設定和執行。
```
///
/// Creates a new schedule in Amazon EventBridge Scheduler.
///
/// The name of the schedule.
/// The schedule expression that defines when the schedule should run.
/// The name of the schedule group to which the schedule should be added.
/// Indicates whether to delete the schedule after completion.
/// Indicates whether to use a flexible time window for the schedule.
/// ARN of the event target.
/// Execution Role ARN.
/// True if the schedule was created successfully, false otherwise.
public async Task CreateScheduleAsync(
string name,
string scheduleExpression,
string scheduleGroupName,
string targetArn,
string roleArn,
string input,
bool deleteAfterCompletion = false,
bool useFlexibleTimeWindow = false)
{
try
{
int hoursToRun = 1;
int flexibleTimeWindowMinutes = 10;
var request = new CreateScheduleRequest
{
Name = name,
ScheduleExpression = scheduleExpression,
GroupName = scheduleGroupName,
Target = new Target { Arn = targetArn, RoleArn = roleArn, Input = input },
ActionAfterCompletion = deleteAfterCompletion
? ActionAfterCompletion.DELETE
: ActionAfterCompletion.NONE,
StartDate = DateTime.UtcNow, // Ignored for one-time schedules.
EndDate =
DateTime.UtcNow
.AddHours(hoursToRun) // Ignored for one-time schedules.
};
// Allow a flexible time window if the caller specifies it.
request.FlexibleTimeWindow = new FlexibleTimeWindow
{
Mode = useFlexibleTimeWindow
? FlexibleTimeWindowMode.FLEXIBLE
: FlexibleTimeWindowMode.OFF,
MaximumWindowInMinutes = useFlexibleTimeWindow
? flexibleTimeWindowMinutes
: null
};
var response = await _amazonScheduler.CreateScheduleAsync(request);
Console.WriteLine($"Successfully created schedule '{name}' " +
$"in schedule group '{scheduleGroupName}': {response.ScheduleArn}.");
return true;
}
catch (ConflictException ex)
{
// If the name is not unique, a ConflictException will be thrown.
_logger.LogError($"Failed to create schedule '{name}' due to a conflict. {ex.Message}");
return false;
}
catch (Exception ex)
{
_logger.LogError($"An error occurred while creating schedule '{name}' " +
$"in schedule group '{scheduleGroupName}': {ex.Message}");
return false;
}
}
```
+ 如需 API 詳細資訊，請參閱《*適用於 .NET 的 AWS SDK API 參考*》中的 [CreateSchedule](https://docs.aws.amazon.com/goto/DotNetSDKV3/scheduler-2021-06-30/CreateSchedule)。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/scheduler#code-examples)中設定和執行。
```
/**
* Creates a new schedule for a target task.
*
* @param name the name of the schedule
* @param scheduleExpression The schedule expression that defines when the schedule should run.
* @param scheduleGroupName the name of the schedule group to which the schedule belongs
* @param targetArn the Amazon Resource Name (ARN) of the target task
* @param roleArn the ARN of the IAM role to be used for the schedule
* @param input the input data for the target task
* @param deleteAfterCompletion whether to delete the schedule after it's executed
* @param useFlexibleTimeWindow whether to use a flexible time window for the schedule execution
* @return true if the schedule was successfully created, false otherwise
*/
public CompletableFuture createScheduleAsync(
String name,
String scheduleExpression,
String scheduleGroupName,
String targetArn,
String roleArn,
String input,
boolean deleteAfterCompletion,
boolean useFlexibleTimeWindow) {
int hoursToRun = 1;
int flexibleTimeWindowMinutes = 10;
Target target = Target.builder()
.arn(targetArn)
.roleArn(roleArn)
.input(input)
.build();
FlexibleTimeWindow flexibleTimeWindow = FlexibleTimeWindow.builder()
.mode(useFlexibleTimeWindow
? FlexibleTimeWindowMode.FLEXIBLE
: FlexibleTimeWindowMode.OFF)
.maximumWindowInMinutes(useFlexibleTimeWindow
? flexibleTimeWindowMinutes
: null)
.build();
Instant startDate = Instant.now();
Instant endDate = startDate.plus(Duration.ofHours(hoursToRun));
CreateScheduleRequest request = CreateScheduleRequest.builder()
.name(name)
.scheduleExpression(scheduleExpression)
.groupName(scheduleGroupName)
.target(target)
.actionAfterCompletion(deleteAfterCompletion
? ActionAfterCompletion.DELETE
: ActionAfterCompletion.NONE)
.startDate(startDate)
.endDate(endDate)
.flexibleTimeWindow(flexibleTimeWindow)
.build();
return getAsyncClient().createSchedule(request)
.thenApply(response -> {
logger.info("Successfully created schedule {} in schedule group {}, The ARN is {} ", name, scheduleGroupName, response.scheduleArn());
return true;
})
.whenComplete((result, ex) -> {
if (ex != null) {
if (ex instanceof ConflictException) {
// Handle ConflictException
logger.error("A conflict exception occurred while creating the schedule: {}", ex.getMessage());
throw new CompletionException("A conflict exception occurred while creating the schedule: " + ex.getMessage(), ex);
} else {
throw new CompletionException("Error creating schedule: " + ex.getMessage(), ex);
}
}
});
}
```
+ 如需 API 詳細資訊，請參閱《*AWS SDK for Java 2.x API 參考*》中的 [CreateSchedule](https://docs.aws.amazon.com/goto/SdkForJavaV2/scheduler-2021-06-30/CreateSchedule)。
------
#### [ Python ]
**適用於 Python 的 SDK (Boto3)**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/scheduler#code-examples)中設定和執行。
```
class SchedulerWrapper:
def __init__(self, eventbridge_scheduler_client: client):
self.scheduler_client = eventbridge_scheduler_client
@classmethod
def from_client(cls) -> "SchedulerWrapper":
"""
Creates a SchedulerWrapper instance with a default EventBridge Scheduler client.
:return: An instance of SchedulerWrapper initialized with the default EventBridge Scheduler client.
"""
eventbridge_scheduler_client = boto3.client("scheduler")
return cls(eventbridge_scheduler_client)
def create_schedule(
self,
name: str,
schedule_expression: str,
schedule_group_name: str,
target_arn: str,
role_arn: str,
input: str,
delete_after_completion: bool = False,
use_flexible_time_window: bool = False,
) -> str:
"""
Creates a new schedule with the specified parameters.
:param name: The name of the schedule.
:param schedule_expression: The expression that defines when the schedule runs.
:param schedule_group_name: The name of the schedule group.
:param target_arn: The Amazon Resource Name (ARN) of the target.
:param role_arn: The Amazon Resource Name (ARN) of the execution IAM role.
:param input: The input for the target.
:param delete_after_completion: Whether to delete the schedule after it completes.
:param use_flexible_time_window: Whether to use a flexible time window.
:return The ARN of the created schedule.
"""
try:
hours_to_run = 1
flexible_time_window_minutes = 10
parameters = {
"Name": name,
"ScheduleExpression": schedule_expression,
"GroupName": schedule_group_name,
"Target": {"Arn": target_arn, "RoleArn": role_arn, "Input": input},
"StartDate": datetime.now(timezone.utc),
"EndDate": datetime.now(timezone.utc) + timedelta(hours=hours_to_run),
}
if delete_after_completion:
parameters["ActionAfterCompletion"] = "DELETE"
if use_flexible_time_window:
parameters["FlexibleTimeWindow"] = {
"Mode": "FLEXIBLE",
"MaximumWindowInMinutes": flexible_time_window_minutes,
}
else:
parameters["FlexibleTimeWindow"] = {"Mode": "OFF"}
response = self.scheduler_client.create_schedule(**parameters)
return response["ScheduleArn"]
except ClientError as err:
if err.response["Error"]["Code"] == "ConflictException":
logger.error(
"Failed to create schedule '%s' due to a conflict. %s",
name,
err.response["Error"]["Message"],
)
else:
logger.error(
"Error creating schedule: %s", err.response["Error"]["Message"]
)
raise
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Python (Boto3) API 參考》**中的 [CreateSchedule](https://docs.aws.amazon.com/goto/boto3/scheduler-2021-06-30/CreateSchedule)。
------
#### [ SAP ABAP ]
**適用於 SAP ABAP 的開發套件**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/scd#code-examples)中設定和執行。
```
TRY.
" Constants for time calculations
DATA lv_start_date TYPE /aws1/scdstartdate.
DATA lv_end_date TYPE /aws1/scdenddate.
DATA lv_start_timestamp TYPE timestamp.
DATA lv_end_timestamp TYPE timestamp.
DATA lv_hours_to_run TYPE i VALUE 1.
" Get current timestamp
GET TIME STAMP FIELD lv_start_timestamp.
" Add 1 hour to the current timestamp using CL_ABAP_TSTMP
lv_end_timestamp = cl_abap_tstmp=>add(
tstmp = lv_start_timestamp
secs = lv_hours_to_run * 3600 ).
" Convert timestamps to decimal format for AWS API
lv_start_date = lv_start_timestamp.
lv_end_date = lv_end_timestamp.
" Prepare flexible time window configuration
DATA lo_flexible_time_window TYPE REF TO /aws1/cl_scdflexibletimewindow.
IF iv_use_flexible_time_win = abap_true.
" iv_use_flexible_time_win = ABAP_TRUE
" Example: Set MaximumWindowInMinutes to 10 for flexible window
lo_flexible_time_window = NEW /aws1/cl_scdflexibletimewindow(
iv_mode = 'FLEXIBLE'
iv_maximumwindowinminutes = 10 ).
ELSE.
lo_flexible_time_window = NEW /aws1/cl_scdflexibletimewindow(
iv_mode = 'OFF' ).
ENDIF.
" Prepare target configuration
" Example iv_target_arn = 'arn:aws:sqs:us-east-1:123456789012:my-queue'
" Example iv_role_arn = 'arn:aws:iam::123456789012:role/SchedulerRole'
" Example iv_input = '{"message": "Hello from EventBridge Scheduler"}'
DATA(lo_target) = NEW /aws1/cl_scdtarget(
iv_arn = iv_target_arn
iv_rolearn = iv_role_arn
iv_input = iv_input ).
" Set action after completion if needed
DATA lv_action_after_completion TYPE /aws1/scdactionaftercompletion.
IF iv_delete_after_completion = abap_true.
" iv_delete_after_completion = ABAP_TRUE
lv_action_after_completion = 'DELETE'.
ELSE.
lv_action_after_completion = 'NONE'.
ENDIF.
" Create the schedule
" Example iv_name = 'my-schedule'
" Example iv_schedule_expression = 'rate(15 minutes)'
" Example iv_schedule_group_name = 'my-schedule-group'
DATA(lo_result) = lo_scd->createschedule(
iv_name = iv_name
iv_scheduleexpression = iv_schedule_expression
iv_groupname = iv_schedule_group_name
io_target = lo_target
io_flexibletimewindow = lo_flexible_time_window
iv_startdate = lv_start_date
iv_enddate = lv_end_date
iv_actionaftercompletion = lv_action_after_completion ).
ov_schedule_arn = lo_result->get_schedulearn( ).
MESSAGE 'Schedule created successfully.' TYPE 'I'.
CATCH /aws1/cx_scdconflictexception INTO DATA(lo_conflict_ex).
DATA(lv_error) = |Conflict creating schedule: { lo_conflict_ex->if_message~get_text( ) }|.
MESSAGE lv_error TYPE 'I'.
CATCH /aws1/cx_rt_generic INTO DATA(lo_generic_ex).
DATA(lv_generic_error) = |Error creating schedule: { lo_generic_ex->if_message~get_text( ) }|.
MESSAGE lv_generic_error TYPE 'I'.
ENDTRY.
```
+ 如需 API 詳細資訊，請參閱《適用於 *AWS SAP ABAP 的 SDK API 參考*》中的 [CreateSchedule](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)。
------
# `CreateScheduleGroup` 搭配 AWS SDK 使用
下列程式碼範例示範如何使用 `CreateScheduleGroup`。
動作範例是大型程式的程式碼摘錄，必須在內容中執行。您可以在下列程式碼範例的內容中看到此動作：
+ [排程事件](scheduler_example_scheduler_ScheduledEventsScenario_section.md)
------
#### [ .NET ]
**適用於 .NET 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/EventBridge Scheduler#code-examples)中設定和執行。
```
///
/// Creates a new schedule group in Amazon EventBridge Scheduler.
///
/// The name of the schedule group.
/// True if the schedule group was created successfully, false otherwise.
public async Task CreateScheduleGroupAsync(string name)
{
try
{
var request = new CreateScheduleGroupRequest { Name = name };
var response = await _amazonScheduler.CreateScheduleGroupAsync(request);
Console.WriteLine($"Successfully created schedule group '{name}': {response.ScheduleGroupArn}.");
return true;
}
catch (ConflictException ex)
{
// If the name is not unique, a ConflictException will be thrown.
_logger.LogError($"Failed to create schedule group '{name}' due to a conflict. {ex.Message}");
return false;
}
catch (Exception ex)
{
_logger.LogError(
$"An error occurred while creating schedule group '{name}': {ex.Message}");
return false;
}
}
```
+ 如需 API 詳細資訊，請參閱《*適用於 .NET 的 AWS SDK API 參考*》中的 [CreateScheduleGroup](https://docs.aws.amazon.com/goto/DotNetSDKV3/scheduler-2021-06-30/CreateScheduleGroup)。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/scheduler#code-examples)中設定和執行。
```
/**
* Creates a new schedule group.
*
* @param name the name of the schedule group to be created
* @return a {@link CompletableFuture} representing the asynchronous operation of creating the schedule group
*/
public CompletableFuture createScheduleGroup(String name) {
CreateScheduleGroupRequest request = CreateScheduleGroupRequest.builder()
.name(name)
.build();
logger.info("Initiating createScheduleGroup call for group: {}", name);
CompletableFuture futureResponse = getAsyncClient().createScheduleGroup(request);
futureResponse.whenComplete((response, ex) -> {
if (ex != null) {
if (ex instanceof CompletionException && ex.getCause() instanceof ConflictException) {
// Rethrow the ConflictException
throw (ConflictException) ex.getCause();
} else {
throw new CompletionException("Failed to create schedule group: " + name, ex);
}
} else if (response == null) {
throw new RuntimeException("Failed to create schedule group: response was null");
} else {
logger.info("Successfully created schedule group '{}': {}", name, response.scheduleGroupArn());
}
});
return futureResponse;
}
```
+ 如需 API 詳細資訊，請參閱《*AWS SDK for Java 2.x API 參考*》中的 [CreateScheduleGroup](https://docs.aws.amazon.com/goto/SdkForJavaV2/scheduler-2021-06-30/CreateScheduleGroup)。
------
#### [ Python ]
**適用於 Python 的 SDK (Boto3)**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/scheduler#code-examples)中設定和執行。
```
class SchedulerWrapper:
def __init__(self, eventbridge_scheduler_client: client):
self.scheduler_client = eventbridge_scheduler_client
@classmethod
def from_client(cls) -> "SchedulerWrapper":
"""
Creates a SchedulerWrapper instance with a default EventBridge Scheduler client.
:return: An instance of SchedulerWrapper initialized with the default EventBridge Scheduler client.
"""
eventbridge_scheduler_client = boto3.client("scheduler")
return cls(eventbridge_scheduler_client)
def create_schedule_group(self, name: str) -> str:
"""
Creates a new schedule group with the specified name and description.
:param name: The name of the schedule group.
:param description: The description of the schedule group.
:return: The ARN of the created schedule group.
"""
try:
response = self.scheduler_client.create_schedule_group(Name=name)
return response["ScheduleGroupArn"]
except ClientError as err:
if err.response["Error"]["Code"] == "ConflictException":
logger.error(
"Failed to create schedule group '%s' due to a conflict. %s",
name,
err.response["Error"]["Message"],
)
else:
logger.error(
"Error creating schedule group: %s",
err.response["Error"]["Message"],
)
raise
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Python (Boto3) API 參考》**中的 [CreateScheduleGroup](https://docs.aws.amazon.com/goto/boto3/scheduler-2021-06-30/CreateScheduleGroup)。
------
#### [ SAP ABAP ]
**適用於 SAP ABAP 的開發套件**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/scd#code-examples)中設定和執行。
```
TRY.
" Example iv_name = 'my-schedule-group'
DATA(lo_result) = lo_scd->createschedulegroup(
iv_name = iv_name ).
ov_schedule_group_arn = lo_result->get_schedulegrouparn( ).
MESSAGE 'Schedule group created successfully.' TYPE 'I'.
CATCH /aws1/cx_scdconflictexception INTO DATA(lo_conflict_ex).
DATA(lv_error) = |Conflict creating schedule group: { lo_conflict_ex->if_message~get_text( ) }|.
MESSAGE lv_error TYPE 'I'.
CATCH /aws1/cx_rt_generic INTO DATA(lo_generic_ex).
DATA(lv_generic_error) = |Error creating schedule group: { lo_generic_ex->if_message~get_text( ) }|.
MESSAGE lv_generic_error TYPE 'I'.
ENDTRY.
```
+ 如需 API 詳細資訊，請參閱《適用於 *AWS SAP ABAP 的 SDK API 參考*》中的 [CreateScheduleGroup](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)。
------
# `DeleteSchedule` 搭配 AWS SDK 使用
下列程式碼範例示範如何使用 `DeleteSchedule`。
動作範例是大型程式的程式碼摘錄，必須在內容中執行。您可以在下列程式碼範例的內容中看到此動作：
+ [排程事件](scheduler_example_scheduler_ScheduledEventsScenario_section.md)
------
#### [ .NET ]
**適用於 .NET 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/EventBridge Scheduler#code-examples)中設定和執行。
```
///
/// Deletes an existing schedule from Amazon EventBridge Scheduler.
///
/// The name of the schedule to delete.
/// The group name of the schedule to delete.
/// True if the schedule was deleted successfully, false otherwise.
public async Task DeleteScheduleAsync(string name, string groupName)
{
try
{
var request = new DeleteScheduleRequest
{
Name = name,
GroupName = groupName
};
await _amazonScheduler.DeleteScheduleAsync(request);
Console.WriteLine($"Successfully deleted schedule with name '{name}'.");
return true;
}
catch (ResourceNotFoundException ex)
{
_logger.LogError(
$"Failed to delete schedule with ID '{name}' because the resource was not found: {ex.Message}");
return true;
}
catch (Exception ex)
{
_logger.LogError(
$"An error occurred while deleting schedule with ID '{name}': {ex.Message}");
return false;
}
}
```
+ 如需 API 詳細資訊，請參閱《*適用於 .NET 的 AWS SDK API 參考*》中的 [DeleteSchedule](https://docs.aws.amazon.com/goto/DotNetSDKV3/scheduler-2021-06-30/DeleteSchedule)。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/scheduler#code-examples)中設定和執行。
```
/**
* Deletes a schedule with the specified name and group name.
*
* @param name the name of the schedule to be deleted
* @param groupName the group name of the schedule to be deleted
* @return a {@link CompletableFuture} that, when completed, indicates whether the schedule was successfully deleted
* @throws CompletionException if an error occurs while deleting the schedule, except for the case where the schedule is not found
*/
public CompletableFuture deleteScheduleAsync(String name, String groupName) {
DeleteScheduleRequest request = DeleteScheduleRequest.builder()
.name(name)
.groupName(groupName)
.build();
CompletableFuture response = getAsyncClient().deleteSchedule(request);
return response.handle((result, ex) -> {
if (ex != null) {
if (ex instanceof ResourceNotFoundException) {
throw new CompletionException("Resource not found while deleting schedule with ID: " + name, ex);
} else {
throw new CompletionException("Failed to delete schedule.", ex);
}
}
logger.info("Successfully deleted schedule with name {}.", name);
return true;
});
}
```
+ 如需 API 詳細資訊，請參閱《*AWS SDK for Java 2.x API 參考*》中的 [DeleteSchedule](https://docs.aws.amazon.com/goto/SdkForJavaV2/scheduler-2021-06-30/DeleteSchedule)。
------
#### [ Python ]
**適用於 Python 的 SDK (Boto3)**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/scheduler#code-examples)中設定和執行。
```
class SchedulerWrapper:
def __init__(self, eventbridge_scheduler_client: client):
self.scheduler_client = eventbridge_scheduler_client
@classmethod
def from_client(cls) -> "SchedulerWrapper":
"""
Creates a SchedulerWrapper instance with a default EventBridge Scheduler client.
:return: An instance of SchedulerWrapper initialized with the default EventBridge Scheduler client.
"""
eventbridge_scheduler_client = boto3.client("scheduler")
return cls(eventbridge_scheduler_client)
def delete_schedule(self, name: str, schedule_group_name: str) -> None:
"""
Deletes the schedule with the specified name and schedule group.
:param name: The name of the schedule.
:param schedule_group_name: The name of the schedule group.
"""
try:
self.scheduler_client.delete_schedule(
Name=name, GroupName=schedule_group_name
)
except ClientError as err:
if err.response["Error"]["Code"] == "ResourceNotFoundException":
logger.error(
"Failed to delete schedule with ID '%s' because the resource was not found: %s",
name,
err.response["Error"]["Message"],
)
else:
logger.error(
"Error deleting schedule: %s", err.response["Error"]["Message"]
)
raise
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Python (Boto3) API 參考》**中的 [DeleteSchedule](https://docs.aws.amazon.com/goto/boto3/scheduler-2021-06-30/DeleteSchedule)。
------
#### [ SAP ABAP ]
**適用於 SAP ABAP 的開發套件**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/scd#code-examples)中設定和執行。
```
TRY.
" Example iv_name = 'my-schedule'
" Example iv_schedule_group_name = 'my-schedule-group'
lo_scd->deleteschedule(
iv_name = iv_name
iv_groupname = iv_schedule_group_name ).
MESSAGE 'Schedule deleted successfully.' TYPE 'I'.
CATCH /aws1/cx_scdresourcenotfoundex INTO DATA(lo_not_found_ex).
DATA(lv_error) = |Schedule not found: { lo_not_found_ex->if_message~get_text( ) }|.
MESSAGE lv_error TYPE 'I'.
CATCH /aws1/cx_rt_generic INTO DATA(lo_generic_ex).
DATA(lv_generic_error) = |Error deleting schedule: { lo_generic_ex->if_message~get_text( ) }|.
MESSAGE lv_generic_error TYPE 'I'.
ENDTRY.
```
+ 如需 API 詳細資訊，請參閱《適用於 *AWS SAP ABAP 的 SDK API 參考*》中的 [DeleteSchedule](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)。
------
# `DeleteScheduleGroup` 搭配 AWS SDK 使用
下列程式碼範例示範如何使用 `DeleteScheduleGroup`。
------
#### [ .NET ]
**適用於 .NET 的 SDK**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/EventBridge Scheduler#code-examples)中設定和執行。
```
///
/// Deletes an existing schedule group from Amazon EventBridge Scheduler.
///
/// The name of the schedule group to delete.
/// True if the schedule group was deleted successfully, false otherwise.
public async Task DeleteScheduleGroupAsync(string name)
{
try
{
var request = new DeleteScheduleGroupRequest { Name = name };
await _amazonScheduler.DeleteScheduleGroupAsync(request);
Console.WriteLine($"Successfully deleted schedule group '{name}'.");
return true;
}
catch (ResourceNotFoundException ex)
{
_logger.LogError(
$"Failed to delete schedule group '{name}' because the resource was not found: {ex.Message}");
return true;
}
catch (Exception ex)
{
_logger.LogError(
$"An error occurred while deleting schedule group '{name}': {ex.Message}");
return false;
}
}
```
+ 如需 API 詳細資訊，請參閱《*適用於 .NET 的 AWS SDK API 參考*》中的 [DeleteScheduleGroup](https://docs.aws.amazon.com/goto/DotNetSDKV3/scheduler-2021-06-30/DeleteScheduleGroup)。
------
#### [ Java ]
**SDK for Java 2.x**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/scheduler#code-examples)中設定和執行。
```
/**
* Deletes the specified schedule group.
*
* @param name the name of the schedule group to delete
* @return a {@link CompletableFuture} that completes when the schedule group has been deleted
* @throws CompletionException if an error occurs while deleting the schedule group
*/
public CompletableFuture deleteScheduleGroupAsync(String name) {
DeleteScheduleGroupRequest request = DeleteScheduleGroupRequest.builder()
.name(name)
.build();
return getAsyncClient().deleteScheduleGroup(request)
.thenRun(() -> {
logger.info("Successfully deleted schedule group {}", name);
})
.whenComplete((result, ex) -> {
if (ex != null) {
if (ex instanceof ResourceNotFoundException) {
throw new CompletionException("The resource was not found: " + ex.getMessage(), ex);
} else {
throw new CompletionException("Error deleting schedule group: " + ex.getMessage(), ex);
}
}
});
}
```
+ 如需 API 詳細資訊，請參閱《*AWS SDK for Java 2.x API 參考*》中的 [DeleteScheduleGroup](https://docs.aws.amazon.com/goto/SdkForJavaV2/scheduler-2021-06-30/DeleteScheduleGroup)。
------
#### [ Python ]
**適用於 Python 的 SDK (Boto3)**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/scheduler#code-examples)中設定和執行。
```
class SchedulerWrapper:
def __init__(self, eventbridge_scheduler_client: client):
self.scheduler_client = eventbridge_scheduler_client
@classmethod
def from_client(cls) -> "SchedulerWrapper":
"""
Creates a SchedulerWrapper instance with a default EventBridge Scheduler client.
:return: An instance of SchedulerWrapper initialized with the default EventBridge Scheduler client.
"""
eventbridge_scheduler_client = boto3.client("scheduler")
return cls(eventbridge_scheduler_client)
def delete_schedule_group(self, name: str) -> None:
"""
Deletes the schedule group with the specified name.
:param name: The name of the schedule group.
"""
try:
self.scheduler_client.delete_schedule_group(Name=name)
logger.info("Schedule group %s deleted successfully.", name)
except ClientError as err:
if err.response["Error"]["Code"] == "ResourceNotFoundException":
logger.error(
"Failed to delete schedule group with ID '%s' because the resource was not found: %s",
name,
err.response["Error"]["Message"],
)
else:
logger.error(
"Error deleting schedule group: %s",
err.response["Error"]["Message"],
)
raise
```
+ 如需 API 詳細資訊，請參閱《AWS SDK for Python (Boto3) API 參考》**中的 [DeleteScheduleGroup](https://docs.aws.amazon.com/goto/boto3/scheduler-2021-06-30/DeleteScheduleGroup)。
------
#### [ SAP ABAP ]
**適用於 SAP ABAP 的開發套件**
GitHub 上提供更多範例。尋找完整範例，並了解如何在 [AWS 程式碼範例儲存庫](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/scd#code-examples)中設定和執行。
```
TRY.
" Example iv_name = 'my-schedule-group'
lo_scd->deleteschedulegroup(
iv_name = iv_name ).
MESSAGE 'Schedule group deleted successfully.' TYPE 'I'.
CATCH /aws1/cx_scdresourcenotfoundex INTO DATA(lo_not_found_ex).
DATA(lv_error) = |Schedule group not found: { lo_not_found_ex->if_message~get_text( ) }|.
MESSAGE lv_error TYPE 'I'.
CATCH /aws1/cx_rt_generic INTO DATA(lo_generic_ex).
DATA(lv_generic_error) = |Error deleting schedule group: { lo_generic_ex->if_message~get_text( ) }|.
MESSAGE lv_generic_error TYPE 'I'.
ENDTRY.
```
+ 如需 API 詳細資訊，請參閱《適用於 *AWS SAP ABAP 的 SDK API 參考*》中的 [DeleteScheduleGroup](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)。
------