| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.Scheduler
Contents
- Service Configuration
- Errors
- Waiters
- Operations
- Types
- AssignPublicIp
- FlexibleTimeWindowMode
- LaunchType
- PlacementConstraintType
- PlacementStrategyType
- PropagateTags
- ScheduleGroupState
- ScheduleState
- AwsVpcConfiguration
- CapacityProviderStrategyItem
- DeadLetterConfig
- EcsParameters
- EventBridgeParameters
- FlexibleTimeWindow
- KinesisParameters
- NetworkConfiguration
- PlacementConstraint
- PlacementStrategy
- RetryPolicy
- SageMakerPipelineParameter
- SageMakerPipelineParameters
- ScheduleGroupSummary
- ScheduleSummary
- SqsParameters
- Tag
- Target
- TargetSummary
Description
Derived from API version 2021-06-30 of the AWS service descriptions, licensed under Apache 2.0.
Amazon EventBridge Scheduler is a serverless scheduler that allows you to create, run, and manage tasks from one central, managed service. EventBridge Scheduler delivers your tasks reliably, with built-in mechanisms that adjust your schedules based on the availability of downstream targets. The following reference lists the available API actions, and data types for EventBridge Scheduler.
Synopsis
- defaultService :: Service
- _ConflictException :: AsError a => Fold a ServiceError
- _InternalServerException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _ServiceQuotaExceededException :: AsError a => Fold a ServiceError
- _ThrottlingException :: AsError a => Fold a ServiceError
- _ValidationException :: AsError a => Fold a ServiceError
- data CreateSchedule = CreateSchedule' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe ScheduleState) FlexibleTimeWindow Text Text Target
- newCreateSchedule :: FlexibleTimeWindow -> Text -> Text -> Target -> CreateSchedule
- data CreateScheduleResponse = CreateScheduleResponse' Int Text
- newCreateScheduleResponse :: Int -> Text -> CreateScheduleResponse
- data CreateScheduleGroup = CreateScheduleGroup' (Maybe Text) (Maybe [Tag]) Text
- newCreateScheduleGroup :: Text -> CreateScheduleGroup
- data CreateScheduleGroupResponse = CreateScheduleGroupResponse' Int Text
- newCreateScheduleGroupResponse :: Int -> Text -> CreateScheduleGroupResponse
- data DeleteSchedule = DeleteSchedule' (Maybe Text) (Maybe Text) Text
- newDeleteSchedule :: Text -> DeleteSchedule
- data DeleteScheduleResponse = DeleteScheduleResponse' Int
- newDeleteScheduleResponse :: Int -> DeleteScheduleResponse
- data DeleteScheduleGroup = DeleteScheduleGroup' (Maybe Text) Text
- newDeleteScheduleGroup :: Text -> DeleteScheduleGroup
- data DeleteScheduleGroupResponse = DeleteScheduleGroupResponse' Int
- newDeleteScheduleGroupResponse :: Int -> DeleteScheduleGroupResponse
- data GetSchedule = GetSchedule' (Maybe Text) Text
- newGetSchedule :: Text -> GetSchedule
- data GetScheduleResponse = GetScheduleResponse' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe FlexibleTimeWindow) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe ScheduleState) (Maybe Target) Int
- newGetScheduleResponse :: Int -> GetScheduleResponse
- data GetScheduleGroup = GetScheduleGroup' Text
- newGetScheduleGroup :: Text -> GetScheduleGroup
- data GetScheduleGroupResponse = GetScheduleGroupResponse' (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe ScheduleGroupState) Int
- newGetScheduleGroupResponse :: Int -> GetScheduleGroupResponse
- data ListScheduleGroups = ListScheduleGroups' (Maybe Natural) (Maybe Text) (Maybe Text)
- newListScheduleGroups :: ListScheduleGroups
- data ListScheduleGroupsResponse = ListScheduleGroupsResponse' (Maybe Text) Int [ScheduleGroupSummary]
- newListScheduleGroupsResponse :: Int -> ListScheduleGroupsResponse
- data ListSchedules = ListSchedules' (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe ScheduleState)
- newListSchedules :: ListSchedules
- data ListSchedulesResponse = ListSchedulesResponse' (Maybe Text) Int [ScheduleSummary]
- newListSchedulesResponse :: Int -> ListSchedulesResponse
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe [Tag]) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data TagResource = TagResource' Text [Tag]
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data UntagResource = UntagResource' Text [Text]
- newUntagResource :: Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data UpdateSchedule = UpdateSchedule' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe ScheduleState) FlexibleTimeWindow Text Text Target
- newUpdateSchedule :: FlexibleTimeWindow -> Text -> Text -> Target -> UpdateSchedule
- data UpdateScheduleResponse = UpdateScheduleResponse' Int Text
- newUpdateScheduleResponse :: Int -> Text -> UpdateScheduleResponse
- newtype AssignPublicIp where
- AssignPublicIp' { }
- pattern AssignPublicIp_DISABLED :: AssignPublicIp
- pattern AssignPublicIp_ENABLED :: AssignPublicIp
- newtype FlexibleTimeWindowMode where
- newtype LaunchType where
- LaunchType' { }
- pattern LaunchType_EC2 :: LaunchType
- pattern LaunchType_EXTERNAL :: LaunchType
- pattern LaunchType_FARGATE :: LaunchType
- newtype PlacementConstraintType where
- newtype PlacementStrategyType where
- newtype PropagateTags where
- PropagateTags' { }
- pattern PropagateTags_TASK_DEFINITION :: PropagateTags
- newtype ScheduleGroupState where
- newtype ScheduleState where
- ScheduleState' { }
- pattern ScheduleState_DISABLED :: ScheduleState
- pattern ScheduleState_ENABLED :: ScheduleState
- data AwsVpcConfiguration = AwsVpcConfiguration' (Maybe AssignPublicIp) (Maybe (NonEmpty Text)) (NonEmpty Text)
- newAwsVpcConfiguration :: NonEmpty Text -> AwsVpcConfiguration
- data CapacityProviderStrategyItem = CapacityProviderStrategyItem' (Maybe Natural) (Maybe Natural) Text
- newCapacityProviderStrategyItem :: Text -> CapacityProviderStrategyItem
- data DeadLetterConfig = DeadLetterConfig' (Maybe Text)
- newDeadLetterConfig :: DeadLetterConfig
- data EcsParameters = EcsParameters' (Maybe [CapacityProviderStrategyItem]) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe LaunchType) (Maybe NetworkConfiguration) (Maybe [PlacementConstraint]) (Maybe [PlacementStrategy]) (Maybe Text) (Maybe PropagateTags) (Maybe Text) (Maybe [HashMap Text Text]) (Maybe Natural) Text
- newEcsParameters :: Text -> EcsParameters
- data EventBridgeParameters = EventBridgeParameters' Text Text
- newEventBridgeParameters :: Text -> Text -> EventBridgeParameters
- data FlexibleTimeWindow = FlexibleTimeWindow' (Maybe Natural) FlexibleTimeWindowMode
- newFlexibleTimeWindow :: FlexibleTimeWindowMode -> FlexibleTimeWindow
- data KinesisParameters = KinesisParameters' Text
- newKinesisParameters :: Text -> KinesisParameters
- data NetworkConfiguration = NetworkConfiguration' (Maybe AwsVpcConfiguration)
- newNetworkConfiguration :: NetworkConfiguration
- data PlacementConstraint = PlacementConstraint' (Maybe Text) (Maybe PlacementConstraintType)
- newPlacementConstraint :: PlacementConstraint
- data PlacementStrategy = PlacementStrategy' (Maybe Text) (Maybe PlacementStrategyType)
- newPlacementStrategy :: PlacementStrategy
- data RetryPolicy = RetryPolicy' (Maybe Natural) (Maybe Natural)
- newRetryPolicy :: RetryPolicy
- data SageMakerPipelineParameter = SageMakerPipelineParameter' Text Text
- newSageMakerPipelineParameter :: Text -> Text -> SageMakerPipelineParameter
- data SageMakerPipelineParameters = SageMakerPipelineParameters' (Maybe [SageMakerPipelineParameter])
- newSageMakerPipelineParameters :: SageMakerPipelineParameters
- data ScheduleGroupSummary = ScheduleGroupSummary' (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe ScheduleGroupState)
- newScheduleGroupSummary :: ScheduleGroupSummary
- data ScheduleSummary = ScheduleSummary' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe ScheduleState) (Maybe TargetSummary)
- newScheduleSummary :: ScheduleSummary
- data SqsParameters = SqsParameters' (Maybe Text)
- newSqsParameters :: SqsParameters
- data Tag = Tag' Text Text
- newTag :: Text -> Text -> Tag
- data Target = Target' (Maybe DeadLetterConfig) (Maybe EcsParameters) (Maybe EventBridgeParameters) (Maybe Text) (Maybe KinesisParameters) (Maybe RetryPolicy) (Maybe SageMakerPipelineParameters) (Maybe SqsParameters) Text Text
- newTarget :: Text -> Text -> Target
- data TargetSummary = TargetSummary' Text
- newTargetSummary :: Text -> TargetSummary
Service Configuration
defaultService :: Service Source #
API version 2021-06-30 of the Amazon EventBridge Scheduler SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by Scheduler.
ConflictException
_ConflictException :: AsError a => Fold a ServiceError Source #
Updating or deleting the resource can cause an inconsistent state.
InternalServerException
_InternalServerException :: AsError a => Fold a ServiceError Source #
Unexpected error encountered while processing the request.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
The request references a resource which does not exist.
ServiceQuotaExceededException
_ServiceQuotaExceededException :: AsError a => Fold a ServiceError Source #
The request exceeds a service quota.
ThrottlingException
_ThrottlingException :: AsError a => Fold a ServiceError Source #
The request was denied due to request throttling.
ValidationException
_ValidationException :: AsError a => Fold a ServiceError Source #
The input fails to satisfy the constraints specified by an AWS service.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
CreateSchedule
data CreateSchedule Source #
See: newCreateSchedule smart constructor.
Constructors
| CreateSchedule' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe ScheduleState) FlexibleTimeWindow Text Text Target |
Instances
Arguments
| :: FlexibleTimeWindow | |
| -> Text | |
| -> Text | |
| -> Target | |
| -> CreateSchedule |
Create a value of CreateSchedule with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:CreateSchedule', createSchedule_clientToken - 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.
$sel:description:CreateSchedule', createSchedule_description - The description you specify for the schedule.
$sel:endDate:CreateSchedule', createSchedule_endDate - 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.
CreateSchedule, createSchedule_groupName - The name of the schedule group to associate with this schedule. If you
omit this, the default schedule group is used.
$sel:kmsKeyArn:CreateSchedule', createSchedule_kmsKeyArn - The Amazon Resource Name (ARN) for the customer managed KMS key that
EventBridge Scheduler will use to encrypt and decrypt your data.
$sel:scheduleExpressionTimezone:CreateSchedule', createSchedule_scheduleExpressionTimezone - The timezone in which the scheduling expression is evaluated.
$sel:startDate:CreateSchedule', createSchedule_startDate - 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.
CreateSchedule, createSchedule_state - Specifies whether the schedule is enabled or disabled.
$sel:flexibleTimeWindow:CreateSchedule', createSchedule_flexibleTimeWindow - Allows you to configure a time window during which EventBridge Scheduler
invokes the schedule.
CreateSchedule, createSchedule_name - The name of the schedule that you are creating.
$sel:scheduleExpression:CreateSchedule', createSchedule_scheduleExpression - The expression that defines when the schedule runs. The following
formats are supported.
atexpression -at(yyyy-mm-ddThh:mm:ss)rateexpression -rate(unit value)cronexpression -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.
CreateSchedule, createSchedule_target - The schedule's target.
data CreateScheduleResponse Source #
See: newCreateScheduleResponse smart constructor.
Constructors
| CreateScheduleResponse' Int Text |
Instances
newCreateScheduleResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> CreateScheduleResponse |
Create a value of CreateScheduleResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CreateScheduleResponse', createScheduleResponse_httpStatus - The response's http status code.
$sel:scheduleArn:CreateScheduleResponse', createScheduleResponse_scheduleArn - The Amazon Resource Name (ARN) of the schedule.
CreateScheduleGroup
data CreateScheduleGroup Source #
See: newCreateScheduleGroup smart constructor.
Instances
newCreateScheduleGroup Source #
Arguments
| :: Text | |
| -> CreateScheduleGroup |
Create a value of CreateScheduleGroup with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:CreateScheduleGroup', createScheduleGroup_clientToken - 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.
CreateScheduleGroup, createScheduleGroup_tags - The list of tags to associate with the schedule group.
CreateScheduleGroup, createScheduleGroup_name - The name of the schedule group that you are creating.
data CreateScheduleGroupResponse Source #
See: newCreateScheduleGroupResponse smart constructor.
Constructors
| CreateScheduleGroupResponse' Int Text |
Instances
newCreateScheduleGroupResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> CreateScheduleGroupResponse |
Create a value of CreateScheduleGroupResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CreateScheduleGroupResponse', createScheduleGroupResponse_httpStatus - The response's http status code.
$sel:scheduleGroupArn:CreateScheduleGroupResponse', createScheduleGroupResponse_scheduleGroupArn - The Amazon Resource Name (ARN) of the schedule group.
DeleteSchedule
data DeleteSchedule Source #
See: newDeleteSchedule smart constructor.
Instances
Arguments
| :: Text | |
| -> DeleteSchedule |
Create a value of DeleteSchedule with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:DeleteSchedule', deleteSchedule_clientToken - 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.
DeleteSchedule, deleteSchedule_groupName - The name of the schedule group associated with this schedule. If you
omit this, the default schedule group is used.
DeleteSchedule, deleteSchedule_name - The name of the schedule to delete.
data DeleteScheduleResponse Source #
See: newDeleteScheduleResponse smart constructor.
Constructors
| DeleteScheduleResponse' Int |
Instances
newDeleteScheduleResponse Source #
Create a value of DeleteScheduleResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteScheduleResponse', deleteScheduleResponse_httpStatus - The response's http status code.
DeleteScheduleGroup
data DeleteScheduleGroup Source #
See: newDeleteScheduleGroup smart constructor.
Constructors
| DeleteScheduleGroup' (Maybe Text) Text |
Instances
newDeleteScheduleGroup Source #
Arguments
| :: Text | |
| -> DeleteScheduleGroup |
Create a value of DeleteScheduleGroup with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:DeleteScheduleGroup', deleteScheduleGroup_clientToken - 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.
DeleteScheduleGroup, deleteScheduleGroup_name - The name of the schedule group to delete.
data DeleteScheduleGroupResponse Source #
See: newDeleteScheduleGroupResponse smart constructor.
Constructors
| DeleteScheduleGroupResponse' Int |
Instances
newDeleteScheduleGroupResponse Source #
Create a value of DeleteScheduleGroupResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteScheduleGroupResponse', deleteScheduleGroupResponse_httpStatus - The response's http status code.
GetSchedule
data GetSchedule Source #
See: newGetSchedule smart constructor.
Constructors
| GetSchedule' (Maybe Text) Text |
Instances
Arguments
| :: Text | |
| -> GetSchedule |
Create a value of GetSchedule with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetSchedule, getSchedule_groupName - 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.
GetSchedule, getSchedule_name - The name of the schedule to retrieve.
data GetScheduleResponse Source #
See: newGetScheduleResponse smart constructor.
Constructors
| GetScheduleResponse' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe FlexibleTimeWindow) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe ScheduleState) (Maybe Target) Int |
Instances
newGetScheduleResponse Source #
Arguments
| :: Int | |
| -> GetScheduleResponse |
Create a value of GetScheduleResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetScheduleResponse, getScheduleResponse_arn - The Amazon Resource Name (ARN) of the schedule.
GetScheduleResponse, getScheduleResponse_creationDate - The time at which the schedule was created.
$sel:description:GetScheduleResponse', getScheduleResponse_description - The description of the schedule.
$sel:endDate:GetScheduleResponse', getScheduleResponse_endDate - 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.
$sel:flexibleTimeWindow:GetScheduleResponse', getScheduleResponse_flexibleTimeWindow - Allows you to configure a time window during which EventBridge Scheduler
invokes the schedule.
GetSchedule, getScheduleResponse_groupName - The name of the schedule group associated with this schedule.
$sel:kmsKeyArn:GetScheduleResponse', getScheduleResponse_kmsKeyArn - The ARN for a customer managed KMS Key that is be used to encrypt and
decrypt your data.
GetScheduleResponse, getScheduleResponse_lastModificationDate - The time at which the schedule was last modified.
GetSchedule, getScheduleResponse_name - The name of the schedule.
$sel:scheduleExpression:GetScheduleResponse', getScheduleResponse_scheduleExpression - The expression that defines when the schedule runs. The following
formats are supported.
atexpression -at(yyyy-mm-ddThh:mm:ss)rateexpression -rate(unit value)cronexpression -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.
$sel:scheduleExpressionTimezone:GetScheduleResponse', getScheduleResponse_scheduleExpressionTimezone - The timezone in which the scheduling expression is evaluated.
$sel:startDate:GetScheduleResponse', getScheduleResponse_startDate - 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.
GetScheduleResponse, getScheduleResponse_state - Specifies whether the schedule is enabled or disabled.
GetScheduleResponse, getScheduleResponse_target - The schedule target.
$sel:httpStatus:GetScheduleResponse', getScheduleResponse_httpStatus - The response's http status code.
GetScheduleGroup
data GetScheduleGroup Source #
See: newGetScheduleGroup smart constructor.
Constructors
| GetScheduleGroup' Text |
Instances
Arguments
| :: Text | |
| -> GetScheduleGroup |
Create a value of GetScheduleGroup with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetScheduleGroup, getScheduleGroup_name - The name of the schedule group to retrieve.
data GetScheduleGroupResponse Source #
See: newGetScheduleGroupResponse smart constructor.
Constructors
| GetScheduleGroupResponse' (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe ScheduleGroupState) Int |
Instances
newGetScheduleGroupResponse Source #
Create a value of GetScheduleGroupResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetScheduleGroupResponse, getScheduleGroupResponse_arn - The Amazon Resource Name (ARN) of the schedule group.
GetScheduleGroupResponse, getScheduleGroupResponse_creationDate - The time at which the schedule group was created.
GetScheduleGroupResponse, getScheduleGroupResponse_lastModificationDate - The time at which the schedule group was last modified.
GetScheduleGroup, getScheduleGroupResponse_name - The name of the schedule group.
GetScheduleGroupResponse, getScheduleGroupResponse_state - Specifies the state of the schedule group.
$sel:httpStatus:GetScheduleGroupResponse', getScheduleGroupResponse_httpStatus - The response's http status code.
ListScheduleGroups (Paginated)
data ListScheduleGroups Source #
See: newListScheduleGroups smart constructor.
Instances
newListScheduleGroups :: ListScheduleGroups Source #
Create a value of ListScheduleGroups with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListScheduleGroups', listScheduleGroups_maxResults - 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.
$sel:namePrefix:ListScheduleGroups', listScheduleGroups_namePrefix - The name prefix that you can use to return a filtered list of your
schedule groups.
ListScheduleGroups, listScheduleGroups_nextToken - The token returned by a previous call to retrieve the next set of
results.
data ListScheduleGroupsResponse Source #
See: newListScheduleGroupsResponse smart constructor.
Constructors
| ListScheduleGroupsResponse' (Maybe Text) Int [ScheduleGroupSummary] |
Instances
newListScheduleGroupsResponse Source #
Create a value of ListScheduleGroupsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListScheduleGroups, listScheduleGroupsResponse_nextToken - Indicates whether there are additional results to retrieve. If the value
is null, there are no more results.
$sel:httpStatus:ListScheduleGroupsResponse', listScheduleGroupsResponse_httpStatus - The response's http status code.
$sel:scheduleGroups:ListScheduleGroupsResponse', listScheduleGroupsResponse_scheduleGroups - The schedule groups that match the specified criteria.
ListSchedules (Paginated)
data ListSchedules Source #
See: newListSchedules smart constructor.
Constructors
| ListSchedules' (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe ScheduleState) |
Instances
newListSchedules :: ListSchedules Source #
Create a value of ListSchedules with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListSchedules, listSchedules_groupName - If specified, only lists the schedules whose associated schedule group
matches the given filter.
$sel:maxResults:ListSchedules', listSchedules_maxResults - 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.
$sel:namePrefix:ListSchedules', listSchedules_namePrefix - Schedule name prefix to return the filtered list of resources.
ListSchedules, listSchedules_nextToken - The token returned by a previous call to retrieve the next set of
results.
ListSchedules, listSchedules_state - If specified, only lists the schedules whose current state matches the
given filter.
data ListSchedulesResponse Source #
See: newListSchedulesResponse smart constructor.
Constructors
| ListSchedulesResponse' (Maybe Text) Int [ScheduleSummary] |
Instances
newListSchedulesResponse Source #
Create a value of ListSchedulesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListSchedules, listSchedulesResponse_nextToken - Indicates whether there are additional results to retrieve. If the value
is null, there are no more results.
$sel:httpStatus:ListSchedulesResponse', listSchedulesResponse_httpStatus - The response's http status code.
$sel:schedules:ListSchedulesResponse', listSchedulesResponse_schedules - The schedules that match the specified criteria.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource smart constructor.
Constructors
| ListTagsForResource' Text |
Instances
newListTagsForResource Source #
Arguments
| :: Text | |
| -> ListTagsForResource |
Create a value of ListTagsForResource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceArn:ListTagsForResource', listTagsForResource_resourceArn - The ARN of the EventBridge Scheduler resource for which you want to view
tags.
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse smart constructor.
Constructors
| ListTagsForResourceResponse' (Maybe [Tag]) Int |
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListTagsForResourceResponse, listTagsForResourceResponse_tags - The list of tags associated with the specified resource.
$sel:httpStatus:ListTagsForResourceResponse', listTagsForResourceResponse_httpStatus - The response's http status code.
TagResource
data TagResource Source #
See: newTagResource smart constructor.
Constructors
| TagResource' Text [Tag] |
Instances
Arguments
| :: Text | |
| -> TagResource |
Create a value of TagResource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceArn:TagResource', tagResource_resourceArn - The Amazon Resource Name (ARN) of the schedule group that you are adding
tags to.
TagResource, tagResource_tags - The list of tags to associate with the schedule group.
data TagResourceResponse Source #
See: newTagResourceResponse smart constructor.
Constructors
| TagResourceResponse' Int |
Instances
newTagResourceResponse Source #
Arguments
| :: Int | |
| -> TagResourceResponse |
Create a value of TagResourceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:TagResourceResponse', tagResourceResponse_httpStatus - The response's http status code.
UntagResource
data UntagResource Source #
See: newUntagResource smart constructor.
Constructors
| UntagResource' Text [Text] |
Instances
Arguments
| :: Text | |
| -> UntagResource |
Create a value of UntagResource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceArn:UntagResource', untagResource_resourceArn - The Amazon Resource Name (ARN) of the schedule group from which you are
removing tags.
$sel:tagKeys:UntagResource', untagResource_tagKeys - The list of tag keys to remove from the resource.
data UntagResourceResponse Source #
See: newUntagResourceResponse smart constructor.
Constructors
| UntagResourceResponse' Int |
Instances
newUntagResourceResponse Source #
Create a value of UntagResourceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UntagResourceResponse', untagResourceResponse_httpStatus - The response's http status code.
UpdateSchedule
data UpdateSchedule Source #
See: newUpdateSchedule smart constructor.
Constructors
| UpdateSchedule' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe ScheduleState) FlexibleTimeWindow Text Text Target |
Instances
Arguments
| :: FlexibleTimeWindow | |
| -> Text | |
| -> Text | |
| -> Target | |
| -> UpdateSchedule |
Create a value of UpdateSchedule with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:UpdateSchedule', updateSchedule_clientToken - 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.
$sel:description:UpdateSchedule', updateSchedule_description - The description you specify for the schedule.
$sel:endDate:UpdateSchedule', updateSchedule_endDate - 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.
UpdateSchedule, updateSchedule_groupName - 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.
$sel:kmsKeyArn:UpdateSchedule', updateSchedule_kmsKeyArn - The ARN for the customer managed KMS key that that you want EventBridge
Scheduler to use to encrypt and decrypt your data.
$sel:scheduleExpressionTimezone:UpdateSchedule', updateSchedule_scheduleExpressionTimezone - The timezone in which the scheduling expression is evaluated.
$sel:startDate:UpdateSchedule', updateSchedule_startDate - 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.
UpdateSchedule, updateSchedule_state - Specifies whether the schedule is enabled or disabled.
$sel:flexibleTimeWindow:UpdateSchedule', updateSchedule_flexibleTimeWindow - Allows you to configure a time window during which EventBridge Scheduler
invokes the schedule.
UpdateSchedule, updateSchedule_name - The name of the schedule that you are updating.
$sel:scheduleExpression:UpdateSchedule', updateSchedule_scheduleExpression - The expression that defines when the schedule runs. The following
formats are supported.
atexpression -at(yyyy-mm-ddThh:mm:ss)rateexpression -rate(unit value)cronexpression -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.
UpdateSchedule, updateSchedule_target - The schedule target. You can use this operation to change the target
that your schedule invokes.
data UpdateScheduleResponse Source #
See: newUpdateScheduleResponse smart constructor.
Constructors
| UpdateScheduleResponse' Int Text |
Instances
newUpdateScheduleResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> UpdateScheduleResponse |
Create a value of UpdateScheduleResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateScheduleResponse', updateScheduleResponse_httpStatus - The response's http status code.
$sel:scheduleArn:UpdateScheduleResponse', updateScheduleResponse_scheduleArn - The Amazon Resource Name (ARN) of the schedule that you updated.
Types
AssignPublicIp
newtype AssignPublicIp Source #
Constructors
| AssignPublicIp' | |
Fields | |
Bundled Patterns
| pattern AssignPublicIp_DISABLED :: AssignPublicIp | |
| pattern AssignPublicIp_ENABLED :: AssignPublicIp |
Instances
FlexibleTimeWindowMode
newtype FlexibleTimeWindowMode Source #
Constructors
| FlexibleTimeWindowMode' | |
Fields | |
Bundled Patterns
| pattern FlexibleTimeWindowMode_FLEXIBLE :: FlexibleTimeWindowMode | |
| pattern FlexibleTimeWindowMode_OFF :: FlexibleTimeWindowMode |
Instances
LaunchType
newtype LaunchType Source #
Constructors
| LaunchType' | |
Fields | |
Bundled Patterns
| pattern LaunchType_EC2 :: LaunchType | |
| pattern LaunchType_EXTERNAL :: LaunchType | |
| pattern LaunchType_FARGATE :: LaunchType |
Instances
PlacementConstraintType
newtype PlacementConstraintType Source #
Constructors
| PlacementConstraintType' | |
Fields | |
Bundled Patterns
| pattern PlacementConstraintType_DistinctInstance :: PlacementConstraintType | |
| pattern PlacementConstraintType_MemberOf :: PlacementConstraintType |
Instances
PlacementStrategyType
newtype PlacementStrategyType Source #
Constructors
| PlacementStrategyType' | |
Fields | |
Bundled Patterns
| pattern PlacementStrategyType_Binpack :: PlacementStrategyType | |
| pattern PlacementStrategyType_Random :: PlacementStrategyType | |
| pattern PlacementStrategyType_Spread :: PlacementStrategyType |
Instances
PropagateTags
newtype PropagateTags Source #
Constructors
| PropagateTags' | |
Fields | |
Bundled Patterns
| pattern PropagateTags_TASK_DEFINITION :: PropagateTags |
Instances
ScheduleGroupState
newtype ScheduleGroupState Source #
Constructors
| ScheduleGroupState' | |
Fields | |
Bundled Patterns
| pattern ScheduleGroupState_ACTIVE :: ScheduleGroupState | |
| pattern ScheduleGroupState_DELETING :: ScheduleGroupState |
Instances
ScheduleState
newtype ScheduleState Source #
Constructors
| ScheduleState' | |
Fields | |
Bundled Patterns
| pattern ScheduleState_DISABLED :: ScheduleState | |
| pattern ScheduleState_ENABLED :: ScheduleState |
Instances
AwsVpcConfiguration
data AwsVpcConfiguration Source #
This structure specifies the 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.
See: newAwsVpcConfiguration smart constructor.
Constructors
| AwsVpcConfiguration' (Maybe AssignPublicIp) (Maybe (NonEmpty Text)) (NonEmpty Text) |
Instances
newAwsVpcConfiguration Source #
Arguments
| :: NonEmpty Text | |
| -> AwsVpcConfiguration |
Create a value of AwsVpcConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:assignPublicIp:AwsVpcConfiguration', awsVpcConfiguration_assignPublicIp - 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.
$sel:securityGroups:AwsVpcConfiguration', awsVpcConfiguration_securityGroups - Specifies the security groups associated with the task. These security
groups must all be in the same VPC. You can specify as many as five
security groups. If you do not specify a security group, the default
security group for the VPC is used.
$sel:subnets:AwsVpcConfiguration', awsVpcConfiguration_subnets - Specifies the subnets associated with the task. These subnets must all
be in the same VPC. You can specify as many as 16 subnets.
CapacityProviderStrategyItem
data CapacityProviderStrategyItem Source #
The details of a capacity provider strategy.
See: newCapacityProviderStrategyItem smart constructor.
Instances
newCapacityProviderStrategyItem Source #
Create a value of CapacityProviderStrategyItem with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:base:CapacityProviderStrategyItem', capacityProviderStrategyItem_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.
$sel:weight:CapacityProviderStrategyItem', capacityProviderStrategyItem_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.
$sel:capacityProvider:CapacityProviderStrategyItem', capacityProviderStrategyItem_capacityProvider - The short name of the capacity provider.
DeadLetterConfig
data DeadLetterConfig Source #
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.
See: newDeadLetterConfig smart constructor.
Constructors
| DeadLetterConfig' (Maybe Text) |
Instances
newDeadLetterConfig :: DeadLetterConfig Source #
Create a value of DeadLetterConfig with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:DeadLetterConfig', deadLetterConfig_arn - The Amazon Resource Name (ARN) of the SQS queue specified as the
destination for the dead-letter queue.
EcsParameters
data EcsParameters Source #
The templated target type for the Amazon ECS RunTask API operation.
See: newEcsParameters smart constructor.
Constructors
| EcsParameters' (Maybe [CapacityProviderStrategyItem]) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe LaunchType) (Maybe NetworkConfiguration) (Maybe [PlacementConstraint]) (Maybe [PlacementStrategy]) (Maybe Text) (Maybe PropagateTags) (Maybe Text) (Maybe [HashMap Text Text]) (Maybe Natural) Text |
Instances
Arguments
| :: Text | |
| -> EcsParameters |
Create a value of EcsParameters with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:capacityProviderStrategy:EcsParameters', ecsParameters_capacityProviderStrategy - The capacity provider strategy to use for the task.
$sel:enableECSManagedTags:EcsParameters', ecsParameters_enableECSManagedTags - 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.
$sel:enableExecuteCommand:EcsParameters', ecsParameters_enableExecuteCommand - 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.
$sel:group':EcsParameters', ecsParameters_group - Specifies an ECS task group for the task. The maximum length is 255
characters.
$sel:launchType:EcsParameters', ecsParameters_launchType - 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.
$sel:networkConfiguration:EcsParameters', ecsParameters_networkConfiguration - This structure specifies the network configuration for an ECS task.
$sel:placementConstraints:EcsParameters', ecsParameters_placementConstraints - An array of placement constraint objects to use for the task. You can
specify up to 10 constraints per task (including constraints in the task
definition and those specified at runtime).
$sel:placementStrategy:EcsParameters', ecsParameters_placementStrategy - The task placement strategy for a task or service.
$sel:platformVersion:EcsParameters', ecsParameters_platformVersion - Specifies the platform version for the task. Specify only the numeric
portion of the platform version, such as 1.1.0.
$sel:propagateTags:EcsParameters', ecsParameters_propagateTags - 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.
$sel:referenceId:EcsParameters', ecsParameters_referenceId - The reference ID to use for the task.
$sel:tags:EcsParameters', ecsParameters_tags - The metadata that you apply to the task to help you categorize and
organize them. Each tag consists of a key and an optional value, both of
which you define. For more information, see
RunTask
in the Amazon ECS API Reference.
$sel:taskCount:EcsParameters', ecsParameters_taskCount - The number of tasks to create based on TaskDefinition. The default is
1.
$sel:taskDefinitionArn:EcsParameters', ecsParameters_taskDefinitionArn - The Amazon Resource Name (ARN) of the task definition to use if the
event target is an Amazon ECS task.
EventBridgeParameters
data EventBridgeParameters Source #
The templated target type for the EventBridge PutEvents API operation.
See: newEventBridgeParameters smart constructor.
Constructors
| EventBridgeParameters' Text Text |
Instances
newEventBridgeParameters Source #
Arguments
| :: Text | |
| -> Text | |
| -> EventBridgeParameters |
Create a value of EventBridgeParameters with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:detailType:EventBridgeParameters', eventBridgeParameters_detailType - A free-form string, with a maximum of 128 characters, used to decide
what fields to expect in the event detail.
$sel:source:EventBridgeParameters', eventBridgeParameters_source - The source of the event.
FlexibleTimeWindow
data FlexibleTimeWindow Source #
Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.
See: newFlexibleTimeWindow smart constructor.
Constructors
| FlexibleTimeWindow' (Maybe Natural) FlexibleTimeWindowMode |
Instances
newFlexibleTimeWindow Source #
Create a value of FlexibleTimeWindow with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maximumWindowInMinutes:FlexibleTimeWindow', flexibleTimeWindow_maximumWindowInMinutes - The maximum time window during which a schedule can be invoked.
$sel:mode:FlexibleTimeWindow', flexibleTimeWindow_mode - Determines whether the schedule is invoked within a flexible time
window.
KinesisParameters
data KinesisParameters Source #
The templated target type for the Amazon Kinesis PutRecord API operation.
See: newKinesisParameters smart constructor.
Constructors
| KinesisParameters' Text |
Instances
Arguments
| :: Text | |
| -> KinesisParameters |
Create a value of KinesisParameters with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:partitionKey:KinesisParameters', kinesisParameters_partitionKey - 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.
NetworkConfiguration
data NetworkConfiguration Source #
Specifies the network configuration for an ECS task.
See: newNetworkConfiguration smart constructor.
Constructors
| NetworkConfiguration' (Maybe AwsVpcConfiguration) |
Instances
newNetworkConfiguration :: NetworkConfiguration Source #
Create a value of NetworkConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:awsvpcConfiguration:NetworkConfiguration', networkConfiguration_awsvpcConfiguration - 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.
PlacementConstraint
data PlacementConstraint Source #
An object representing a constraint on task placement.
See: newPlacementConstraint smart constructor.
Constructors
| PlacementConstraint' (Maybe Text) (Maybe PlacementConstraintType) |
Instances
newPlacementConstraint :: PlacementConstraint Source #
Create a value of PlacementConstraint with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:expression:PlacementConstraint', placementConstraint_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.
$sel:type':PlacementConstraint', placementConstraint_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.
PlacementStrategy
data PlacementStrategy Source #
The task placement strategy for a task or service.
See: newPlacementStrategy smart constructor.
Constructors
| PlacementStrategy' (Maybe Text) (Maybe PlacementStrategyType) |
Instances
newPlacementStrategy :: PlacementStrategy Source #
Create a value of PlacementStrategy with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:field:PlacementStrategy', placementStrategy_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.
$sel:type':PlacementStrategy', placementStrategy_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).
RetryPolicy
data RetryPolicy Source #
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.
See: newRetryPolicy smart constructor.
Constructors
| RetryPolicy' (Maybe Natural) (Maybe Natural) |
Instances
newRetryPolicy :: RetryPolicy Source #
Create a value of RetryPolicy with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maximumEventAgeInSeconds:RetryPolicy', retryPolicy_maximumEventAgeInSeconds - The maximum amount of time, in seconds, to continue to make retry
attempts.
$sel:maximumRetryAttempts:RetryPolicy', retryPolicy_maximumRetryAttempts - 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.
SageMakerPipelineParameter
data SageMakerPipelineParameter Source #
The name and value pair of a parameter to use to start execution of a SageMaker Model Building Pipeline.
See: newSageMakerPipelineParameter smart constructor.
Constructors
| SageMakerPipelineParameter' Text Text |
Instances
newSageMakerPipelineParameter Source #
Arguments
| :: Text | |
| -> Text | |
| -> SageMakerPipelineParameter |
Create a value of SageMakerPipelineParameter with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:SageMakerPipelineParameter', sageMakerPipelineParameter_name - Name of parameter to start execution of a SageMaker Model Building
Pipeline.
$sel:value:SageMakerPipelineParameter', sageMakerPipelineParameter_value - Value of parameter to start execution of a SageMaker Model Building
Pipeline.
SageMakerPipelineParameters
data SageMakerPipelineParameters Source #
The templated target type for the Amazon SageMaker StartPipelineExecution API operation.
See: newSageMakerPipelineParameters smart constructor.
Constructors
| SageMakerPipelineParameters' (Maybe [SageMakerPipelineParameter]) |
Instances
newSageMakerPipelineParameters :: SageMakerPipelineParameters Source #
Create a value of SageMakerPipelineParameters with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:pipelineParameterList:SageMakerPipelineParameters', sageMakerPipelineParameters_pipelineParameterList - List of parameter names and values to use when executing the SageMaker
Model Building Pipeline.
ScheduleGroupSummary
data ScheduleGroupSummary Source #
The details of a schedule group.
See: newScheduleGroupSummary smart constructor.
Constructors
| ScheduleGroupSummary' (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe ScheduleGroupState) |
Instances
newScheduleGroupSummary :: ScheduleGroupSummary Source #
Create a value of ScheduleGroupSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:ScheduleGroupSummary', scheduleGroupSummary_arn - The Amazon Resource Name (ARN) of the schedule group.
$sel:creationDate:ScheduleGroupSummary', scheduleGroupSummary_creationDate - The time at which the schedule group was created.
$sel:lastModificationDate:ScheduleGroupSummary', scheduleGroupSummary_lastModificationDate - The time at which the schedule group was last modified.
$sel:name:ScheduleGroupSummary', scheduleGroupSummary_name - The name of the schedule group.
$sel:state:ScheduleGroupSummary', scheduleGroupSummary_state - Specifies the state of the schedule group.
ScheduleSummary
data ScheduleSummary Source #
The details of a schedule.
See: newScheduleSummary smart constructor.
Constructors
| ScheduleSummary' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe ScheduleState) (Maybe TargetSummary) |
Instances
newScheduleSummary :: ScheduleSummary Source #
Create a value of ScheduleSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ScheduleSummary, scheduleSummary_arn - The Amazon Resource Name (ARN) of the schedule.
$sel:creationDate:ScheduleSummary', scheduleSummary_creationDate - The time at which the schedule was created.
$sel:groupName:ScheduleSummary', scheduleSummary_groupName - The name of the schedule group associated with this schedule.
$sel:lastModificationDate:ScheduleSummary', scheduleSummary_lastModificationDate - The time at which the schedule was last modified.
$sel:name:ScheduleSummary', scheduleSummary_name - The name of the schedule.
$sel:state:ScheduleSummary', scheduleSummary_state - Specifies whether the schedule is enabled or disabled.
$sel:target:ScheduleSummary', scheduleSummary_target - The schedule's target details.
SqsParameters
data SqsParameters Source #
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.
See: newSqsParameters smart constructor.
Constructors
| SqsParameters' (Maybe Text) |
Instances
newSqsParameters :: SqsParameters Source #
Create a value of SqsParameters with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:messageGroupId:SqsParameters', sqsParameters_messageGroupId - The FIFO message group ID to use as the target.
Tag
Tag to associate with a schedule group.
See: newTag smart constructor.
Instances
| FromJSON Tag Source # | |
| ToJSON Tag Source # | |
Defined in Amazonka.Scheduler.Types.Tag | |
| Generic Tag Source # | |
| Read Tag Source # | |
| Show Tag Source # | |
| NFData Tag Source # | |
Defined in Amazonka.Scheduler.Types.Tag | |
| Eq Tag Source # | |
| Hashable Tag Source # | |
Defined in Amazonka.Scheduler.Types.Tag | |
| type Rep Tag Source # | |
Defined in Amazonka.Scheduler.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.Scheduler.Types.Tag" "amazonka-scheduler-2.0-8LKlva3Whvt7TpHIvtcn6a" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) | |
Create a value of Tag with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:key:Tag', tag_key - The key for the tag.
$sel:value:Tag', tag_value - The value for the tag.
Target
The schedule's target. EventBridge Scheduler supports templated target that invoke common API operations, as well as universal targets that you can customize to invoke over 6,000 API operations across more than 270 services. You can only specify one templated or universal target for a schedule.
See: newTarget smart constructor.
Constructors
Instances
Create a value of Target with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:deadLetterConfig:Target', target_deadLetterConfig - 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.
$sel:ecsParameters:Target', target_ecsParameters - The templated target type for the Amazon ECS
RunTask
API operation.
$sel:eventBridgeParameters:Target', target_eventBridgeParameters - The templated target type for the EventBridge
PutEvents
API operation.
$sel:input:Target', 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.
$sel:kinesisParameters:Target', target_kinesisParameters - The templated target type for the Amazon Kinesis
PutRecord API
operation.
$sel:retryPolicy:Target', target_retryPolicy - 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.
$sel:sageMakerPipelineParameters:Target', target_sageMakerPipelineParameters - The templated target type for the Amazon SageMaker
StartPipelineExecution
API operation.
$sel:sqsParameters:Target', target_sqsParameters - 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.
Target, target_arn - The Amazon Resource Name (ARN) of the target.
$sel:roleArn:Target', target_roleArn - The Amazon Resource Name (ARN) of the IAM role that EventBridge
Scheduler will use for this target when the schedule is invoked.
TargetSummary
data TargetSummary Source #
The details of a target.
See: newTargetSummary smart constructor.
Constructors
| TargetSummary' Text |
Instances
Arguments
| :: Text | |
| -> TargetSummary |
Create a value of TargetSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:TargetSummary', targetSummary_arn - The Amazon Resource Name (ARN) of the target.