Struct Client

pub struct Client { /* private fields */ }

Client for Amazon EventBridge Scheduler

Client for invoking operations on Amazon EventBridge Scheduler. Each operation on Amazon EventBridge Scheduler is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_scheduler::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Builder struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_scheduler::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the CreateSchedule operation has a Client::create_schedule, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.create_schedule()
    .name("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations

impl Client

pub fn create_schedule(&self) -> CreateScheduleFluentBuilder

Constructs a fluent builder for the CreateSchedule operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the schedule that you are creating.

    
    
  • group_name(impl Into<String>) / set_group_name(Option<String>):
    required: false
    

    The name of the schedule group to associate with this schedule. If you omit this, the default schedule group is used.

    
    
  • schedule_expression(impl Into<String>) / set_schedule_expression(Option<String>):
    required: true
    

    The expression that defines when the schedule runs. The following formats are supported.

    • at expression - at(yyyy-mm-ddThh:mm:ss)

    • rate expression - rate(value unit)

    • cron expression - cron(fields)

    You can use at expressions to create one-time schedules that invoke a target once, at the time and in the time zone, that you specify. You can use rate and cron expressions to create recurring schedules. Rate-based schedules are useful when you want to invoke a target at regular intervals, such as every 15 minutes or every five days. Cron-based schedules are useful when you want to invoke a target periodically at a specific time, such as at 8:00 am (UTC+0) every 1st day of the month.

    A cron expression consists of six fields separated by white spaces: (minutes hours day_of_month month day_of_week year).

    A rate expression consists of a value as a positive integer, and a unit with the following options: minute | minutes | hour | hours | day | days

    For more information and examples, see Schedule types on EventBridge Scheduler in the EventBridge Scheduler User Guide.

    
    
  • start_date(DateTime) / set_start_date(Option<DateTime>):
    required: false
    

    The date, in UTC, after which the schedule can begin invoking its target. Depending on the schedule’s recurrence expression, invocations might occur on, or after, the StartDate you specify. EventBridge Scheduler ignores StartDate for one-time schedules.

    
    
  • end_date(DateTime) / set_end_date(Option<DateTime>):
    required: false
    

    The date, in UTC, before which the schedule can invoke its target. Depending on the schedule’s recurrence expression, invocations might stop on, or before, the EndDate you specify. EventBridge Scheduler ignores EndDate for one-time schedules.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description you specify for the schedule.

    
    
  • schedule_expression_timezone(impl Into<String>) / set_schedule_expression_timezone(Option<String>):
    required: false
    

    The timezone in which the scheduling expression is evaluated.

    
    
  • state(ScheduleState) / set_state(Option<ScheduleState>):
    required: false
    

    Specifies whether the schedule is enabled or disabled.

    
    
  • kms_key_arn(impl Into<String>) / set_kms_key_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) for the customer managed KMS key that EventBridge Scheduler will use to encrypt and decrypt your data.

    
    
  • target(Target) / set_target(Option<Target>):
    required: true
    

    The schedule’s target.

    
    
  • flexible_time_window(FlexibleTimeWindow) / set_flexible_time_window(Option<FlexibleTimeWindow>):
    required: true
    

    Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token, EventBridge Scheduler uses a randomly generated token for the request to ensure idempotency.

    
    
  • action_after_completion(ActionAfterCompletion) / set_action_after_completion(Option<ActionAfterCompletion>):
    required: false
    

    Specifies the action that EventBridge Scheduler applies to the schedule after the schedule completes invoking the target.

    
    
• On success, responds with CreateScheduleOutput with field(s):
  • schedule_arn(String):

    The Amazon Resource Name (ARN) of the schedule.

• On failure, responds with SdkError<CreateScheduleError>

impl Client

pub fn create_schedule_group(&self) -> CreateScheduleGroupFluentBuilder

Constructs a fluent builder for the CreateScheduleGroup operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the schedule group that you are creating.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    The list of tags to associate with the schedule group.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token, EventBridge Scheduler uses a randomly generated token for the request to ensure idempotency.

    
    
• On success, responds with CreateScheduleGroupOutput with field(s):
  • schedule_group_arn(String):

    The Amazon Resource Name (ARN) of the schedule group.

• On failure, responds with SdkError<CreateScheduleGroupError>

impl Client

pub fn delete_schedule(&self) -> DeleteScheduleFluentBuilder

Constructs a fluent builder for the DeleteSchedule operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the schedule to delete.

    
    
  • group_name(impl Into<String>) / set_group_name(Option<String>):
    required: false
    

    The name of the schedule group associated with this schedule. If you omit this, the default schedule group is used.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token, EventBridge Scheduler uses a randomly generated token for the request to ensure idempotency.

    
    
• On success, responds with DeleteScheduleOutput
• On failure, responds with SdkError<DeleteScheduleError>

impl Client

pub fn delete_schedule_group(&self) -> DeleteScheduleGroupFluentBuilder

Constructs a fluent builder for the DeleteScheduleGroup operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the schedule group to delete.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token, EventBridge Scheduler uses a randomly generated token for the request to ensure idempotency.

    
    
• On success, responds with DeleteScheduleGroupOutput
• On failure, responds with SdkError<DeleteScheduleGroupError>

impl Client

pub fn get_schedule(&self) -> GetScheduleFluentBuilder

Constructs a fluent builder for the GetSchedule operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the schedule to retrieve.

    
    
  • group_name(impl Into<String>) / set_group_name(Option<String>):
    required: false
    

    The name of the schedule group associated with this schedule. If you omit this, EventBridge Scheduler assumes that the schedule is associated with the default group.

    
    
• On success, responds with GetScheduleOutput with field(s):
  • arn(Option<String>):

    The Amazon Resource Name (ARN) of the schedule.

  • group_name(Option<String>):

    The name of the schedule group associated with this schedule.

  • name(Option<String>):

    The name of the schedule.

  • schedule_expression(Option<String>):

    The expression that defines when the schedule runs. The following formats are supported.

    • at expression - at(yyyy-mm-ddThh:mm:ss)

    • rate expression - rate(value unit)

    • cron expression - cron(fields)

    You can use at expressions to create one-time schedules that invoke a target once, at the time and in the time zone, that you specify. You can use rate and cron expressions to create recurring schedules. Rate-based schedules are useful when you want to invoke a target at regular intervals, such as every 15 minutes or every five days. Cron-based schedules are useful when you want to invoke a target periodically at a specific time, such as at 8:00 am (UTC+0) every 1st day of the month.

    A cron expression consists of six fields separated by white spaces: (minutes hours day_of_month month day_of_week year).

    A rate expression consists of a value as a positive integer, and a unit with the following options: minute | minutes | hour | hours | day | days

    For more information and examples, see Schedule types on EventBridge Scheduler in the EventBridge Scheduler User Guide.

  • start_date(Option<DateTime>):

    The date, in UTC, after which the schedule can begin invoking its target. Depending on the schedule’s recurrence expression, invocations might occur on, or after, the StartDate you specify. EventBridge Scheduler ignores StartDate for one-time schedules.

  • end_date(Option<DateTime>):

    The date, in UTC, before which the schedule can invoke its target. Depending on the schedule’s recurrence expression, invocations might stop on, or before, the EndDate you specify. EventBridge Scheduler ignores EndDate for one-time schedules.

  • description(Option<String>):

    The description of the schedule.

  • schedule_expression_timezone(Option<String>):

    The timezone in which the scheduling expression is evaluated.

  • state(Option<ScheduleState>):

    Specifies whether the schedule is enabled or disabled.

  • creation_date(Option<DateTime>):

    The time at which the schedule was created.

  • last_modification_date(Option<DateTime>):

    The time at which the schedule was last modified.

  • kms_key_arn(Option<String>):

    The ARN for a customer managed KMS Key that is be used to encrypt and decrypt your data.

  • target(Option<Target>):

    The schedule target.

  • flexible_time_window(Option<FlexibleTimeWindow>):

    Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.

  • action_after_completion(Option<ActionAfterCompletion>):

    Indicates the action that EventBridge Scheduler applies to the schedule after the schedule completes invoking the target.

• On failure, responds with SdkError<GetScheduleError>

impl Client

pub fn get_schedule_group(&self) -> GetScheduleGroupFluentBuilder

Constructs a fluent builder for the GetScheduleGroup operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the schedule group to retrieve.

    
    
• On success, responds with GetScheduleGroupOutput with field(s):
  • arn(Option<String>):

    The Amazon Resource Name (ARN) of the schedule group.

  • name(Option<String>):

    The name of the schedule group.

  • state(Option<ScheduleGroupState>):

    Specifies the state of the schedule group.

  • creation_date(Option<DateTime>):

    The time at which the schedule group was created.

  • last_modification_date(Option<DateTime>):

    The time at which the schedule group was last modified.

• On failure, responds with SdkError<GetScheduleGroupError>

impl Client

pub fn list_schedule_groups(&self) -> ListScheduleGroupsFluentBuilder

Constructs a fluent builder for the ListScheduleGroups operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • name_prefix(impl Into<String>) / set_name_prefix(Option<String>):
    required: false
    

    The name prefix that you can use to return a filtered list of your schedule groups.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token returned by a previous call to retrieve the next set of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    If specified, limits the number of results returned by this operation. The operation also returns a NextToken which you can use in a subsequent operation to retrieve the next set of results.

    
    
• On success, responds with ListScheduleGroupsOutput with field(s):
  • next_token(Option<String>):

    Indicates whether there are additional results to retrieve. If the value is null, there are no more results.

  • schedule_groups(Vec::<ScheduleGroupSummary>):

    The schedule groups that match the specified criteria.

• On failure, responds with SdkError<ListScheduleGroupsError>

impl Client

pub fn list_schedules(&self) -> ListSchedulesFluentBuilder

Constructs a fluent builder for the ListSchedules operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • group_name(impl Into<String>) / set_group_name(Option<String>):
    required: false
    

    If specified, only lists the schedules whose associated schedule group matches the given filter.

    
    
  • name_prefix(impl Into<String>) / set_name_prefix(Option<String>):
    required: false
    

    Schedule name prefix to return the filtered list of resources.

    
    
  • state(ScheduleState) / set_state(Option<ScheduleState>):
    required: false
    

    If specified, only lists the schedules whose current state matches the given filter.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token returned by a previous call to retrieve the next set of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    If specified, limits the number of results returned by this operation. The operation also returns a NextToken which you can use in a subsequent operation to retrieve the next set of results.

    
    
• On success, responds with ListSchedulesOutput with field(s):
  • next_token(Option<String>):

    Indicates whether there are additional results to retrieve. If the value is null, there are no more results.

  • schedules(Vec::<ScheduleSummary>):

    The schedules that match the specified criteria.

• On failure, responds with SdkError<ListSchedulesError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The ARN of the EventBridge Scheduler resource for which you want to view tags.

    
    
• On success, responds with ListTagsForResourceOutput with field(s):
  • tags(Option<Vec::<Tag>>):

    The list of tags associated with the specified resource.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the schedule group that you are adding tags to.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: true
    

    The list of tags to associate with the schedule group.

    
    
• On success, responds with TagResourceOutput
• On failure, responds with SdkError<TagResourceError>

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the schedule group from which you are removing tags.

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    

    The list of tag keys to remove from the resource.

    
    
• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

impl Client

pub fn update_schedule(&self) -> UpdateScheduleFluentBuilder

Constructs a fluent builder for the UpdateSchedule operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the schedule that you are updating.

    
    
  • group_name(impl Into<String>) / set_group_name(Option<String>):
    required: false
    

    The name of the schedule group with which the schedule is associated. You must provide this value in order for EventBridge Scheduler to find the schedule you want to update. If you omit this value, EventBridge Scheduler assumes the group is associated to the default group.

    
    
  • schedule_expression(impl Into<String>) / set_schedule_expression(Option<String>):
    required: true
    

    The expression that defines when the schedule runs. The following formats are supported.

    • at expression - at(yyyy-mm-ddThh:mm:ss)

    • rate expression - rate(value unit)

    • cron expression - cron(fields)

    You can use at expressions to create one-time schedules that invoke a target once, at the time and in the time zone, that you specify. You can use rate and cron expressions to create recurring schedules. Rate-based schedules are useful when you want to invoke a target at regular intervals, such as every 15 minutes or every five days. Cron-based schedules are useful when you want to invoke a target periodically at a specific time, such as at 8:00 am (UTC+0) every 1st day of the month.

    A cron expression consists of six fields separated by white spaces: (minutes hours day_of_month month day_of_week year).

    A rate expression consists of a value as a positive integer, and a unit with the following options: minute | minutes | hour | hours | day | days

    For more information and examples, see Schedule types on EventBridge Scheduler in the EventBridge Scheduler User Guide.

    
    
  • start_date(DateTime) / set_start_date(Option<DateTime>):
    required: false
    

    The date, in UTC, after which the schedule can begin invoking its target. Depending on the schedule’s recurrence expression, invocations might occur on, or after, the StartDate you specify. EventBridge Scheduler ignores StartDate for one-time schedules.

    
    
  • end_date(DateTime) / set_end_date(Option<DateTime>):
    required: false
    

    The date, in UTC, before which the schedule can invoke its target. Depending on the schedule’s recurrence expression, invocations might stop on, or before, the EndDate you specify. EventBridge Scheduler ignores EndDate for one-time schedules.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description you specify for the schedule.

    
    
  • schedule_expression_timezone(impl Into<String>) / set_schedule_expression_timezone(Option<String>):
    required: false
    

    The timezone in which the scheduling expression is evaluated.

    
    
  • state(ScheduleState) / set_state(Option<ScheduleState>):
    required: false
    

    Specifies whether the schedule is enabled or disabled.

    
    
  • kms_key_arn(impl Into<String>) / set_kms_key_arn(Option<String>):
    required: false
    

    The ARN for the customer managed KMS key that that you want EventBridge Scheduler to use to encrypt and decrypt your data.

    
    
  • target(Target) / set_target(Option<Target>):
    required: true
    

    The schedule target. You can use this operation to change the target that your schedule invokes.

    
    
  • flexible_time_window(FlexibleTimeWindow) / set_flexible_time_window(Option<FlexibleTimeWindow>):
    required: true
    

    Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token, EventBridge Scheduler uses a randomly generated token for the request to ensure idempotency.

    
    
  • action_after_completion(ActionAfterCompletion) / set_action_after_completion(Option<ActionAfterCompletion>):
    required: false
    

    Specifies the action that EventBridge Scheduler applies to the schedule after the schedule completes invoking the target.

    
    
• On success, responds with UpdateScheduleOutput with field(s):
  • schedule_arn(String):

    The Amazon Resource Name (ARN) of the schedule that you updated.

• On failure, responds with SdkError<UpdateScheduleError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.