| Column Name | Column Data Type |
|---|
name Required Input Column
The name of the schedule. | VARCHAR |
group_name Input Column
The name of the schedule group associated with this schedule. | VARCHAR |
_aws_profile Input Column
The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role. | STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
) |
Show child fields- _aws_profile.account_id
The AWS account id - _aws_profile.assumed_role_arn
The ARN of the assumed role - _aws_profile.name
The unique name of the profile. - _aws_profile.organization
Information about this profile's membership in the AWS organization. Show child fields- _aws_profile.organization.account_name
The name of account speciifed by the organization - _aws_profile.organization.id
The organization id - _aws_profile.organization.master_account
Show child fields- _aws_profile.organization.master_account.email
The organization master account email address - _aws_profile.organization.master_account.id
The organization master account id
- _aws_profile.organization.parents[]
Show child fields- _aws_profile.organization.parents[].id
The id of the parent - _aws_profile.organization.parents[].name
The name of the parent - _aws_profile.organization.parents[].tags[]
Show child fields- _aws_profile.organization.parents[].tags[].key
- _aws_profile.organization.parents[].tags[].value
- _aws_profile.organization.parents[].type
The type of parent can be an organization unit or a root
- _aws_profile.organization.tags[]
Show child fields- _aws_profile.organization.tags[].key
- _aws_profile.organization.tags[].value
- _aws_profile.type
The type of profile, either 'credentials' or 'assumed_role' - _aws_profile.via_profile_name
This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.
|
_aws_region Input Column
The AWS region to use. | VARCHAR |
action_after_completion
Indicates the action that EventBridge Scheduler applies to the schedule after the schedule completes invoking the target. | VARCHAR |
arn
The Amazon Resource Name (ARN) of the schedule. | VARCHAR |
creation_date
The time at which the schedule was created. | TIMESTAMP_S |
description
The description of the schedule. | VARCHAR |
end_date
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. | TIMESTAMP_S |
flexible_time_window
Allows you to configure a time window during which EventBridge Scheduler invokes the schedule. | STRUCT(
"maximum_window_in_minutes" BIGINT,
"mode" VARCHAR
) |
Show child fields- flexible_time_window.maximum_window_in_minutes
The maximum time window during which a schedule can be invoked. - flexible_time_window.mode
Determines whether the schedule is invoked within a flexible time window.
|
kms_key_arn
The ARN for a customer managed KMS Key that is be used to encrypt and decrypt your data. | VARCHAR |
last_modification_date
The time at which the schedule was last modified. | TIMESTAMP_S |
schedule_expression
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. | VARCHAR |
schedule_expression_timezone
The timezone in which the scheduling expression is evaluated. | VARCHAR |
start_date
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. | TIMESTAMP_S |
state
Specifies whether the schedule is enabled or disabled. | VARCHAR |
target
The schedule target. | STRUCT(
"arn" VARCHAR,
"dead_letter_config" STRUCT(
"arn" VARCHAR
),
"ecs_parameters" STRUCT(
"capacity_provider_strategy" STRUCT(
"base" BIGINT,
"capacity_provider" VARCHAR,
"weight" BIGINT
)[],
"enable_ecs_managed_tags" BOOLEAN,
"enable_execute_command" BOOLEAN,
"group" VARCHAR,
"launch_type" VARCHAR,
"network_configuration" STRUCT(
"awsvpc_configuration" STRUCT(
"assign_public_ip" VARCHAR,
"security_groups" VARCHAR[],
"subnets" VARCHAR[]
)
),
"placement_constraints" STRUCT(
"expression" VARCHAR,
"type" VARCHAR
)[],
"placement_strategy" STRUCT(
"field" VARCHAR,
"type" VARCHAR
)[],
"platform_version" VARCHAR,
"propagate_tags" VARCHAR,
"reference_id" VARCHAR,
"tags" MAP(VARCHAR, VARCHAR)[],
"task_count" BIGINT,
"task_definition_arn" VARCHAR
),
"event_bridge_parameters" STRUCT(
"detail_type" VARCHAR,
"source" VARCHAR
),
"input" VARCHAR,
"kinesis_parameters" STRUCT(
"partition_key" VARCHAR
),
"retry_policy" STRUCT(
"maximum_event_age_in_seconds" BIGINT,
"maximum_retry_attempts" BIGINT
),
"role_arn" VARCHAR,
"sage_maker_pipeline_parameters" STRUCT(
"pipeline_parameter_list" STRUCT(
"name" VARCHAR,
"value" VARCHAR
)[]
),
"sqs_parameters" STRUCT(
"message_group_id" VARCHAR
)
) |
Show child fields- target.arn
The Amazon Resource Name (ARN) of the target. - target.dead_letter_config
An object that contains information about an Amazon SQS queue that EventBridge Scheduler uses as a dead-letter queue for your schedule. If specified, EventBridge Scheduler delivers failed events that could not be successfully delivered to a target to the queue. Show child fields- target.dead_letter_config.arn
The Amazon Resource Name (ARN) of the SQS queue specified as the destination for the dead-letter queue.
- target.ecs_parameters
The templated target type for the Amazon ECS RunTask API operation. Show child fields- target.ecs_parameters.capacity_provider_strategy[]
Show child fields- target.ecs_parameters.capacity_provider_strategy[].base
The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of 0 is used. - target.ecs_parameters.capacity_provider_strategy[].capacity_provider
The short name of the capacity provider. - target.ecs_parameters.capacity_provider_strategy[].weight
The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The weight value is taken into consideration after the base value, if defined, is satisfied.
- target.ecs_parameters.enable_ecs_managed_tags
Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon ECS Developer Guide. - target.ecs_parameters.enable_execute_command
Whether or not to enable the execute command functionality for the containers in this task. If true, this enables execute command functionality on all containers in the task. - target.ecs_parameters.group
Specifies an ECS task group for the task. The maximum length is 255 characters. - target.ecs_parameters.launch_type
Specifies the launch type on which your task is running. The launch type that you specify here must match one of the launch type (compatibilities) of the target task. The FARGATE value is supported only in the Regions where Fargate with Amazon ECS is supported. For more information, see AWS Fargate on Amazon ECS in the Amazon ECS Developer Guide. - target.ecs_parameters.network_configuration
This structure specifies the network configuration for an ECS task. Show child fields- target.ecs_parameters.network_configuration.awsvpc_configuration
Specifies the Amazon VPC subnets and security groups for the task, and whether a public IP address is to be used. This structure is relevant only for ECS tasks that use the awsvpc network mode. Show child fields- target.ecs_parameters.network_configuration.awsvpc_configuration.assign_public_ip
Specifies whether the task's elastic network interface receives a public IP address. You can specify ENABLED only when LaunchType in EcsParameters is set to FARGATE. - target.ecs_parameters.network_configuration.awsvpc_configuration.security_groups[]
- target.ecs_parameters.network_configuration.awsvpc_configuration.subnets[]
- target.ecs_parameters.placement_constraints[]
Show child fields- target.ecs_parameters.placement_constraints[].expression
A cluster query language expression to apply to the constraint. You cannot specify an expression if the constraint type is distinctInstance. For more information, see Cluster query language in the Amazon ECS Developer Guide. - target.ecs_parameters.placement_constraints[].type
The type of constraint. Use distinctInstance to ensure that each task in a particular group is running on a different container instance. Use memberOf to restrict the selection to a group of valid candidates.
- target.ecs_parameters.placement_strategy[]
Show child fields- target.ecs_parameters.placement_strategy[].field
The field to apply the placement strategy against. For the spread placement strategy, valid values are instanceId (or instanceId, which has the same effect), or any platform or custom attribute that is applied to a container instance, such as attribute:ecs.availability-zone. For the binpack placement strategy, valid values are cpu and memory. For the random placement strategy, this field is not used. - target.ecs_parameters.placement_strategy[].type
The type of placement strategy. The random placement strategy randomly places tasks on available candidates. The spread placement strategy spreads placement across available candidates evenly based on the field parameter. The binpack strategy places tasks on available candidates that have the least available amount of the resource that is specified with the field parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory (but still enough to run the task).
- target.ecs_parameters.platform_version
Specifies the platform version for the task. Specify only the numeric portion of the platform version, such as 1.1.0. - target.ecs_parameters.propagate_tags
Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags are not propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use Amazon ECS's TagResource API action. - target.ecs_parameters.reference_id
The reference ID to use for the task. - target.ecs_parameters.tags[]
- target.ecs_parameters.task_count
The number of tasks to create based on TaskDefinition. The default is 1. - target.ecs_parameters.task_definition_arn
The Amazon Resource Name (ARN) of the task definition to use if the event target is an Amazon ECS task.
- target.event_bridge_parameters
The templated target type for the EventBridge PutEvents API operation. Show child fields- target.event_bridge_parameters.detail_type
A free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail. - target.event_bridge_parameters.source
The source of the event.
- target.input
The text, or well-formed JSON, passed to the target. If you are configuring a templated Lambda, AWS Step Functions, or Amazon EventBridge target, the input must be a well-formed JSON. For all other target types, a JSON is not required. If you do not specify anything for this field, EventBridge Scheduler delivers a default notification to the target. - target.kinesis_parameters
The templated target type for the Amazon Kinesis PutRecord API operation. Show child fields- target.kinesis_parameters.partition_key
Specifies the shard to which EventBridge Scheduler sends the event. For more information, see Amazon Kinesis Data Streams terminology and concepts in the Amazon Kinesis Streams Developer Guide.
- target.retry_policy
A RetryPolicy object that includes information about the retry policy settings, including the maximum age of an event, and the maximum number of times EventBridge Scheduler will try to deliver the event to a target. Show child fields- target.retry_policy.maximum_event_age_in_seconds
The maximum amount of time, in seconds, to continue to make retry attempts. - target.retry_policy.maximum_retry_attempts
The maximum number of retry attempts to make before the request fails. Retry attempts with exponential backoff continue until either the maximum number of attempts is made or until the duration of the MaximumEventAgeInSeconds is reached.
- target.role_arn
The Amazon Resource Name (ARN) of the IAM role that EventBridge Scheduler will use for this target when the schedule is invoked. - target.sage_maker_pipeline_parameters
The templated target type for the Amazon SageMaker StartPipelineExecution API operation. Show child fields- target.sage_maker_pipeline_parameters.pipeline_parameter_list[]
Show child fields- target.sage_maker_pipeline_parameters.pipeline_parameter_list[].name
Name of parameter to start execution of a SageMaker Model Building Pipeline. - target.sage_maker_pipeline_parameters.pipeline_parameter_list[].value
Value of parameter to start execution of a SageMaker Model Building Pipeline.
- target.sqs_parameters
The templated target type for the Amazon SQS SendMessage API operation. Contains the message group ID to use when the target is a FIFO queue. If you specify an Amazon SQS FIFO queue as a target, the queue must have content-based deduplication enabled. For more information, see Using the Amazon SQS message deduplication ID in the Amazon SQS Developer Guide. Show child fields- target.sqs_parameters.message_group_id
The FIFO message group ID to use as the target.
|