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 |
- Service Configuration
- Errors
- 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
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
- 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' {}
- newAwsVpcConfiguration :: NonEmpty Text -> AwsVpcConfiguration
- awsVpcConfiguration_assignPublicIp :: Lens' AwsVpcConfiguration (Maybe AssignPublicIp)
- awsVpcConfiguration_securityGroups :: Lens' AwsVpcConfiguration (Maybe (NonEmpty Text))
- awsVpcConfiguration_subnets :: Lens' AwsVpcConfiguration (NonEmpty Text)
- data CapacityProviderStrategyItem = CapacityProviderStrategyItem' {}
- newCapacityProviderStrategyItem :: Text -> CapacityProviderStrategyItem
- capacityProviderStrategyItem_base :: Lens' CapacityProviderStrategyItem (Maybe Natural)
- capacityProviderStrategyItem_weight :: Lens' CapacityProviderStrategyItem (Maybe Natural)
- capacityProviderStrategyItem_capacityProvider :: Lens' CapacityProviderStrategyItem Text
- data DeadLetterConfig = DeadLetterConfig' {}
- newDeadLetterConfig :: DeadLetterConfig
- deadLetterConfig_arn :: Lens' DeadLetterConfig (Maybe Text)
- data EcsParameters = EcsParameters' {
- capacityProviderStrategy :: Maybe [CapacityProviderStrategyItem]
- enableECSManagedTags :: Maybe Bool
- enableExecuteCommand :: Maybe Bool
- group' :: Maybe Text
- launchType :: Maybe LaunchType
- networkConfiguration :: Maybe NetworkConfiguration
- placementConstraints :: Maybe [PlacementConstraint]
- placementStrategy :: Maybe [PlacementStrategy]
- platformVersion :: Maybe Text
- propagateTags :: Maybe PropagateTags
- referenceId :: Maybe Text
- tags :: Maybe [HashMap Text Text]
- taskCount :: Maybe Natural
- taskDefinitionArn :: Text
- newEcsParameters :: Text -> EcsParameters
- ecsParameters_capacityProviderStrategy :: Lens' EcsParameters (Maybe [CapacityProviderStrategyItem])
- ecsParameters_enableECSManagedTags :: Lens' EcsParameters (Maybe Bool)
- ecsParameters_enableExecuteCommand :: Lens' EcsParameters (Maybe Bool)
- ecsParameters_group :: Lens' EcsParameters (Maybe Text)
- ecsParameters_launchType :: Lens' EcsParameters (Maybe LaunchType)
- ecsParameters_networkConfiguration :: Lens' EcsParameters (Maybe NetworkConfiguration)
- ecsParameters_placementConstraints :: Lens' EcsParameters (Maybe [PlacementConstraint])
- ecsParameters_placementStrategy :: Lens' EcsParameters (Maybe [PlacementStrategy])
- ecsParameters_platformVersion :: Lens' EcsParameters (Maybe Text)
- ecsParameters_propagateTags :: Lens' EcsParameters (Maybe PropagateTags)
- ecsParameters_referenceId :: Lens' EcsParameters (Maybe Text)
- ecsParameters_tags :: Lens' EcsParameters (Maybe [HashMap Text Text])
- ecsParameters_taskCount :: Lens' EcsParameters (Maybe Natural)
- ecsParameters_taskDefinitionArn :: Lens' EcsParameters Text
- data EventBridgeParameters = EventBridgeParameters' {
- detailType :: Text
- source :: Text
- newEventBridgeParameters :: Text -> Text -> EventBridgeParameters
- eventBridgeParameters_detailType :: Lens' EventBridgeParameters Text
- eventBridgeParameters_source :: Lens' EventBridgeParameters Text
- data FlexibleTimeWindow = FlexibleTimeWindow' {}
- newFlexibleTimeWindow :: FlexibleTimeWindowMode -> FlexibleTimeWindow
- flexibleTimeWindow_maximumWindowInMinutes :: Lens' FlexibleTimeWindow (Maybe Natural)
- flexibleTimeWindow_mode :: Lens' FlexibleTimeWindow FlexibleTimeWindowMode
- data KinesisParameters = KinesisParameters' {
- partitionKey :: Text
- newKinesisParameters :: Text -> KinesisParameters
- kinesisParameters_partitionKey :: Lens' KinesisParameters Text
- data NetworkConfiguration = NetworkConfiguration' {}
- newNetworkConfiguration :: NetworkConfiguration
- networkConfiguration_awsvpcConfiguration :: Lens' NetworkConfiguration (Maybe AwsVpcConfiguration)
- data PlacementConstraint = PlacementConstraint' {}
- newPlacementConstraint :: PlacementConstraint
- placementConstraint_expression :: Lens' PlacementConstraint (Maybe Text)
- placementConstraint_type :: Lens' PlacementConstraint (Maybe PlacementConstraintType)
- data PlacementStrategy = PlacementStrategy' {}
- newPlacementStrategy :: PlacementStrategy
- placementStrategy_field :: Lens' PlacementStrategy (Maybe Text)
- placementStrategy_type :: Lens' PlacementStrategy (Maybe PlacementStrategyType)
- data RetryPolicy = RetryPolicy' {}
- newRetryPolicy :: RetryPolicy
- retryPolicy_maximumEventAgeInSeconds :: Lens' RetryPolicy (Maybe Natural)
- retryPolicy_maximumRetryAttempts :: Lens' RetryPolicy (Maybe Natural)
- data SageMakerPipelineParameter = SageMakerPipelineParameter' {}
- newSageMakerPipelineParameter :: Text -> Text -> SageMakerPipelineParameter
- sageMakerPipelineParameter_name :: Lens' SageMakerPipelineParameter Text
- sageMakerPipelineParameter_value :: Lens' SageMakerPipelineParameter Text
- data SageMakerPipelineParameters = SageMakerPipelineParameters' {}
- newSageMakerPipelineParameters :: SageMakerPipelineParameters
- sageMakerPipelineParameters_pipelineParameterList :: Lens' SageMakerPipelineParameters (Maybe [SageMakerPipelineParameter])
- data ScheduleGroupSummary = ScheduleGroupSummary' {}
- newScheduleGroupSummary :: ScheduleGroupSummary
- scheduleGroupSummary_arn :: Lens' ScheduleGroupSummary (Maybe Text)
- scheduleGroupSummary_creationDate :: Lens' ScheduleGroupSummary (Maybe UTCTime)
- scheduleGroupSummary_lastModificationDate :: Lens' ScheduleGroupSummary (Maybe UTCTime)
- scheduleGroupSummary_name :: Lens' ScheduleGroupSummary (Maybe Text)
- scheduleGroupSummary_state :: Lens' ScheduleGroupSummary (Maybe ScheduleGroupState)
- data ScheduleSummary = ScheduleSummary' {}
- newScheduleSummary :: ScheduleSummary
- scheduleSummary_arn :: Lens' ScheduleSummary (Maybe Text)
- scheduleSummary_creationDate :: Lens' ScheduleSummary (Maybe UTCTime)
- scheduleSummary_groupName :: Lens' ScheduleSummary (Maybe Text)
- scheduleSummary_lastModificationDate :: Lens' ScheduleSummary (Maybe UTCTime)
- scheduleSummary_name :: Lens' ScheduleSummary (Maybe Text)
- scheduleSummary_state :: Lens' ScheduleSummary (Maybe ScheduleState)
- scheduleSummary_target :: Lens' ScheduleSummary (Maybe TargetSummary)
- data SqsParameters = SqsParameters' {}
- newSqsParameters :: SqsParameters
- sqsParameters_messageGroupId :: Lens' SqsParameters (Maybe Text)
- data Tag = Tag' {}
- newTag :: Text -> Text -> Tag
- tag_key :: Lens' Tag Text
- tag_value :: Lens' Tag Text
- data Target = Target' {
- deadLetterConfig :: Maybe DeadLetterConfig
- ecsParameters :: Maybe EcsParameters
- eventBridgeParameters :: Maybe EventBridgeParameters
- input :: Maybe Text
- kinesisParameters :: Maybe KinesisParameters
- retryPolicy :: Maybe RetryPolicy
- sageMakerPipelineParameters :: Maybe SageMakerPipelineParameters
- sqsParameters :: Maybe SqsParameters
- arn :: Text
- roleArn :: Text
- newTarget :: Text -> Text -> Target
- target_deadLetterConfig :: Lens' Target (Maybe DeadLetterConfig)
- target_ecsParameters :: Lens' Target (Maybe EcsParameters)
- target_eventBridgeParameters :: Lens' Target (Maybe EventBridgeParameters)
- target_input :: Lens' Target (Maybe Text)
- target_kinesisParameters :: Lens' Target (Maybe KinesisParameters)
- target_retryPolicy :: Lens' Target (Maybe RetryPolicy)
- target_sageMakerPipelineParameters :: Lens' Target (Maybe SageMakerPipelineParameters)
- target_sqsParameters :: Lens' Target (Maybe SqsParameters)
- target_arn :: Lens' Target Text
- target_roleArn :: Lens' Target Text
- data TargetSummary = TargetSummary' {}
- newTargetSummary :: Text -> TargetSummary
- targetSummary_arn :: Lens' TargetSummary Text
Service Configuration
defaultService :: Service Source #
API version 2021-06-30
of the Amazon EventBridge Scheduler SDK configuration.
Errors
_ConflictException :: AsError a => Fold a ServiceError Source #
Updating or deleting the resource can cause an inconsistent state.
_InternalServerException :: AsError a => Fold a ServiceError Source #
Unexpected error encountered while processing the request.
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
The request references a resource which does not exist.
_ServiceQuotaExceededException :: AsError a => Fold a ServiceError Source #
The request exceeds a service quota.
_ThrottlingException :: AsError a => Fold a ServiceError Source #
The request was denied due to request throttling.
_ValidationException :: AsError a => Fold a ServiceError Source #
The input fails to satisfy the constraints specified by an AWS service.
AssignPublicIp
newtype AssignPublicIp Source #
pattern AssignPublicIp_DISABLED :: AssignPublicIp | |
pattern AssignPublicIp_ENABLED :: AssignPublicIp |
Instances
FlexibleTimeWindowMode
newtype FlexibleTimeWindowMode Source #
pattern FlexibleTimeWindowMode_FLEXIBLE :: FlexibleTimeWindowMode | |
pattern FlexibleTimeWindowMode_OFF :: FlexibleTimeWindowMode |
Instances
LaunchType
newtype LaunchType Source #
pattern LaunchType_EC2 :: LaunchType | |
pattern LaunchType_EXTERNAL :: LaunchType | |
pattern LaunchType_FARGATE :: LaunchType |
Instances
PlacementConstraintType
newtype PlacementConstraintType Source #
pattern PlacementConstraintType_DistinctInstance :: PlacementConstraintType | |
pattern PlacementConstraintType_MemberOf :: PlacementConstraintType |
Instances
PlacementStrategyType
newtype PlacementStrategyType Source #
pattern PlacementStrategyType_Binpack :: PlacementStrategyType | |
pattern PlacementStrategyType_Random :: PlacementStrategyType | |
pattern PlacementStrategyType_Spread :: PlacementStrategyType |
Instances
PropagateTags
newtype PropagateTags Source #
pattern PropagateTags_TASK_DEFINITION :: PropagateTags |
Instances
ScheduleGroupState
newtype ScheduleGroupState Source #
pattern ScheduleGroupState_ACTIVE :: ScheduleGroupState | |
pattern ScheduleGroupState_DELETING :: ScheduleGroupState |
Instances
ScheduleState
newtype ScheduleState Source #
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.
AwsVpcConfiguration' | |
|
Instances
newAwsVpcConfiguration Source #
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.
awsVpcConfiguration_assignPublicIp :: Lens' AwsVpcConfiguration (Maybe AssignPublicIp) Source #
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
.
awsVpcConfiguration_securityGroups :: Lens' AwsVpcConfiguration (Maybe (NonEmpty Text)) Source #
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.
awsVpcConfiguration_subnets :: Lens' AwsVpcConfiguration (NonEmpty Text) Source #
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.
CapacityProviderStrategyItem' | |
|
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.
capacityProviderStrategyItem_base :: Lens' CapacityProviderStrategyItem (Maybe Natural) Source #
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.
capacityProviderStrategyItem_weight :: Lens' CapacityProviderStrategyItem (Maybe Natural) Source #
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.
capacityProviderStrategyItem_capacityProvider :: Lens' CapacityProviderStrategyItem Text Source #
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.
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.
deadLetterConfig_arn :: Lens' DeadLetterConfig (Maybe Text) Source #
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.
EcsParameters' | |
|
Instances
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.
ecsParameters_capacityProviderStrategy :: Lens' EcsParameters (Maybe [CapacityProviderStrategyItem]) Source #
The capacity provider strategy to use for the task.
ecsParameters_enableECSManagedTags :: Lens' EcsParameters (Maybe Bool) Source #
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.
ecsParameters_enableExecuteCommand :: Lens' EcsParameters (Maybe Bool) Source #
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.
ecsParameters_group :: Lens' EcsParameters (Maybe Text) Source #
Specifies an ECS task group for the task. The maximum length is 255 characters.
ecsParameters_launchType :: Lens' EcsParameters (Maybe LaunchType) Source #
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.
ecsParameters_networkConfiguration :: Lens' EcsParameters (Maybe NetworkConfiguration) Source #
This structure specifies the network configuration for an ECS task.
ecsParameters_placementConstraints :: Lens' EcsParameters (Maybe [PlacementConstraint]) Source #
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).
ecsParameters_placementStrategy :: Lens' EcsParameters (Maybe [PlacementStrategy]) Source #
The task placement strategy for a task or service.
ecsParameters_platformVersion :: Lens' EcsParameters (Maybe Text) Source #
Specifies the platform version for the task. Specify only the numeric
portion of the platform version, such as 1.1.0
.
ecsParameters_propagateTags :: Lens' EcsParameters (Maybe PropagateTags) Source #
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.
ecsParameters_referenceId :: Lens' EcsParameters (Maybe Text) Source #
The reference ID to use for the task.
ecsParameters_tags :: Lens' EcsParameters (Maybe [HashMap Text Text]) Source #
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.
ecsParameters_taskCount :: Lens' EcsParameters (Maybe Natural) Source #
The number of tasks to create based on TaskDefinition
. The default is
1
.
ecsParameters_taskDefinitionArn :: Lens' EcsParameters Text Source #
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.
EventBridgeParameters' | |
|
Instances
newEventBridgeParameters Source #
:: 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.
eventBridgeParameters_detailType :: Lens' EventBridgeParameters Text Source #
A free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail.
eventBridgeParameters_source :: Lens' EventBridgeParameters Text 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.
FlexibleTimeWindow' | |
|
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.
flexibleTimeWindow_maximumWindowInMinutes :: Lens' FlexibleTimeWindow (Maybe Natural) Source #
The maximum time window during which a schedule can be invoked.
flexibleTimeWindow_mode :: Lens' FlexibleTimeWindow FlexibleTimeWindowMode Source #
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.
KinesisParameters' | |
|
Instances
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.
kinesisParameters_partitionKey :: Lens' KinesisParameters Text Source #
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.
NetworkConfiguration' | |
|
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.
networkConfiguration_awsvpcConfiguration :: Lens' NetworkConfiguration (Maybe AwsVpcConfiguration) Source #
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.
PlacementConstraint' | |
|
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.
placementConstraint_expression :: Lens' PlacementConstraint (Maybe Text) Source #
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.
placementConstraint_type :: Lens' PlacementConstraint (Maybe PlacementConstraintType) Source #
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.
PlacementStrategy' | |
|
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).
placementStrategy_field :: Lens' PlacementStrategy (Maybe Text) Source #
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.
placementStrategy_type :: Lens' PlacementStrategy (Maybe PlacementStrategyType) Source #
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.
RetryPolicy' | |
|
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.
retryPolicy_maximumEventAgeInSeconds :: Lens' RetryPolicy (Maybe Natural) Source #
The maximum amount of time, in seconds, to continue to make retry attempts.
retryPolicy_maximumRetryAttempts :: Lens' RetryPolicy (Maybe Natural) Source #
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.
Instances
newSageMakerPipelineParameter Source #
:: 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.
sageMakerPipelineParameter_name :: Lens' SageMakerPipelineParameter Text Source #
Name of parameter to start execution of a SageMaker Model Building Pipeline.
sageMakerPipelineParameter_value :: Lens' SageMakerPipelineParameter Text Source #
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.
SageMakerPipelineParameters' | |
|
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.
sageMakerPipelineParameters_pipelineParameterList :: Lens' SageMakerPipelineParameters (Maybe [SageMakerPipelineParameter]) Source #
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.
ScheduleGroupSummary' | |
|
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.
scheduleGroupSummary_arn :: Lens' ScheduleGroupSummary (Maybe Text) Source #
The Amazon Resource Name (ARN) of the schedule group.
scheduleGroupSummary_creationDate :: Lens' ScheduleGroupSummary (Maybe UTCTime) Source #
The time at which the schedule group was created.
scheduleGroupSummary_lastModificationDate :: Lens' ScheduleGroupSummary (Maybe UTCTime) Source #
The time at which the schedule group was last modified.
scheduleGroupSummary_name :: Lens' ScheduleGroupSummary (Maybe Text) Source #
The name of the schedule group.
scheduleGroupSummary_state :: Lens' ScheduleGroupSummary (Maybe ScheduleGroupState) Source #
Specifies the state of the schedule group.
ScheduleSummary
data ScheduleSummary Source #
The details of a schedule.
See: newScheduleSummary
smart constructor.
ScheduleSummary' | |
|
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.
scheduleSummary_arn :: Lens' ScheduleSummary (Maybe Text) Source #
The Amazon Resource Name (ARN) of the schedule.
scheduleSummary_creationDate :: Lens' ScheduleSummary (Maybe UTCTime) Source #
The time at which the schedule was created.
scheduleSummary_groupName :: Lens' ScheduleSummary (Maybe Text) Source #
The name of the schedule group associated with this schedule.
scheduleSummary_lastModificationDate :: Lens' ScheduleSummary (Maybe UTCTime) Source #
The time at which the schedule was last modified.
scheduleSummary_name :: Lens' ScheduleSummary (Maybe Text) Source #
The name of the schedule.
scheduleSummary_state :: Lens' ScheduleSummary (Maybe ScheduleState) Source #
Specifies whether the schedule is enabled or disabled.
scheduleSummary_target :: Lens' ScheduleSummary (Maybe TargetSummary) Source #
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.
SqsParameters' | |
|
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.
sqsParameters_messageGroupId :: Lens' SqsParameters (Maybe Text) Source #
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.
Target' | |
|
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.
target_deadLetterConfig :: Lens' Target (Maybe 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.
target_ecsParameters :: Lens' Target (Maybe EcsParameters) Source #
The templated target type for the Amazon ECS RunTask API operation.
target_eventBridgeParameters :: Lens' Target (Maybe EventBridgeParameters) Source #
The templated target type for the EventBridge PutEvents API operation.
target_input :: Lens' Target (Maybe Text) Source #
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_kinesisParameters :: Lens' Target (Maybe KinesisParameters) Source #
The templated target type for the Amazon Kinesis PutRecord API operation.
target_retryPolicy :: Lens' Target (Maybe 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.
target_sageMakerPipelineParameters :: Lens' Target (Maybe SageMakerPipelineParameters) Source #
The templated target type for the Amazon SageMaker StartPipelineExecution API operation.
target_sqsParameters :: Lens' Target (Maybe 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.
target_roleArn :: Lens' Target Text Source #
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.
Instances
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.
targetSummary_arn :: Lens' TargetSummary Text Source #
The Amazon Resource Name (ARN) of the target.