Class: Aws::Scheduler::Client

Inherits:
Seahorse::Client::Base show all
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

#config, #handlers

API Operations collapse

Instance Method Summary collapse

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.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials used for authentication. This can be any class that includes and implements Aws::CredentialProvider, or instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]

    • The :access_key_id, :secret_access_key, :session_token, and :account_id options.

    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID'].

    • ~/.aws/credentials

    • ~/.aws/config

    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentials or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.

  • :region (required, String) —

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :account_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :auth_scheme_preference (Array<String>) —

    A list of preferred authentication schemes to use when making a request. Supported values are: sigv4, sigv4a, httpBearerAuth, and noAuth. When set using ENV['AWS_AUTH_SCHEME_PREFERENCE'] or in shared config as auth_scheme_preference, the value should be a comma-separated list.

  • :client_side_monitoring (Boolean) — default: false —

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    When true, the SDK will not prepend the modeled host prefix to the endpoint.

  • :disable_request_compression (Boolean) — default: false —

    When set to 'true' the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the :endpoint option directly. This is normally constructed from the :region option. Configuring :endpoint is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to true, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the :logger at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :request_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • when_supported - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true and/or a requestAlgorithmMember is modeled.
    • when_required - When set, a checksum will only be calculated for request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true or where a requestAlgorithmMember is modeled and supplied.
  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • when_supported - (default) When set, checksum validation is performed on all response payloads of operations modeled with the httpChecksum trait where responseAlgorithms is modeled, except when no modeled checksum algorithms are supported.
    • when_required - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the requestValidationModeMember member is set to ENABLED.
  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is the default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - A retry mode that includes all the functionality of standard mode along with automatic client side throttling.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default :sigv4a_signing_region_set is searched for in the following locations:

    • Aws.config[:sigv4a_signing_region_set]
    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
    • ~/.aws/config
  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses NoOpTelemetryProvider which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the opentelemetry-sdk gem and then, pass in an instance of a Aws::Telemetry::OTelProvider for telemetry provider.
  • :token_provider (Aws::TokenProvider) —

    Your Bearer token used for authentication. This can be any class that includes and implements Aws::TokenProvider, or instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

    • Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from aws login.

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::Scheduler::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::Scheduler::EndpointParameters.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a content-length).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.



471
472
473
 
# File 'gems/aws-sdk-scheduler/lib/aws-sdk-scheduler/client.rb', line 471

def initialize(*args)
  super
end

Instance Method Details

#create_schedule(params = {}) ⇒ Types::CreateScheduleOutput

Creates the specified schedule.

Examples:

Request syntax with placeholder values


resp = client.create_schedule({
  action_after_completion: "NONE", # accepts NONE, DELETE
  client_token: "ClientToken",
  description: "Description",
  end_date: Time.now,
  flexible_time_window: { # required
    maximum_window_in_minutes: 1,
    mode: "OFF", # required, accepts OFF, FLEXIBLE
  },
  group_name: "ScheduleGroupName",
  kms_key_arn: "KmsKeyArn",
  name: "Name", # required
  schedule_expression: "ScheduleExpression", # required
  schedule_expression_timezone: "ScheduleExpressionTimezone",
  start_date: Time.now,
  state: "ENABLED", # accepts ENABLED, DISABLED
  target: { # required
    arn: "TargetArn", # required
    dead_letter_config: {
      arn: "DeadLetterConfigArnString",
    },
    ecs_parameters: {
      capacity_provider_strategy: [
        {
          base: 1,
          capacity_provider: "CapacityProvider", # required
          weight: 1,
        },
      ],
      enable_ecs_managed_tags: false,
      enable_execute_command: false,
      group: "Group",
      launch_type: "EC2", # accepts EC2, FARGATE, EXTERNAL
      network_configuration: {
        awsvpc_configuration: {
          assign_public_ip: "ENABLED", # accepts ENABLED, DISABLED
          security_groups: ["SecurityGroup"],
          subnets: ["Subnet"], # required
        },
      },
      placement_constraints: [
        {
          expression: "PlacementConstraintExpression",
          type: "distinctInstance", # accepts distinctInstance, memberOf
        },
      ],
      placement_strategy: [
        {
          field: "PlacementStrategyField",
          type: "random", # accepts random, spread, binpack
        },
      ],
      platform_version: "PlatformVersion",
      propagate_tags: "TASK_DEFINITION", # accepts TASK_DEFINITION
      reference_id: "ReferenceId",
      tags: [
        {
          "TagKey" => "TagValue",
        },
      ],
      task_count: 1,
      task_definition_arn: "TaskDefinitionArn", # required
    },
    event_bridge_parameters: {
      detail_type: "DetailType", # required
      source: "Source", # required
    },
    input: "TargetInput",
    kinesis_parameters: {
      partition_key: "TargetPartitionKey", # required
    },
    retry_policy: {
      maximum_event_age_in_seconds: 1,
      maximum_retry_attempts: 1,
    },
    role_arn: "RoleArn", # required
    sage_maker_pipeline_parameters: {
      pipeline_parameter_list: [
        {
          name: "SageMakerPipelineParameterName", # required
          value: "SageMakerPipelineParameterValue", # required
        },
      ],
    },
    sqs_parameters: {
      message_group_id: "MessageGroupId",
    },
  },
})

Response structure


resp.schedule_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :action_after_completion (String) —

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

  • :client_token (String) —

    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.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :description (String) —

    The description you specify for the schedule.

  • :end_date (Time, DateTime, Date, Integer, String) —

    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.

  • :flexible_time_window (required, Types::FlexibleTimeWindow) —

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

  • :group_name (String) —

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

  • :kms_key_arn (String) —

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

  • :name (required, String) —

    The name of the schedule that you are creating.

  • :schedule_expression (required, 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.

  • :schedule_expression_timezone (String) —

    The timezone in which the scheduling expression is evaluated.

  • :start_date (Time, DateTime, Date, Integer, String) —

    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.

  • :state (String) —

    Specifies whether the schedule is enabled or disabled.

  • :target (required, Types::Target) —

    The schedule's target.

Returns:

See Also:



668
669
670
671
 
# File 'gems/aws-sdk-scheduler/lib/aws-sdk-scheduler/client.rb', line 668

def create_schedule(params = {}, options = {})
  req = build_request(:create_schedule, params)
  req.send_request(options)
end

#create_schedule_group(params = {}) ⇒ Types::CreateScheduleGroupOutput

Creates the specified schedule group.

Examples:

Request syntax with placeholder values


resp = client.create_schedule_group({
  client_token: "ClientToken",
  name: "ScheduleGroupName", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.schedule_group_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_token (String) —

    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.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :name (required, String) —

    The name of the schedule group that you are creating.

  • :tags (Array<Types::Tag>) —

    The list of tags to associate with the schedule group.

Returns:

See Also:



715
716
717
718
 
# File 'gems/aws-sdk-scheduler/lib/aws-sdk-scheduler/client.rb', line 715

def create_schedule_group(params = {}, options = {})
  req = build_request(:create_schedule_group, params)
  req.send_request(options)
end

#delete_schedule(params = {}) ⇒ Struct

Deletes the specified schedule.

Examples:

Request syntax with placeholder values


resp = client.delete_schedule({
  client_token: "ClientToken",
  group_name: "ScheduleGroupName",
  name: "Name", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_token (String) —

    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.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :group_name (String) —

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

  • :name (required, String) —

    The name of the schedule to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



752
753
754
755
 
# File 'gems/aws-sdk-scheduler/lib/aws-sdk-scheduler/client.rb', line 752

def delete_schedule(params = {}, options = {})
  req = build_request(:delete_schedule, params)
  req.send_request(options)
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.

This operation is eventually consistent.

Examples:

Request syntax with placeholder values


resp = client.delete_schedule_group({
  client_token: "ClientToken",
  name: "ScheduleGroupName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_token (String) —

    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.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :name (required, String) —

    The name of the schedule group to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



795
796
797
798
 
# File 'gems/aws-sdk-scheduler/lib/aws-sdk-scheduler/client.rb', line 795

def delete_schedule_group(params = {}, options = {})
  req = build_request(:delete_schedule_group, params)
  req.send_request(options)
end

#get_schedule(params = {}) ⇒ Types::GetScheduleOutput

Retrieves the specified schedule.

Examples:

Request syntax with placeholder values


resp = client.get_schedule({
  group_name: "ScheduleGroupName",
  name: "Name", # required
})

Response structure


resp.action_after_completion #=> String, one of "NONE", "DELETE"
resp.arn #=> String
resp.creation_date #=> Time
resp.description #=> String
resp.end_date #=> Time
resp.flexible_time_window.maximum_window_in_minutes #=> Integer
resp.flexible_time_window.mode #=> String, one of "OFF", "FLEXIBLE"
resp.group_name #=> String
resp.kms_key_arn #=> String
resp.last_modification_date #=> Time
resp.name #=> String
resp.schedule_expression #=> String
resp.schedule_expression_timezone #=> String
resp.start_date #=> Time
resp.state #=> String, one of "ENABLED", "DISABLED"
resp.target.arn #=> String
resp.target.dead_letter_config.arn #=> String
resp.target.ecs_parameters.capacity_provider_strategy #=> Array
resp.target.ecs_parameters.capacity_provider_strategy[0].base #=> Integer
resp.target.ecs_parameters.capacity_provider_strategy[0].capacity_provider #=> String
resp.target.ecs_parameters.capacity_provider_strategy[0].weight #=> Integer
resp.target.ecs_parameters.enable_ecs_managed_tags #=> Boolean
resp.target.ecs_parameters.enable_execute_command #=> Boolean
resp.target.ecs_parameters.group #=> String
resp.target.ecs_parameters.launch_type #=> String, one of "EC2", "FARGATE", "EXTERNAL"
resp.target.ecs_parameters.network_configuration.awsvpc_configuration.assign_public_ip #=> String, one of "ENABLED", "DISABLED"
resp.target.ecs_parameters.network_configuration.awsvpc_configuration.security_groups #=> Array
resp.target.ecs_parameters.network_configuration.awsvpc_configuration.security_groups[0] #=> String
resp.target.ecs_parameters.network_configuration.awsvpc_configuration.subnets #=> Array
resp.target.ecs_parameters.network_configuration.awsvpc_configuration.subnets[0] #=> String
resp.target.ecs_parameters.placement_constraints #=> Array
resp.target.ecs_parameters.placement_constraints[0].expression #=> String
resp.target.ecs_parameters.placement_constraints[0].type #=> String, one of "distinctInstance", "memberOf"
resp.target.ecs_parameters.placement_strategy #=> Array
resp.target.ecs_parameters.placement_strategy[0].field #=> String
resp.target.ecs_parameters.placement_strategy[0].type #=> String, one of "random", "spread", "binpack"
resp.target.ecs_parameters.platform_version #=> String
resp.target.ecs_parameters.propagate_tags #=> String, one of "TASK_DEFINITION"
resp.target.ecs_parameters.reference_id #=> String
resp.target.ecs_parameters.tags #=> Array
resp.target.ecs_parameters.tags[0] #=> Hash
resp.target.ecs_parameters.tags[0]["TagKey"] #=> String
resp.target.ecs_parameters.task_count #=> Integer
resp.target.ecs_parameters.task_definition_arn #=> String
resp.target.event_bridge_parameters.detail_type #=> String
resp.target.event_bridge_parameters.source #=> String
resp.target.input #=> String
resp.target.kinesis_parameters.partition_key #=> String
resp.target.retry_policy.maximum_event_age_in_seconds #=> Integer
resp.target.retry_policy.maximum_retry_attempts #=> Integer
resp.target.role_arn #=> String
resp.target.sage_maker_pipeline_parameters.pipeline_parameter_list #=> Array
resp.target.sage_maker_pipeline_parameters.pipeline_parameter_list[0].name #=> String
resp.target.sage_maker_pipeline_parameters.pipeline_parameter_list[0].value #=> String
resp.target.sqs_parameters.message_group_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :group_name (String) —

    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.

  • :name (required, String) —

    The name of the schedule to retrieve.

Returns:

See Also:



897
898
899
900
 
# File 'gems/aws-sdk-scheduler/lib/aws-sdk-scheduler/client.rb', line 897

def get_schedule(params = {}, options = {})
  req = build_request(:get_schedule, params)
  req.send_request(options)
end

#get_schedule_group(params = {}) ⇒ Types::GetScheduleGroupOutput

Retrieves the specified schedule group.

Examples:

Request syntax with placeholder values


resp = client.get_schedule_group({
  name: "ScheduleGroupName", # required
})

Response structure


resp.arn #=> String
resp.creation_date #=> Time
resp.last_modification_date #=> Time
resp.name #=> String
resp.state #=> String, one of "ACTIVE", "DELETING"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the schedule group to retrieve.

Returns:

See Also:



933
934
935
936
 
# File 'gems/aws-sdk-scheduler/lib/aws-sdk-scheduler/client.rb', line 933

def get_schedule_group(params = {}, options = {})
  req = build_request(:get_schedule_group, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_schedule_groups({
  max_results: 1,
  name_prefix: "ScheduleGroupNamePrefix",
  next_token: "NextToken",
})

Response structure


resp.next_token #=> String
resp.schedule_groups #=> Array
resp.schedule_groups[0].arn #=> String
resp.schedule_groups[0].creation_date #=> Time
resp.schedule_groups[0].last_modification_date #=> Time
resp.schedule_groups[0].name #=> String
resp.schedule_groups[0].state #=> String, one of "ACTIVE", "DELETING"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    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.

  • :name_prefix (String) —

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

  • :next_token (String) —

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

Returns:

See Also:



982
983
984
985
 
# File 'gems/aws-sdk-scheduler/lib/aws-sdk-scheduler/client.rb', line 982

def list_schedule_groups(params = {}, options = {})
  req = build_request(:list_schedule_groups, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_schedules({
  group_name: "ScheduleGroupName",
  max_results: 1,
  name_prefix: "NamePrefix",
  next_token: "NextToken",
  state: "ENABLED", # accepts ENABLED, DISABLED
})

Response structure


resp.next_token #=> String
resp.schedules #=> Array
resp.schedules[0].arn #=> String
resp.schedules[0].creation_date #=> Time
resp.schedules[0].group_name #=> String
resp.schedules[0].last_modification_date #=> Time
resp.schedules[0].name #=> String
resp.schedules[0].state #=> String, one of "ENABLED", "DISABLED"
resp.schedules[0].target.arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :group_name (String) —

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

  • :max_results (Integer) —

    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.

  • :name_prefix (String) —

    Schedule name prefix to return the filtered list of resources.

  • :next_token (String) —

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

  • :state (String) —

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

Returns:

See Also:



1042
1043
1044
1045
 
# File 'gems/aws-sdk-scheduler/lib/aws-sdk-scheduler/client.rb', line 1042

def list_schedules(params = {}, options = {})
  req = build_request(:list_schedules, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceOutput

Lists the tags associated with the Scheduler resource.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "TagResourceArn", # required
})

Response structure


resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

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

Returns:

See Also:



1073
1074
1075
1076
 
# File 'gems/aws-sdk-scheduler/lib/aws-sdk-scheduler/client.rb', line 1073

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "TagResourceArn", # required
  tags: [ # required
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

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

  • :tags (required, Array<Types::Tag>) —

    The list of tags to associate with the schedule group.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1107
1108
1109
1110
 
# File 'gems/aws-sdk-scheduler/lib/aws-sdk-scheduler/client.rb', line 1107

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

Removes one or more tags from the specified EventBridge Scheduler schedule group.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "TagResourceArn", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

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

  • :tag_keys (required, Array<String>) —

    The list of tag keys to remove from the resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1135
1136
1137
1138
 
# File 'gems/aws-sdk-scheduler/lib/aws-sdk-scheduler/client.rb', line 1135

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.update_schedule({
  action_after_completion: "NONE", # accepts NONE, DELETE
  client_token: "ClientToken",
  description: "Description",
  end_date: Time.now,
  flexible_time_window: { # required
    maximum_window_in_minutes: 1,
    mode: "OFF", # required, accepts OFF, FLEXIBLE
  },
  group_name: "ScheduleGroupName",
  kms_key_arn: "KmsKeyArn",
  name: "Name", # required
  schedule_expression: "ScheduleExpression", # required
  schedule_expression_timezone: "ScheduleExpressionTimezone",
  start_date: Time.now,
  state: "ENABLED", # accepts ENABLED, DISABLED
  target: { # required
    arn: "TargetArn", # required
    dead_letter_config: {
      arn: "DeadLetterConfigArnString",
    },
    ecs_parameters: {
      capacity_provider_strategy: [
        {
          base: 1,
          capacity_provider: "CapacityProvider", # required
          weight: 1,
        },
      ],
      enable_ecs_managed_tags: false,
      enable_execute_command: false,
      group: "Group",
      launch_type: "EC2", # accepts EC2, FARGATE, EXTERNAL
      network_configuration: {
        awsvpc_configuration: {
          assign_public_ip: "ENABLED", # accepts ENABLED, DISABLED
          security_groups: ["SecurityGroup"],
          subnets: ["Subnet"], # required
        },
      },
      placement_constraints: [
        {
          expression: "PlacementConstraintExpression",
          type: "distinctInstance", # accepts distinctInstance, memberOf
        },
      ],
      placement_strategy: [
        {
          field: "PlacementStrategyField",
          type: "random", # accepts random, spread, binpack
        },
      ],
      platform_version: "PlatformVersion",
      propagate_tags: "TASK_DEFINITION", # accepts TASK_DEFINITION
      reference_id: "ReferenceId",
      tags: [
        {
          "TagKey" => "TagValue",
        },
      ],
      task_count: 1,
      task_definition_arn: "TaskDefinitionArn", # required
    },
    event_bridge_parameters: {
      detail_type: "DetailType", # required
      source: "Source", # required
    },
    input: "TargetInput",
    kinesis_parameters: {
      partition_key: "TargetPartitionKey", # required
    },
    retry_policy: {
      maximum_event_age_in_seconds: 1,
      maximum_retry_attempts: 1,
    },
    role_arn: "RoleArn", # required
    sage_maker_pipeline_parameters: {
      pipeline_parameter_list: [
        {
          name: "SageMakerPipelineParameterName", # required
          value: "SageMakerPipelineParameterValue", # required
        },
      ],
    },
    sqs_parameters: {
      message_group_id: "MessageGroupId",
    },
  },
})

Response structure


resp.schedule_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :action_after_completion (String) —

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

  • :client_token (String) —

    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.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :description (String) —

    The description you specify for the schedule.

  • :end_date (Time, DateTime, Date, Integer, String) —

    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.

  • :flexible_time_window (required, Types::FlexibleTimeWindow) —

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

  • :group_name (String) —

    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.

  • :kms_key_arn (String) —

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

  • :name (required, String) —

    The name of the schedule that you are updating.

  • :schedule_expression (required, 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.

  • :schedule_expression_timezone (String) —

    The timezone in which the scheduling expression is evaluated.

  • :start_date (Time, DateTime, Date, Integer, String) —

    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.

  • :state (String) —

    Specifies whether the schedule is enabled or disabled.

  • :target (required, Types::Target) —

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

Returns:

See Also:



1343
1344
1345
1346
 
# File 'gems/aws-sdk-scheduler/lib/aws-sdk-scheduler/client.rb', line 1343

def update_schedule(params = {}, options = {})
  req = build_request(:update_schedule, params)
  req.send_request(options)
end