Copyright | (c) 2013-2021 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 |
- Service Configuration
- Errors
- Waiters
- Operations
- DeauthorizeConnection
- RemoveTargets
- DeleteRule
- ListPartnerEventSourceAccounts
- ListConnections
- DeleteConnection
- UpdateConnection
- ListRules (Paginated)
- PutRule
- DisableRule
- PutPermission
- ListTagsForResource
- ListReplays
- CreateConnection
- CancelReplay
- ListTargetsByRule (Paginated)
- RemovePermission
- ListApiDestinations
- UpdateApiDestination
- DeleteApiDestination
- ActivateEventSource
- CreateApiDestination
- PutPartnerEvents
- DescribeConnection
- DescribeRule
- ListArchives
- StartReplay
- DeletePartnerEventSource
- DescribeReplay
- DescribeApiDestination
- ListEventBuses
- CreateEventBus
- DescribeEventSource
- DescribeArchive
- EnableRule
- ListRuleNamesByTarget (Paginated)
- TestEventPattern
- DescribePartnerEventSource
- DescribeEventBus
- ListEventSources
- TagResource
- CreatePartnerEventSource
- PutTargets
- UpdateArchive
- DeleteArchive
- UntagResource
- PutEvents
- ListPartnerEventSources
- CreateArchive
- DeactivateEventSource
- DeleteEventBus
- Types
- ApiDestinationHttpMethod
- ApiDestinationState
- ArchiveState
- AssignPublicIp
- ConnectionAuthorizationType
- ConnectionOAuthHttpMethod
- ConnectionState
- EventSourceState
- LaunchType
- PlacementConstraintType
- PlacementStrategyType
- PropagateTags
- ReplayState
- RuleState
- ApiDestination
- Archive
- AwsVpcConfiguration
- BatchArrayProperties
- BatchParameters
- BatchRetryStrategy
- CapacityProviderStrategyItem
- Condition
- Connection
- ConnectionApiKeyAuthResponseParameters
- ConnectionAuthResponseParameters
- ConnectionBasicAuthResponseParameters
- ConnectionBodyParameter
- ConnectionHeaderParameter
- ConnectionHttpParameters
- ConnectionOAuthClientResponseParameters
- ConnectionOAuthResponseParameters
- ConnectionQueryStringParameter
- CreateConnectionApiKeyAuthRequestParameters
- CreateConnectionAuthRequestParameters
- CreateConnectionBasicAuthRequestParameters
- CreateConnectionOAuthClientRequestParameters
- CreateConnectionOAuthRequestParameters
- DeadLetterConfig
- EcsParameters
- EventBus
- EventSource
- HttpParameters
- InputTransformer
- KinesisParameters
- NetworkConfiguration
- PartnerEventSource
- PartnerEventSourceAccount
- PlacementConstraint
- PlacementStrategy
- PutEventsRequestEntry
- PutEventsResultEntry
- PutPartnerEventsRequestEntry
- PutPartnerEventsResultEntry
- PutTargetsResultEntry
- RedshiftDataParameters
- RemoveTargetsResultEntry
- Replay
- ReplayDestination
- RetryPolicy
- Rule
- RunCommandParameters
- RunCommandTarget
- SageMakerPipelineParameter
- SageMakerPipelineParameters
- SqsParameters
- Tag
- Target
- UpdateConnectionApiKeyAuthRequestParameters
- UpdateConnectionAuthRequestParameters
- UpdateConnectionBasicAuthRequestParameters
- UpdateConnectionOAuthClientRequestParameters
- UpdateConnectionOAuthRequestParameters
Derived from API version 2015-10-07
of the AWS service descriptions, licensed under Apache 2.0.
Amazon EventBridge helps you to respond to state changes in your Amazon Web Services resources. When your resources change state, they automatically send events to an event stream. You can create rules that match selected events in the stream and route them to targets to take action. You can also use rules to take action on a predetermined schedule. For example, you can configure rules to:
- Automatically invoke an Lambda function to update DNS entries when an event notifies you that Amazon EC2 instance enters the running state.
- Direct specific API records from CloudTrail to an Amazon Kinesis data stream for detailed analysis of potential security or availability risks.
- Periodically invoke a built-in target to create a snapshot of an Amazon EBS volume.
For more information about the features of Amazon EventBridge, see the Amazon EventBridge User Guide.
Synopsis
- defaultService :: Service
- _ManagedRuleException :: AsError a => Getting (First ServiceError) a ServiceError
- _IllegalStatusException :: AsError a => Getting (First ServiceError) a ServiceError
- _PolicyLengthExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError
- _OperationDisabledException :: 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
- _InvalidStateException :: AsError a => Getting (First ServiceError) a ServiceError
- _LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- data DeauthorizeConnection = DeauthorizeConnection' Text
- newDeauthorizeConnection :: Text -> DeauthorizeConnection
- data DeauthorizeConnectionResponse = DeauthorizeConnectionResponse' (Maybe POSIX) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe ConnectionState) Int
- newDeauthorizeConnectionResponse :: Int -> DeauthorizeConnectionResponse
- data RemoveTargets = RemoveTargets' (Maybe Bool) (Maybe Text) Text (NonEmpty Text)
- newRemoveTargets :: Text -> NonEmpty Text -> RemoveTargets
- data RemoveTargetsResponse = RemoveTargetsResponse' (Maybe Int) (Maybe [RemoveTargetsResultEntry]) Int
- newRemoveTargetsResponse :: Int -> RemoveTargetsResponse
- data DeleteRule = DeleteRule' (Maybe Bool) (Maybe Text) Text
- newDeleteRule :: Text -> DeleteRule
- data DeleteRuleResponse = DeleteRuleResponse' {
- newDeleteRuleResponse :: DeleteRuleResponse
- data ListPartnerEventSourceAccounts = ListPartnerEventSourceAccounts' (Maybe Text) (Maybe Natural) Text
- newListPartnerEventSourceAccounts :: Text -> ListPartnerEventSourceAccounts
- data ListPartnerEventSourceAccountsResponse = ListPartnerEventSourceAccountsResponse' (Maybe [PartnerEventSourceAccount]) (Maybe Text) Int
- newListPartnerEventSourceAccountsResponse :: Int -> ListPartnerEventSourceAccountsResponse
- data ListConnections = ListConnections' (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe ConnectionState)
- newListConnections :: ListConnections
- data ListConnectionsResponse = ListConnectionsResponse' (Maybe [Connection]) (Maybe Text) Int
- newListConnectionsResponse :: Int -> ListConnectionsResponse
- data DeleteConnection = DeleteConnection' Text
- newDeleteConnection :: Text -> DeleteConnection
- data DeleteConnectionResponse = DeleteConnectionResponse' (Maybe POSIX) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe ConnectionState) Int
- newDeleteConnectionResponse :: Int -> DeleteConnectionResponse
- data UpdateConnection = UpdateConnection' (Maybe UpdateConnectionAuthRequestParameters) (Maybe ConnectionAuthorizationType) (Maybe Text) Text
- newUpdateConnection :: Text -> UpdateConnection
- data UpdateConnectionResponse = UpdateConnectionResponse' (Maybe POSIX) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe ConnectionState) Int
- newUpdateConnectionResponse :: Int -> UpdateConnectionResponse
- data ListRules = ListRules' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Natural)
- newListRules :: ListRules
- data ListRulesResponse = ListRulesResponse' (Maybe [Rule]) (Maybe Text) Int
- newListRulesResponse :: Int -> ListRulesResponse
- data PutRule = PutRule' (Maybe Text) (Maybe RuleState) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Tag]) (Maybe Text) Text
- newPutRule :: Text -> PutRule
- data PutRuleResponse = PutRuleResponse' (Maybe Text) Int
- newPutRuleResponse :: Int -> PutRuleResponse
- data DisableRule = DisableRule' (Maybe Text) Text
- newDisableRule :: Text -> DisableRule
- data DisableRuleResponse = DisableRuleResponse' {
- newDisableRuleResponse :: DisableRuleResponse
- data PutPermission = PutPermission' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Condition)
- newPutPermission :: PutPermission
- data PutPermissionResponse = PutPermissionResponse' {
- newPutPermissionResponse :: PutPermissionResponse
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe [Tag]) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data ListReplays = ListReplays' (Maybe Text) (Maybe ReplayState) (Maybe Text) (Maybe Text) (Maybe Natural)
- newListReplays :: ListReplays
- data ListReplaysResponse = ListReplaysResponse' (Maybe [Replay]) (Maybe Text) Int
- newListReplaysResponse :: Int -> ListReplaysResponse
- data CreateConnection = CreateConnection' (Maybe Text) Text ConnectionAuthorizationType CreateConnectionAuthRequestParameters
- newCreateConnection :: Text -> ConnectionAuthorizationType -> CreateConnectionAuthRequestParameters -> CreateConnection
- data CreateConnectionResponse = CreateConnectionResponse' (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe ConnectionState) Int
- newCreateConnectionResponse :: Int -> CreateConnectionResponse
- data CancelReplay = CancelReplay' Text
- newCancelReplay :: Text -> CancelReplay
- data CancelReplayResponse = CancelReplayResponse' (Maybe ReplayState) (Maybe Text) (Maybe Text) Int
- newCancelReplayResponse :: Int -> CancelReplayResponse
- data ListTargetsByRule = ListTargetsByRule' (Maybe Text) (Maybe Text) (Maybe Natural) Text
- newListTargetsByRule :: Text -> ListTargetsByRule
- data ListTargetsByRuleResponse = ListTargetsByRuleResponse' (Maybe Text) (Maybe (NonEmpty Target)) Int
- newListTargetsByRuleResponse :: Int -> ListTargetsByRuleResponse
- data RemovePermission = RemovePermission' (Maybe Text) (Maybe Bool) (Maybe Text)
- newRemovePermission :: RemovePermission
- data RemovePermissionResponse = RemovePermissionResponse' {
- newRemovePermissionResponse :: RemovePermissionResponse
- data ListApiDestinations = ListApiDestinations' (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe Text)
- newListApiDestinations :: ListApiDestinations
- data ListApiDestinationsResponse = ListApiDestinationsResponse' (Maybe [ApiDestination]) (Maybe Text) Int
- newListApiDestinationsResponse :: Int -> ListApiDestinationsResponse
- data UpdateApiDestination = UpdateApiDestination' (Maybe ApiDestinationHttpMethod) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe Text) Text
- newUpdateApiDestination :: Text -> UpdateApiDestination
- data UpdateApiDestinationResponse = UpdateApiDestinationResponse' (Maybe POSIX) (Maybe POSIX) (Maybe ApiDestinationState) (Maybe Text) Int
- newUpdateApiDestinationResponse :: Int -> UpdateApiDestinationResponse
- data DeleteApiDestination = DeleteApiDestination' Text
- newDeleteApiDestination :: Text -> DeleteApiDestination
- data DeleteApiDestinationResponse = DeleteApiDestinationResponse' Int
- newDeleteApiDestinationResponse :: Int -> DeleteApiDestinationResponse
- data ActivateEventSource = ActivateEventSource' Text
- newActivateEventSource :: Text -> ActivateEventSource
- data ActivateEventSourceResponse = ActivateEventSourceResponse' {
- newActivateEventSourceResponse :: ActivateEventSourceResponse
- data CreateApiDestination = CreateApiDestination' (Maybe Natural) (Maybe Text) Text Text Text ApiDestinationHttpMethod
- newCreateApiDestination :: Text -> Text -> Text -> ApiDestinationHttpMethod -> CreateApiDestination
- data CreateApiDestinationResponse = CreateApiDestinationResponse' (Maybe POSIX) (Maybe POSIX) (Maybe ApiDestinationState) (Maybe Text) Int
- newCreateApiDestinationResponse :: Int -> CreateApiDestinationResponse
- data PutPartnerEvents = PutPartnerEvents' (NonEmpty PutPartnerEventsRequestEntry)
- newPutPartnerEvents :: NonEmpty PutPartnerEventsRequestEntry -> PutPartnerEvents
- data PutPartnerEventsResponse = PutPartnerEventsResponse' (Maybe Int) (Maybe [PutPartnerEventsResultEntry]) Int
- newPutPartnerEventsResponse :: Int -> PutPartnerEventsResponse
- data DescribeConnection = DescribeConnection' Text
- newDescribeConnection :: Text -> DescribeConnection
- data DescribeConnectionResponse = DescribeConnectionResponse' (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe ConnectionAuthResponseParameters) (Maybe POSIX) (Maybe ConnectionAuthorizationType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ConnectionState) Int
- newDescribeConnectionResponse :: Int -> DescribeConnectionResponse
- data DescribeRule = DescribeRule' (Maybe Text) Text
- newDescribeRule :: Text -> DescribeRule
- data DescribeRuleResponse = DescribeRuleResponse' (Maybe Text) (Maybe RuleState) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int
- newDescribeRuleResponse :: Int -> DescribeRuleResponse
- data ListArchives = ListArchives' (Maybe Text) (Maybe ArchiveState) (Maybe Text) (Maybe Text) (Maybe Natural)
- newListArchives :: ListArchives
- data ListArchivesResponse = ListArchivesResponse' (Maybe [Archive]) (Maybe Text) Int
- newListArchivesResponse :: Int -> ListArchivesResponse
- data StartReplay = StartReplay' (Maybe Text) Text Text POSIX POSIX ReplayDestination
- newStartReplay :: Text -> Text -> UTCTime -> UTCTime -> ReplayDestination -> StartReplay
- data StartReplayResponse = StartReplayResponse' (Maybe ReplayState) (Maybe POSIX) (Maybe Text) (Maybe Text) Int
- newStartReplayResponse :: Int -> StartReplayResponse
- data DeletePartnerEventSource = DeletePartnerEventSource' Text Text
- newDeletePartnerEventSource :: Text -> Text -> DeletePartnerEventSource
- data DeletePartnerEventSourceResponse = DeletePartnerEventSourceResponse' {
- newDeletePartnerEventSourceResponse :: DeletePartnerEventSourceResponse
- data DescribeReplay = DescribeReplay' Text
- newDescribeReplay :: Text -> DescribeReplay
- data DescribeReplayResponse = DescribeReplayResponse' (Maybe Text) (Maybe ReplayDestination) (Maybe ReplayState) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) Int
- newDescribeReplayResponse :: Int -> DescribeReplayResponse
- data DescribeApiDestination = DescribeApiDestination' Text
- newDescribeApiDestination :: Text -> DescribeApiDestination
- data DescribeApiDestinationResponse = DescribeApiDestinationResponse' (Maybe POSIX) (Maybe ApiDestinationHttpMethod) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Natural) (Maybe ApiDestinationState) (Maybe Text) (Maybe Text) (Maybe Text) Int
- newDescribeApiDestinationResponse :: Int -> DescribeApiDestinationResponse
- data ListEventBuses = ListEventBuses' (Maybe Text) (Maybe Text) (Maybe Natural)
- newListEventBuses :: ListEventBuses
- data ListEventBusesResponse = ListEventBusesResponse' (Maybe [EventBus]) (Maybe Text) Int
- newListEventBusesResponse :: Int -> ListEventBusesResponse
- data CreateEventBus = CreateEventBus' (Maybe Text) (Maybe [Tag]) Text
- newCreateEventBus :: Text -> CreateEventBus
- data CreateEventBusResponse = CreateEventBusResponse' (Maybe Text) Int
- newCreateEventBusResponse :: Int -> CreateEventBusResponse
- data DescribeEventSource = DescribeEventSource' Text
- newDescribeEventSource :: Text -> DescribeEventSource
- data DescribeEventSourceResponse = DescribeEventSourceResponse' (Maybe POSIX) (Maybe EventSourceState) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) Int
- newDescribeEventSourceResponse :: Int -> DescribeEventSourceResponse
- data DescribeArchive = DescribeArchive' Text
- newDescribeArchive :: Text -> DescribeArchive
- data DescribeArchiveResponse = DescribeArchiveResponse' (Maybe POSIX) (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe ArchiveState) (Maybe Integer) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Text) Int
- newDescribeArchiveResponse :: Int -> DescribeArchiveResponse
- data EnableRule = EnableRule' (Maybe Text) Text
- newEnableRule :: Text -> EnableRule
- data EnableRuleResponse = EnableRuleResponse' {
- newEnableRuleResponse :: EnableRuleResponse
- data ListRuleNamesByTarget = ListRuleNamesByTarget' (Maybe Text) (Maybe Text) (Maybe Natural) Text
- newListRuleNamesByTarget :: Text -> ListRuleNamesByTarget
- data ListRuleNamesByTargetResponse = ListRuleNamesByTargetResponse' (Maybe [Text]) (Maybe Text) Int
- newListRuleNamesByTargetResponse :: Int -> ListRuleNamesByTargetResponse
- data TestEventPattern = TestEventPattern' Text Text
- newTestEventPattern :: Text -> Text -> TestEventPattern
- data TestEventPatternResponse = TestEventPatternResponse' (Maybe Bool) Int
- newTestEventPatternResponse :: Int -> TestEventPatternResponse
- data DescribePartnerEventSource = DescribePartnerEventSource' Text
- newDescribePartnerEventSource :: Text -> DescribePartnerEventSource
- data DescribePartnerEventSourceResponse = DescribePartnerEventSourceResponse' (Maybe Text) (Maybe Text) Int
- newDescribePartnerEventSourceResponse :: Int -> DescribePartnerEventSourceResponse
- data DescribeEventBus = DescribeEventBus' (Maybe Text)
- newDescribeEventBus :: DescribeEventBus
- data DescribeEventBusResponse = DescribeEventBusResponse' (Maybe Text) (Maybe Text) (Maybe Text) Int
- newDescribeEventBusResponse :: Int -> DescribeEventBusResponse
- data ListEventSources = ListEventSources' (Maybe Text) (Maybe Text) (Maybe Natural)
- newListEventSources :: ListEventSources
- data ListEventSourcesResponse = ListEventSourcesResponse' (Maybe Text) (Maybe [EventSource]) Int
- newListEventSourcesResponse :: Int -> ListEventSourcesResponse
- data TagResource = TagResource' Text [Tag]
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data CreatePartnerEventSource = CreatePartnerEventSource' Text Text
- newCreatePartnerEventSource :: Text -> Text -> CreatePartnerEventSource
- data CreatePartnerEventSourceResponse = CreatePartnerEventSourceResponse' (Maybe Text) Int
- newCreatePartnerEventSourceResponse :: Int -> CreatePartnerEventSourceResponse
- data PutTargets = PutTargets' (Maybe Text) Text (NonEmpty Target)
- newPutTargets :: Text -> NonEmpty Target -> PutTargets
- data PutTargetsResponse = PutTargetsResponse' (Maybe Int) (Maybe [PutTargetsResultEntry]) Int
- newPutTargetsResponse :: Int -> PutTargetsResponse
- data UpdateArchive = UpdateArchive' (Maybe Text) (Maybe Natural) (Maybe Text) Text
- newUpdateArchive :: Text -> UpdateArchive
- data UpdateArchiveResponse = UpdateArchiveResponse' (Maybe POSIX) (Maybe ArchiveState) (Maybe Text) (Maybe Text) Int
- newUpdateArchiveResponse :: Int -> UpdateArchiveResponse
- data DeleteArchive = DeleteArchive' Text
- newDeleteArchive :: Text -> DeleteArchive
- data DeleteArchiveResponse = DeleteArchiveResponse' Int
- newDeleteArchiveResponse :: Int -> DeleteArchiveResponse
- data UntagResource = UntagResource' Text [Text]
- newUntagResource :: Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data PutEvents = PutEvents' (NonEmpty PutEventsRequestEntry)
- newPutEvents :: NonEmpty PutEventsRequestEntry -> PutEvents
- data PutEventsResponse = PutEventsResponse' (Maybe Int) (Maybe [PutEventsResultEntry]) Int
- newPutEventsResponse :: Int -> PutEventsResponse
- data ListPartnerEventSources = ListPartnerEventSources' (Maybe Text) (Maybe Natural) Text
- newListPartnerEventSources :: Text -> ListPartnerEventSources
- data ListPartnerEventSourcesResponse = ListPartnerEventSourcesResponse' (Maybe [PartnerEventSource]) (Maybe Text) Int
- newListPartnerEventSourcesResponse :: Int -> ListPartnerEventSourcesResponse
- data CreateArchive = CreateArchive' (Maybe Text) (Maybe Natural) (Maybe Text) Text Text
- newCreateArchive :: Text -> Text -> CreateArchive
- data CreateArchiveResponse = CreateArchiveResponse' (Maybe POSIX) (Maybe ArchiveState) (Maybe Text) (Maybe Text) Int
- newCreateArchiveResponse :: Int -> CreateArchiveResponse
- data DeactivateEventSource = DeactivateEventSource' Text
- newDeactivateEventSource :: Text -> DeactivateEventSource
- data DeactivateEventSourceResponse = DeactivateEventSourceResponse' {
- newDeactivateEventSourceResponse :: DeactivateEventSourceResponse
- data DeleteEventBus = DeleteEventBus' Text
- newDeleteEventBus :: Text -> DeleteEventBus
- data DeleteEventBusResponse = DeleteEventBusResponse' {
- newDeleteEventBusResponse :: DeleteEventBusResponse
- newtype ApiDestinationHttpMethod where
- ApiDestinationHttpMethod' { }
- pattern ApiDestinationHttpMethod_DELETE :: ApiDestinationHttpMethod
- pattern ApiDestinationHttpMethod_GET :: ApiDestinationHttpMethod
- pattern ApiDestinationHttpMethod_HEAD :: ApiDestinationHttpMethod
- pattern ApiDestinationHttpMethod_OPTIONS :: ApiDestinationHttpMethod
- pattern ApiDestinationHttpMethod_PATCH :: ApiDestinationHttpMethod
- pattern ApiDestinationHttpMethod_POST :: ApiDestinationHttpMethod
- pattern ApiDestinationHttpMethod_PUT :: ApiDestinationHttpMethod
- newtype ApiDestinationState where
- newtype ArchiveState where
- ArchiveState' { }
- pattern ArchiveState_CREATE_FAILED :: ArchiveState
- pattern ArchiveState_CREATING :: ArchiveState
- pattern ArchiveState_DISABLED :: ArchiveState
- pattern ArchiveState_ENABLED :: ArchiveState
- pattern ArchiveState_UPDATE_FAILED :: ArchiveState
- pattern ArchiveState_UPDATING :: ArchiveState
- newtype AssignPublicIp where
- AssignPublicIp' { }
- pattern AssignPublicIp_DISABLED :: AssignPublicIp
- pattern AssignPublicIp_ENABLED :: AssignPublicIp
- newtype ConnectionAuthorizationType where
- newtype ConnectionOAuthHttpMethod where
- newtype ConnectionState where
- ConnectionState' { }
- pattern ConnectionState_AUTHORIZED :: ConnectionState
- pattern ConnectionState_AUTHORIZING :: ConnectionState
- pattern ConnectionState_CREATING :: ConnectionState
- pattern ConnectionState_DEAUTHORIZED :: ConnectionState
- pattern ConnectionState_DEAUTHORIZING :: ConnectionState
- pattern ConnectionState_DELETING :: ConnectionState
- pattern ConnectionState_UPDATING :: ConnectionState
- newtype EventSourceState where
- EventSourceState' { }
- pattern EventSourceState_ACTIVE :: EventSourceState
- pattern EventSourceState_DELETED :: EventSourceState
- pattern EventSourceState_PENDING :: EventSourceState
- 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 ReplayState where
- ReplayState' { }
- pattern ReplayState_CANCELLED :: ReplayState
- pattern ReplayState_CANCELLING :: ReplayState
- pattern ReplayState_COMPLETED :: ReplayState
- pattern ReplayState_FAILED :: ReplayState
- pattern ReplayState_RUNNING :: ReplayState
- pattern ReplayState_STARTING :: ReplayState
- newtype RuleState where
- RuleState' { }
- pattern RuleState_DISABLED :: RuleState
- pattern RuleState_ENABLED :: RuleState
- data ApiDestination = ApiDestination' (Maybe POSIX) (Maybe ApiDestinationHttpMethod) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Natural) (Maybe ApiDestinationState) (Maybe Text) (Maybe Text)
- newApiDestination :: ApiDestination
- data Archive = Archive' (Maybe POSIX) (Maybe Integer) (Maybe Text) (Maybe ArchiveState) (Maybe Integer) (Maybe Text) (Maybe Natural) (Maybe Text)
- newArchive :: Archive
- data AwsVpcConfiguration = AwsVpcConfiguration' (Maybe [Text]) (Maybe AssignPublicIp) [Text]
- newAwsVpcConfiguration :: AwsVpcConfiguration
- data BatchArrayProperties = BatchArrayProperties' (Maybe Int)
- newBatchArrayProperties :: BatchArrayProperties
- data BatchParameters = BatchParameters' (Maybe BatchRetryStrategy) (Maybe BatchArrayProperties) Text Text
- newBatchParameters :: Text -> Text -> BatchParameters
- data BatchRetryStrategy = BatchRetryStrategy' (Maybe Int)
- newBatchRetryStrategy :: BatchRetryStrategy
- data CapacityProviderStrategyItem = CapacityProviderStrategyItem' (Maybe Natural) (Maybe Natural) Text
- newCapacityProviderStrategyItem :: Text -> CapacityProviderStrategyItem
- data Condition = Condition' Text Text Text
- newCondition :: Text -> Text -> Text -> Condition
- data Connection = Connection' (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe ConnectionAuthorizationType) (Maybe Text) (Maybe Text) (Maybe ConnectionState)
- newConnection :: Connection
- data ConnectionApiKeyAuthResponseParameters = ConnectionApiKeyAuthResponseParameters' (Maybe Text)
- newConnectionApiKeyAuthResponseParameters :: ConnectionApiKeyAuthResponseParameters
- data ConnectionAuthResponseParameters = ConnectionAuthResponseParameters' (Maybe ConnectionOAuthResponseParameters) (Maybe ConnectionHttpParameters) (Maybe ConnectionApiKeyAuthResponseParameters) (Maybe ConnectionBasicAuthResponseParameters)
- newConnectionAuthResponseParameters :: ConnectionAuthResponseParameters
- data ConnectionBasicAuthResponseParameters = ConnectionBasicAuthResponseParameters' (Maybe Text)
- newConnectionBasicAuthResponseParameters :: ConnectionBasicAuthResponseParameters
- data ConnectionBodyParameter = ConnectionBodyParameter' (Maybe Bool) (Maybe Text) (Maybe Text)
- newConnectionBodyParameter :: ConnectionBodyParameter
- data ConnectionHeaderParameter = ConnectionHeaderParameter' (Maybe Bool) (Maybe Text) (Maybe Text)
- newConnectionHeaderParameter :: ConnectionHeaderParameter
- data ConnectionHttpParameters = ConnectionHttpParameters' (Maybe [ConnectionQueryStringParameter]) (Maybe [ConnectionHeaderParameter]) (Maybe [ConnectionBodyParameter])
- newConnectionHttpParameters :: ConnectionHttpParameters
- data ConnectionOAuthClientResponseParameters = ConnectionOAuthClientResponseParameters' (Maybe Text)
- newConnectionOAuthClientResponseParameters :: ConnectionOAuthClientResponseParameters
- data ConnectionOAuthResponseParameters = ConnectionOAuthResponseParameters' (Maybe ConnectionOAuthHttpMethod) (Maybe ConnectionOAuthClientResponseParameters) (Maybe ConnectionHttpParameters) (Maybe Text)
- newConnectionOAuthResponseParameters :: ConnectionOAuthResponseParameters
- data ConnectionQueryStringParameter = ConnectionQueryStringParameter' (Maybe Bool) (Maybe Text) (Maybe Text)
- newConnectionQueryStringParameter :: ConnectionQueryStringParameter
- data CreateConnectionApiKeyAuthRequestParameters = CreateConnectionApiKeyAuthRequestParameters' Text Text
- newCreateConnectionApiKeyAuthRequestParameters :: Text -> Text -> CreateConnectionApiKeyAuthRequestParameters
- data CreateConnectionAuthRequestParameters = CreateConnectionAuthRequestParameters' (Maybe CreateConnectionOAuthRequestParameters) (Maybe ConnectionHttpParameters) (Maybe CreateConnectionApiKeyAuthRequestParameters) (Maybe CreateConnectionBasicAuthRequestParameters)
- newCreateConnectionAuthRequestParameters :: CreateConnectionAuthRequestParameters
- data CreateConnectionBasicAuthRequestParameters = CreateConnectionBasicAuthRequestParameters' Text Text
- newCreateConnectionBasicAuthRequestParameters :: Text -> Text -> CreateConnectionBasicAuthRequestParameters
- data CreateConnectionOAuthClientRequestParameters = CreateConnectionOAuthClientRequestParameters' Text Text
- newCreateConnectionOAuthClientRequestParameters :: Text -> Text -> CreateConnectionOAuthClientRequestParameters
- data CreateConnectionOAuthRequestParameters = CreateConnectionOAuthRequestParameters' (Maybe ConnectionHttpParameters) CreateConnectionOAuthClientRequestParameters Text ConnectionOAuthHttpMethod
- newCreateConnectionOAuthRequestParameters :: CreateConnectionOAuthClientRequestParameters -> Text -> ConnectionOAuthHttpMethod -> CreateConnectionOAuthRequestParameters
- data DeadLetterConfig = DeadLetterConfig' (Maybe Text)
- newDeadLetterConfig :: DeadLetterConfig
- data EcsParameters = EcsParameters' (Maybe Text) (Maybe PropagateTags) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe [PlacementConstraint]) (Maybe [PlacementStrategy]) (Maybe LaunchType) (Maybe [CapacityProviderStrategyItem]) (Maybe Natural) (Maybe NetworkConfiguration) (Maybe [Tag]) (Maybe Bool) Text
- newEcsParameters :: Text -> EcsParameters
- data EventBus = EventBus' (Maybe Text) (Maybe Text) (Maybe Text)
- newEventBus :: EventBus
- data EventSource = EventSource' (Maybe POSIX) (Maybe EventSourceState) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX)
- newEventSource :: EventSource
- data HttpParameters = HttpParameters' (Maybe [Text]) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text))
- newHttpParameters :: HttpParameters
- data InputTransformer = InputTransformer' (Maybe (HashMap Text Text)) Text
- newInputTransformer :: Text -> InputTransformer
- data KinesisParameters = KinesisParameters' Text
- newKinesisParameters :: Text -> KinesisParameters
- data NetworkConfiguration = NetworkConfiguration' (Maybe AwsVpcConfiguration)
- newNetworkConfiguration :: NetworkConfiguration
- data PartnerEventSource = PartnerEventSource' (Maybe Text) (Maybe Text)
- newPartnerEventSource :: PartnerEventSource
- data PartnerEventSourceAccount = PartnerEventSourceAccount' (Maybe POSIX) (Maybe EventSourceState) (Maybe Text) (Maybe POSIX)
- newPartnerEventSourceAccount :: PartnerEventSourceAccount
- data PlacementConstraint = PlacementConstraint' (Maybe Text) (Maybe PlacementConstraintType)
- newPlacementConstraint :: PlacementConstraint
- data PlacementStrategy = PlacementStrategy' (Maybe Text) (Maybe PlacementStrategyType)
- newPlacementStrategy :: PlacementStrategy
- data PutEventsRequestEntry = PutEventsRequestEntry' (Maybe POSIX) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newPutEventsRequestEntry :: PutEventsRequestEntry
- data PutEventsResultEntry = PutEventsResultEntry' (Maybe Text) (Maybe Text) (Maybe Text)
- newPutEventsResultEntry :: PutEventsResultEntry
- data PutPartnerEventsRequestEntry = PutPartnerEventsRequestEntry' (Maybe POSIX) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text)
- newPutPartnerEventsRequestEntry :: PutPartnerEventsRequestEntry
- data PutPartnerEventsResultEntry = PutPartnerEventsResultEntry' (Maybe Text) (Maybe Text) (Maybe Text)
- newPutPartnerEventsResultEntry :: PutPartnerEventsResultEntry
- data PutTargetsResultEntry = PutTargetsResultEntry' (Maybe Text) (Maybe Text) (Maybe Text)
- newPutTargetsResultEntry :: PutTargetsResultEntry
- data RedshiftDataParameters = RedshiftDataParameters' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) Text Text
- newRedshiftDataParameters :: Text -> Text -> RedshiftDataParameters
- data RemoveTargetsResultEntry = RemoveTargetsResultEntry' (Maybe Text) (Maybe Text) (Maybe Text)
- newRemoveTargetsResultEntry :: RemoveTargetsResultEntry
- data Replay = Replay' (Maybe Text) (Maybe ReplayState) (Maybe POSIX) (Maybe POSIX) (Maybe POSIX) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Text)
- newReplay :: Replay
- data ReplayDestination = ReplayDestination' (Maybe [Text]) Text
- newReplayDestination :: Text -> ReplayDestination
- data RetryPolicy = RetryPolicy' (Maybe Natural) (Maybe Natural)
- newRetryPolicy :: RetryPolicy
- data Rule = Rule' (Maybe Text) (Maybe RuleState) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newRule :: Rule
- data RunCommandParameters = RunCommandParameters' (NonEmpty RunCommandTarget)
- newRunCommandParameters :: NonEmpty RunCommandTarget -> RunCommandParameters
- data RunCommandTarget = RunCommandTarget' Text (NonEmpty Text)
- newRunCommandTarget :: Text -> NonEmpty Text -> RunCommandTarget
- data SageMakerPipelineParameter = SageMakerPipelineParameter' Text Text
- newSageMakerPipelineParameter :: Text -> Text -> SageMakerPipelineParameter
- data SageMakerPipelineParameters = SageMakerPipelineParameters' (Maybe [SageMakerPipelineParameter])
- newSageMakerPipelineParameters :: SageMakerPipelineParameters
- data SqsParameters = SqsParameters' (Maybe Text)
- newSqsParameters :: SqsParameters
- data Tag = Tag' Text Text
- newTag :: Text -> Text -> Tag
- data Target = Target' (Maybe RunCommandParameters) (Maybe HttpParameters) (Maybe KinesisParameters) (Maybe InputTransformer) (Maybe DeadLetterConfig) (Maybe SageMakerPipelineParameters) (Maybe SqsParameters) (Maybe Text) (Maybe BatchParameters) (Maybe RedshiftDataParameters) (Maybe EcsParameters) (Maybe RetryPolicy) (Maybe Text) (Maybe Text) Text Text
- newTarget :: Text -> Text -> Target
- data UpdateConnectionApiKeyAuthRequestParameters = UpdateConnectionApiKeyAuthRequestParameters' (Maybe Text) (Maybe Text)
- newUpdateConnectionApiKeyAuthRequestParameters :: UpdateConnectionApiKeyAuthRequestParameters
- data UpdateConnectionAuthRequestParameters = UpdateConnectionAuthRequestParameters' (Maybe UpdateConnectionOAuthRequestParameters) (Maybe ConnectionHttpParameters) (Maybe UpdateConnectionApiKeyAuthRequestParameters) (Maybe UpdateConnectionBasicAuthRequestParameters)
- newUpdateConnectionAuthRequestParameters :: UpdateConnectionAuthRequestParameters
- data UpdateConnectionBasicAuthRequestParameters = UpdateConnectionBasicAuthRequestParameters' (Maybe Text) (Maybe Text)
- newUpdateConnectionBasicAuthRequestParameters :: UpdateConnectionBasicAuthRequestParameters
- data UpdateConnectionOAuthClientRequestParameters = UpdateConnectionOAuthClientRequestParameters' (Maybe Text) (Maybe Text)
- newUpdateConnectionOAuthClientRequestParameters :: UpdateConnectionOAuthClientRequestParameters
- data UpdateConnectionOAuthRequestParameters = UpdateConnectionOAuthRequestParameters' (Maybe ConnectionOAuthHttpMethod) (Maybe UpdateConnectionOAuthClientRequestParameters) (Maybe ConnectionHttpParameters) (Maybe Text)
- newUpdateConnectionOAuthRequestParameters :: UpdateConnectionOAuthRequestParameters
Service Configuration
defaultService :: Service Source #
API version 2015-10-07
of the Amazon EventBridge 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 CloudWatchEvents
.
ManagedRuleException
_ManagedRuleException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This rule was created by an Amazon Web Services service on behalf of
your account. It is managed by that service. If you see this error in
response to DeleteRule
or RemoveTargets
, you can use the Force
parameter in those calls to delete the rule or remove targets from the
rule. You cannot modify these managed rules by using DisableRule
,
EnableRule
, PutTargets
, PutRule
, TagResource
, or
UntagResource
.
IllegalStatusException
_IllegalStatusException :: AsError a => Getting (First ServiceError) a ServiceError Source #
An error occurred because a replay can be canceled only when the state is Running or Starting.
PolicyLengthExceededException
_PolicyLengthExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The event bus policy is too long. For more information, see the limits.
ResourceAlreadyExistsException
_ResourceAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The resource you are trying to create already exists.
OperationDisabledException
_OperationDisabledException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The operation you are attempting is not available in this region.
ConcurrentModificationException
_ConcurrentModificationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
There is concurrent modification on a rule, target, archive, or replay.
InvalidEventPatternException
_InvalidEventPatternException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The event pattern is not valid.
InternalException
_InternalException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception occurs due to unexpected causes.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
An entity that you specified does not exist.
InvalidStateException
_InvalidStateException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified state is not a valid state for an event source.
LimitExceededException
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request failed because it attempted to create resource beyond the allowed service quota.
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.
DeauthorizeConnection
newDeauthorizeConnection Source #
Create a value of DeauthorizeConnection
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:DeauthorizeConnection'
, deauthorizeConnection_name
- The name of the connection to remove authorization from.
data DeauthorizeConnectionResponse Source #
See: newDeauthorizeConnectionResponse
smart constructor.
DeauthorizeConnectionResponse' (Maybe POSIX) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe ConnectionState) Int |
Instances
newDeauthorizeConnectionResponse Source #
Create a value of DeauthorizeConnectionResponse
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:creationTime:DeauthorizeConnectionResponse'
, deauthorizeConnectionResponse_creationTime
- A time stamp for the time that the connection was created.
$sel:lastModifiedTime:DeauthorizeConnectionResponse'
, deauthorizeConnectionResponse_lastModifiedTime
- A time stamp for the time that the connection was last updated.
$sel:lastAuthorizedTime:DeauthorizeConnectionResponse'
, deauthorizeConnectionResponse_lastAuthorizedTime
- A time stamp for the time that the connection was last authorized.
$sel:connectionArn:DeauthorizeConnectionResponse'
, deauthorizeConnectionResponse_connectionArn
- The ARN of the connection that authorization was removed from.
$sel:connectionState:DeauthorizeConnectionResponse'
, deauthorizeConnectionResponse_connectionState
- The state of the connection.
$sel:httpStatus:DeauthorizeConnectionResponse'
, deauthorizeConnectionResponse_httpStatus
- The response's http status code.
RemoveTargets
data RemoveTargets Source #
See: newRemoveTargets
smart constructor.
Instances
Create a value of RemoveTargets
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:force:RemoveTargets'
, removeTargets_force
- If this is a managed rule, created by an Amazon Web Services service on
your behalf, you must specify Force
as True
to remove targets. This
parameter is ignored for rules that are not managed rules. You can check
whether a rule is a managed rule by using DescribeRule
or ListRules
and checking the ManagedBy
field of the response.
$sel:eventBusName:RemoveTargets'
, removeTargets_eventBusName
- The name or ARN of the event bus associated with the rule. If you omit
this, the default event bus is used.
$sel:rule:RemoveTargets'
, removeTargets_rule
- The name of the rule.
$sel:ids:RemoveTargets'
, removeTargets_ids
- The IDs of the targets to remove from the rule.
data RemoveTargetsResponse Source #
See: newRemoveTargetsResponse
smart constructor.
Instances
newRemoveTargetsResponse Source #
Create a value of RemoveTargetsResponse
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:failedEntryCount:RemoveTargetsResponse'
, removeTargetsResponse_failedEntryCount
- The number of failed entries.
$sel:failedEntries:RemoveTargetsResponse'
, removeTargetsResponse_failedEntries
- The failed target entries.
$sel:httpStatus:RemoveTargetsResponse'
, removeTargetsResponse_httpStatus
- The response's http status code.
DeleteRule
data DeleteRule Source #
See: newDeleteRule
smart constructor.
Instances
Create a value of DeleteRule
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:force:DeleteRule'
, deleteRule_force
- If this is a managed rule, created by an Amazon Web Services service on
your behalf, you must specify Force
as True
to delete the rule. This
parameter is ignored for rules that are not managed rules. You can check
whether a rule is a managed rule by using DescribeRule
or ListRules
and checking the ManagedBy
field of the response.
$sel:eventBusName:DeleteRule'
, deleteRule_eventBusName
- The name or ARN of the event bus associated with the rule. If you omit
this, the default event bus is used.
$sel:name:DeleteRule'
, deleteRule_name
- The name of the rule.
data DeleteRuleResponse Source #
See: newDeleteRuleResponse
smart constructor.
Instances
Eq DeleteRuleResponse Source # | |
Defined in Amazonka.CloudWatchEvents.DeleteRule (==) :: DeleteRuleResponse -> DeleteRuleResponse -> Bool # (/=) :: DeleteRuleResponse -> DeleteRuleResponse -> Bool # | |
Read DeleteRuleResponse Source # | |
Show DeleteRuleResponse Source # | |
Defined in Amazonka.CloudWatchEvents.DeleteRule showsPrec :: Int -> DeleteRuleResponse -> ShowS # show :: DeleteRuleResponse -> String # showList :: [DeleteRuleResponse] -> ShowS # | |
Generic DeleteRuleResponse Source # | |
Defined in Amazonka.CloudWatchEvents.DeleteRule type Rep DeleteRuleResponse :: Type -> Type # from :: DeleteRuleResponse -> Rep DeleteRuleResponse x # to :: Rep DeleteRuleResponse x -> DeleteRuleResponse # | |
NFData DeleteRuleResponse Source # | |
Defined in Amazonka.CloudWatchEvents.DeleteRule rnf :: DeleteRuleResponse -> () # | |
type Rep DeleteRuleResponse Source # | |
Defined in Amazonka.CloudWatchEvents.DeleteRule |
newDeleteRuleResponse :: DeleteRuleResponse Source #
Create a value of DeleteRuleResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
ListPartnerEventSourceAccounts
data ListPartnerEventSourceAccounts Source #
See: newListPartnerEventSourceAccounts
smart constructor.
Instances
newListPartnerEventSourceAccounts Source #
Create a value of ListPartnerEventSourceAccounts
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:nextToken:ListPartnerEventSourceAccounts'
, listPartnerEventSourceAccounts_nextToken
- The token returned by a previous call to this operation. Specifying this
retrieves the next set of results.
$sel:limit:ListPartnerEventSourceAccounts'
, listPartnerEventSourceAccounts_limit
- Specifying this 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:eventSourceName:ListPartnerEventSourceAccounts'
, listPartnerEventSourceAccounts_eventSourceName
- The name of the partner event source to display account information
about.
data ListPartnerEventSourceAccountsResponse Source #
See: newListPartnerEventSourceAccountsResponse
smart constructor.
Instances
newListPartnerEventSourceAccountsResponse Source #
Create a value of ListPartnerEventSourceAccountsResponse
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:partnerEventSourceAccounts:ListPartnerEventSourceAccountsResponse'
, listPartnerEventSourceAccountsResponse_partnerEventSourceAccounts
- The list of partner event sources returned by the operation.
$sel:nextToken:ListPartnerEventSourceAccounts'
, listPartnerEventSourceAccountsResponse_nextToken
- A token you can use in a subsequent operation to retrieve the next set
of results.
$sel:httpStatus:ListPartnerEventSourceAccountsResponse'
, listPartnerEventSourceAccountsResponse_httpStatus
- The response's http status code.
ListConnections
data ListConnections Source #
See: newListConnections
smart constructor.
Instances
newListConnections :: ListConnections Source #
Create a value of ListConnections
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:nextToken:ListConnections'
, listConnections_nextToken
- The token returned by a previous call to retrieve the next set of
results.
$sel:namePrefix:ListConnections'
, listConnections_namePrefix
- A name prefix to filter results returned. Only connections with a name
that starts with the prefix are returned.
$sel:limit:ListConnections'
, listConnections_limit
- The maximum number of connections to return.
$sel:connectionState:ListConnections'
, listConnections_connectionState
- The state of the connection.
data ListConnectionsResponse Source #
See: newListConnectionsResponse
smart constructor.
Instances
newListConnectionsResponse Source #
Create a value of ListConnectionsResponse
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:connections:ListConnectionsResponse'
, listConnectionsResponse_connections
- An array of connections objects that include details about the
connections.
$sel:nextToken:ListConnections'
, listConnectionsResponse_nextToken
- A token you can use in a subsequent request to retrieve the next set of
results.
$sel:httpStatus:ListConnectionsResponse'
, listConnectionsResponse_httpStatus
- The response's http status code.
DeleteConnection
data DeleteConnection Source #
See: newDeleteConnection
smart constructor.
Instances
Create a value of DeleteConnection
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:DeleteConnection'
, deleteConnection_name
- The name of the connection to delete.
data DeleteConnectionResponse Source #
See: newDeleteConnectionResponse
smart constructor.
DeleteConnectionResponse' (Maybe POSIX) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe ConnectionState) Int |
Instances
newDeleteConnectionResponse Source #
Create a value of DeleteConnectionResponse
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:creationTime:DeleteConnectionResponse'
, deleteConnectionResponse_creationTime
- A time stamp for the time that the connection was created.
$sel:lastModifiedTime:DeleteConnectionResponse'
, deleteConnectionResponse_lastModifiedTime
- A time stamp for the time that the connection was last modified before
it was deleted.
$sel:lastAuthorizedTime:DeleteConnectionResponse'
, deleteConnectionResponse_lastAuthorizedTime
- A time stamp for the time that the connection was last authorized before
it wa deleted.
$sel:connectionArn:DeleteConnectionResponse'
, deleteConnectionResponse_connectionArn
- The ARN of the connection that was deleted.
$sel:connectionState:DeleteConnectionResponse'
, deleteConnectionResponse_connectionState
- The state of the connection before it was deleted.
$sel:httpStatus:DeleteConnectionResponse'
, deleteConnectionResponse_httpStatus
- The response's http status code.
UpdateConnection
data UpdateConnection Source #
See: newUpdateConnection
smart constructor.
UpdateConnection' (Maybe UpdateConnectionAuthRequestParameters) (Maybe ConnectionAuthorizationType) (Maybe Text) Text |
Instances
Create a value of UpdateConnection
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:authParameters:UpdateConnection'
, updateConnection_authParameters
- The authorization parameters to use for the connection.
$sel:authorizationType:UpdateConnection'
, updateConnection_authorizationType
- The type of authorization to use for the connection.
$sel:description:UpdateConnection'
, updateConnection_description
- A description for the connection.
$sel:name:UpdateConnection'
, updateConnection_name
- The name of the connection to update.
data UpdateConnectionResponse Source #
See: newUpdateConnectionResponse
smart constructor.
UpdateConnectionResponse' (Maybe POSIX) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe ConnectionState) Int |
Instances
newUpdateConnectionResponse Source #
Create a value of UpdateConnectionResponse
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:creationTime:UpdateConnectionResponse'
, updateConnectionResponse_creationTime
- A time stamp for the time that the connection was created.
$sel:lastModifiedTime:UpdateConnectionResponse'
, updateConnectionResponse_lastModifiedTime
- A time stamp for the time that the connection was last modified.
$sel:lastAuthorizedTime:UpdateConnectionResponse'
, updateConnectionResponse_lastAuthorizedTime
- A time stamp for the time that the connection was last authorized.
$sel:connectionArn:UpdateConnectionResponse'
, updateConnectionResponse_connectionArn
- The ARN of the connection that was updated.
$sel:connectionState:UpdateConnectionResponse'
, updateConnectionResponse_connectionState
- The state of the connection that was updated.
$sel:httpStatus:UpdateConnectionResponse'
, updateConnectionResponse_httpStatus
- The response's http status code.
ListRules (Paginated)
See: newListRules
smart constructor.
Instances
newListRules :: ListRules Source #
Create a value of ListRules
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:nextToken:ListRules'
, listRules_nextToken
- The token returned by a previous call to retrieve the next set of
results.
$sel:eventBusName:ListRules'
, listRules_eventBusName
- The name or ARN of the event bus to list the rules for. If you omit
this, the default event bus is used.
$sel:namePrefix:ListRules'
, listRules_namePrefix
- The prefix matching the rule name.
$sel:limit:ListRules'
, listRules_limit
- The maximum number of results to return.
data ListRulesResponse Source #
See: newListRulesResponse
smart constructor.
Instances
Create a value of ListRulesResponse
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:rules:ListRulesResponse'
, listRulesResponse_rules
- The rules that match the specified criteria.
$sel:nextToken:ListRules'
, listRulesResponse_nextToken
- Indicates whether there are additional results to retrieve. If there are
no more results, the value is null.
$sel:httpStatus:ListRulesResponse'
, listRulesResponse_httpStatus
- The response's http status code.
PutRule
See: newPutRule
smart constructor.
PutRule' (Maybe Text) (Maybe RuleState) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Tag]) (Maybe Text) Text |
Instances
Create a value of PutRule
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:eventPattern:PutRule'
, putRule_eventPattern
- The event pattern. For more information, see
Events and Event Patterns
in the Amazon EventBridge User Guide.
$sel:state:PutRule'
, putRule_state
- Indicates whether the rule is enabled or disabled.
$sel:eventBusName:PutRule'
, putRule_eventBusName
- The name or ARN of the event bus to associate with this rule. If you
omit this, the default event bus is used.
$sel:scheduleExpression:PutRule'
, putRule_scheduleExpression
- The scheduling expression. For example, "cron(0 20 * * ? *)" or
"rate(5 minutes)".
$sel:description:PutRule'
, putRule_description
- A description of the rule.
$sel:tags:PutRule'
, putRule_tags
- The list of key-value pairs to associate with the rule.
$sel:roleArn:PutRule'
, putRule_roleArn
- The Amazon Resource Name (ARN) of the IAM role associated with the rule.
If you're setting an event bus in another account as the target and
that account granted permission to your account through an organization
instead of directly by the account ID, you must specify a RoleArn
with
proper permissions in the Target
structure, instead of here in this
parameter.
$sel:name:PutRule'
, putRule_name
- The name of the rule that you are creating or updating.
data PutRuleResponse Source #
See: newPutRuleResponse
smart constructor.
Instances
Create a value of PutRuleResponse
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:ruleArn:PutRuleResponse'
, putRuleResponse_ruleArn
- The Amazon Resource Name (ARN) of the rule.
$sel:httpStatus:PutRuleResponse'
, putRuleResponse_httpStatus
- The response's http status code.
DisableRule
data DisableRule Source #
See: newDisableRule
smart constructor.
Instances
Create a value of DisableRule
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:eventBusName:DisableRule'
, disableRule_eventBusName
- The name or ARN of the event bus associated with the rule. If you omit
this, the default event bus is used.
$sel:name:DisableRule'
, disableRule_name
- The name of the rule.
data DisableRuleResponse Source #
See: newDisableRuleResponse
smart constructor.
Instances
Eq DisableRuleResponse Source # | |
Defined in Amazonka.CloudWatchEvents.DisableRule (==) :: DisableRuleResponse -> DisableRuleResponse -> Bool # (/=) :: DisableRuleResponse -> DisableRuleResponse -> Bool # | |
Read DisableRuleResponse Source # | |
Show DisableRuleResponse Source # | |
Defined in Amazonka.CloudWatchEvents.DisableRule showsPrec :: Int -> DisableRuleResponse -> ShowS # show :: DisableRuleResponse -> String # showList :: [DisableRuleResponse] -> ShowS # | |
Generic DisableRuleResponse Source # | |
Defined in Amazonka.CloudWatchEvents.DisableRule type Rep DisableRuleResponse :: Type -> Type # from :: DisableRuleResponse -> Rep DisableRuleResponse x # to :: Rep DisableRuleResponse x -> DisableRuleResponse # | |
NFData DisableRuleResponse Source # | |
Defined in Amazonka.CloudWatchEvents.DisableRule rnf :: DisableRuleResponse -> () # | |
type Rep DisableRuleResponse Source # | |
Defined in Amazonka.CloudWatchEvents.DisableRule |
newDisableRuleResponse :: DisableRuleResponse Source #
Create a value of DisableRuleResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
PutPermission
data PutPermission Source #
See: newPutPermission
smart constructor.
Instances
newPutPermission :: PutPermission Source #
Create a value of PutPermission
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:action:PutPermission'
, putPermission_action
- The action that you are enabling the other account to perform.
$sel:eventBusName:PutPermission'
, putPermission_eventBusName
- The name of the event bus associated with the rule. If you omit this,
the default event bus is used.
$sel:principal:PutPermission'
, putPermission_principal
- The 12-digit Amazon Web Services account ID that you are permitting to
put events to your default event bus. Specify "*" to permit any
account to put events to your default event bus.
If you specify "*" without specifying Condition
, avoid creating
rules that may match undesirable events. To create more secure rules,
make sure that the event pattern for each rule contains an account
field with a specific account ID from which to receive events. Rules
with an account field do not match any events sent from other accounts.
$sel:policy:PutPermission'
, putPermission_policy
- A JSON string that describes the permission policy statement. You can
include a Policy
parameter in the request instead of using the
StatementId
, Action
, Principal
, or Condition
parameters.
$sel:statementId:PutPermission'
, putPermission_statementId
- An identifier string for the external account that you are granting
permissions to. If you later want to revoke the permission for this
external account, specify this StatementId
when you run
RemovePermission.
$sel:condition:PutPermission'
, putPermission_condition
- This parameter enables you to limit the permission to accounts that
fulfill a certain condition, such as being a member of a certain Amazon
Web Services organization. For more information about Amazon Web
Services Organizations, see
What Is Amazon Web Services Organizations
in the Amazon Web Services Organizations User Guide.
If you specify Condition
with an Amazon Web Services organization ID,
and specify "*" as the value for Principal
, you grant permission to
all the accounts in the named organization.
The Condition
is a JSON string which must contain Type
, Key
, and
Value
fields.
data PutPermissionResponse Source #
See: newPutPermissionResponse
smart constructor.
Instances
Eq PutPermissionResponse Source # | |
Defined in Amazonka.CloudWatchEvents.PutPermission (==) :: PutPermissionResponse -> PutPermissionResponse -> Bool # (/=) :: PutPermissionResponse -> PutPermissionResponse -> Bool # | |
Read PutPermissionResponse Source # | |
Show PutPermissionResponse Source # | |
Defined in Amazonka.CloudWatchEvents.PutPermission showsPrec :: Int -> PutPermissionResponse -> ShowS # show :: PutPermissionResponse -> String # showList :: [PutPermissionResponse] -> ShowS # | |
Generic PutPermissionResponse Source # | |
Defined in Amazonka.CloudWatchEvents.PutPermission type Rep PutPermissionResponse :: Type -> Type # | |
NFData PutPermissionResponse Source # | |
Defined in Amazonka.CloudWatchEvents.PutPermission rnf :: PutPermissionResponse -> () # | |
type Rep PutPermissionResponse Source # | |
Defined in Amazonka.CloudWatchEvents.PutPermission |
newPutPermissionResponse :: PutPermissionResponse Source #
Create a value of PutPermissionResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource
smart constructor.
Instances
newListTagsForResource Source #
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 resource for which you want to view tags.
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse
smart constructor.
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:
$sel:tags:ListTagsForResourceResponse'
, listTagsForResourceResponse_tags
- The list of tag keys and values associated with the resource you
specified
$sel:httpStatus:ListTagsForResourceResponse'
, listTagsForResourceResponse_httpStatus
- The response's http status code.
ListReplays
data ListReplays Source #
See: newListReplays
smart constructor.
Instances
newListReplays :: ListReplays Source #
Create a value of ListReplays
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:eventSourceArn:ListReplays'
, listReplays_eventSourceArn
- The ARN of the archive from which the events are replayed.
$sel:state:ListReplays'
, listReplays_state
- The state of the replay.
$sel:nextToken:ListReplays'
, listReplays_nextToken
- The token returned by a previous call to retrieve the next set of
results.
$sel:namePrefix:ListReplays'
, listReplays_namePrefix
- A name prefix to filter the replays returned. Only replays with name
that match the prefix are returned.
$sel:limit:ListReplays'
, listReplays_limit
- The maximum number of replays to retrieve.
data ListReplaysResponse Source #
See: newListReplaysResponse
smart constructor.
Instances
newListReplaysResponse Source #
Create a value of ListReplaysResponse
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:replays:ListReplaysResponse'
, listReplaysResponse_replays
- An array of Replay
objects that contain information about the replay.
$sel:nextToken:ListReplays'
, listReplaysResponse_nextToken
- The token returned by a previous call to retrieve the next set of
results.
$sel:httpStatus:ListReplaysResponse'
, listReplaysResponse_httpStatus
- The response's http status code.
CreateConnection
data CreateConnection Source #
See: newCreateConnection
smart constructor.
CreateConnection' (Maybe Text) Text ConnectionAuthorizationType CreateConnectionAuthRequestParameters |
Instances
Create a value of CreateConnection
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:description:CreateConnection'
, createConnection_description
- A description for the connection to create.
$sel:name:CreateConnection'
, createConnection_name
- The name for the connection to create.
$sel:authorizationType:CreateConnection'
, createConnection_authorizationType
- The type of authorization to use for the connection.
$sel:authParameters:CreateConnection'
, createConnection_authParameters
- A CreateConnectionAuthRequestParameters
object that contains the
authorization parameters to use to authorize with the endpoint.
data CreateConnectionResponse Source #
See: newCreateConnectionResponse
smart constructor.
Instances
newCreateConnectionResponse Source #
Create a value of CreateConnectionResponse
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:creationTime:CreateConnectionResponse'
, createConnectionResponse_creationTime
- A time stamp for the time that the connection was created.
$sel:lastModifiedTime:CreateConnectionResponse'
, createConnectionResponse_lastModifiedTime
- A time stamp for the time that the connection was last updated.
$sel:connectionArn:CreateConnectionResponse'
, createConnectionResponse_connectionArn
- The ARN of the connection that was created by the request.
$sel:connectionState:CreateConnectionResponse'
, createConnectionResponse_connectionState
- The state of the connection that was created by the request.
$sel:httpStatus:CreateConnectionResponse'
, createConnectionResponse_httpStatus
- The response's http status code.
CancelReplay
data CancelReplay Source #
See: newCancelReplay
smart constructor.
Instances
Create a value of CancelReplay
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:replayName:CancelReplay'
, cancelReplay_replayName
- The name of the replay to cancel.
data CancelReplayResponse Source #
See: newCancelReplayResponse
smart constructor.
Instances
newCancelReplayResponse Source #
Create a value of CancelReplayResponse
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:state:CancelReplayResponse'
, cancelReplayResponse_state
- The current state of the replay.
$sel:replayArn:CancelReplayResponse'
, cancelReplayResponse_replayArn
- The ARN of the replay to cancel.
$sel:stateReason:CancelReplayResponse'
, cancelReplayResponse_stateReason
- The reason that the replay is in the current state.
$sel:httpStatus:CancelReplayResponse'
, cancelReplayResponse_httpStatus
- The response's http status code.
ListTargetsByRule (Paginated)
data ListTargetsByRule Source #
See: newListTargetsByRule
smart constructor.
Instances
Create a value of ListTargetsByRule
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:nextToken:ListTargetsByRule'
, listTargetsByRule_nextToken
- The token returned by a previous call to retrieve the next set of
results.
$sel:eventBusName:ListTargetsByRule'
, listTargetsByRule_eventBusName
- The name or ARN of the event bus associated with the rule. If you omit
this, the default event bus is used.
$sel:limit:ListTargetsByRule'
, listTargetsByRule_limit
- The maximum number of results to return.
$sel:rule:ListTargetsByRule'
, listTargetsByRule_rule
- The name of the rule.
data ListTargetsByRuleResponse Source #
See: newListTargetsByRuleResponse
smart constructor.
Instances
newListTargetsByRuleResponse Source #
Create a value of ListTargetsByRuleResponse
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:nextToken:ListTargetsByRule'
, listTargetsByRuleResponse_nextToken
- Indicates whether there are additional results to retrieve. If there are
no more results, the value is null.
$sel:targets:ListTargetsByRuleResponse'
, listTargetsByRuleResponse_targets
- The targets assigned to the rule.
$sel:httpStatus:ListTargetsByRuleResponse'
, listTargetsByRuleResponse_httpStatus
- The response's http status code.
RemovePermission
data RemovePermission Source #
See: newRemovePermission
smart constructor.
Instances
newRemovePermission :: RemovePermission Source #
Create a value of RemovePermission
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:eventBusName:RemovePermission'
, removePermission_eventBusName
- The name of the event bus to revoke permissions for. If you omit this,
the default event bus is used.
$sel:removeAllPermissions:RemovePermission'
, removePermission_removeAllPermissions
- Specifies whether to remove all permissions.
$sel:statementId:RemovePermission'
, removePermission_statementId
- The statement ID corresponding to the account that is no longer allowed
to put events to the default event bus.
data RemovePermissionResponse Source #
See: newRemovePermissionResponse
smart constructor.
Instances
newRemovePermissionResponse :: RemovePermissionResponse Source #
Create a value of RemovePermissionResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
ListApiDestinations
data ListApiDestinations Source #
See: newListApiDestinations
smart constructor.
Instances
newListApiDestinations :: ListApiDestinations Source #
Create a value of ListApiDestinations
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:nextToken:ListApiDestinations'
, listApiDestinations_nextToken
- The token returned by a previous call to retrieve the next set of
results.
$sel:namePrefix:ListApiDestinations'
, listApiDestinations_namePrefix
- A name prefix to filter results returned. Only API destinations with a
name that starts with the prefix are returned.
$sel:limit:ListApiDestinations'
, listApiDestinations_limit
- The maximum number of API destinations to include in the response.
$sel:connectionArn:ListApiDestinations'
, listApiDestinations_connectionArn
- The ARN of the connection specified for the API destination.
data ListApiDestinationsResponse Source #
See: newListApiDestinationsResponse
smart constructor.
Instances
newListApiDestinationsResponse Source #
Create a value of ListApiDestinationsResponse
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:apiDestinations:ListApiDestinationsResponse'
, listApiDestinationsResponse_apiDestinations
- An array of ApiDestination
objects that include information about an
API destination.
$sel:nextToken:ListApiDestinations'
, listApiDestinationsResponse_nextToken
- A token you can use in a subsequent request to retrieve the next set of
results.
$sel:httpStatus:ListApiDestinationsResponse'
, listApiDestinationsResponse_httpStatus
- The response's http status code.
UpdateApiDestination
data UpdateApiDestination Source #
See: newUpdateApiDestination
smart constructor.
UpdateApiDestination' (Maybe ApiDestinationHttpMethod) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe Text) Text |
Instances
newUpdateApiDestination Source #
Create a value of UpdateApiDestination
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:httpMethod:UpdateApiDestination'
, updateApiDestination_httpMethod
- The method to use for the API destination.
$sel:invocationEndpoint:UpdateApiDestination'
, updateApiDestination_invocationEndpoint
- The URL to the endpoint to use for the API destination.
$sel:invocationRateLimitPerSecond:UpdateApiDestination'
, updateApiDestination_invocationRateLimitPerSecond
- The maximum number of invocations per second to send to the API
destination.
$sel:connectionArn:UpdateApiDestination'
, updateApiDestination_connectionArn
- The ARN of the connection to use for the API destination.
$sel:description:UpdateApiDestination'
, updateApiDestination_description
- The name of the API destination to update.
$sel:name:UpdateApiDestination'
, updateApiDestination_name
- The name of the API destination to update.
data UpdateApiDestinationResponse Source #
See: newUpdateApiDestinationResponse
smart constructor.
UpdateApiDestinationResponse' (Maybe POSIX) (Maybe POSIX) (Maybe ApiDestinationState) (Maybe Text) Int |
Instances
newUpdateApiDestinationResponse Source #
Create a value of UpdateApiDestinationResponse
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:creationTime:UpdateApiDestinationResponse'
, updateApiDestinationResponse_creationTime
- A time stamp for the time that the API destination was created.
$sel:lastModifiedTime:UpdateApiDestinationResponse'
, updateApiDestinationResponse_lastModifiedTime
- A time stamp for the time that the API destination was last modified.
$sel:apiDestinationState:UpdateApiDestinationResponse'
, updateApiDestinationResponse_apiDestinationState
- The state of the API destination that was updated.
$sel:apiDestinationArn:UpdateApiDestinationResponse'
, updateApiDestinationResponse_apiDestinationArn
- The ARN of the API destination that was updated.
$sel:httpStatus:UpdateApiDestinationResponse'
, updateApiDestinationResponse_httpStatus
- The response's http status code.
DeleteApiDestination
data DeleteApiDestination Source #
See: newDeleteApiDestination
smart constructor.
Instances
newDeleteApiDestination Source #
Create a value of DeleteApiDestination
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:DeleteApiDestination'
, deleteApiDestination_name
- The name of the destination to delete.
data DeleteApiDestinationResponse Source #
See: newDeleteApiDestinationResponse
smart constructor.
Instances
newDeleteApiDestinationResponse Source #
Create a value of DeleteApiDestinationResponse
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:DeleteApiDestinationResponse'
, deleteApiDestinationResponse_httpStatus
- The response's http status code.
ActivateEventSource
data ActivateEventSource Source #
See: newActivateEventSource
smart constructor.
Instances
newActivateEventSource Source #
Create a value of ActivateEventSource
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:ActivateEventSource'
, activateEventSource_name
- The name of the partner event source to activate.
data ActivateEventSourceResponse Source #
See: newActivateEventSourceResponse
smart constructor.
Instances
newActivateEventSourceResponse :: ActivateEventSourceResponse Source #
Create a value of ActivateEventSourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
CreateApiDestination
data CreateApiDestination Source #
See: newCreateApiDestination
smart constructor.
Instances
newCreateApiDestination Source #
:: Text | |
-> Text | |
-> Text | |
-> ApiDestinationHttpMethod | |
-> CreateApiDestination |
Create a value of CreateApiDestination
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:invocationRateLimitPerSecond:CreateApiDestination'
, createApiDestination_invocationRateLimitPerSecond
- The maximum number of requests per second to send to the HTTP invocation
endpoint.
$sel:description:CreateApiDestination'
, createApiDestination_description
- A description for the API destination to create.
$sel:name:CreateApiDestination'
, createApiDestination_name
- The name for the API destination to create.
$sel:connectionArn:CreateApiDestination'
, createApiDestination_connectionArn
- The ARN of the connection to use for the API destination. The
destination endpoint must support the authorization type specified for
the connection.
$sel:invocationEndpoint:CreateApiDestination'
, createApiDestination_invocationEndpoint
- The URL to the HTTP invocation endpoint for the API destination.
$sel:httpMethod:CreateApiDestination'
, createApiDestination_httpMethod
- The method to use for the request to the HTTP invocation endpoint.
data CreateApiDestinationResponse Source #
See: newCreateApiDestinationResponse
smart constructor.
CreateApiDestinationResponse' (Maybe POSIX) (Maybe POSIX) (Maybe ApiDestinationState) (Maybe Text) Int |
Instances
newCreateApiDestinationResponse Source #
Create a value of CreateApiDestinationResponse
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:creationTime:CreateApiDestinationResponse'
, createApiDestinationResponse_creationTime
- A time stamp indicating the time that the API destination was created.
$sel:lastModifiedTime:CreateApiDestinationResponse'
, createApiDestinationResponse_lastModifiedTime
- A time stamp indicating the time that the API destination was last
modified.
$sel:apiDestinationState:CreateApiDestinationResponse'
, createApiDestinationResponse_apiDestinationState
- The state of the API destination that was created by the request.
$sel:apiDestinationArn:CreateApiDestinationResponse'
, createApiDestinationResponse_apiDestinationArn
- The ARN of the API destination that was created by the request.
$sel:httpStatus:CreateApiDestinationResponse'
, createApiDestinationResponse_httpStatus
- The response's http status code.
PutPartnerEvents
data PutPartnerEvents Source #
See: newPutPartnerEvents
smart constructor.
Instances
Create a value of PutPartnerEvents
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:entries:PutPartnerEvents'
, putPartnerEvents_entries
- The list of events to write to the event bus.
data PutPartnerEventsResponse Source #
See: newPutPartnerEventsResponse
smart constructor.
Instances
newPutPartnerEventsResponse Source #
Create a value of PutPartnerEventsResponse
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:failedEntryCount:PutPartnerEventsResponse'
, putPartnerEventsResponse_failedEntryCount
- The number of events from this operation that could not be written to
the partner event bus.
$sel:entries:PutPartnerEvents'
, putPartnerEventsResponse_entries
- The list of events from this operation that were successfully written to
the partner event bus.
$sel:httpStatus:PutPartnerEventsResponse'
, putPartnerEventsResponse_httpStatus
- The response's http status code.
DescribeConnection
data DescribeConnection Source #
See: newDescribeConnection
smart constructor.
Instances
newDescribeConnection Source #
Create a value of DescribeConnection
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:DescribeConnection'
, describeConnection_name
- The name of the connection to retrieve.
data DescribeConnectionResponse Source #
See: newDescribeConnectionResponse
smart constructor.
Instances
newDescribeConnectionResponse Source #
Create a value of DescribeConnectionResponse
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:creationTime:DescribeConnectionResponse'
, describeConnectionResponse_creationTime
- A time stamp for the time that the connection was created.
$sel:lastModifiedTime:DescribeConnectionResponse'
, describeConnectionResponse_lastModifiedTime
- A time stamp for the time that the connection was last modified.
$sel:name:DescribeConnection'
, describeConnectionResponse_name
- The name of the connection retrieved.
$sel:authParameters:DescribeConnectionResponse'
, describeConnectionResponse_authParameters
- The parameters to use for authorization for the connection.
$sel:lastAuthorizedTime:DescribeConnectionResponse'
, describeConnectionResponse_lastAuthorizedTime
- A time stamp for the time that the connection was last authorized.
$sel:authorizationType:DescribeConnectionResponse'
, describeConnectionResponse_authorizationType
- The type of authorization specified for the connection.
$sel:connectionArn:DescribeConnectionResponse'
, describeConnectionResponse_connectionArn
- The ARN of the connection retrieved.
$sel:stateReason:DescribeConnectionResponse'
, describeConnectionResponse_stateReason
- The reason that the connection is in the current connection state.
$sel:secretArn:DescribeConnectionResponse'
, describeConnectionResponse_secretArn
- The ARN of the secret created from the authorization parameters
specified for the connection.
$sel:description:DescribeConnectionResponse'
, describeConnectionResponse_description
- The description for the connection retrieved.
$sel:connectionState:DescribeConnectionResponse'
, describeConnectionResponse_connectionState
- The state of the connection retrieved.
$sel:httpStatus:DescribeConnectionResponse'
, describeConnectionResponse_httpStatus
- The response's http status code.
DescribeRule
data DescribeRule Source #
See: newDescribeRule
smart constructor.
Instances
Create a value of DescribeRule
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:eventBusName:DescribeRule'
, describeRule_eventBusName
- The name or ARN of the event bus associated with the rule. If you omit
this, the default event bus is used.
$sel:name:DescribeRule'
, describeRule_name
- The name of the rule.
data DescribeRuleResponse Source #
See: newDescribeRuleResponse
smart constructor.
DescribeRuleResponse' (Maybe Text) (Maybe RuleState) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int |
Instances
newDescribeRuleResponse Source #
Create a value of DescribeRuleResponse
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:eventPattern:DescribeRuleResponse'
, describeRuleResponse_eventPattern
- The event pattern. For more information, see
Events and Event Patterns
in the Amazon EventBridge User Guide.
$sel:state:DescribeRuleResponse'
, describeRuleResponse_state
- Specifies whether the rule is enabled or disabled.
$sel:arn:DescribeRuleResponse'
, describeRuleResponse_arn
- The Amazon Resource Name (ARN) of the rule.
$sel:createdBy:DescribeRuleResponse'
, describeRuleResponse_createdBy
- The account ID of the user that created the rule. If you use PutRule
to put a rule on an event bus in another account, the other account is
the owner of the rule, and the rule ARN includes the account ID for that
account. However, the value for CreatedBy
is the account ID as the
account that created the rule in the other account.
$sel:eventBusName:DescribeRule'
, describeRuleResponse_eventBusName
- The name of the event bus associated with the rule.
$sel:scheduleExpression:DescribeRuleResponse'
, describeRuleResponse_scheduleExpression
- The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5
minutes)".
$sel:name:DescribeRule'
, describeRuleResponse_name
- The name of the rule.
$sel:description:DescribeRuleResponse'
, describeRuleResponse_description
- The description of the rule.
$sel:managedBy:DescribeRuleResponse'
, describeRuleResponse_managedBy
- If this is a managed rule, created by an Amazon Web Services service on
your behalf, this field displays the principal name of the Amazon Web
Services service that created the rule.
$sel:roleArn:DescribeRuleResponse'
, describeRuleResponse_roleArn
- The Amazon Resource Name (ARN) of the IAM role associated with the rule.
$sel:httpStatus:DescribeRuleResponse'
, describeRuleResponse_httpStatus
- The response's http status code.
ListArchives
data ListArchives Source #
See: newListArchives
smart constructor.
Instances
newListArchives :: ListArchives Source #
Create a value of ListArchives
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:eventSourceArn:ListArchives'
, listArchives_eventSourceArn
- The ARN of the event source associated with the archive.
$sel:state:ListArchives'
, listArchives_state
- The state of the archive.
$sel:nextToken:ListArchives'
, listArchives_nextToken
- The token returned by a previous call to retrieve the next set of
results.
$sel:namePrefix:ListArchives'
, listArchives_namePrefix
- A name prefix to filter the archives returned. Only archives with name
that match the prefix are returned.
$sel:limit:ListArchives'
, listArchives_limit
- The maximum number of results to return.
data ListArchivesResponse Source #
See: newListArchivesResponse
smart constructor.
Instances
newListArchivesResponse Source #
Create a value of ListArchivesResponse
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:archives:ListArchivesResponse'
, listArchivesResponse_archives
- An array of Archive
objects that include details about an archive.
$sel:nextToken:ListArchives'
, listArchivesResponse_nextToken
- The token returned by a previous call to retrieve the next set of
results.
$sel:httpStatus:ListArchivesResponse'
, listArchivesResponse_httpStatus
- The response's http status code.
StartReplay
data StartReplay Source #
See: newStartReplay
smart constructor.
Instances
:: Text | |
-> Text | |
-> UTCTime | |
-> UTCTime | |
-> ReplayDestination | |
-> StartReplay |
Create a value of StartReplay
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:description:StartReplay'
, startReplay_description
- A description for the replay to start.
$sel:replayName:StartReplay'
, startReplay_replayName
- The name of the replay to start.
$sel:eventSourceArn:StartReplay'
, startReplay_eventSourceArn
- The ARN of the archive to replay events from.
$sel:eventStartTime:StartReplay'
, startReplay_eventStartTime
- A time stamp for the time to start replaying events. Only events that
occurred between the EventStartTime
and EventEndTime
are replayed.
$sel:eventEndTime:StartReplay'
, startReplay_eventEndTime
- A time stamp for the time to stop replaying events. Only events that
occurred between the EventStartTime
and EventEndTime
are replayed.
$sel:destination:StartReplay'
, startReplay_destination
- A ReplayDestination
object that includes details about the destination
for the replay.
data StartReplayResponse Source #
See: newStartReplayResponse
smart constructor.
StartReplayResponse' (Maybe ReplayState) (Maybe POSIX) (Maybe Text) (Maybe Text) Int |
Instances
newStartReplayResponse Source #
Create a value of StartReplayResponse
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:state:StartReplayResponse'
, startReplayResponse_state
- The state of the replay.
$sel:replayStartTime:StartReplayResponse'
, startReplayResponse_replayStartTime
- The time at which the replay started.
$sel:replayArn:StartReplayResponse'
, startReplayResponse_replayArn
- The ARN of the replay.
$sel:stateReason:StartReplayResponse'
, startReplayResponse_stateReason
- The reason that the replay is in the state.
$sel:httpStatus:StartReplayResponse'
, startReplayResponse_httpStatus
- The response's http status code.
DeletePartnerEventSource
data DeletePartnerEventSource Source #
See: newDeletePartnerEventSource
smart constructor.
Instances
newDeletePartnerEventSource Source #
:: Text | |
-> Text | |
-> DeletePartnerEventSource |
Create a value of DeletePartnerEventSource
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:DeletePartnerEventSource'
, deletePartnerEventSource_name
- The name of the event source to delete.
$sel:account:DeletePartnerEventSource'
, deletePartnerEventSource_account
- The Amazon Web Services account ID of the Amazon Web Services customer
that the event source was created for.
data DeletePartnerEventSourceResponse Source #
See: newDeletePartnerEventSourceResponse
smart constructor.
Instances
Eq DeletePartnerEventSourceResponse Source # | |
Read DeletePartnerEventSourceResponse Source # | |
Show DeletePartnerEventSourceResponse Source # | |
Generic DeletePartnerEventSourceResponse Source # | |
NFData DeletePartnerEventSourceResponse Source # | |
Defined in Amazonka.CloudWatchEvents.DeletePartnerEventSource rnf :: DeletePartnerEventSourceResponse -> () # | |
type Rep DeletePartnerEventSourceResponse Source # | |
Defined in Amazonka.CloudWatchEvents.DeletePartnerEventSource type Rep DeletePartnerEventSourceResponse = D1 ('MetaData "DeletePartnerEventSourceResponse" "Amazonka.CloudWatchEvents.DeletePartnerEventSource" "libZSservicesZSamazonka-cloudwatch-eventsZSamazonka-cloudwatch-events" 'False) (C1 ('MetaCons "DeletePartnerEventSourceResponse'" 'PrefixI 'False) (U1 :: Type -> Type)) |
newDeletePartnerEventSourceResponse :: DeletePartnerEventSourceResponse Source #
Create a value of DeletePartnerEventSourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DescribeReplay
data DescribeReplay Source #
See: newDescribeReplay
smart constructor.
Instances
Create a value of DescribeReplay
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:replayName:DescribeReplay'
, describeReplay_replayName
- The name of the replay to retrieve.
data DescribeReplayResponse Source #
See: newDescribeReplayResponse
smart constructor.
DescribeReplayResponse' (Maybe Text) (Maybe ReplayDestination) (Maybe ReplayState) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) Int |
Instances
newDescribeReplayResponse Source #
Create a value of DescribeReplayResponse
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:eventSourceArn:DescribeReplayResponse'
, describeReplayResponse_eventSourceArn
- The ARN of the archive events were replayed from.
$sel:destination:DescribeReplayResponse'
, describeReplayResponse_destination
- A ReplayDestination
object that contains details about the replay.
$sel:state:DescribeReplayResponse'
, describeReplayResponse_state
- The current state of the replay.
$sel:eventEndTime:DescribeReplayResponse'
, describeReplayResponse_eventEndTime
- The time stamp for the last event that was replayed from the archive.
$sel:replayStartTime:DescribeReplayResponse'
, describeReplayResponse_replayStartTime
- A time stamp for the time that the replay started.
$sel:replayArn:DescribeReplayResponse'
, describeReplayResponse_replayArn
- The ARN of the replay.
$sel:replayEndTime:DescribeReplayResponse'
, describeReplayResponse_replayEndTime
- A time stamp for the time that the replay stopped.
$sel:eventLastReplayedTime:DescribeReplayResponse'
, describeReplayResponse_eventLastReplayedTime
- The time that the event was last replayed.
$sel:eventStartTime:DescribeReplayResponse'
, describeReplayResponse_eventStartTime
- The time stamp of the first event that was last replayed from the
archive.
$sel:replayName:DescribeReplay'
, describeReplayResponse_replayName
- The name of the replay.
$sel:stateReason:DescribeReplayResponse'
, describeReplayResponse_stateReason
- The reason that the replay is in the current state.
$sel:description:DescribeReplayResponse'
, describeReplayResponse_description
- The description of the replay.
$sel:httpStatus:DescribeReplayResponse'
, describeReplayResponse_httpStatus
- The response's http status code.
DescribeApiDestination
data DescribeApiDestination Source #
See: newDescribeApiDestination
smart constructor.
Instances
newDescribeApiDestination Source #
Create a value of DescribeApiDestination
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:DescribeApiDestination'
, describeApiDestination_name
- The name of the API destination to retrieve.
data DescribeApiDestinationResponse Source #
See: newDescribeApiDestinationResponse
smart constructor.
DescribeApiDestinationResponse' (Maybe POSIX) (Maybe ApiDestinationHttpMethod) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Natural) (Maybe ApiDestinationState) (Maybe Text) (Maybe Text) (Maybe Text) Int |
Instances
newDescribeApiDestinationResponse Source #
Create a value of DescribeApiDestinationResponse
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:creationTime:DescribeApiDestinationResponse'
, describeApiDestinationResponse_creationTime
- A time stamp for the time that the API destination was created.
$sel:httpMethod:DescribeApiDestinationResponse'
, describeApiDestinationResponse_httpMethod
- The method to use to connect to the HTTP endpoint.
$sel:invocationEndpoint:DescribeApiDestinationResponse'
, describeApiDestinationResponse_invocationEndpoint
- The URL to use to connect to the HTTP endpoint.
$sel:lastModifiedTime:DescribeApiDestinationResponse'
, describeApiDestinationResponse_lastModifiedTime
- A time stamp for the time that the API destination was last modified.
$sel:name:DescribeApiDestination'
, describeApiDestinationResponse_name
- The name of the API destination retrieved.
$sel:invocationRateLimitPerSecond:DescribeApiDestinationResponse'
, describeApiDestinationResponse_invocationRateLimitPerSecond
- The maximum number of invocations per second to specified for the API
destination. Note that if you set the invocation rate maximum to a value
lower the rate necessary to send all events received on to the
destination HTTP endpoint, some events may not be delivered within the
24-hour retry window. If you plan to set the rate lower than the rate
necessary to deliver all events, consider using a dead-letter queue to
catch events that are not delivered within 24 hours.
$sel:apiDestinationState:DescribeApiDestinationResponse'
, describeApiDestinationResponse_apiDestinationState
- The state of the API destination retrieved.
$sel:connectionArn:DescribeApiDestinationResponse'
, describeApiDestinationResponse_connectionArn
- The ARN of the connection specified for the API destination retrieved.
$sel:description:DescribeApiDestinationResponse'
, describeApiDestinationResponse_description
- The description for the API destination retrieved.
$sel:apiDestinationArn:DescribeApiDestinationResponse'
, describeApiDestinationResponse_apiDestinationArn
- The ARN of the API destination retrieved.
$sel:httpStatus:DescribeApiDestinationResponse'
, describeApiDestinationResponse_httpStatus
- The response's http status code.
ListEventBuses
data ListEventBuses Source #
See: newListEventBuses
smart constructor.
Instances
newListEventBuses :: ListEventBuses Source #
Create a value of ListEventBuses
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:nextToken:ListEventBuses'
, listEventBuses_nextToken
- The token returned by a previous call to retrieve the next set of
results.
$sel:namePrefix:ListEventBuses'
, listEventBuses_namePrefix
- Specifying this limits the results to only those event buses with names
that start with the specified prefix.
$sel:limit:ListEventBuses'
, listEventBuses_limit
- Specifying this 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.
data ListEventBusesResponse Source #
See: newListEventBusesResponse
smart constructor.
Instances
newListEventBusesResponse Source #
Create a value of ListEventBusesResponse
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:eventBuses:ListEventBusesResponse'
, listEventBusesResponse_eventBuses
- This list of event buses.
$sel:nextToken:ListEventBuses'
, listEventBusesResponse_nextToken
- A token you can use in a subsequent operation to retrieve the next set
of results.
$sel:httpStatus:ListEventBusesResponse'
, listEventBusesResponse_httpStatus
- The response's http status code.
CreateEventBus
data CreateEventBus Source #
See: newCreateEventBus
smart constructor.
Instances
Create a value of CreateEventBus
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:eventSourceName:CreateEventBus'
, createEventBus_eventSourceName
- If you are creating a partner event bus, this specifies the partner
event source that the new event bus will be matched with.
$sel:tags:CreateEventBus'
, createEventBus_tags
- Tags to associate with the event bus.
$sel:name:CreateEventBus'
, createEventBus_name
- The name of the new event bus.
Event bus names cannot contain the / character. You can't use the name
default
for a custom event bus, as this name is already used for your
account's default event bus.
If this is a partner event bus, the name must exactly match the name of the partner event source that this event bus is matched to.
data CreateEventBusResponse Source #
See: newCreateEventBusResponse
smart constructor.
Instances
newCreateEventBusResponse Source #
Create a value of CreateEventBusResponse
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:eventBusArn:CreateEventBusResponse'
, createEventBusResponse_eventBusArn
- The ARN of the new event bus.
$sel:httpStatus:CreateEventBusResponse'
, createEventBusResponse_httpStatus
- The response's http status code.
DescribeEventSource
data DescribeEventSource Source #
See: newDescribeEventSource
smart constructor.
Instances
newDescribeEventSource Source #
Create a value of DescribeEventSource
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:DescribeEventSource'
, describeEventSource_name
- The name of the partner event source to display the details of.
data DescribeEventSourceResponse Source #
See: newDescribeEventSourceResponse
smart constructor.
DescribeEventSourceResponse' (Maybe POSIX) (Maybe EventSourceState) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) Int |
Instances
newDescribeEventSourceResponse Source #
Create a value of DescribeEventSourceResponse
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:creationTime:DescribeEventSourceResponse'
, describeEventSourceResponse_creationTime
- The date and time that the event source was created.
$sel:state:DescribeEventSourceResponse'
, describeEventSourceResponse_state
- The state of the event source. If it is ACTIVE, you have already created
a matching event bus for this event source, and that event bus is
active. If it is PENDING, either you haven't yet created a matching
event bus, or that event bus is deactivated. If it is DELETED, you have
created a matching event bus, but the event source has since been
deleted.
$sel:arn:DescribeEventSourceResponse'
, describeEventSourceResponse_arn
- The ARN of the partner event source.
$sel:createdBy:DescribeEventSourceResponse'
, describeEventSourceResponse_createdBy
- The name of the SaaS partner that created the event source.
$sel:name:DescribeEventSource'
, describeEventSourceResponse_name
- The name of the partner event source.
$sel:expirationTime:DescribeEventSourceResponse'
, describeEventSourceResponse_expirationTime
- The date and time that the event source will expire if you do not create
a matching event bus.
$sel:httpStatus:DescribeEventSourceResponse'
, describeEventSourceResponse_httpStatus
- The response's http status code.
DescribeArchive
data DescribeArchive Source #
See: newDescribeArchive
smart constructor.
Instances
Create a value of DescribeArchive
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:archiveName:DescribeArchive'
, describeArchive_archiveName
- The name of the archive to retrieve.
data DescribeArchiveResponse Source #
See: newDescribeArchiveResponse
smart constructor.
DescribeArchiveResponse' (Maybe POSIX) (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe ArchiveState) (Maybe Integer) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Text) Int |
Instances
newDescribeArchiveResponse Source #
Create a value of DescribeArchiveResponse
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:creationTime:DescribeArchiveResponse'
, describeArchiveResponse_creationTime
- The time at which the archive was created.
$sel:sizeBytes:DescribeArchiveResponse'
, describeArchiveResponse_sizeBytes
- The size of the archive in bytes.
$sel:eventSourceArn:DescribeArchiveResponse'
, describeArchiveResponse_eventSourceArn
- The ARN of the event source associated with the archive.
$sel:eventPattern:DescribeArchiveResponse'
, describeArchiveResponse_eventPattern
- The event pattern used to filter events sent to the archive.
$sel:state:DescribeArchiveResponse'
, describeArchiveResponse_state
- The state of the archive.
$sel:eventCount:DescribeArchiveResponse'
, describeArchiveResponse_eventCount
- The number of events in the archive.
$sel:archiveName:DescribeArchive'
, describeArchiveResponse_archiveName
- The name of the archive.
$sel:retentionDays:DescribeArchiveResponse'
, describeArchiveResponse_retentionDays
- The number of days to retain events for in the archive.
$sel:archiveArn:DescribeArchiveResponse'
, describeArchiveResponse_archiveArn
- The ARN of the archive.
$sel:stateReason:DescribeArchiveResponse'
, describeArchiveResponse_stateReason
- The reason that the archive is in the state.
$sel:description:DescribeArchiveResponse'
, describeArchiveResponse_description
- The description of the archive.
$sel:httpStatus:DescribeArchiveResponse'
, describeArchiveResponse_httpStatus
- The response's http status code.
EnableRule
data EnableRule Source #
See: newEnableRule
smart constructor.
Instances
Create a value of EnableRule
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:eventBusName:EnableRule'
, enableRule_eventBusName
- The name or ARN of the event bus associated with the rule. If you omit
this, the default event bus is used.
$sel:name:EnableRule'
, enableRule_name
- The name of the rule.
data EnableRuleResponse Source #
See: newEnableRuleResponse
smart constructor.
Instances
Eq EnableRuleResponse Source # | |
Defined in Amazonka.CloudWatchEvents.EnableRule (==) :: EnableRuleResponse -> EnableRuleResponse -> Bool # (/=) :: EnableRuleResponse -> EnableRuleResponse -> Bool # | |
Read EnableRuleResponse Source # | |
Show EnableRuleResponse Source # | |
Defined in Amazonka.CloudWatchEvents.EnableRule showsPrec :: Int -> EnableRuleResponse -> ShowS # show :: EnableRuleResponse -> String # showList :: [EnableRuleResponse] -> ShowS # | |
Generic EnableRuleResponse Source # | |
Defined in Amazonka.CloudWatchEvents.EnableRule type Rep EnableRuleResponse :: Type -> Type # from :: EnableRuleResponse -> Rep EnableRuleResponse x # to :: Rep EnableRuleResponse x -> EnableRuleResponse # | |
NFData EnableRuleResponse Source # | |
Defined in Amazonka.CloudWatchEvents.EnableRule rnf :: EnableRuleResponse -> () # | |
type Rep EnableRuleResponse Source # | |
Defined in Amazonka.CloudWatchEvents.EnableRule |
newEnableRuleResponse :: EnableRuleResponse Source #
Create a value of EnableRuleResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
ListRuleNamesByTarget (Paginated)
data ListRuleNamesByTarget Source #
See: newListRuleNamesByTarget
smart constructor.
Instances
newListRuleNamesByTarget Source #
Create a value of ListRuleNamesByTarget
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:nextToken:ListRuleNamesByTarget'
, listRuleNamesByTarget_nextToken
- The token returned by a previous call to retrieve the next set of
results.
$sel:eventBusName:ListRuleNamesByTarget'
, listRuleNamesByTarget_eventBusName
- The name or ARN of the event bus to list rules for. If you omit this,
the default event bus is used.
$sel:limit:ListRuleNamesByTarget'
, listRuleNamesByTarget_limit
- The maximum number of results to return.
$sel:targetArn:ListRuleNamesByTarget'
, listRuleNamesByTarget_targetArn
- The Amazon Resource Name (ARN) of the target resource.
data ListRuleNamesByTargetResponse Source #
See: newListRuleNamesByTargetResponse
smart constructor.
Instances
newListRuleNamesByTargetResponse Source #
Create a value of ListRuleNamesByTargetResponse
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:ruleNames:ListRuleNamesByTargetResponse'
, listRuleNamesByTargetResponse_ruleNames
- The names of the rules that can invoke the given target.
$sel:nextToken:ListRuleNamesByTarget'
, listRuleNamesByTargetResponse_nextToken
- Indicates whether there are additional results to retrieve. If there are
no more results, the value is null.
$sel:httpStatus:ListRuleNamesByTargetResponse'
, listRuleNamesByTargetResponse_httpStatus
- The response's http status code.
TestEventPattern
data TestEventPattern Source #
See: newTestEventPattern
smart constructor.
Instances
Create a value of TestEventPattern
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:eventPattern:TestEventPattern'
, testEventPattern_eventPattern
- The event pattern. For more information, see
Events and Event Patterns
in the Amazon EventBridge User Guide.
$sel:event:TestEventPattern'
, testEventPattern_event
- The event, in JSON format, to test against the event pattern. The JSON
must follow the format specified in
Amazon Web Services Events,
and the following fields are mandatory:
id
account
source
time
region
resources
detail-type
data TestEventPatternResponse Source #
See: newTestEventPatternResponse
smart constructor.
Instances
newTestEventPatternResponse Source #
Create a value of TestEventPatternResponse
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:result:TestEventPatternResponse'
, testEventPatternResponse_result
- Indicates whether the event matches the event pattern.
$sel:httpStatus:TestEventPatternResponse'
, testEventPatternResponse_httpStatus
- The response's http status code.
DescribePartnerEventSource
data DescribePartnerEventSource Source #
See: newDescribePartnerEventSource
smart constructor.
Instances
newDescribePartnerEventSource Source #
Create a value of DescribePartnerEventSource
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:DescribePartnerEventSource'
, describePartnerEventSource_name
- The name of the event source to display.
data DescribePartnerEventSourceResponse Source #
See: newDescribePartnerEventSourceResponse
smart constructor.
Instances
newDescribePartnerEventSourceResponse Source #
Create a value of DescribePartnerEventSourceResponse
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:DescribePartnerEventSourceResponse'
, describePartnerEventSourceResponse_arn
- The ARN of the event source.
$sel:name:DescribePartnerEventSource'
, describePartnerEventSourceResponse_name
- The name of the event source.
$sel:httpStatus:DescribePartnerEventSourceResponse'
, describePartnerEventSourceResponse_httpStatus
- The response's http status code.
DescribeEventBus
data DescribeEventBus Source #
See: newDescribeEventBus
smart constructor.
Instances
newDescribeEventBus :: DescribeEventBus Source #
Create a value of DescribeEventBus
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:DescribeEventBus'
, describeEventBus_name
- The name or ARN of the event bus to show details for. If you omit this,
the default event bus is displayed.
data DescribeEventBusResponse Source #
See: newDescribeEventBusResponse
smart constructor.
Instances
newDescribeEventBusResponse Source #
Create a value of DescribeEventBusResponse
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:DescribeEventBusResponse'
, describeEventBusResponse_arn
- The Amazon Resource Name (ARN) of the account permitted to write events
to the current account.
$sel:name:DescribeEventBus'
, describeEventBusResponse_name
- The name of the event bus. Currently, this is always default
.
$sel:policy:DescribeEventBusResponse'
, describeEventBusResponse_policy
- The policy that enables the external account to send events to your
account.
$sel:httpStatus:DescribeEventBusResponse'
, describeEventBusResponse_httpStatus
- The response's http status code.
ListEventSources
data ListEventSources Source #
See: newListEventSources
smart constructor.
Instances
newListEventSources :: ListEventSources Source #
Create a value of ListEventSources
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:nextToken:ListEventSources'
, listEventSources_nextToken
- The token returned by a previous call to retrieve the next set of
results.
$sel:namePrefix:ListEventSources'
, listEventSources_namePrefix
- Specifying this limits the results to only those partner event sources
with names that start with the specified prefix.
$sel:limit:ListEventSources'
, listEventSources_limit
- Specifying this 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.
data ListEventSourcesResponse Source #
See: newListEventSourcesResponse
smart constructor.
Instances
newListEventSourcesResponse Source #
Create a value of ListEventSourcesResponse
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:nextToken:ListEventSources'
, listEventSourcesResponse_nextToken
- A token you can use in a subsequent operation to retrieve the next set
of results.
$sel:eventSources:ListEventSourcesResponse'
, listEventSourcesResponse_eventSources
- The list of event sources.
$sel:httpStatus:ListEventSourcesResponse'
, listEventSourcesResponse_httpStatus
- The response's http status code.
TagResource
data TagResource Source #
See: newTagResource
smart constructor.
Instances
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 ARN of the EventBridge resource that you're adding tags to.
$sel:tags:TagResource'
, tagResource_tags
- The list of key-value pairs to associate with the resource.
data TagResourceResponse Source #
See: newTagResourceResponse
smart constructor.
Instances
newTagResourceResponse Source #
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.
CreatePartnerEventSource
data CreatePartnerEventSource Source #
See: newCreatePartnerEventSource
smart constructor.
Instances
newCreatePartnerEventSource Source #
:: Text | |
-> Text | |
-> CreatePartnerEventSource |
Create a value of CreatePartnerEventSource
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:CreatePartnerEventSource'
, createPartnerEventSource_name
- The name of the partner event source. This name must be unique and must
be in the format partner_name/event_namespace/event_name
. The
Amazon Web Services account that wants to use this partner event source
must create a partner event bus with a name that matches the name of the
partner event source.
$sel:account:CreatePartnerEventSource'
, createPartnerEventSource_account
- The Amazon Web Services account ID that is permitted to create a
matching partner event bus for this partner event source.
data CreatePartnerEventSourceResponse Source #
See: newCreatePartnerEventSourceResponse
smart constructor.
Instances
Eq CreatePartnerEventSourceResponse Source # | |
Read CreatePartnerEventSourceResponse Source # | |
Show CreatePartnerEventSourceResponse Source # | |
Generic CreatePartnerEventSourceResponse Source # | |
NFData CreatePartnerEventSourceResponse Source # | |
Defined in Amazonka.CloudWatchEvents.CreatePartnerEventSource rnf :: CreatePartnerEventSourceResponse -> () # | |
type Rep CreatePartnerEventSourceResponse Source # | |
Defined in Amazonka.CloudWatchEvents.CreatePartnerEventSource type Rep CreatePartnerEventSourceResponse = D1 ('MetaData "CreatePartnerEventSourceResponse" "Amazonka.CloudWatchEvents.CreatePartnerEventSource" "libZSservicesZSamazonka-cloudwatch-eventsZSamazonka-cloudwatch-events" 'False) (C1 ('MetaCons "CreatePartnerEventSourceResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "eventSourceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newCreatePartnerEventSourceResponse Source #
Create a value of CreatePartnerEventSourceResponse
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:eventSourceArn:CreatePartnerEventSourceResponse'
, createPartnerEventSourceResponse_eventSourceArn
- The ARN of the partner event source.
$sel:httpStatus:CreatePartnerEventSourceResponse'
, createPartnerEventSourceResponse_httpStatus
- The response's http status code.
PutTargets
data PutTargets Source #
See: newPutTargets
smart constructor.
Instances
Create a value of PutTargets
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:eventBusName:PutTargets'
, putTargets_eventBusName
- The name or ARN of the event bus associated with the rule. If you omit
this, the default event bus is used.
$sel:rule:PutTargets'
, putTargets_rule
- The name of the rule.
$sel:targets:PutTargets'
, putTargets_targets
- The targets to update or add to the rule.
data PutTargetsResponse Source #
See: newPutTargetsResponse
smart constructor.
Instances
newPutTargetsResponse Source #
Create a value of PutTargetsResponse
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:failedEntryCount:PutTargetsResponse'
, putTargetsResponse_failedEntryCount
- The number of failed entries.
$sel:failedEntries:PutTargetsResponse'
, putTargetsResponse_failedEntries
- The failed target entries.
$sel:httpStatus:PutTargetsResponse'
, putTargetsResponse_httpStatus
- The response's http status code.
UpdateArchive
data UpdateArchive Source #
See: newUpdateArchive
smart constructor.
Instances
Create a value of UpdateArchive
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:eventPattern:UpdateArchive'
, updateArchive_eventPattern
- The event pattern to use to filter events sent to the archive.
$sel:retentionDays:UpdateArchive'
, updateArchive_retentionDays
- The number of days to retain events in the archive.
$sel:description:UpdateArchive'
, updateArchive_description
- The description for the archive.
$sel:archiveName:UpdateArchive'
, updateArchive_archiveName
- The name of the archive to update.
data UpdateArchiveResponse Source #
See: newUpdateArchiveResponse
smart constructor.
Instances
newUpdateArchiveResponse Source #
Create a value of UpdateArchiveResponse
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:creationTime:UpdateArchiveResponse'
, updateArchiveResponse_creationTime
- The time at which the archive was updated.
$sel:state:UpdateArchiveResponse'
, updateArchiveResponse_state
- The state of the archive.
$sel:archiveArn:UpdateArchiveResponse'
, updateArchiveResponse_archiveArn
- The ARN of the archive.
$sel:stateReason:UpdateArchiveResponse'
, updateArchiveResponse_stateReason
- The reason that the archive is in the current state.
$sel:httpStatus:UpdateArchiveResponse'
, updateArchiveResponse_httpStatus
- The response's http status code.
DeleteArchive
data DeleteArchive Source #
See: newDeleteArchive
smart constructor.
Instances
Create a value of DeleteArchive
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:archiveName:DeleteArchive'
, deleteArchive_archiveName
- The name of the archive to delete.
data DeleteArchiveResponse Source #
See: newDeleteArchiveResponse
smart constructor.
Instances
newDeleteArchiveResponse Source #
Create a value of DeleteArchiveResponse
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:DeleteArchiveResponse'
, deleteArchiveResponse_httpStatus
- The response's http status code.
UntagResource
data UntagResource Source #
See: newUntagResource
smart constructor.
Instances
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 ARN of the EventBridge resource 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.
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.
PutEvents
See: newPutEvents
smart constructor.
Instances
Create a value of PutEvents
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:entries:PutEvents'
, putEvents_entries
- The entry that defines an event in your system. You can specify several
parameters for the entry such as the source and type of the event,
resources associated with the event, and so on.
data PutEventsResponse Source #
See: newPutEventsResponse
smart constructor.
Instances
Create a value of PutEventsResponse
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:failedEntryCount:PutEventsResponse'
, putEventsResponse_failedEntryCount
- The number of failed entries.
$sel:entries:PutEvents'
, putEventsResponse_entries
- The successfully and unsuccessfully ingested events results. If the
ingestion was successful, the entry has the event ID in it. Otherwise,
you can use the error code and error message to identify the problem
with the entry.
$sel:httpStatus:PutEventsResponse'
, putEventsResponse_httpStatus
- The response's http status code.
ListPartnerEventSources
data ListPartnerEventSources Source #
See: newListPartnerEventSources
smart constructor.
Instances
newListPartnerEventSources Source #
Create a value of ListPartnerEventSources
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:nextToken:ListPartnerEventSources'
, listPartnerEventSources_nextToken
- The token returned by a previous call to this operation. Specifying this
retrieves the next set of results.
$sel:limit:ListPartnerEventSources'
, listPartnerEventSources_limit
- pecifying this 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:ListPartnerEventSources'
, listPartnerEventSources_namePrefix
- If you specify this, the results are limited to only those partner event
sources that start with the string you specify.
data ListPartnerEventSourcesResponse Source #
See: newListPartnerEventSourcesResponse
smart constructor.
Instances
newListPartnerEventSourcesResponse Source #
Create a value of ListPartnerEventSourcesResponse
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:partnerEventSources:ListPartnerEventSourcesResponse'
, listPartnerEventSourcesResponse_partnerEventSources
- The list of partner event sources returned by the operation.
$sel:nextToken:ListPartnerEventSources'
, listPartnerEventSourcesResponse_nextToken
- A token you can use in a subsequent operation to retrieve the next set
of results.
$sel:httpStatus:ListPartnerEventSourcesResponse'
, listPartnerEventSourcesResponse_httpStatus
- The response's http status code.
CreateArchive
data CreateArchive Source #
See: newCreateArchive
smart constructor.
Instances
Create a value of CreateArchive
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:eventPattern:CreateArchive'
, createArchive_eventPattern
- An event pattern to use to filter events sent to the archive.
$sel:retentionDays:CreateArchive'
, createArchive_retentionDays
- The number of days to retain events for. Default value is 0. If set to
0, events are retained indefinitely
$sel:description:CreateArchive'
, createArchive_description
- A description for the archive.
$sel:archiveName:CreateArchive'
, createArchive_archiveName
- The name for the archive to create.
$sel:eventSourceArn:CreateArchive'
, createArchive_eventSourceArn
- The ARN of the event bus that sends events to the archive.
data CreateArchiveResponse Source #
See: newCreateArchiveResponse
smart constructor.
Instances
newCreateArchiveResponse Source #
Create a value of CreateArchiveResponse
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:creationTime:CreateArchiveResponse'
, createArchiveResponse_creationTime
- The time at which the archive was created.
$sel:state:CreateArchiveResponse'
, createArchiveResponse_state
- The state of the archive that was created.
$sel:archiveArn:CreateArchiveResponse'
, createArchiveResponse_archiveArn
- The ARN of the archive that was created.
$sel:stateReason:CreateArchiveResponse'
, createArchiveResponse_stateReason
- The reason that the archive is in the state.
$sel:httpStatus:CreateArchiveResponse'
, createArchiveResponse_httpStatus
- The response's http status code.
DeactivateEventSource
data DeactivateEventSource Source #
See: newDeactivateEventSource
smart constructor.
Instances
newDeactivateEventSource Source #
Create a value of DeactivateEventSource
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:DeactivateEventSource'
, deactivateEventSource_name
- The name of the partner event source to deactivate.
data DeactivateEventSourceResponse Source #
See: newDeactivateEventSourceResponse
smart constructor.
Instances
Eq DeactivateEventSourceResponse Source # | |
Read DeactivateEventSourceResponse Source # | |
Show DeactivateEventSourceResponse Source # | |
Defined in Amazonka.CloudWatchEvents.DeactivateEventSource showsPrec :: Int -> DeactivateEventSourceResponse -> ShowS # show :: DeactivateEventSourceResponse -> String # showList :: [DeactivateEventSourceResponse] -> ShowS # | |
Generic DeactivateEventSourceResponse Source # | |
NFData DeactivateEventSourceResponse Source # | |
Defined in Amazonka.CloudWatchEvents.DeactivateEventSource rnf :: DeactivateEventSourceResponse -> () # | |
type Rep DeactivateEventSourceResponse Source # | |
Defined in Amazonka.CloudWatchEvents.DeactivateEventSource type Rep DeactivateEventSourceResponse = D1 ('MetaData "DeactivateEventSourceResponse" "Amazonka.CloudWatchEvents.DeactivateEventSource" "libZSservicesZSamazonka-cloudwatch-eventsZSamazonka-cloudwatch-events" 'False) (C1 ('MetaCons "DeactivateEventSourceResponse'" 'PrefixI 'False) (U1 :: Type -> Type)) |
newDeactivateEventSourceResponse :: DeactivateEventSourceResponse Source #
Create a value of DeactivateEventSourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteEventBus
data DeleteEventBus Source #
See: newDeleteEventBus
smart constructor.
Instances
Create a value of DeleteEventBus
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:DeleteEventBus'
, deleteEventBus_name
- The name of the event bus to delete.
data DeleteEventBusResponse Source #
See: newDeleteEventBusResponse
smart constructor.
Instances
Eq DeleteEventBusResponse Source # | |
Defined in Amazonka.CloudWatchEvents.DeleteEventBus | |
Read DeleteEventBusResponse Source # | |
Show DeleteEventBusResponse Source # | |
Defined in Amazonka.CloudWatchEvents.DeleteEventBus showsPrec :: Int -> DeleteEventBusResponse -> ShowS # show :: DeleteEventBusResponse -> String # showList :: [DeleteEventBusResponse] -> ShowS # | |
Generic DeleteEventBusResponse Source # | |
Defined in Amazonka.CloudWatchEvents.DeleteEventBus type Rep DeleteEventBusResponse :: Type -> Type # | |
NFData DeleteEventBusResponse Source # | |
Defined in Amazonka.CloudWatchEvents.DeleteEventBus rnf :: DeleteEventBusResponse -> () # | |
type Rep DeleteEventBusResponse Source # | |
Defined in Amazonka.CloudWatchEvents.DeleteEventBus |
newDeleteEventBusResponse :: DeleteEventBusResponse Source #
Create a value of DeleteEventBusResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
Types
ApiDestinationHttpMethod
newtype ApiDestinationHttpMethod Source #
Instances
ApiDestinationState
newtype ApiDestinationState Source #
pattern ApiDestinationState_ACTIVE :: ApiDestinationState | |
pattern ApiDestinationState_INACTIVE :: ApiDestinationState |
Instances
ArchiveState
newtype ArchiveState Source #
pattern ArchiveState_CREATE_FAILED :: ArchiveState | |
pattern ArchiveState_CREATING :: ArchiveState | |
pattern ArchiveState_DISABLED :: ArchiveState | |
pattern ArchiveState_ENABLED :: ArchiveState | |
pattern ArchiveState_UPDATE_FAILED :: ArchiveState | |
pattern ArchiveState_UPDATING :: ArchiveState |
Instances
AssignPublicIp
newtype AssignPublicIp Source #
pattern AssignPublicIp_DISABLED :: AssignPublicIp | |
pattern AssignPublicIp_ENABLED :: AssignPublicIp |
Instances
ConnectionAuthorizationType
newtype ConnectionAuthorizationType Source #
Instances
ConnectionOAuthHttpMethod
newtype ConnectionOAuthHttpMethod Source #
Instances
ConnectionState
newtype ConnectionState Source #
pattern ConnectionState_AUTHORIZED :: ConnectionState | |
pattern ConnectionState_AUTHORIZING :: ConnectionState | |
pattern ConnectionState_CREATING :: ConnectionState | |
pattern ConnectionState_DEAUTHORIZED :: ConnectionState | |
pattern ConnectionState_DEAUTHORIZING :: ConnectionState | |
pattern ConnectionState_DELETING :: ConnectionState | |
pattern ConnectionState_UPDATING :: ConnectionState |
Instances
EventSourceState
newtype EventSourceState Source #
pattern EventSourceState_ACTIVE :: EventSourceState | |
pattern EventSourceState_DELETED :: EventSourceState | |
pattern EventSourceState_PENDING :: EventSourceState |
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
ReplayState
newtype ReplayState Source #
pattern ReplayState_CANCELLED :: ReplayState | |
pattern ReplayState_CANCELLING :: ReplayState | |
pattern ReplayState_COMPLETED :: ReplayState | |
pattern ReplayState_FAILED :: ReplayState | |
pattern ReplayState_RUNNING :: ReplayState | |
pattern ReplayState_STARTING :: ReplayState |
Instances
RuleState
pattern RuleState_DISABLED :: RuleState | |
pattern RuleState_ENABLED :: RuleState |
Instances
ApiDestination
data ApiDestination Source #
Contains details about an API destination.
See: newApiDestination
smart constructor.
ApiDestination' (Maybe POSIX) (Maybe ApiDestinationHttpMethod) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Natural) (Maybe ApiDestinationState) (Maybe Text) (Maybe Text) |
Instances
newApiDestination :: ApiDestination Source #
Create a value of ApiDestination
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:creationTime:ApiDestination'
, apiDestination_creationTime
- A time stamp for the time that the API destination was created.
$sel:httpMethod:ApiDestination'
, apiDestination_httpMethod
- The method to use to connect to the HTTP endpoint.
$sel:invocationEndpoint:ApiDestination'
, apiDestination_invocationEndpoint
- The URL to the endpoint for the API destination.
$sel:lastModifiedTime:ApiDestination'
, apiDestination_lastModifiedTime
- A time stamp for the time that the API destination was last modified.
$sel:name:ApiDestination'
, apiDestination_name
- The name of the API destination.
$sel:invocationRateLimitPerSecond:ApiDestination'
, apiDestination_invocationRateLimitPerSecond
- The maximum number of invocations per second to send to the HTTP
endpoint.
$sel:apiDestinationState:ApiDestination'
, apiDestination_apiDestinationState
- The state of the API destination.
$sel:connectionArn:ApiDestination'
, apiDestination_connectionArn
- The ARN of the connection specified for the API destination.
$sel:apiDestinationArn:ApiDestination'
, apiDestination_apiDestinationArn
- The ARN of the API destination.
Archive
An Archive
object that contains details about an archive.
See: newArchive
smart constructor.
Archive' (Maybe POSIX) (Maybe Integer) (Maybe Text) (Maybe ArchiveState) (Maybe Integer) (Maybe Text) (Maybe Natural) (Maybe Text) |
Instances
newArchive :: Archive Source #
Create a value of Archive
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:creationTime:Archive'
, archive_creationTime
- The time stamp for the time that the archive was created.
$sel:sizeBytes:Archive'
, archive_sizeBytes
- The size of the archive, in bytes.
$sel:eventSourceArn:Archive'
, archive_eventSourceArn
- The ARN of the event bus associated with the archive. Only events from
this event bus are sent to the archive.
$sel:state:Archive'
, archive_state
- The current state of the archive.
$sel:eventCount:Archive'
, archive_eventCount
- The number of events in the archive.
$sel:archiveName:Archive'
, archive_archiveName
- The name of the archive.
$sel:retentionDays:Archive'
, archive_retentionDays
- The number of days to retain events in the archive before they are
deleted.
$sel:stateReason:Archive'
, archive_stateReason
- A description for the reason that the archive is in the current state.
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' (Maybe [Text]) (Maybe AssignPublicIp) [Text] |
Instances
newAwsVpcConfiguration :: AwsVpcConfiguration 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: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: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: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.
BatchArrayProperties
data BatchArrayProperties Source #
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 Batch job.
See: newBatchArrayProperties
smart constructor.
Instances
newBatchArrayProperties :: BatchArrayProperties Source #
Create a value of BatchArrayProperties
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:size:BatchArrayProperties'
, batchArrayProperties_size
- The size of the array, if this is an array batch job. Valid values are
integers between 2 and 10,000.
BatchParameters
data BatchParameters Source #
The custom parameters to be used when the target is an Batch job.
See: newBatchParameters
smart constructor.
Instances
Create a value of BatchParameters
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:retryStrategy:BatchParameters'
, batchParameters_retryStrategy
- The retry strategy to use for failed jobs, if the target is an Batch
job. The retry strategy is the number of times to retry the failed job
execution. Valid values are 1–10. When you specify a retry strategy
here, it overrides the retry strategy defined in the job definition.
$sel:arrayProperties:BatchParameters'
, batchParameters_arrayProperties
- 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 Batch job.
$sel:jobDefinition:BatchParameters'
, batchParameters_jobDefinition
- The ARN or name of the job definition to use if the event target is an
Batch job. This job definition must already exist.
$sel:jobName:BatchParameters'
, batchParameters_jobName
- The name to use for this execution of the job, if the target is an Batch
job.
BatchRetryStrategy
data BatchRetryStrategy Source #
The retry strategy to use for failed jobs, if the target is an Batch job. If you specify a retry strategy here, it overrides the retry strategy defined in the job definition.
See: newBatchRetryStrategy
smart constructor.
Instances
newBatchRetryStrategy :: BatchRetryStrategy Source #
Create a value of BatchRetryStrategy
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:attempts:BatchRetryStrategy'
, batchRetryStrategy_attempts
- The number of times to attempt to retry, if the job fails. Valid values
are 1–10.
CapacityProviderStrategyItem
data CapacityProviderStrategyItem Source #
The details of a capacity provider strategy. To learn more, see CapacityProviderStrategyItem in the Amazon ECS API Reference.
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.
Condition
A JSON string which you can use to limit the event bus permissions you
are granting to only accounts that fulfill the condition. Currently, the
only supported condition is membership in a certain Amazon Web Services
organization. The string must contain Type
, Key
, and Value
fields.
The Value
field specifies the ID of the Amazon Web Services
organization. Following is an example value for Condition
:
'{"Type" : "StringEquals", "Key": "aws:PrincipalOrgID", "Value": "o-1234567890"}'
See: newCondition
smart constructor.
Instances
Eq Condition Source # | |
Read Condition Source # | |
Show Condition Source # | |
Generic Condition Source # | |
NFData Condition Source # | |
Defined in Amazonka.CloudWatchEvents.Types.Condition | |
Hashable Condition Source # | |
Defined in Amazonka.CloudWatchEvents.Types.Condition | |
ToJSON Condition Source # | |
Defined in Amazonka.CloudWatchEvents.Types.Condition | |
type Rep Condition Source # | |
Defined in Amazonka.CloudWatchEvents.Types.Condition type Rep Condition = D1 ('MetaData "Condition" "Amazonka.CloudWatchEvents.Types.Condition" "libZSservicesZSamazonka-cloudwatch-eventsZSamazonka-cloudwatch-events" 'False) (C1 ('MetaCons "Condition'" 'PrefixI 'True) (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))) |
Create a value of Condition
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:type':Condition'
, condition_type
- Specifies the type of condition. Currently the only supported value is
StringEquals
.
$sel:key:Condition'
, condition_key
- Specifies the key for the condition. Currently the only supported key is
aws:PrincipalOrgID
.
$sel:value:Condition'
, condition_value
- Specifies the value for the key. Currently, this must be the ID of the
organization.
Connection
data Connection Source #
Contains information about a connection.
See: newConnection
smart constructor.
Connection' (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe ConnectionAuthorizationType) (Maybe Text) (Maybe Text) (Maybe ConnectionState) |
Instances
newConnection :: Connection Source #
Create a value of Connection
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:creationTime:Connection'
, connection_creationTime
- A time stamp for the time that the connection was created.
$sel:lastModifiedTime:Connection'
, connection_lastModifiedTime
- A time stamp for the time that the connection was last modified.
$sel:name:Connection'
, connection_name
- The name of the connection.
$sel:lastAuthorizedTime:Connection'
, connection_lastAuthorizedTime
- A time stamp for the time that the connection was last authorized.
$sel:authorizationType:Connection'
, connection_authorizationType
- The authorization type specified for the connection.
$sel:connectionArn:Connection'
, connection_connectionArn
- The ARN of the connection.
$sel:stateReason:Connection'
, connection_stateReason
- The reason that the connection is in the connection state.
$sel:connectionState:Connection'
, connection_connectionState
- The state of the connection.
ConnectionApiKeyAuthResponseParameters
data ConnectionApiKeyAuthResponseParameters Source #
Contains the authorization parameters for the connection if API Key is specified as the authorization type.
See: newConnectionApiKeyAuthResponseParameters
smart constructor.
Instances
Eq ConnectionApiKeyAuthResponseParameters Source # | |
Read ConnectionApiKeyAuthResponseParameters Source # | |
Show ConnectionApiKeyAuthResponseParameters Source # | |
Generic ConnectionApiKeyAuthResponseParameters Source # | |
NFData ConnectionApiKeyAuthResponseParameters Source # | |
Hashable ConnectionApiKeyAuthResponseParameters Source # | |
FromJSON ConnectionApiKeyAuthResponseParameters Source # | |
type Rep ConnectionApiKeyAuthResponseParameters Source # | |
Defined in Amazonka.CloudWatchEvents.Types.ConnectionApiKeyAuthResponseParameters type Rep ConnectionApiKeyAuthResponseParameters = D1 ('MetaData "ConnectionApiKeyAuthResponseParameters" "Amazonka.CloudWatchEvents.Types.ConnectionApiKeyAuthResponseParameters" "libZSservicesZSamazonka-cloudwatch-eventsZSamazonka-cloudwatch-events" 'False) (C1 ('MetaCons "ConnectionApiKeyAuthResponseParameters'" 'PrefixI 'True) (S1 ('MetaSel ('Just "apiKeyName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) |
newConnectionApiKeyAuthResponseParameters :: ConnectionApiKeyAuthResponseParameters Source #
Create a value of ConnectionApiKeyAuthResponseParameters
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:apiKeyName:ConnectionApiKeyAuthResponseParameters'
, connectionApiKeyAuthResponseParameters_apiKeyName
- The name of the header to use for the APIKeyValue
used for
authorization.
ConnectionAuthResponseParameters
data ConnectionAuthResponseParameters Source #
Contains the authorization parameters to use for the connection.
See: newConnectionAuthResponseParameters
smart constructor.
Instances
newConnectionAuthResponseParameters :: ConnectionAuthResponseParameters Source #
Create a value of ConnectionAuthResponseParameters
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:oAuthParameters:ConnectionAuthResponseParameters'
, connectionAuthResponseParameters_oAuthParameters
- The OAuth parameters to use for authorization.
$sel:invocationHttpParameters:ConnectionAuthResponseParameters'
, connectionAuthResponseParameters_invocationHttpParameters
- Additional parameters for the connection that are passed through with
every invocation to the HTTP endpoint.
$sel:apiKeyAuthParameters:ConnectionAuthResponseParameters'
, connectionAuthResponseParameters_apiKeyAuthParameters
- The API Key parameters to use for authorization.
$sel:basicAuthParameters:ConnectionAuthResponseParameters'
, connectionAuthResponseParameters_basicAuthParameters
- The authorization parameters for Basic authorization.
ConnectionBasicAuthResponseParameters
data ConnectionBasicAuthResponseParameters Source #
Contains the authorization parameters for the connection if Basic is specified as the authorization type.
See: newConnectionBasicAuthResponseParameters
smart constructor.
Instances
Eq ConnectionBasicAuthResponseParameters Source # | |
Read ConnectionBasicAuthResponseParameters Source # | |
Show ConnectionBasicAuthResponseParameters Source # | |
Generic ConnectionBasicAuthResponseParameters Source # | |
NFData ConnectionBasicAuthResponseParameters Source # | |
Hashable ConnectionBasicAuthResponseParameters Source # | |
FromJSON ConnectionBasicAuthResponseParameters Source # | |
type Rep ConnectionBasicAuthResponseParameters Source # | |
Defined in Amazonka.CloudWatchEvents.Types.ConnectionBasicAuthResponseParameters type Rep ConnectionBasicAuthResponseParameters = D1 ('MetaData "ConnectionBasicAuthResponseParameters" "Amazonka.CloudWatchEvents.Types.ConnectionBasicAuthResponseParameters" "libZSservicesZSamazonka-cloudwatch-eventsZSamazonka-cloudwatch-events" 'False) (C1 ('MetaCons "ConnectionBasicAuthResponseParameters'" 'PrefixI 'True) (S1 ('MetaSel ('Just "username") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) |
newConnectionBasicAuthResponseParameters :: ConnectionBasicAuthResponseParameters Source #
Create a value of ConnectionBasicAuthResponseParameters
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:username:ConnectionBasicAuthResponseParameters'
, connectionBasicAuthResponseParameters_username
- The user name to use for Basic authorization.
ConnectionBodyParameter
data ConnectionBodyParameter Source #
Additional parameter included in the body. You can include up to 100 additional body parameters per request. An event payload cannot exceed 64 KB.
See: newConnectionBodyParameter
smart constructor.
Instances
newConnectionBodyParameter :: ConnectionBodyParameter Source #
Create a value of ConnectionBodyParameter
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:isValueSecret:ConnectionBodyParameter'
, connectionBodyParameter_isValueSecret
- Specified whether the value is secret.
$sel:value:ConnectionBodyParameter'
, connectionBodyParameter_value
- The value associated with the key.
$sel:key:ConnectionBodyParameter'
, connectionBodyParameter_key
- The key for the parameter.
ConnectionHeaderParameter
data ConnectionHeaderParameter Source #
Additional parameter included in the header. You can include up to 100 additional header parameters per request. An event payload cannot exceed 64 KB.
See: newConnectionHeaderParameter
smart constructor.
Instances
newConnectionHeaderParameter :: ConnectionHeaderParameter Source #
Create a value of ConnectionHeaderParameter
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:isValueSecret:ConnectionHeaderParameter'
, connectionHeaderParameter_isValueSecret
- Specified whether the value is a secret.
$sel:value:ConnectionHeaderParameter'
, connectionHeaderParameter_value
- The value associated with the key.
$sel:key:ConnectionHeaderParameter'
, connectionHeaderParameter_key
- The key for the parameter.
ConnectionHttpParameters
data ConnectionHttpParameters Source #
Contains additional parameters for the connection.
See: newConnectionHttpParameters
smart constructor.
ConnectionHttpParameters' (Maybe [ConnectionQueryStringParameter]) (Maybe [ConnectionHeaderParameter]) (Maybe [ConnectionBodyParameter]) |
Instances
newConnectionHttpParameters :: ConnectionHttpParameters Source #
Create a value of ConnectionHttpParameters
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:queryStringParameters:ConnectionHttpParameters'
, connectionHttpParameters_queryStringParameters
- Contains additional query string parameters for the connection.
$sel:headerParameters:ConnectionHttpParameters'
, connectionHttpParameters_headerParameters
- Contains additional header parameters for the connection.
$sel:bodyParameters:ConnectionHttpParameters'
, connectionHttpParameters_bodyParameters
- Contains additional body string parameters for the connection.
ConnectionOAuthClientResponseParameters
data ConnectionOAuthClientResponseParameters Source #
Contains the client response parameters for the connection when OAuth is specified as the authorization type.
See: newConnectionOAuthClientResponseParameters
smart constructor.
Instances
Eq ConnectionOAuthClientResponseParameters Source # | |
Read ConnectionOAuthClientResponseParameters Source # | |
Show ConnectionOAuthClientResponseParameters Source # | |
Generic ConnectionOAuthClientResponseParameters Source # | |
NFData ConnectionOAuthClientResponseParameters Source # | |
Hashable ConnectionOAuthClientResponseParameters Source # | |
FromJSON ConnectionOAuthClientResponseParameters Source # | |
type Rep ConnectionOAuthClientResponseParameters Source # | |
Defined in Amazonka.CloudWatchEvents.Types.ConnectionOAuthClientResponseParameters type Rep ConnectionOAuthClientResponseParameters = D1 ('MetaData "ConnectionOAuthClientResponseParameters" "Amazonka.CloudWatchEvents.Types.ConnectionOAuthClientResponseParameters" "libZSservicesZSamazonka-cloudwatch-eventsZSamazonka-cloudwatch-events" 'False) (C1 ('MetaCons "ConnectionOAuthClientResponseParameters'" 'PrefixI 'True) (S1 ('MetaSel ('Just "clientID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) |
newConnectionOAuthClientResponseParameters :: ConnectionOAuthClientResponseParameters Source #
Create a value of ConnectionOAuthClientResponseParameters
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:clientID:ConnectionOAuthClientResponseParameters'
, connectionOAuthClientResponseParameters_clientID
- The client ID associated with the response to the connection request.
ConnectionOAuthResponseParameters
data ConnectionOAuthResponseParameters Source #
Contains the response parameters when OAuth is specified as the authorization type.
See: newConnectionOAuthResponseParameters
smart constructor.
ConnectionOAuthResponseParameters' (Maybe ConnectionOAuthHttpMethod) (Maybe ConnectionOAuthClientResponseParameters) (Maybe ConnectionHttpParameters) (Maybe Text) |
Instances
newConnectionOAuthResponseParameters :: ConnectionOAuthResponseParameters Source #
Create a value of ConnectionOAuthResponseParameters
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:httpMethod:ConnectionOAuthResponseParameters'
, connectionOAuthResponseParameters_httpMethod
- The method used to connect to the HTTP endpoint.
$sel:clientParameters:ConnectionOAuthResponseParameters'
, connectionOAuthResponseParameters_clientParameters
- A ConnectionOAuthClientResponseParameters
object that contains details
about the client parameters returned when OAuth is specified as the
authorization type.
$sel:oAuthHttpParameters:ConnectionOAuthResponseParameters'
, connectionOAuthResponseParameters_oAuthHttpParameters
- The additional HTTP parameters used for the OAuth authorization request.
$sel:authorizationEndpoint:ConnectionOAuthResponseParameters'
, connectionOAuthResponseParameters_authorizationEndpoint
- The URL to the HTTP endpoint that authorized the request.
ConnectionQueryStringParameter
data ConnectionQueryStringParameter Source #
Additional query string parameter for the connection. You can include up to 100 additional query string parameters per request. Each additional parameter counts towards the event payload size, which cannot exceed 64 KB.
See: newConnectionQueryStringParameter
smart constructor.
Instances
newConnectionQueryStringParameter :: ConnectionQueryStringParameter Source #
Create a value of ConnectionQueryStringParameter
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:isValueSecret:ConnectionQueryStringParameter'
, connectionQueryStringParameter_isValueSecret
- Specifies whether the value is secret.
$sel:value:ConnectionQueryStringParameter'
, connectionQueryStringParameter_value
- The value associated with the key for the query string parameter.
$sel:key:ConnectionQueryStringParameter'
, connectionQueryStringParameter_key
- The key for a query string parameter.
CreateConnectionApiKeyAuthRequestParameters
data CreateConnectionApiKeyAuthRequestParameters Source #
Contains the API key authorization parameters for the connection.
See: newCreateConnectionApiKeyAuthRequestParameters
smart constructor.
Instances
newCreateConnectionApiKeyAuthRequestParameters Source #
:: Text |
|
-> Text |
|
-> CreateConnectionApiKeyAuthRequestParameters |
Create a value of CreateConnectionApiKeyAuthRequestParameters
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:apiKeyName:CreateConnectionApiKeyAuthRequestParameters'
, createConnectionApiKeyAuthRequestParameters_apiKeyName
- The name of the API key to use for authorization.
$sel:apiKeyValue:CreateConnectionApiKeyAuthRequestParameters'
, createConnectionApiKeyAuthRequestParameters_apiKeyValue
- The value for the API key to use for authorization.
CreateConnectionAuthRequestParameters
data CreateConnectionAuthRequestParameters Source #
Contains the authorization parameters for the connection.
See: newCreateConnectionAuthRequestParameters
smart constructor.
Instances
newCreateConnectionAuthRequestParameters :: CreateConnectionAuthRequestParameters Source #
Create a value of CreateConnectionAuthRequestParameters
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:oAuthParameters:CreateConnectionAuthRequestParameters'
, createConnectionAuthRequestParameters_oAuthParameters
- A CreateConnectionOAuthRequestParameters
object that contains the
OAuth authorization parameters to use for the connection.
$sel:invocationHttpParameters:CreateConnectionAuthRequestParameters'
, createConnectionAuthRequestParameters_invocationHttpParameters
- A ConnectionHttpParameters
object that contains the API key
authorization parameters to use for the connection. Note that if you
include additional parameters for the target of a rule via
HttpParameters
, including query strings, the parameters added for the
connection take precedence.
$sel:apiKeyAuthParameters:CreateConnectionAuthRequestParameters'
, createConnectionAuthRequestParameters_apiKeyAuthParameters
- A CreateConnectionApiKeyAuthRequestParameters
object that contains the
API key authorization parameters to use for the connection.
$sel:basicAuthParameters:CreateConnectionAuthRequestParameters'
, createConnectionAuthRequestParameters_basicAuthParameters
- A CreateConnectionBasicAuthRequestParameters
object that contains the
Basic authorization parameters to use for the connection.
CreateConnectionBasicAuthRequestParameters
data CreateConnectionBasicAuthRequestParameters Source #
Contains the Basic authorization parameters to use for the connection.
See: newCreateConnectionBasicAuthRequestParameters
smart constructor.
Instances
newCreateConnectionBasicAuthRequestParameters Source #
Create a value of CreateConnectionBasicAuthRequestParameters
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:username:CreateConnectionBasicAuthRequestParameters'
, createConnectionBasicAuthRequestParameters_username
- The user name to use for Basic authorization.
$sel:password:CreateConnectionBasicAuthRequestParameters'
, createConnectionBasicAuthRequestParameters_password
- The password associated with the user name to use for Basic
authorization.
CreateConnectionOAuthClientRequestParameters
data CreateConnectionOAuthClientRequestParameters Source #
Contains the Basic authorization parameters to use for the connection.
See: newCreateConnectionOAuthClientRequestParameters
smart constructor.
Instances
newCreateConnectionOAuthClientRequestParameters Source #
:: Text | |
-> Text |
|
-> CreateConnectionOAuthClientRequestParameters |
Create a value of CreateConnectionOAuthClientRequestParameters
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:clientID:CreateConnectionOAuthClientRequestParameters'
, createConnectionOAuthClientRequestParameters_clientID
- The client ID to use for OAuth authorization for the connection.
$sel:clientSecret:CreateConnectionOAuthClientRequestParameters'
, createConnectionOAuthClientRequestParameters_clientSecret
- The client secret associated with the client ID to use for OAuth
authorization for the connection.
CreateConnectionOAuthRequestParameters
data CreateConnectionOAuthRequestParameters Source #
Contains the OAuth authorization parameters to use for the connection.
See: newCreateConnectionOAuthRequestParameters
smart constructor.
CreateConnectionOAuthRequestParameters' (Maybe ConnectionHttpParameters) CreateConnectionOAuthClientRequestParameters Text ConnectionOAuthHttpMethod |
Instances
newCreateConnectionOAuthRequestParameters Source #
Create a value of CreateConnectionOAuthRequestParameters
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:oAuthHttpParameters:CreateConnectionOAuthRequestParameters'
, createConnectionOAuthRequestParameters_oAuthHttpParameters
- A ConnectionHttpParameters
object that contains details about the
additional parameters to use for the connection.
$sel:clientParameters:CreateConnectionOAuthRequestParameters'
, createConnectionOAuthRequestParameters_clientParameters
- A CreateConnectionOAuthClientRequestParameters
object that contains
the client parameters for OAuth authorization.
$sel:authorizationEndpoint:CreateConnectionOAuthRequestParameters'
, createConnectionOAuthRequestParameters_authorizationEndpoint
- The URL to the authorization endpoint when OAuth is specified as the
authorization type.
$sel:httpMethod:CreateConnectionOAuthRequestParameters'
, createConnectionOAuthRequestParameters_httpMethod
- The method to use for the authorization request.
DeadLetterConfig
data DeadLetterConfig Source #
A DeadLetterConfig
object that contains information about a
dead-letter queue configuration.
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 ARN of the SQS queue specified as the target for the dead-letter
queue.
EcsParameters
data EcsParameters Source #
The custom parameters to be used when the target is an Amazon ECS task.
See: newEcsParameters
smart constructor.
EcsParameters' (Maybe Text) (Maybe PropagateTags) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe [PlacementConstraint]) (Maybe [PlacementStrategy]) (Maybe LaunchType) (Maybe [CapacityProviderStrategyItem]) (Maybe Natural) (Maybe NetworkConfiguration) (Maybe [Tag]) (Maybe Bool) Text |
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:group':EcsParameters'
, ecsParameters_group
- Specifies an ECS task group for the task. The maximum length is 255
characters.
$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 the TagResource API action.
$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
.
This structure is used only if LaunchType
is FARGATE
. For more
information about valid platform versions, see
Fargate Platform Versions
in the Amazon Elastic Container Service Developer Guide.
$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 Elastic Container Service Developer Guide.
$sel:referenceId:EcsParameters'
, ecsParameters_referenceId
- The reference ID to use for the 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 placement strategy objects to use for the task. You can specify a
maximum of five strategy rules per task.
$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 witt Amazon ECS is supported. For more
information, see
Fargate on Amazon ECS
in the Amazon Elastic Container Service Developer Guide.
$sel:capacityProviderStrategy:EcsParameters'
, ecsParameters_capacityProviderStrategy
- The capacity provider strategy to use for the task.
If a capacityProviderStrategy
is specified, the launchType
parameter
must be omitted. If no capacityProviderStrategy
or launchType is
specified, the defaultCapacityProviderStrategy
for the cluster is
used.
$sel:taskCount:EcsParameters'
, ecsParameters_taskCount
- The number of tasks to create based on TaskDefinition
. The default is
1.
$sel:networkConfiguration:EcsParameters'
, ecsParameters_networkConfiguration
- Use this structure if the Amazon ECS task uses the awsvpc
network
mode. This structure specifies the VPC subnets and security groups
associated with the task, and whether a public IP address is to be used.
This structure is required if LaunchType
is FARGATE
because the
awsvpc
mode is required for Fargate tasks.
If you specify NetworkConfiguration
when the target ECS task does not
use the awsvpc
network mode, the task fails.
$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. To learn more, see
RunTask
in the Amazon ECS API Reference.
$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:taskDefinitionArn:EcsParameters'
, ecsParameters_taskDefinitionArn
- The ARN of the task definition to use if the event target is an Amazon
ECS task.
EventBus
An event bus receives events from a source and routes them to rules associated with that event bus. Your account's default event bus receives events from Amazon Web Services services. A custom event bus can receive events from your custom applications and services. A partner event bus receives events from an event source created by an SaaS partner. These events come from the partners services or applications.
See: newEventBus
smart constructor.
Instances
Eq EventBus Source # | |
Read EventBus Source # | |
Show EventBus Source # | |
Generic EventBus Source # | |
NFData EventBus Source # | |
Defined in Amazonka.CloudWatchEvents.Types.EventBus | |
Hashable EventBus Source # | |
Defined in Amazonka.CloudWatchEvents.Types.EventBus | |
FromJSON EventBus Source # | |
type Rep EventBus Source # | |
Defined in Amazonka.CloudWatchEvents.Types.EventBus type Rep EventBus = D1 ('MetaData "EventBus" "Amazonka.CloudWatchEvents.Types.EventBus" "libZSservicesZSamazonka-cloudwatch-eventsZSamazonka-cloudwatch-events" 'False) (C1 ('MetaCons "EventBus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "policy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) |
newEventBus :: EventBus Source #
Create a value of EventBus
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:EventBus'
, eventBus_arn
- The ARN of the event bus.
$sel:name:EventBus'
, eventBus_name
- The name of the event bus.
$sel:policy:EventBus'
, eventBus_policy
- The permissions policy of the event bus, describing which other Amazon
Web Services accounts can write events to this event bus.
EventSource
data EventSource Source #
A partner event source is created by an SaaS partner. If a customer creates a partner event bus that matches this event source, that Amazon Web Services account can receive events from the partner's applications or services.
See: newEventSource
smart constructor.
EventSource' (Maybe POSIX) (Maybe EventSourceState) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) |
Instances
newEventSource :: EventSource Source #
Create a value of EventSource
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:creationTime:EventSource'
, eventSource_creationTime
- The date and time the event source was created.
$sel:state:EventSource'
, eventSource_state
- The state of the event source. If it is ACTIVE, you have already created
a matching event bus for this event source, and that event bus is
active. If it is PENDING, either you haven't yet created a matching
event bus, or that event bus is deactivated. If it is DELETED, you have
created a matching event bus, but the event source has since been
deleted.
$sel:arn:EventSource'
, eventSource_arn
- The ARN of the event source.
$sel:createdBy:EventSource'
, eventSource_createdBy
- The name of the partner that created the event source.
$sel:name:EventSource'
, eventSource_name
- The name of the event source.
$sel:expirationTime:EventSource'
, eventSource_expirationTime
- The date and time that the event source will expire, if the Amazon Web
Services account doesn't create a matching event bus for it.
HttpParameters
data HttpParameters Source #
These are custom parameter to be used when the target is an API Gateway REST APIs or EventBridge ApiDestinations. In the latter case, these are merged with any InvocationParameters specified on the Connection, with any values from the Connection taking precedence.
See: newHttpParameters
smart constructor.
Instances
newHttpParameters :: HttpParameters Source #
Create a value of HttpParameters
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:pathParameterValues:HttpParameters'
, httpParameters_pathParameterValues
- The path parameter values to be used to populate API Gateway REST API or
EventBridge ApiDestination path wildcards ("*").
$sel:queryStringParameters:HttpParameters'
, httpParameters_queryStringParameters
- The query string keys/values that need to be sent as part of request
invoking the API Gateway REST API or EventBridge ApiDestination.
$sel:headerParameters:HttpParameters'
, httpParameters_headerParameters
- The headers that need to be sent as part of request invoking the API
Gateway REST API or EventBridge ApiDestination.
InputTransformer
data InputTransformer Source #
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: newInputTransformer
smart constructor.
Instances
Create a value of InputTransformer
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:inputPathsMap:InputTransformer'
, inputTransformer_inputPathsMap
- Map of JSON paths to be extracted from the event. You can then insert
these in the template in InputTemplate
to produce the output you want
to be sent to the target.
InputPathsMap
is an array key-value pairs, where each value is a valid
JSON path. You can have as many as 100 key-value pairs. You must use
JSON dot notation, not bracket notation.
The keys cannot start with "Amazon Web Services."
$sel:inputTemplate:InputTransformer'
, inputTransformer_inputTemplate
- Input template where you specify placeholders that will be filled with
the values of the keys from InputPathsMap
to customize the data sent
to the target. Enclose each InputPathsMaps
value in brackets:
<value> The InputTemplate must be valid JSON.
If InputTemplate
is a JSON object (surrounded by curly braces), the
following restrictions apply:
- The placeholder cannot be used as an object key.
The following example shows the syntax for using InputPathsMap
and
InputTemplate
.
"InputTransformer":
{
"InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"},
"InputTemplate": "<instance> is in state <status>"
}
To have the InputTemplate
include quote marks within a JSON string,
escape each quote marks with a slash, as in the following example:
"InputTransformer":
{
"InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"},
"InputTemplate": "<instance> is in state \"<status>\""
}
The InputTemplate
can also be valid JSON with varibles in quotes or
out, as in the following example:
"InputTransformer":
{
"InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"},
"InputTemplate": '{"myInstance": <instance>,"myStatus": "<instance> is in state \"<status>\""}'
}
KinesisParameters
data KinesisParameters Source #
This object enables you to specify a JSON path to extract from the event
and use as the partition key for the Amazon Kinesis data 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: newKinesisParameters
smart constructor.
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:partitionKeyPath:KinesisParameters'
, kinesisParameters_partitionKeyPath
- 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.
NetworkConfiguration
data NetworkConfiguration Source #
This structure specifies the network configuration for an ECS task.
See: newNetworkConfiguration
smart constructor.
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
- Use this structure to specify 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.
PartnerEventSource
data PartnerEventSource Source #
A partner event source is created by an SaaS partner. If a customer creates a partner event bus that matches this event source, that Amazon Web Services account can receive events from the partner's applications or services.
See: newPartnerEventSource
smart constructor.
Instances
newPartnerEventSource :: PartnerEventSource Source #
Create a value of PartnerEventSource
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:PartnerEventSource'
, partnerEventSource_arn
- The ARN of the partner event source.
$sel:name:PartnerEventSource'
, partnerEventSource_name
- The name of the partner event source.
PartnerEventSourceAccount
data PartnerEventSourceAccount Source #
The Amazon Web Services account that a partner event source has been offered to.
See: newPartnerEventSourceAccount
smart constructor.
Instances
newPartnerEventSourceAccount :: PartnerEventSourceAccount Source #
Create a value of PartnerEventSourceAccount
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:creationTime:PartnerEventSourceAccount'
, partnerEventSourceAccount_creationTime
- The date and time the event source was created.
$sel:state:PartnerEventSourceAccount'
, partnerEventSourceAccount_state
- The state of the event source. If it is ACTIVE, you have already created
a matching event bus for this event source, and that event bus is
active. If it is PENDING, either you haven't yet created a matching
event bus, or that event bus is deactivated. If it is DELETED, you have
created a matching event bus, but the event source has since been
deleted.
$sel:account:PartnerEventSourceAccount'
, partnerEventSourceAccount_account
- The Amazon Web Services account ID that the partner event source was
offered to.
$sel:expirationTime:PartnerEventSourceAccount'
, partnerEventSourceAccount_expirationTime
- The date and time that the event source will expire, if the Amazon Web
Services account doesn't create a matching event bus for it.
PlacementConstraint
data PlacementConstraint Source #
An object representing a constraint on task placement. To learn more, see Task Placement Constraints in the Amazon Elastic Container Service Developer Guide.
See: newPlacementConstraint
smart constructor.
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
. To learn more, see
Cluster Query Language
in the Amazon Elastic Container Service 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. To learn more, see Task Placement Strategies in the Amazon Elastic Container Service Service Developer Guide.
See: newPlacementStrategy
smart constructor.
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 host, 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).
PutEventsRequestEntry
data PutEventsRequestEntry Source #
Represents an event to be submitted.
See: newPutEventsRequestEntry
smart constructor.
PutEventsRequestEntry' (Maybe POSIX) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newPutEventsRequestEntry :: PutEventsRequestEntry Source #
Create a value of PutEventsRequestEntry
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:time:PutEventsRequestEntry'
, putEventsRequestEntry_time
- The time stamp of the event, per
RFC3339. If no time stamp
is provided, the time stamp of the
PutEvents
call is used.
$sel:detailType:PutEventsRequestEntry'
, putEventsRequestEntry_detailType
- Free-form string used to decide what fields to expect in the event
detail.
$sel:resources:PutEventsRequestEntry'
, putEventsRequestEntry_resources
- Amazon Web Services resources, identified by Amazon Resource Name (ARN),
which the event primarily concerns. Any number, including zero, may be
present.
$sel:eventBusName:PutEventsRequestEntry'
, putEventsRequestEntry_eventBusName
- The name or ARN of the event bus to receive the event. Only the rules
that are associated with this event bus are used to match the event. If
you omit this, the default event bus is used.
$sel:source:PutEventsRequestEntry'
, putEventsRequestEntry_source
- The source of the event.
$sel:traceHeader:PutEventsRequestEntry'
, putEventsRequestEntry_traceHeader
- An X-Ray trade header, which is an http header (X-Amzn-Trace-Id) that
contains the trace-id associated with the event.
To learn more about X-Ray trace headers, see Tracing header in the X-Ray Developer Guide.
$sel:detail:PutEventsRequestEntry'
, putEventsRequestEntry_detail
- A valid JSON string. There is no other schema imposed. The JSON string
may contain fields and nested subobjects.
PutEventsResultEntry
data PutEventsResultEntry Source #
Represents an event that failed to be submitted.
See: newPutEventsResultEntry
smart constructor.
Instances
newPutEventsResultEntry :: PutEventsResultEntry Source #
Create a value of PutEventsResultEntry
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:errorCode:PutEventsResultEntry'
, putEventsResultEntry_errorCode
- The error code that indicates why the event submission failed.
$sel:errorMessage:PutEventsResultEntry'
, putEventsResultEntry_errorMessage
- The error message that explains why the event submission failed.
$sel:eventId:PutEventsResultEntry'
, putEventsResultEntry_eventId
- The ID of the event.
PutPartnerEventsRequestEntry
data PutPartnerEventsRequestEntry Source #
The details about an event generated by an SaaS partner.
See: newPutPartnerEventsRequestEntry
smart constructor.
Instances
newPutPartnerEventsRequestEntry :: PutPartnerEventsRequestEntry Source #
Create a value of PutPartnerEventsRequestEntry
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:time:PutPartnerEventsRequestEntry'
, putPartnerEventsRequestEntry_time
- The date and time of the event.
$sel:detailType:PutPartnerEventsRequestEntry'
, putPartnerEventsRequestEntry_detailType
- A free-form string used to decide what fields to expect in the event
detail.
$sel:resources:PutPartnerEventsRequestEntry'
, putPartnerEventsRequestEntry_resources
- Amazon Web Services resources, identified by Amazon Resource Name (ARN),
which the event primarily concerns. Any number, including zero, may be
present.
$sel:source:PutPartnerEventsRequestEntry'
, putPartnerEventsRequestEntry_source
- The event source that is generating the entry.
$sel:detail:PutPartnerEventsRequestEntry'
, putPartnerEventsRequestEntry_detail
- A valid JSON string. There is no other schema imposed. The JSON string
may contain fields and nested subobjects.
PutPartnerEventsResultEntry
data PutPartnerEventsResultEntry Source #
Represents an event that a partner tried to generate, but failed.
See: newPutPartnerEventsResultEntry
smart constructor.
Instances
newPutPartnerEventsResultEntry :: PutPartnerEventsResultEntry Source #
Create a value of PutPartnerEventsResultEntry
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:errorCode:PutPartnerEventsResultEntry'
, putPartnerEventsResultEntry_errorCode
- The error code that indicates why the event submission failed.
$sel:errorMessage:PutPartnerEventsResultEntry'
, putPartnerEventsResultEntry_errorMessage
- The error message that explains why the event submission failed.
$sel:eventId:PutPartnerEventsResultEntry'
, putPartnerEventsResultEntry_eventId
- The ID of the event.
PutTargetsResultEntry
data PutTargetsResultEntry Source #
Represents a target that failed to be added to a rule.
See: newPutTargetsResultEntry
smart constructor.
Instances
newPutTargetsResultEntry :: PutTargetsResultEntry Source #
Create a value of PutTargetsResultEntry
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:targetId:PutTargetsResultEntry'
, putTargetsResultEntry_targetId
- The ID of the target.
$sel:errorCode:PutTargetsResultEntry'
, putTargetsResultEntry_errorCode
- The error code that indicates why the target addition failed. If the
value is ConcurrentModificationException
, too many requests were made
at the same time.
$sel:errorMessage:PutTargetsResultEntry'
, putTargetsResultEntry_errorMessage
- The error message that explains why the target addition failed.
RedshiftDataParameters
data RedshiftDataParameters Source #
These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the Amazon Redshift Data API ExecuteStatement based on EventBridge events.
See: newRedshiftDataParameters
smart constructor.
Instances
newRedshiftDataParameters Source #
:: Text | |
-> Text | |
-> RedshiftDataParameters |
Create a value of RedshiftDataParameters
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:dbUser:RedshiftDataParameters'
, redshiftDataParameters_dbUser
- The database user name. Required when authenticating using temporary
credentials.
$sel:secretManagerArn:RedshiftDataParameters'
, redshiftDataParameters_secretManagerArn
- The name or ARN of the secret that enables access to the database.
Required when authenticating using Amazon Web Services Secrets Manager.
$sel:statementName:RedshiftDataParameters'
, redshiftDataParameters_statementName
- The name of the SQL statement. You can name the SQL statement when you
create it to identify the query.
$sel:withEvent:RedshiftDataParameters'
, redshiftDataParameters_withEvent
- Indicates whether to send an event back to EventBridge after the SQL
statement runs.
$sel:database:RedshiftDataParameters'
, redshiftDataParameters_database
- The name of the database. Required when authenticating using temporary
credentials.
$sel:sql:RedshiftDataParameters'
, redshiftDataParameters_sql
- The SQL statement text to run.
RemoveTargetsResultEntry
data RemoveTargetsResultEntry Source #
Represents a target that failed to be removed from a rule.
See: newRemoveTargetsResultEntry
smart constructor.
Instances
newRemoveTargetsResultEntry :: RemoveTargetsResultEntry Source #
Create a value of RemoveTargetsResultEntry
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:targetId:RemoveTargetsResultEntry'
, removeTargetsResultEntry_targetId
- The ID of the target.
$sel:errorCode:RemoveTargetsResultEntry'
, removeTargetsResultEntry_errorCode
- The error code that indicates why the target removal failed. If the
value is ConcurrentModificationException
, too many requests were made
at the same time.
$sel:errorMessage:RemoveTargetsResultEntry'
, removeTargetsResultEntry_errorMessage
- The error message that explains why the target removal failed.
Replay
A Replay
object that contains details about a replay.
See: newReplay
smart constructor.
Replay' (Maybe Text) (Maybe ReplayState) (Maybe POSIX) (Maybe POSIX) (Maybe POSIX) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Text) |
Instances
Create a value of Replay
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:eventSourceArn:Replay'
, replay_eventSourceArn
- The ARN of the archive to replay event from.
$sel:state:Replay'
, replay_state
- The current state of the replay.
$sel:eventEndTime:Replay'
, replay_eventEndTime
- A time stamp for the time to start replaying events. Any event with a
creation time prior to the EventEndTime
specified is replayed.
$sel:replayStartTime:Replay'
, replay_replayStartTime
- A time stamp for the time that the replay started.
$sel:replayEndTime:Replay'
, replay_replayEndTime
- A time stamp for the time that the replay completed.
$sel:eventLastReplayedTime:Replay'
, replay_eventLastReplayedTime
- A time stamp for the time that the last event was replayed.
$sel:eventStartTime:Replay'
, replay_eventStartTime
- A time stamp for the time to start replaying events. This is determined
by the time in the event as described in
Time.
$sel:replayName:Replay'
, replay_replayName
- The name of the replay.
$sel:stateReason:Replay'
, replay_stateReason
- A description of why the replay is in the current state.
ReplayDestination
data ReplayDestination Source #
A ReplayDestination
object that contains details about a replay.
See: newReplayDestination
smart constructor.
Instances
Create a value of ReplayDestination
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:filterArns:ReplayDestination'
, replayDestination_filterArns
- A list of ARNs for rules to replay events to.
$sel:arn:ReplayDestination'
, replayDestination_arn
- The ARN of the event bus to replay event to. You can replay events only
to the event bus specified to create the archive.
RetryPolicy
data RetryPolicy Source #
A RetryPolicy
object that includes information about the retry policy
settings.
See: newRetryPolicy
smart constructor.
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 continue until either the maximum number of attempts is
made or until the duration of the MaximumEventAgeInSeconds
is met.
Rule
Contains information about a rule in Amazon EventBridge.
See: newRule
smart constructor.
Rule' (Maybe Text) (Maybe RuleState) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
Create a value of Rule
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:eventPattern:Rule'
, rule_eventPattern
- The event pattern of the rule. For more information, see
Events and Event Patterns
in the Amazon EventBridge User Guide.
$sel:state:Rule'
, rule_state
- The state of the rule.
$sel:arn:Rule'
, rule_arn
- The Amazon Resource Name (ARN) of the rule.
$sel:eventBusName:Rule'
, rule_eventBusName
- The name or ARN of the event bus associated with the rule. If you omit
this, the default event bus is used.
$sel:scheduleExpression:Rule'
, rule_scheduleExpression
- The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5
minutes)". For more information, see
Creating an Amazon EventBridge rule that runs on a schedule.
$sel:name:Rule'
, rule_name
- The name of the rule.
$sel:description:Rule'
, rule_description
- The description of the rule.
$sel:managedBy:Rule'
, rule_managedBy
- If the rule was created on behalf of your account by an Amazon Web
Services service, this field displays the principal name of the service
that created the rule.
$sel:roleArn:Rule'
, rule_roleArn
- The Amazon Resource Name (ARN) of the role that is used for target
invocation.
If you're setting an event bus in another account as the target and
that account granted permission to your account through an organization
instead of directly by the account ID, you must specify a RoleArn
with
proper permissions in the Target
structure, instead of here in this
parameter.
RunCommandParameters
data RunCommandParameters Source #
This parameter contains the criteria (either InstanceIds or a tag) used to specify which EC2 instances are to be sent the command.
See: newRunCommandParameters
smart constructor.
Instances
newRunCommandParameters Source #
Create a value of RunCommandParameters
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:runCommandTargets:RunCommandParameters'
, runCommandParameters_runCommandTargets
- Currently, we support including only one RunCommandTarget block, which
specifies either an array of InstanceIds or a tag.
RunCommandTarget
data RunCommandTarget Source #
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: newRunCommandTarget
smart constructor.
Instances
Create a value of RunCommandTarget
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:RunCommandTarget'
, runCommandTarget_key
- Can be either tag:
tag-key or InstanceIds
.
$sel:values:RunCommandTarget'
, runCommandTarget_values
- 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.
SageMakerPipelineParameter
data SageMakerPipelineParameter Source #
Name/Value pair of a parameter 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.
SageMakerPipelineParameters
data SageMakerPipelineParameters Source #
These are custom parameters to use when the target is a SageMaker Model Building Pipeline that starts based on EventBridge events.
See: newSageMakerPipelineParameters
smart constructor.
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 for SageMaker Model Building Pipeline
execution.
SqsParameters
data SqsParameters Source #
This structure includes the custom parameter to be used when the target is an SQS FIFO queue.
See: newSqsParameters
smart constructor.
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
A key-value pair associated with an Amazon Web Services resource. In EventBridge, rules and event buses support tagging.
See: newTag
smart constructor.
Instances
Eq Tag Source # | |
Read Tag Source # | |
Show Tag Source # | |
Generic Tag Source # | |
NFData Tag Source # | |
Defined in Amazonka.CloudWatchEvents.Types.Tag | |
Hashable Tag Source # | |
Defined in Amazonka.CloudWatchEvents.Types.Tag | |
ToJSON Tag Source # | |
Defined in Amazonka.CloudWatchEvents.Types.Tag | |
FromJSON Tag Source # | |
type Rep Tag Source # | |
Defined in Amazonka.CloudWatchEvents.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.CloudWatchEvents.Types.Tag" "libZSservicesZSamazonka-cloudwatch-eventsZSamazonka-cloudwatch-events" '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
- A string you can use to assign a value. The combination of tag keys and
values can help you organize and categorize your resources.
$sel:value:Tag'
, tag_value
- The value for the specified tag key.
Target
Targets are the resources to be invoked when a rule is triggered. For a complete list of services and resources that can be set as a target, see PutTargets.
If you are setting the event bus of another account as the target, and
that account granted permission to your account through an organization
instead of directly by the account ID, then you must specify a RoleArn
with proper permissions in the Target
structure. For more information,
see
Sending and Receiving Events Between Amazon Web Services Accounts
in the Amazon EventBridge User Guide.
See: newTarget
smart constructor.
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:runCommandParameters:Target'
, target_runCommandParameters
- Parameters used when you are using the rule to invoke Amazon EC2 Run
Command.
$sel:httpParameters:Target'
, target_httpParameters
- Contains the HTTP parameters to use when the target is a API Gateway
REST endpoint or EventBridge ApiDestination.
If you specify an API Gateway REST API or EventBridge ApiDestination as a target, you can use this parameter to specify headers, path parameters, and query string keys/values as part of your target invoking request. If you're using ApiDestinations, the corresponding Connection can also have these values configured. In case of any conflicting keys, values from the Connection take precedence.
$sel:kinesisParameters:Target'
, target_kinesisParameters
- The custom parameter you can use to control the shard assignment, when
the target is a Kinesis data stream. If you do not include this
parameter, the default is to use the eventId
as the partition key.
$sel:inputTransformer:Target'
, target_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.
$sel:deadLetterConfig:Target'
, target_deadLetterConfig
- The DeadLetterConfig
that defines the target queue to send dead-letter
queue events to.
$sel:sageMakerPipelineParameters:Target'
, target_sageMakerPipelineParameters
- Contains the SageMaker Model Building Pipeline parameters to start
execution of a SageMaker Model Building Pipeline.
If you specify a SageMaker Model Building Pipeline as a target, you can use this to specify parameters to start a pipeline execution based on EventBridge events.
$sel:sqsParameters:Target'
, target_sqsParameters
- Contains the message group ID to use when the target is a FIFO queue.
If you specify an SQS FIFO queue as a target, the queue must have content-based deduplication enabled.
$sel:input:Target'
, target_input
- 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.
$sel:batchParameters:Target'
, target_batchParameters
- If the event target is an Batch job, this contains the job definition,
job name, and other parameters. For more information, see
Jobs in
the Batch User Guide.
$sel:redshiftDataParameters:Target'
, target_redshiftDataParameters
- Contains the Amazon Redshift Data API parameters to use when the target
is a Amazon Redshift cluster.
If you specify a Amazon Redshift Cluster as a Target, you can use this to specify parameters to invoke the Amazon Redshift Data API ExecuteStatement based on EventBridge events.
$sel:ecsParameters:Target'
, target_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.
$sel:retryPolicy:Target'
, target_retryPolicy
- The RetryPolicy
object that contains the retry policy configuration to
use for the dead-letter queue.
$sel:inputPath:Target'
, target_inputPath
- 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.
$sel:roleArn:Target'
, target_roleArn
- 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.
$sel:id:Target'
, target_id
- The ID of the target. We recommend using a memorable and unique string.
$sel:arn:Target'
, target_arn
- The Amazon Resource Name (ARN) of the target.
UpdateConnectionApiKeyAuthRequestParameters
data UpdateConnectionApiKeyAuthRequestParameters Source #
Contains the API key authorization parameters to use to update the connection.
See: newUpdateConnectionApiKeyAuthRequestParameters
smart constructor.
Instances
newUpdateConnectionApiKeyAuthRequestParameters :: UpdateConnectionApiKeyAuthRequestParameters Source #
Create a value of UpdateConnectionApiKeyAuthRequestParameters
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:apiKeyValue:UpdateConnectionApiKeyAuthRequestParameters'
, updateConnectionApiKeyAuthRequestParameters_apiKeyValue
- The value associated with teh API key to use for authorization.
$sel:apiKeyName:UpdateConnectionApiKeyAuthRequestParameters'
, updateConnectionApiKeyAuthRequestParameters_apiKeyName
- The name of the API key to use for authorization.
UpdateConnectionAuthRequestParameters
data UpdateConnectionAuthRequestParameters Source #
Contains the additional parameters to use for the connection.
See: newUpdateConnectionAuthRequestParameters
smart constructor.
Instances
newUpdateConnectionAuthRequestParameters :: UpdateConnectionAuthRequestParameters Source #
Create a value of UpdateConnectionAuthRequestParameters
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:oAuthParameters:UpdateConnectionAuthRequestParameters'
, updateConnectionAuthRequestParameters_oAuthParameters
- A UpdateConnectionOAuthRequestParameters
object that contains the
authorization parameters for OAuth authorization.
$sel:invocationHttpParameters:UpdateConnectionAuthRequestParameters'
, updateConnectionAuthRequestParameters_invocationHttpParameters
- A ConnectionHttpParameters
object that contains the additional
parameters to use for the connection.
$sel:apiKeyAuthParameters:UpdateConnectionAuthRequestParameters'
, updateConnectionAuthRequestParameters_apiKeyAuthParameters
- A UpdateConnectionApiKeyAuthRequestParameters
object that contains the
authorization parameters for API key authorization.
$sel:basicAuthParameters:UpdateConnectionAuthRequestParameters'
, updateConnectionAuthRequestParameters_basicAuthParameters
- A UpdateConnectionBasicAuthRequestParameters
object that contains the
authorization parameters for Basic authorization.
UpdateConnectionBasicAuthRequestParameters
data UpdateConnectionBasicAuthRequestParameters Source #
Contains the Basic authorization parameters for the connection.
See: newUpdateConnectionBasicAuthRequestParameters
smart constructor.
Instances
newUpdateConnectionBasicAuthRequestParameters :: UpdateConnectionBasicAuthRequestParameters Source #
Create a value of UpdateConnectionBasicAuthRequestParameters
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:username:UpdateConnectionBasicAuthRequestParameters'
, updateConnectionBasicAuthRequestParameters_username
- The user name to use for Basic authorization.
$sel:password:UpdateConnectionBasicAuthRequestParameters'
, updateConnectionBasicAuthRequestParameters_password
- The password associated with the user name to use for Basic
authorization.
UpdateConnectionOAuthClientRequestParameters
data UpdateConnectionOAuthClientRequestParameters Source #
Contains the OAuth authorization parameters to use for the connection.
See: newUpdateConnectionOAuthClientRequestParameters
smart constructor.
Instances
newUpdateConnectionOAuthClientRequestParameters :: UpdateConnectionOAuthClientRequestParameters Source #
Create a value of UpdateConnectionOAuthClientRequestParameters
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:clientID:UpdateConnectionOAuthClientRequestParameters'
, updateConnectionOAuthClientRequestParameters_clientID
- The client ID to use for OAuth authorization.
$sel:clientSecret:UpdateConnectionOAuthClientRequestParameters'
, updateConnectionOAuthClientRequestParameters_clientSecret
- The client secret assciated with the client ID to use for OAuth
authorization.
UpdateConnectionOAuthRequestParameters
data UpdateConnectionOAuthRequestParameters Source #
Contains the OAuth request parameters to use for the connection.
See: newUpdateConnectionOAuthRequestParameters
smart constructor.
UpdateConnectionOAuthRequestParameters' (Maybe ConnectionOAuthHttpMethod) (Maybe UpdateConnectionOAuthClientRequestParameters) (Maybe ConnectionHttpParameters) (Maybe Text) |
Instances
newUpdateConnectionOAuthRequestParameters :: UpdateConnectionOAuthRequestParameters Source #
Create a value of UpdateConnectionOAuthRequestParameters
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:httpMethod:UpdateConnectionOAuthRequestParameters'
, updateConnectionOAuthRequestParameters_httpMethod
- The method used to connect to the HTTP endpoint.
$sel:clientParameters:UpdateConnectionOAuthRequestParameters'
, updateConnectionOAuthRequestParameters_clientParameters
- A UpdateConnectionOAuthClientRequestParameters
object that contains
the client parameters to use for the connection when OAuth is specified
as the authorization type.
$sel:oAuthHttpParameters:UpdateConnectionOAuthRequestParameters'
, updateConnectionOAuthRequestParameters_oAuthHttpParameters
- The additional HTTP parameters used for the OAuth authorization request.
$sel:authorizationEndpoint:UpdateConnectionOAuthRequestParameters'
, updateConnectionOAuthRequestParameters_authorizationEndpoint
- The URL to the authorization endpoint when OAuth is specified as the
authorization type.