Class: Aws::Scheduler::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::Scheduler::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-scheduler/lib/aws-sdk-scheduler/client.rb
Overview
An API client for Scheduler. To construct a client, you need to configure a :region and :credentials.
client = Aws::Scheduler::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#create_schedule(params = {}) ⇒ Types::CreateScheduleOutput
Creates the specified schedule.
-
#create_schedule_group(params = {}) ⇒ Types::CreateScheduleGroupOutput
Creates the specified schedule group.
-
#delete_schedule(params = {}) ⇒ Struct
Deletes the specified schedule.
-
#delete_schedule_group(params = {}) ⇒ Struct
Deletes the specified schedule group.
-
#get_schedule(params = {}) ⇒ Types::GetScheduleOutput
Retrieves the specified schedule.
-
#get_schedule_group(params = {}) ⇒ Types::GetScheduleGroupOutput
Retrieves the specified schedule group.
-
#list_schedule_groups(params = {}) ⇒ Types::ListScheduleGroupsOutput
Returns a paginated list of your schedule groups.
-
#list_schedules(params = {}) ⇒ Types::ListSchedulesOutput
Returns a paginated list of your EventBridge Scheduler schedules.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceOutput
Lists the tags associated with the Scheduler resource.
-
#tag_resource(params = {}) ⇒ Struct
Assigns one or more tags (key-value pairs) to the specified EventBridge Scheduler resource.
-
#untag_resource(params = {}) ⇒ Struct
Removes one or more tags from the specified EventBridge Scheduler schedule group.
-
#update_schedule(params = {}) ⇒ Types::UpdateScheduleOutput
Updates the specified schedule.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
479 480 481 |
# File 'gems/aws-sdk-scheduler/lib/aws-sdk-scheduler/client.rb', line 479 def initialize(*args) super end |
Instance Method Details
#create_schedule(params = {}) ⇒ Types::CreateScheduleOutput
Creates the specified schedule.
685 686 687 688 |
# File 'gems/aws-sdk-scheduler/lib/aws-sdk-scheduler/client.rb', line 685 def create_schedule(params = {}, = {}) req = build_request(:create_schedule, params) req.send_request() end |
#create_schedule_group(params = {}) ⇒ Types::CreateScheduleGroupOutput
Creates the specified schedule group.
732 733 734 735 |
# File 'gems/aws-sdk-scheduler/lib/aws-sdk-scheduler/client.rb', line 732 def create_schedule_group(params = {}, = {}) req = build_request(:create_schedule_group, params) req.send_request() end |
#delete_schedule(params = {}) ⇒ Struct
Deletes the specified schedule.
769 770 771 772 |
# File 'gems/aws-sdk-scheduler/lib/aws-sdk-scheduler/client.rb', line 769 def delete_schedule(params = {}, = {}) req = build_request(:delete_schedule, params) req.send_request() end |
#delete_schedule_group(params = {}) ⇒ Struct
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.
812 813 814 815 |
# File 'gems/aws-sdk-scheduler/lib/aws-sdk-scheduler/client.rb', line 812 def delete_schedule_group(params = {}, = {}) req = build_request(:delete_schedule_group, params) req.send_request() end |
#get_schedule(params = {}) ⇒ Types::GetScheduleOutput
Retrieves the specified schedule.
918 919 920 921 |
# File 'gems/aws-sdk-scheduler/lib/aws-sdk-scheduler/client.rb', line 918 def get_schedule(params = {}, = {}) req = build_request(:get_schedule, params) req.send_request() end |
#get_schedule_group(params = {}) ⇒ Types::GetScheduleGroupOutput
Retrieves the specified schedule group.
954 955 956 957 |
# File 'gems/aws-sdk-scheduler/lib/aws-sdk-scheduler/client.rb', line 954 def get_schedule_group(params = {}, = {}) req = build_request(:get_schedule_group, params) req.send_request() end |
#list_schedule_groups(params = {}) ⇒ Types::ListScheduleGroupsOutput
Returns a paginated list of your schedule groups.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1003 1004 1005 1006 |
# File 'gems/aws-sdk-scheduler/lib/aws-sdk-scheduler/client.rb', line 1003 def list_schedule_groups(params = {}, = {}) req = build_request(:list_schedule_groups, params) req.send_request() end |
#list_schedules(params = {}) ⇒ Types::ListSchedulesOutput
Returns a paginated list of your EventBridge Scheduler schedules.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1063 1064 1065 1066 |
# File 'gems/aws-sdk-scheduler/lib/aws-sdk-scheduler/client.rb', line 1063 def list_schedules(params = {}, = {}) req = build_request(:list_schedules, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceOutput
Lists the tags associated with the Scheduler resource.
1094 1095 1096 1097 |
# File 'gems/aws-sdk-scheduler/lib/aws-sdk-scheduler/client.rb', line 1094 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Assigns one or more tags (key-value pairs) to the specified EventBridge Scheduler resource. You can only assign tags to schedule groups.
1128 1129 1130 1131 |
# File 'gems/aws-sdk-scheduler/lib/aws-sdk-scheduler/client.rb', line 1128 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes one or more tags from the specified EventBridge Scheduler schedule group.
1156 1157 1158 1159 |
# File 'gems/aws-sdk-scheduler/lib/aws-sdk-scheduler/client.rb', line 1156 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_schedule(params = {}) ⇒ Types::UpdateScheduleOutput
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.
1373 1374 1375 1376 |
# File 'gems/aws-sdk-scheduler/lib/aws-sdk-scheduler/client.rb', line 1373 def update_schedule(params = {}, = {}) req = build_request(:update_schedule, params) req.send_request() end |