| Copyright | (c) 2013-2018 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.AWS.CloudWatchEvents.Types
Contents
Description
Synopsis
- cloudWatchEvents :: Service
- _PolicyLengthExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _ConcurrentModificationException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidEventPatternException :: AsError a => Getting (First ServiceError) a ServiceError
- _InternalException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- data RuleState
- data BatchArrayProperties
- batchArrayProperties :: BatchArrayProperties
- bapSize :: Lens' BatchArrayProperties (Maybe Int)
- data BatchParameters
- batchParameters :: Text -> Text -> BatchParameters
- bpRetryStrategy :: Lens' BatchParameters (Maybe BatchRetryStrategy)
- bpArrayProperties :: Lens' BatchParameters (Maybe BatchArrayProperties)
- bpJobDefinition :: Lens' BatchParameters Text
- bpJobName :: Lens' BatchParameters Text
- data BatchRetryStrategy
- batchRetryStrategy :: BatchRetryStrategy
- brsAttempts :: Lens' BatchRetryStrategy (Maybe Int)
- data EcsParameters
- ecsParameters :: Text -> EcsParameters
- epTaskCount :: Lens' EcsParameters (Maybe Natural)
- epTaskDefinitionARN :: Lens' EcsParameters Text
- data InputTransformer
- inputTransformer :: Text -> InputTransformer
- itInputPathsMap :: Lens' InputTransformer (HashMap Text Text)
- itInputTemplate :: Lens' InputTransformer Text
- data KinesisParameters
- kinesisParameters :: Text -> KinesisParameters
- kpPartitionKeyPath :: Lens' KinesisParameters Text
- data PutEventsRequestEntry
- putEventsRequestEntry :: PutEventsRequestEntry
- pereTime :: Lens' PutEventsRequestEntry (Maybe UTCTime)
- pereDetailType :: Lens' PutEventsRequestEntry (Maybe Text)
- pereResources :: Lens' PutEventsRequestEntry [Text]
- pereSource :: Lens' PutEventsRequestEntry (Maybe Text)
- pereDetail :: Lens' PutEventsRequestEntry (Maybe Text)
- data PutEventsResultEntry
- putEventsResultEntry :: PutEventsResultEntry
- pereErrorCode :: Lens' PutEventsResultEntry (Maybe Text)
- pereErrorMessage :: Lens' PutEventsResultEntry (Maybe Text)
- pereEventId :: Lens' PutEventsResultEntry (Maybe Text)
- data PutTargetsResultEntry
- putTargetsResultEntry :: PutTargetsResultEntry
- ptreTargetId :: Lens' PutTargetsResultEntry (Maybe Text)
- ptreErrorCode :: Lens' PutTargetsResultEntry (Maybe Text)
- ptreErrorMessage :: Lens' PutTargetsResultEntry (Maybe Text)
- data RemoveTargetsResultEntry
- removeTargetsResultEntry :: RemoveTargetsResultEntry
- rtreTargetId :: Lens' RemoveTargetsResultEntry (Maybe Text)
- rtreErrorCode :: Lens' RemoveTargetsResultEntry (Maybe Text)
- rtreErrorMessage :: Lens' RemoveTargetsResultEntry (Maybe Text)
- data Rule
- rule :: Rule
- rEventPattern :: Lens' Rule (Maybe Text)
- rState :: Lens' Rule (Maybe RuleState)
- rARN :: Lens' Rule (Maybe Text)
- rScheduleExpression :: Lens' Rule (Maybe Text)
- rName :: Lens' Rule (Maybe Text)
- rDescription :: Lens' Rule (Maybe Text)
- rRoleARN :: Lens' Rule (Maybe Text)
- data RunCommandParameters
- runCommandParameters :: NonEmpty RunCommandTarget -> RunCommandParameters
- rcpRunCommandTargets :: Lens' RunCommandParameters (NonEmpty RunCommandTarget)
- data RunCommandTarget
- runCommandTarget :: Text -> NonEmpty Text -> RunCommandTarget
- rctKey :: Lens' RunCommandTarget Text
- rctValues :: Lens' RunCommandTarget (NonEmpty Text)
- data SqsParameters
- sqsParameters :: SqsParameters
- spMessageGroupId :: Lens' SqsParameters (Maybe Text)
- data Target
- target :: Text -> Text -> Target
- tRunCommandParameters :: Lens' Target (Maybe RunCommandParameters)
- tKinesisParameters :: Lens' Target (Maybe KinesisParameters)
- tInputTransformer :: Lens' Target (Maybe InputTransformer)
- tSqsParameters :: Lens' Target (Maybe SqsParameters)
- tInput :: Lens' Target (Maybe Text)
- tBatchParameters :: Lens' Target (Maybe BatchParameters)
- tEcsParameters :: Lens' Target (Maybe EcsParameters)
- tInputPath :: Lens' Target (Maybe Text)
- tRoleARN :: Lens' Target (Maybe Text)
- tId :: Lens' Target Text
- tARN :: Lens' Target Text
Service Configuration
API version 2015-10-07 of the Amazon CloudWatch Events SDK configuration.
Errors
_PolicyLengthExceededException :: AsError a => Getting (First ServiceError) a ServiceError #
The event bus policy is too long. For more information, see the limits.
_ConcurrentModificationException :: AsError a => Getting (First ServiceError) a ServiceError #
There is concurrent modification on a rule or target.
_InvalidEventPatternException :: AsError a => Getting (First ServiceError) a ServiceError #
The event pattern is not valid.
_InternalException :: AsError a => Getting (First ServiceError) a ServiceError #
This exception occurs due to unexpected causes.
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError #
An entity that you specified does not exist.
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError #
You tried to create more rules or add more targets to a rule than is allowed.
RuleState
Instances
BatchArrayProperties
data BatchArrayProperties #
The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. This parameter is used only if the target is an AWS Batch job.
See: batchArrayProperties smart constructor.
Instances
batchArrayProperties :: BatchArrayProperties #
Creates a value of BatchArrayProperties with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
bapSize- The size of the array, if this is an array batch job. Valid values are integers between 2 and 10,000.
bapSize :: Lens' BatchArrayProperties (Maybe Int) #
The size of the array, if this is an array batch job. Valid values are integers between 2 and 10,000.
BatchParameters
data BatchParameters #
The custom parameters to be used when the target is an AWS Batch job.
See: batchParameters smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> BatchParameters |
Creates a value of BatchParameters with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
bpRetryStrategy- The retry strategy to use for failed jobs, if the target is an AWS Batch job. The retry strategy is the number of times to retry the failed job execution. Valid values are 1 to 10. When you specify a retry strategy here, it overrides the retry strategy defined in the job definition.bpArrayProperties- The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. This parameter is used only if the target is an AWS Batch job.bpJobDefinition- The ARN or name of the job definition to use if the event target is an AWS Batch job. This job definition must already exist.bpJobName- The name to use for this execution of the job, if the target is an AWS Batch job.
bpRetryStrategy :: Lens' BatchParameters (Maybe BatchRetryStrategy) #
The retry strategy to use for failed jobs, if the target is an AWS Batch job. The retry strategy is the number of times to retry the failed job execution. Valid values are 1 to 10. When you specify a retry strategy here, it overrides the retry strategy defined in the job definition.
bpArrayProperties :: Lens' BatchParameters (Maybe BatchArrayProperties) #
The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. This parameter is used only if the target is an AWS Batch job.
bpJobDefinition :: Lens' BatchParameters Text #
The ARN or name of the job definition to use if the event target is an AWS Batch job. This job definition must already exist.
bpJobName :: Lens' BatchParameters Text #
The name to use for this execution of the job, if the target is an AWS Batch job.
BatchRetryStrategy
data BatchRetryStrategy #
The retry strategy to use for failed jobs, if the target is an AWS Batch job. If you specify a retry strategy here, it overrides the retry strategy defined in the job definition.
See: batchRetryStrategy smart constructor.
Instances
batchRetryStrategy :: BatchRetryStrategy #
Creates a value of BatchRetryStrategy with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
brsAttempts- The number of times to attempt to retry, if the job fails. Valid values are 1 to 10.
brsAttempts :: Lens' BatchRetryStrategy (Maybe Int) #
The number of times to attempt to retry, if the job fails. Valid values are 1 to 10.
EcsParameters
data EcsParameters #
The custom parameters to be used when the target is an Amazon ECS cluster.
See: ecsParameters smart constructor.
Instances
Arguments
| :: Text | |
| -> EcsParameters |
Creates a value of EcsParameters with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
epTaskCount- The number of tasks to create based on theTaskDefinition. The default is one.epTaskDefinitionARN- The ARN of the task definition to use if the event target is an Amazon ECS cluster.
epTaskCount :: Lens' EcsParameters (Maybe Natural) #
The number of tasks to create based on the TaskDefinition . The default is one.
epTaskDefinitionARN :: Lens' EcsParameters Text #
The ARN of the task definition to use if the event target is an Amazon ECS cluster.
InputTransformer
data InputTransformer #
Contains the parameters needed for you to provide custom input to a target based on one or more pieces of data extracted from the event.
See: inputTransformer smart constructor.
Instances
Arguments
| :: Text | |
| -> InputTransformer |
Creates a value of InputTransformer with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
itInputPathsMap- Map of JSON paths to be extracted from the event. These are key-value pairs, where each value is a JSON path. You must use JSON dot notation, not bracket notation.itInputTemplate- Input template where you can use the values of the keys fromInputPathsMapto customize the data sent to the target.
itInputPathsMap :: Lens' InputTransformer (HashMap Text Text) #
Map of JSON paths to be extracted from the event. These are key-value pairs, where each value is a JSON path. You must use JSON dot notation, not bracket notation.
itInputTemplate :: Lens' InputTransformer Text #
Input template where you can use the values of the keys from InputPathsMap to customize the data sent to the target.
KinesisParameters
data KinesisParameters #
This object enables you to specify a JSON path to extract from the event and use as the partition key for the Amazon Kinesis stream, so that you can control the shard to which the event goes. If you do not include this parameter, the default is to use the eventId as the partition key.
See: kinesisParameters smart constructor.
Instances
Arguments
| :: Text | |
| -> KinesisParameters |
Creates a value of KinesisParameters with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
kpPartitionKeyPath- The JSON path to be extracted from the event and used as the partition key. For more information, see Amazon Kinesis Streams Key Concepts in the Amazon Kinesis Streams Developer Guide .
kpPartitionKeyPath :: Lens' KinesisParameters Text #
The JSON path to be extracted from the event and used as the partition key. For more information, see Amazon Kinesis Streams Key Concepts in the Amazon Kinesis Streams Developer Guide .
PutEventsRequestEntry
data PutEventsRequestEntry #
Represents an event to be submitted.
See: putEventsRequestEntry smart constructor.
Instances
putEventsRequestEntry :: PutEventsRequestEntry #
Creates a value of PutEventsRequestEntry with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pereTime- The timestamp of the event, per RFC3339 . If no timestamp is provided, the timestamp of thePutEventscall is used.pereDetailType- Free-form string used to decide what fields to expect in the event detail.pereResources- AWS resources, identified by Amazon Resource Name (ARN), which the event primarily concerns. Any number, including zero, may be present.pereSource- The source of the event.pereDetail- A valid JSON string. There is no other schema imposed. The JSON string may contain fields and nested subobjects.
pereTime :: Lens' PutEventsRequestEntry (Maybe UTCTime) #
The timestamp of the event, per RFC3339 . If no timestamp is provided, the timestamp of the PutEvents call is used.
pereDetailType :: Lens' PutEventsRequestEntry (Maybe Text) #
Free-form string used to decide what fields to expect in the event detail.
pereResources :: Lens' PutEventsRequestEntry [Text] #
AWS resources, identified by Amazon Resource Name (ARN), which the event primarily concerns. Any number, including zero, may be present.
pereSource :: Lens' PutEventsRequestEntry (Maybe Text) #
The source of the event.
pereDetail :: Lens' PutEventsRequestEntry (Maybe Text) #
A valid JSON string. There is no other schema imposed. The JSON string may contain fields and nested subobjects.
PutEventsResultEntry
data PutEventsResultEntry #
Represents an event that failed to be submitted.
See: putEventsResultEntry smart constructor.
Instances
putEventsResultEntry :: PutEventsResultEntry #
Creates a value of PutEventsResultEntry with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pereErrorCode- The error code that indicates why the event submission failed.pereErrorMessage- The error message that explains why the event submission failed.pereEventId- The ID of the event.
pereErrorCode :: Lens' PutEventsResultEntry (Maybe Text) #
The error code that indicates why the event submission failed.
pereErrorMessage :: Lens' PutEventsResultEntry (Maybe Text) #
The error message that explains why the event submission failed.
pereEventId :: Lens' PutEventsResultEntry (Maybe Text) #
The ID of the event.
PutTargetsResultEntry
data PutTargetsResultEntry #
Represents a target that failed to be added to a rule.
See: putTargetsResultEntry smart constructor.
Instances
putTargetsResultEntry :: PutTargetsResultEntry #
Creates a value of PutTargetsResultEntry with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ptreTargetId- The ID of the target.ptreErrorCode- The error code that indicates why the target addition failed. If the value isConcurrentModificationException, too many requests were made at the same time.ptreErrorMessage- The error message that explains why the target addition failed.
ptreTargetId :: Lens' PutTargetsResultEntry (Maybe Text) #
The ID of the target.
ptreErrorCode :: Lens' PutTargetsResultEntry (Maybe Text) #
The error code that indicates why the target addition failed. If the value is ConcurrentModificationException , too many requests were made at the same time.
ptreErrorMessage :: Lens' PutTargetsResultEntry (Maybe Text) #
The error message that explains why the target addition failed.
RemoveTargetsResultEntry
data RemoveTargetsResultEntry #
Represents a target that failed to be removed from a rule.
See: removeTargetsResultEntry smart constructor.
Instances
removeTargetsResultEntry :: RemoveTargetsResultEntry #
Creates a value of RemoveTargetsResultEntry with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rtreTargetId- The ID of the target.rtreErrorCode- The error code that indicates why the target removal failed. If the value isConcurrentModificationException, too many requests were made at the same time.rtreErrorMessage- The error message that explains why the target removal failed.
rtreTargetId :: Lens' RemoveTargetsResultEntry (Maybe Text) #
The ID of the target.
rtreErrorCode :: Lens' RemoveTargetsResultEntry (Maybe Text) #
The error code that indicates why the target removal failed. If the value is ConcurrentModificationException , too many requests were made at the same time.
rtreErrorMessage :: Lens' RemoveTargetsResultEntry (Maybe Text) #
The error message that explains why the target removal failed.
Rule
Contains information about a rule in Amazon CloudWatch Events.
See: rule smart constructor.
Instances
Creates a value of Rule with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rEventPattern- The event pattern of the rule. For more information, see Events and Event Patterns in the Amazon CloudWatch Events User Guide .rState- The state of the rule.rARN- The Amazon Resource Name (ARN) of the rule.rScheduleExpression- The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)".rName- The name of the rule.rDescription- The description of the rule.rRoleARN- The Amazon Resource Name (ARN) of the role that is used for target invocation.
rEventPattern :: Lens' Rule (Maybe Text) #
The event pattern of the rule. For more information, see Events and Event Patterns in the Amazon CloudWatch Events User Guide .
rScheduleExpression :: Lens' Rule (Maybe Text) #
The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)".
rRoleARN :: Lens' Rule (Maybe Text) #
The Amazon Resource Name (ARN) of the role that is used for target invocation.
RunCommandParameters
data RunCommandParameters #
This parameter contains the criteria (either InstanceIds or a tag) used to specify which EC2 instances are to be sent the command.
See: runCommandParameters smart constructor.
Instances
Arguments
| :: NonEmpty RunCommandTarget | |
| -> RunCommandParameters |
Creates a value of RunCommandParameters with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rcpRunCommandTargets- Currently, we support including only one RunCommandTarget block, which specifies either an array of InstanceIds or a tag.
rcpRunCommandTargets :: Lens' RunCommandParameters (NonEmpty RunCommandTarget) #
Currently, we support including only one RunCommandTarget block, which specifies either an array of InstanceIds or a tag.
RunCommandTarget
data RunCommandTarget #
Information about the EC2 instances that are to be sent the command, specified as key-value pairs. Each RunCommandTarget block can include only one key, but this key may specify multiple values.
See: runCommandTarget smart constructor.
Instances
Creates a value of RunCommandTarget with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rctKey :: Lens' RunCommandTarget Text #
Can be either tag: tag-key or InstanceIds .
rctValues :: Lens' RunCommandTarget (NonEmpty Text) #
If Key is tag: tag-key , Values is a list of tag values. If Key is InstanceIds , Values is a list of Amazon EC2 instance IDs.
SqsParameters
data SqsParameters #
This structure includes the custom parameter to be used when the target is an SQS FIFO queue.
See: sqsParameters smart constructor.
Instances
sqsParameters :: SqsParameters #
Creates a value of SqsParameters with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
spMessageGroupId- The FIFO message group ID to use as the target.
spMessageGroupId :: Lens' SqsParameters (Maybe Text) #
The FIFO message group ID to use as the target.
Target
Targets are the resources to be invoked when a rule is triggered. Target types include EC2 instances, AWS Lambda functions, Amazon Kinesis streams, Amazon ECS tasks, AWS Step Functions state machines, Run Command, and built-in targets.
See: target smart constructor.
Instances
Creates a value of Target with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tRunCommandParameters- Parameters used when you are using the rule to invoke Amazon EC2 Run Command.tKinesisParameters- The custom parameter you can use to control shard assignment, when the target is an Amazon Kinesis stream. If you do not include this parameter, the default is to use theeventIdas the partition key.tInputTransformer- Settings to enable you to provide custom input to a target based on certain event data. You can extract one or more key-value pairs from the event and then use that data to send customized input to the target.tSqsParameters- Contains the message group ID to use when the target is a FIFO queue.tInput- Valid JSON text passed to the target. In this case, nothing from the event itself is passed to the target. For more information, see The JavaScript Object Notation (JSON) Data Interchange Format .tBatchParameters- Contains the job definition, job name, and other parameters if the event target is an AWS Batch job. For more information about AWS Batch, see Jobs in the AWS Batch User Guide .tEcsParameters- Contains the Amazon ECS task definition and task count to be used, if the event target is an Amazon ECS task. For more information about Amazon ECS tasks, see Task Definitions in the Amazon EC2 Container Service Developer Guide .tInputPath- The value of the JSONPath that is used for extracting part of the matched event when passing it to the target. You must use JSON dot notation, not bracket notation. For more information about JSON paths, see JSONPath .tRoleARN- The Amazon Resource Name (ARN) of the IAM role to be used for this target when the rule is triggered. If one rule triggers multiple targets, you can use a different IAM role for each target.tId- The ID of the target.tARN- The Amazon Resource Name (ARN) of the target.
tRunCommandParameters :: Lens' Target (Maybe RunCommandParameters) #
Parameters used when you are using the rule to invoke Amazon EC2 Run Command.
tKinesisParameters :: Lens' Target (Maybe KinesisParameters) #
The custom parameter you can use to control shard assignment, when the target is an Amazon Kinesis stream. If you do not include this parameter, the default is to use the eventId as the partition key.
tInputTransformer :: Lens' Target (Maybe InputTransformer) #
Settings to enable you to provide custom input to a target based on certain event data. You can extract one or more key-value pairs from the event and then use that data to send customized input to the target.
tSqsParameters :: Lens' Target (Maybe SqsParameters) #
Contains the message group ID to use when the target is a FIFO queue.
tInput :: Lens' Target (Maybe Text) #
Valid JSON text passed to the target. In this case, nothing from the event itself is passed to the target. For more information, see The JavaScript Object Notation (JSON) Data Interchange Format .
tBatchParameters :: Lens' Target (Maybe BatchParameters) #
Contains the job definition, job name, and other parameters if the event target is an AWS Batch job. For more information about AWS Batch, see Jobs in the AWS Batch User Guide .
tEcsParameters :: Lens' Target (Maybe EcsParameters) #
Contains the Amazon ECS task definition and task count to be used, if the event target is an Amazon ECS task. For more information about Amazon ECS tasks, see Task Definitions in the Amazon EC2 Container Service Developer Guide .
tInputPath :: Lens' Target (Maybe Text) #
The value of the JSONPath that is used for extracting part of the matched event when passing it to the target. You must use JSON dot notation, not bracket notation. For more information about JSON paths, see JSONPath .