| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.CloudWatchEvents.Types
Contents
- Service Configuration
- Errors
- ApiDestinationHttpMethod
- ApiDestinationState
- ArchiveState
- AssignPublicIp
- ConnectionAuthorizationType
- ConnectionOAuthHttpMethod
- ConnectionState
- EndpointState
- EventSourceState
- LaunchType
- PlacementConstraintType
- PlacementStrategyType
- PropagateTags
- ReplayState
- ReplicationState
- 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
- Endpoint
- EndpointEventBus
- EventBus
- EventSource
- FailoverConfig
- HttpParameters
- InputTransformer
- KinesisParameters
- NetworkConfiguration
- PartnerEventSource
- PartnerEventSourceAccount
- PlacementConstraint
- PlacementStrategy
- Primary
- PutEventsRequestEntry
- PutEventsResultEntry
- PutPartnerEventsRequestEntry
- PutPartnerEventsResultEntry
- PutTargetsResultEntry
- RedshiftDataParameters
- RemoveTargetsResultEntry
- Replay
- ReplayDestination
- ReplicationConfig
- RetryPolicy
- RoutingConfig
- Rule
- RunCommandParameters
- RunCommandTarget
- SageMakerPipelineParameter
- SageMakerPipelineParameters
- Secondary
- SqsParameters
- Tag
- Target
- UpdateConnectionApiKeyAuthRequestParameters
- UpdateConnectionAuthRequestParameters
- UpdateConnectionBasicAuthRequestParameters
- UpdateConnectionOAuthClientRequestParameters
- UpdateConnectionOAuthRequestParameters
Description
Synopsis
- defaultService :: Service
- _ConcurrentModificationException :: AsError a => Fold a ServiceError
- _IllegalStatusException :: AsError a => Fold a ServiceError
- _InternalException :: AsError a => Fold a ServiceError
- _InvalidEventPatternException :: AsError a => Fold a ServiceError
- _InvalidStateException :: AsError a => Fold a ServiceError
- _LimitExceededException :: AsError a => Fold a ServiceError
- _ManagedRuleException :: AsError a => Fold a ServiceError
- _OperationDisabledException :: AsError a => Fold a ServiceError
- _PolicyLengthExceededException :: AsError a => Fold a ServiceError
- _ResourceAlreadyExistsException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- 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 EndpointState where
- EndpointState' { }
- pattern EndpointState_ACTIVE :: EndpointState
- pattern EndpointState_CREATE_FAILED :: EndpointState
- pattern EndpointState_CREATING :: EndpointState
- pattern EndpointState_DELETE_FAILED :: EndpointState
- pattern EndpointState_DELETING :: EndpointState
- pattern EndpointState_UPDATE_FAILED :: EndpointState
- pattern EndpointState_UPDATING :: EndpointState
- 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 ReplicationState where
- ReplicationState' { }
- pattern ReplicationState_DISABLED :: ReplicationState
- pattern ReplicationState_ENABLED :: ReplicationState
- newtype RuleState where
- RuleState' { }
- pattern RuleState_DISABLED :: RuleState
- pattern RuleState_ENABLED :: RuleState
- data ApiDestination = ApiDestination' {
- apiDestinationArn :: Maybe Text
- apiDestinationState :: Maybe ApiDestinationState
- connectionArn :: Maybe Text
- creationTime :: Maybe POSIX
- httpMethod :: Maybe ApiDestinationHttpMethod
- invocationEndpoint :: Maybe Text
- invocationRateLimitPerSecond :: Maybe Natural
- lastModifiedTime :: Maybe POSIX
- name :: Maybe Text
- newApiDestination :: ApiDestination
- apiDestination_apiDestinationArn :: Lens' ApiDestination (Maybe Text)
- apiDestination_apiDestinationState :: Lens' ApiDestination (Maybe ApiDestinationState)
- apiDestination_connectionArn :: Lens' ApiDestination (Maybe Text)
- apiDestination_creationTime :: Lens' ApiDestination (Maybe UTCTime)
- apiDestination_httpMethod :: Lens' ApiDestination (Maybe ApiDestinationHttpMethod)
- apiDestination_invocationEndpoint :: Lens' ApiDestination (Maybe Text)
- apiDestination_invocationRateLimitPerSecond :: Lens' ApiDestination (Maybe Natural)
- apiDestination_lastModifiedTime :: Lens' ApiDestination (Maybe UTCTime)
- apiDestination_name :: Lens' ApiDestination (Maybe Text)
- data Archive = Archive' {}
- newArchive :: Archive
- archive_archiveName :: Lens' Archive (Maybe Text)
- archive_creationTime :: Lens' Archive (Maybe UTCTime)
- archive_eventCount :: Lens' Archive (Maybe Integer)
- archive_eventSourceArn :: Lens' Archive (Maybe Text)
- archive_retentionDays :: Lens' Archive (Maybe Natural)
- archive_sizeBytes :: Lens' Archive (Maybe Integer)
- archive_state :: Lens' Archive (Maybe ArchiveState)
- archive_stateReason :: Lens' Archive (Maybe Text)
- data AwsVpcConfiguration = AwsVpcConfiguration' {
- assignPublicIp :: Maybe AssignPublicIp
- securityGroups :: Maybe [Text]
- subnets :: [Text]
- newAwsVpcConfiguration :: AwsVpcConfiguration
- awsVpcConfiguration_assignPublicIp :: Lens' AwsVpcConfiguration (Maybe AssignPublicIp)
- awsVpcConfiguration_securityGroups :: Lens' AwsVpcConfiguration (Maybe [Text])
- awsVpcConfiguration_subnets :: Lens' AwsVpcConfiguration [Text]
- data BatchArrayProperties = BatchArrayProperties' {}
- newBatchArrayProperties :: BatchArrayProperties
- batchArrayProperties_size :: Lens' BatchArrayProperties (Maybe Int)
- data BatchParameters = BatchParameters' {}
- newBatchParameters :: Text -> Text -> BatchParameters
- batchParameters_arrayProperties :: Lens' BatchParameters (Maybe BatchArrayProperties)
- batchParameters_retryStrategy :: Lens' BatchParameters (Maybe BatchRetryStrategy)
- batchParameters_jobDefinition :: Lens' BatchParameters Text
- batchParameters_jobName :: Lens' BatchParameters Text
- data BatchRetryStrategy = BatchRetryStrategy' {}
- newBatchRetryStrategy :: BatchRetryStrategy
- batchRetryStrategy_attempts :: Lens' BatchRetryStrategy (Maybe Int)
- data CapacityProviderStrategyItem = CapacityProviderStrategyItem' {}
- newCapacityProviderStrategyItem :: Text -> CapacityProviderStrategyItem
- capacityProviderStrategyItem_base :: Lens' CapacityProviderStrategyItem (Maybe Natural)
- capacityProviderStrategyItem_weight :: Lens' CapacityProviderStrategyItem (Maybe Natural)
- capacityProviderStrategyItem_capacityProvider :: Lens' CapacityProviderStrategyItem Text
- data Condition = Condition' {}
- newCondition :: Text -> Text -> Text -> Condition
- condition_type :: Lens' Condition Text
- condition_key :: Lens' Condition Text
- condition_value :: Lens' Condition Text
- data Connection = Connection' {}
- newConnection :: Connection
- connection_authorizationType :: Lens' Connection (Maybe ConnectionAuthorizationType)
- connection_connectionArn :: Lens' Connection (Maybe Text)
- connection_connectionState :: Lens' Connection (Maybe ConnectionState)
- connection_creationTime :: Lens' Connection (Maybe UTCTime)
- connection_lastAuthorizedTime :: Lens' Connection (Maybe UTCTime)
- connection_lastModifiedTime :: Lens' Connection (Maybe UTCTime)
- connection_name :: Lens' Connection (Maybe Text)
- connection_stateReason :: Lens' Connection (Maybe Text)
- data ConnectionApiKeyAuthResponseParameters = ConnectionApiKeyAuthResponseParameters' {
- apiKeyName :: Maybe Text
- newConnectionApiKeyAuthResponseParameters :: ConnectionApiKeyAuthResponseParameters
- connectionApiKeyAuthResponseParameters_apiKeyName :: Lens' ConnectionApiKeyAuthResponseParameters (Maybe Text)
- data ConnectionAuthResponseParameters = ConnectionAuthResponseParameters' {}
- newConnectionAuthResponseParameters :: ConnectionAuthResponseParameters
- connectionAuthResponseParameters_apiKeyAuthParameters :: Lens' ConnectionAuthResponseParameters (Maybe ConnectionApiKeyAuthResponseParameters)
- connectionAuthResponseParameters_basicAuthParameters :: Lens' ConnectionAuthResponseParameters (Maybe ConnectionBasicAuthResponseParameters)
- connectionAuthResponseParameters_invocationHttpParameters :: Lens' ConnectionAuthResponseParameters (Maybe ConnectionHttpParameters)
- connectionAuthResponseParameters_oAuthParameters :: Lens' ConnectionAuthResponseParameters (Maybe ConnectionOAuthResponseParameters)
- data ConnectionBasicAuthResponseParameters = ConnectionBasicAuthResponseParameters' {}
- newConnectionBasicAuthResponseParameters :: ConnectionBasicAuthResponseParameters
- connectionBasicAuthResponseParameters_username :: Lens' ConnectionBasicAuthResponseParameters (Maybe Text)
- data ConnectionBodyParameter = ConnectionBodyParameter' {}
- newConnectionBodyParameter :: ConnectionBodyParameter
- connectionBodyParameter_isValueSecret :: Lens' ConnectionBodyParameter (Maybe Bool)
- connectionBodyParameter_key :: Lens' ConnectionBodyParameter (Maybe Text)
- connectionBodyParameter_value :: Lens' ConnectionBodyParameter (Maybe Text)
- data ConnectionHeaderParameter = ConnectionHeaderParameter' {}
- newConnectionHeaderParameter :: ConnectionHeaderParameter
- connectionHeaderParameter_isValueSecret :: Lens' ConnectionHeaderParameter (Maybe Bool)
- connectionHeaderParameter_key :: Lens' ConnectionHeaderParameter (Maybe Text)
- connectionHeaderParameter_value :: Lens' ConnectionHeaderParameter (Maybe Text)
- data ConnectionHttpParameters = ConnectionHttpParameters' {}
- newConnectionHttpParameters :: ConnectionHttpParameters
- connectionHttpParameters_bodyParameters :: Lens' ConnectionHttpParameters (Maybe [ConnectionBodyParameter])
- connectionHttpParameters_headerParameters :: Lens' ConnectionHttpParameters (Maybe [ConnectionHeaderParameter])
- connectionHttpParameters_queryStringParameters :: Lens' ConnectionHttpParameters (Maybe [ConnectionQueryStringParameter])
- data ConnectionOAuthClientResponseParameters = ConnectionOAuthClientResponseParameters' {}
- newConnectionOAuthClientResponseParameters :: ConnectionOAuthClientResponseParameters
- connectionOAuthClientResponseParameters_clientID :: Lens' ConnectionOAuthClientResponseParameters (Maybe Text)
- data ConnectionOAuthResponseParameters = ConnectionOAuthResponseParameters' {}
- newConnectionOAuthResponseParameters :: ConnectionOAuthResponseParameters
- connectionOAuthResponseParameters_authorizationEndpoint :: Lens' ConnectionOAuthResponseParameters (Maybe Text)
- connectionOAuthResponseParameters_clientParameters :: Lens' ConnectionOAuthResponseParameters (Maybe ConnectionOAuthClientResponseParameters)
- connectionOAuthResponseParameters_httpMethod :: Lens' ConnectionOAuthResponseParameters (Maybe ConnectionOAuthHttpMethod)
- connectionOAuthResponseParameters_oAuthHttpParameters :: Lens' ConnectionOAuthResponseParameters (Maybe ConnectionHttpParameters)
- data ConnectionQueryStringParameter = ConnectionQueryStringParameter' {}
- newConnectionQueryStringParameter :: ConnectionQueryStringParameter
- connectionQueryStringParameter_isValueSecret :: Lens' ConnectionQueryStringParameter (Maybe Bool)
- connectionQueryStringParameter_key :: Lens' ConnectionQueryStringParameter (Maybe Text)
- connectionQueryStringParameter_value :: Lens' ConnectionQueryStringParameter (Maybe Text)
- data CreateConnectionApiKeyAuthRequestParameters = CreateConnectionApiKeyAuthRequestParameters' {
- apiKeyName :: Text
- apiKeyValue :: Text
- newCreateConnectionApiKeyAuthRequestParameters :: Text -> Text -> CreateConnectionApiKeyAuthRequestParameters
- createConnectionApiKeyAuthRequestParameters_apiKeyName :: Lens' CreateConnectionApiKeyAuthRequestParameters Text
- createConnectionApiKeyAuthRequestParameters_apiKeyValue :: Lens' CreateConnectionApiKeyAuthRequestParameters Text
- data CreateConnectionAuthRequestParameters = CreateConnectionAuthRequestParameters' {}
- newCreateConnectionAuthRequestParameters :: CreateConnectionAuthRequestParameters
- createConnectionAuthRequestParameters_apiKeyAuthParameters :: Lens' CreateConnectionAuthRequestParameters (Maybe CreateConnectionApiKeyAuthRequestParameters)
- createConnectionAuthRequestParameters_basicAuthParameters :: Lens' CreateConnectionAuthRequestParameters (Maybe CreateConnectionBasicAuthRequestParameters)
- createConnectionAuthRequestParameters_invocationHttpParameters :: Lens' CreateConnectionAuthRequestParameters (Maybe ConnectionHttpParameters)
- createConnectionAuthRequestParameters_oAuthParameters :: Lens' CreateConnectionAuthRequestParameters (Maybe CreateConnectionOAuthRequestParameters)
- data CreateConnectionBasicAuthRequestParameters = CreateConnectionBasicAuthRequestParameters' {}
- newCreateConnectionBasicAuthRequestParameters :: Text -> Text -> CreateConnectionBasicAuthRequestParameters
- createConnectionBasicAuthRequestParameters_username :: Lens' CreateConnectionBasicAuthRequestParameters Text
- createConnectionBasicAuthRequestParameters_password :: Lens' CreateConnectionBasicAuthRequestParameters Text
- data CreateConnectionOAuthClientRequestParameters = CreateConnectionOAuthClientRequestParameters' {
- clientID :: Text
- clientSecret :: Text
- newCreateConnectionOAuthClientRequestParameters :: Text -> Text -> CreateConnectionOAuthClientRequestParameters
- createConnectionOAuthClientRequestParameters_clientID :: Lens' CreateConnectionOAuthClientRequestParameters Text
- createConnectionOAuthClientRequestParameters_clientSecret :: Lens' CreateConnectionOAuthClientRequestParameters Text
- data CreateConnectionOAuthRequestParameters = CreateConnectionOAuthRequestParameters' {}
- newCreateConnectionOAuthRequestParameters :: CreateConnectionOAuthClientRequestParameters -> Text -> ConnectionOAuthHttpMethod -> CreateConnectionOAuthRequestParameters
- createConnectionOAuthRequestParameters_oAuthHttpParameters :: Lens' CreateConnectionOAuthRequestParameters (Maybe ConnectionHttpParameters)
- createConnectionOAuthRequestParameters_clientParameters :: Lens' CreateConnectionOAuthRequestParameters CreateConnectionOAuthClientRequestParameters
- createConnectionOAuthRequestParameters_authorizationEndpoint :: Lens' CreateConnectionOAuthRequestParameters Text
- createConnectionOAuthRequestParameters_httpMethod :: Lens' CreateConnectionOAuthRequestParameters ConnectionOAuthHttpMethod
- data DeadLetterConfig = DeadLetterConfig' {}
- newDeadLetterConfig :: DeadLetterConfig
- deadLetterConfig_arn :: Lens' DeadLetterConfig (Maybe Text)
- data EcsParameters = EcsParameters' {
- capacityProviderStrategy :: Maybe [CapacityProviderStrategyItem]
- enableECSManagedTags :: Maybe Bool
- enableExecuteCommand :: Maybe Bool
- group' :: Maybe Text
- launchType :: Maybe LaunchType
- networkConfiguration :: Maybe NetworkConfiguration
- placementConstraints :: Maybe [PlacementConstraint]
- placementStrategy :: Maybe [PlacementStrategy]
- platformVersion :: Maybe Text
- propagateTags :: Maybe PropagateTags
- referenceId :: Maybe Text
- tags :: Maybe [Tag]
- taskCount :: Maybe Natural
- taskDefinitionArn :: Text
- newEcsParameters :: Text -> EcsParameters
- ecsParameters_capacityProviderStrategy :: Lens' EcsParameters (Maybe [CapacityProviderStrategyItem])
- ecsParameters_enableECSManagedTags :: Lens' EcsParameters (Maybe Bool)
- ecsParameters_enableExecuteCommand :: Lens' EcsParameters (Maybe Bool)
- ecsParameters_group :: Lens' EcsParameters (Maybe Text)
- ecsParameters_launchType :: Lens' EcsParameters (Maybe LaunchType)
- ecsParameters_networkConfiguration :: Lens' EcsParameters (Maybe NetworkConfiguration)
- ecsParameters_placementConstraints :: Lens' EcsParameters (Maybe [PlacementConstraint])
- ecsParameters_placementStrategy :: Lens' EcsParameters (Maybe [PlacementStrategy])
- ecsParameters_platformVersion :: Lens' EcsParameters (Maybe Text)
- ecsParameters_propagateTags :: Lens' EcsParameters (Maybe PropagateTags)
- ecsParameters_referenceId :: Lens' EcsParameters (Maybe Text)
- ecsParameters_tags :: Lens' EcsParameters (Maybe [Tag])
- ecsParameters_taskCount :: Lens' EcsParameters (Maybe Natural)
- ecsParameters_taskDefinitionArn :: Lens' EcsParameters Text
- data Endpoint = Endpoint' {
- arn :: Maybe Text
- creationTime :: Maybe POSIX
- description :: Maybe Text
- endpointId :: Maybe Text
- endpointUrl :: Maybe Text
- eventBuses :: Maybe (NonEmpty EndpointEventBus)
- lastModifiedTime :: Maybe POSIX
- name :: Maybe Text
- replicationConfig :: Maybe ReplicationConfig
- roleArn :: Maybe Text
- routingConfig :: Maybe RoutingConfig
- state :: Maybe EndpointState
- stateReason :: Maybe Text
- newEndpoint :: Endpoint
- endpoint_arn :: Lens' Endpoint (Maybe Text)
- endpoint_creationTime :: Lens' Endpoint (Maybe UTCTime)
- endpoint_description :: Lens' Endpoint (Maybe Text)
- endpoint_endpointId :: Lens' Endpoint (Maybe Text)
- endpoint_endpointUrl :: Lens' Endpoint (Maybe Text)
- endpoint_eventBuses :: Lens' Endpoint (Maybe (NonEmpty EndpointEventBus))
- endpoint_lastModifiedTime :: Lens' Endpoint (Maybe UTCTime)
- endpoint_name :: Lens' Endpoint (Maybe Text)
- endpoint_replicationConfig :: Lens' Endpoint (Maybe ReplicationConfig)
- endpoint_roleArn :: Lens' Endpoint (Maybe Text)
- endpoint_routingConfig :: Lens' Endpoint (Maybe RoutingConfig)
- endpoint_state :: Lens' Endpoint (Maybe EndpointState)
- endpoint_stateReason :: Lens' Endpoint (Maybe Text)
- data EndpointEventBus = EndpointEventBus' {
- eventBusArn :: Text
- newEndpointEventBus :: Text -> EndpointEventBus
- endpointEventBus_eventBusArn :: Lens' EndpointEventBus Text
- data EventBus = EventBus' {}
- newEventBus :: EventBus
- eventBus_arn :: Lens' EventBus (Maybe Text)
- eventBus_name :: Lens' EventBus (Maybe Text)
- eventBus_policy :: Lens' EventBus (Maybe Text)
- data EventSource = EventSource' {}
- newEventSource :: EventSource
- eventSource_arn :: Lens' EventSource (Maybe Text)
- eventSource_createdBy :: Lens' EventSource (Maybe Text)
- eventSource_creationTime :: Lens' EventSource (Maybe UTCTime)
- eventSource_expirationTime :: Lens' EventSource (Maybe UTCTime)
- eventSource_name :: Lens' EventSource (Maybe Text)
- eventSource_state :: Lens' EventSource (Maybe EventSourceState)
- data FailoverConfig = FailoverConfig' {}
- newFailoverConfig :: Primary -> Secondary -> FailoverConfig
- failoverConfig_primary :: Lens' FailoverConfig Primary
- failoverConfig_secondary :: Lens' FailoverConfig Secondary
- data HttpParameters = HttpParameters' {}
- newHttpParameters :: HttpParameters
- httpParameters_headerParameters :: Lens' HttpParameters (Maybe (HashMap Text Text))
- httpParameters_pathParameterValues :: Lens' HttpParameters (Maybe [Text])
- httpParameters_queryStringParameters :: Lens' HttpParameters (Maybe (HashMap Text Text))
- data InputTransformer = InputTransformer' {
- inputPathsMap :: Maybe (HashMap Text Text)
- inputTemplate :: Text
- newInputTransformer :: Text -> InputTransformer
- inputTransformer_inputPathsMap :: Lens' InputTransformer (Maybe (HashMap Text Text))
- inputTransformer_inputTemplate :: Lens' InputTransformer Text
- data KinesisParameters = KinesisParameters' {}
- newKinesisParameters :: Text -> KinesisParameters
- kinesisParameters_partitionKeyPath :: Lens' KinesisParameters Text
- data NetworkConfiguration = NetworkConfiguration' {}
- newNetworkConfiguration :: NetworkConfiguration
- networkConfiguration_awsvpcConfiguration :: Lens' NetworkConfiguration (Maybe AwsVpcConfiguration)
- data PartnerEventSource = PartnerEventSource' {}
- newPartnerEventSource :: PartnerEventSource
- partnerEventSource_arn :: Lens' PartnerEventSource (Maybe Text)
- partnerEventSource_name :: Lens' PartnerEventSource (Maybe Text)
- data PartnerEventSourceAccount = PartnerEventSourceAccount' {}
- newPartnerEventSourceAccount :: PartnerEventSourceAccount
- partnerEventSourceAccount_account :: Lens' PartnerEventSourceAccount (Maybe Text)
- partnerEventSourceAccount_creationTime :: Lens' PartnerEventSourceAccount (Maybe UTCTime)
- partnerEventSourceAccount_expirationTime :: Lens' PartnerEventSourceAccount (Maybe UTCTime)
- partnerEventSourceAccount_state :: Lens' PartnerEventSourceAccount (Maybe EventSourceState)
- data PlacementConstraint = PlacementConstraint' {}
- newPlacementConstraint :: PlacementConstraint
- placementConstraint_expression :: Lens' PlacementConstraint (Maybe Text)
- placementConstraint_type :: Lens' PlacementConstraint (Maybe PlacementConstraintType)
- data PlacementStrategy = PlacementStrategy' {}
- newPlacementStrategy :: PlacementStrategy
- placementStrategy_field :: Lens' PlacementStrategy (Maybe Text)
- placementStrategy_type :: Lens' PlacementStrategy (Maybe PlacementStrategyType)
- data Primary = Primary' {
- healthCheck :: Text
- newPrimary :: Text -> Primary
- primary_healthCheck :: Lens' Primary Text
- data PutEventsRequestEntry = PutEventsRequestEntry' {}
- newPutEventsRequestEntry :: PutEventsRequestEntry
- putEventsRequestEntry_detail :: Lens' PutEventsRequestEntry (Maybe Text)
- putEventsRequestEntry_detailType :: Lens' PutEventsRequestEntry (Maybe Text)
- putEventsRequestEntry_eventBusName :: Lens' PutEventsRequestEntry (Maybe Text)
- putEventsRequestEntry_resources :: Lens' PutEventsRequestEntry (Maybe [Text])
- putEventsRequestEntry_source :: Lens' PutEventsRequestEntry (Maybe Text)
- putEventsRequestEntry_time :: Lens' PutEventsRequestEntry (Maybe UTCTime)
- putEventsRequestEntry_traceHeader :: Lens' PutEventsRequestEntry (Maybe Text)
- data PutEventsResultEntry = PutEventsResultEntry' {}
- newPutEventsResultEntry :: PutEventsResultEntry
- putEventsResultEntry_errorCode :: Lens' PutEventsResultEntry (Maybe Text)
- putEventsResultEntry_errorMessage :: Lens' PutEventsResultEntry (Maybe Text)
- putEventsResultEntry_eventId :: Lens' PutEventsResultEntry (Maybe Text)
- data PutPartnerEventsRequestEntry = PutPartnerEventsRequestEntry' {}
- newPutPartnerEventsRequestEntry :: PutPartnerEventsRequestEntry
- putPartnerEventsRequestEntry_detail :: Lens' PutPartnerEventsRequestEntry (Maybe Text)
- putPartnerEventsRequestEntry_detailType :: Lens' PutPartnerEventsRequestEntry (Maybe Text)
- putPartnerEventsRequestEntry_resources :: Lens' PutPartnerEventsRequestEntry (Maybe [Text])
- putPartnerEventsRequestEntry_source :: Lens' PutPartnerEventsRequestEntry (Maybe Text)
- putPartnerEventsRequestEntry_time :: Lens' PutPartnerEventsRequestEntry (Maybe UTCTime)
- data PutPartnerEventsResultEntry = PutPartnerEventsResultEntry' {}
- newPutPartnerEventsResultEntry :: PutPartnerEventsResultEntry
- putPartnerEventsResultEntry_errorCode :: Lens' PutPartnerEventsResultEntry (Maybe Text)
- putPartnerEventsResultEntry_errorMessage :: Lens' PutPartnerEventsResultEntry (Maybe Text)
- putPartnerEventsResultEntry_eventId :: Lens' PutPartnerEventsResultEntry (Maybe Text)
- data PutTargetsResultEntry = PutTargetsResultEntry' {}
- newPutTargetsResultEntry :: PutTargetsResultEntry
- putTargetsResultEntry_errorCode :: Lens' PutTargetsResultEntry (Maybe Text)
- putTargetsResultEntry_errorMessage :: Lens' PutTargetsResultEntry (Maybe Text)
- putTargetsResultEntry_targetId :: Lens' PutTargetsResultEntry (Maybe Text)
- data RedshiftDataParameters = RedshiftDataParameters' {}
- newRedshiftDataParameters :: Text -> Text -> RedshiftDataParameters
- redshiftDataParameters_dbUser :: Lens' RedshiftDataParameters (Maybe Text)
- redshiftDataParameters_secretManagerArn :: Lens' RedshiftDataParameters (Maybe Text)
- redshiftDataParameters_statementName :: Lens' RedshiftDataParameters (Maybe Text)
- redshiftDataParameters_withEvent :: Lens' RedshiftDataParameters (Maybe Bool)
- redshiftDataParameters_database :: Lens' RedshiftDataParameters Text
- redshiftDataParameters_sql :: Lens' RedshiftDataParameters Text
- data RemoveTargetsResultEntry = RemoveTargetsResultEntry' {}
- newRemoveTargetsResultEntry :: RemoveTargetsResultEntry
- removeTargetsResultEntry_errorCode :: Lens' RemoveTargetsResultEntry (Maybe Text)
- removeTargetsResultEntry_errorMessage :: Lens' RemoveTargetsResultEntry (Maybe Text)
- removeTargetsResultEntry_targetId :: Lens' RemoveTargetsResultEntry (Maybe Text)
- data Replay = Replay' {}
- newReplay :: Replay
- replay_eventEndTime :: Lens' Replay (Maybe UTCTime)
- replay_eventLastReplayedTime :: Lens' Replay (Maybe UTCTime)
- replay_eventSourceArn :: Lens' Replay (Maybe Text)
- replay_eventStartTime :: Lens' Replay (Maybe UTCTime)
- replay_replayEndTime :: Lens' Replay (Maybe UTCTime)
- replay_replayName :: Lens' Replay (Maybe Text)
- replay_replayStartTime :: Lens' Replay (Maybe UTCTime)
- replay_state :: Lens' Replay (Maybe ReplayState)
- replay_stateReason :: Lens' Replay (Maybe Text)
- data ReplayDestination = ReplayDestination' {
- filterArns :: Maybe [Text]
- arn :: Text
- newReplayDestination :: Text -> ReplayDestination
- replayDestination_filterArns :: Lens' ReplayDestination (Maybe [Text])
- replayDestination_arn :: Lens' ReplayDestination Text
- data ReplicationConfig = ReplicationConfig' {}
- newReplicationConfig :: ReplicationConfig
- replicationConfig_state :: Lens' ReplicationConfig (Maybe ReplicationState)
- data RetryPolicy = RetryPolicy' {}
- newRetryPolicy :: RetryPolicy
- retryPolicy_maximumEventAgeInSeconds :: Lens' RetryPolicy (Maybe Natural)
- retryPolicy_maximumRetryAttempts :: Lens' RetryPolicy (Maybe Natural)
- data RoutingConfig = RoutingConfig' {}
- newRoutingConfig :: FailoverConfig -> RoutingConfig
- routingConfig_failoverConfig :: Lens' RoutingConfig FailoverConfig
- data Rule = Rule' {}
- newRule :: Rule
- rule_arn :: Lens' Rule (Maybe Text)
- rule_description :: Lens' Rule (Maybe Text)
- rule_eventBusName :: Lens' Rule (Maybe Text)
- rule_eventPattern :: Lens' Rule (Maybe Text)
- rule_managedBy :: Lens' Rule (Maybe Text)
- rule_name :: Lens' Rule (Maybe Text)
- rule_roleArn :: Lens' Rule (Maybe Text)
- rule_scheduleExpression :: Lens' Rule (Maybe Text)
- rule_state :: Lens' Rule (Maybe RuleState)
- data RunCommandParameters = RunCommandParameters' {}
- newRunCommandParameters :: NonEmpty RunCommandTarget -> RunCommandParameters
- runCommandParameters_runCommandTargets :: Lens' RunCommandParameters (NonEmpty RunCommandTarget)
- data RunCommandTarget = RunCommandTarget' {}
- newRunCommandTarget :: Text -> NonEmpty Text -> RunCommandTarget
- runCommandTarget_key :: Lens' RunCommandTarget Text
- runCommandTarget_values :: Lens' RunCommandTarget (NonEmpty Text)
- data SageMakerPipelineParameter = SageMakerPipelineParameter' {}
- newSageMakerPipelineParameter :: Text -> Text -> SageMakerPipelineParameter
- sageMakerPipelineParameter_name :: Lens' SageMakerPipelineParameter Text
- sageMakerPipelineParameter_value :: Lens' SageMakerPipelineParameter Text
- data SageMakerPipelineParameters = SageMakerPipelineParameters' {}
- newSageMakerPipelineParameters :: SageMakerPipelineParameters
- sageMakerPipelineParameters_pipelineParameterList :: Lens' SageMakerPipelineParameters (Maybe [SageMakerPipelineParameter])
- data Secondary = Secondary' {}
- newSecondary :: Text -> Secondary
- secondary_route :: Lens' Secondary Text
- data SqsParameters = SqsParameters' {}
- newSqsParameters :: SqsParameters
- sqsParameters_messageGroupId :: Lens' SqsParameters (Maybe Text)
- data Tag = Tag' {}
- newTag :: Text -> Text -> Tag
- tag_key :: Lens' Tag Text
- tag_value :: Lens' Tag Text
- data Target = Target' {
- batchParameters :: Maybe BatchParameters
- deadLetterConfig :: Maybe DeadLetterConfig
- ecsParameters :: Maybe EcsParameters
- httpParameters :: Maybe HttpParameters
- input :: Maybe Text
- inputPath :: Maybe Text
- inputTransformer :: Maybe InputTransformer
- kinesisParameters :: Maybe KinesisParameters
- redshiftDataParameters :: Maybe RedshiftDataParameters
- retryPolicy :: Maybe RetryPolicy
- roleArn :: Maybe Text
- runCommandParameters :: Maybe RunCommandParameters
- sageMakerPipelineParameters :: Maybe SageMakerPipelineParameters
- sqsParameters :: Maybe SqsParameters
- id :: Text
- arn :: Text
- newTarget :: Text -> Text -> Target
- target_batchParameters :: Lens' Target (Maybe BatchParameters)
- target_deadLetterConfig :: Lens' Target (Maybe DeadLetterConfig)
- target_ecsParameters :: Lens' Target (Maybe EcsParameters)
- target_httpParameters :: Lens' Target (Maybe HttpParameters)
- target_input :: Lens' Target (Maybe Text)
- target_inputPath :: Lens' Target (Maybe Text)
- target_inputTransformer :: Lens' Target (Maybe InputTransformer)
- target_kinesisParameters :: Lens' Target (Maybe KinesisParameters)
- target_redshiftDataParameters :: Lens' Target (Maybe RedshiftDataParameters)
- target_retryPolicy :: Lens' Target (Maybe RetryPolicy)
- target_roleArn :: Lens' Target (Maybe Text)
- target_runCommandParameters :: Lens' Target (Maybe RunCommandParameters)
- target_sageMakerPipelineParameters :: Lens' Target (Maybe SageMakerPipelineParameters)
- target_sqsParameters :: Lens' Target (Maybe SqsParameters)
- target_id :: Lens' Target Text
- target_arn :: Lens' Target Text
- data UpdateConnectionApiKeyAuthRequestParameters = UpdateConnectionApiKeyAuthRequestParameters' {
- apiKeyName :: Maybe Text
- apiKeyValue :: Maybe Text
- newUpdateConnectionApiKeyAuthRequestParameters :: UpdateConnectionApiKeyAuthRequestParameters
- updateConnectionApiKeyAuthRequestParameters_apiKeyName :: Lens' UpdateConnectionApiKeyAuthRequestParameters (Maybe Text)
- updateConnectionApiKeyAuthRequestParameters_apiKeyValue :: Lens' UpdateConnectionApiKeyAuthRequestParameters (Maybe Text)
- data UpdateConnectionAuthRequestParameters = UpdateConnectionAuthRequestParameters' {}
- newUpdateConnectionAuthRequestParameters :: UpdateConnectionAuthRequestParameters
- updateConnectionAuthRequestParameters_apiKeyAuthParameters :: Lens' UpdateConnectionAuthRequestParameters (Maybe UpdateConnectionApiKeyAuthRequestParameters)
- updateConnectionAuthRequestParameters_basicAuthParameters :: Lens' UpdateConnectionAuthRequestParameters (Maybe UpdateConnectionBasicAuthRequestParameters)
- updateConnectionAuthRequestParameters_invocationHttpParameters :: Lens' UpdateConnectionAuthRequestParameters (Maybe ConnectionHttpParameters)
- updateConnectionAuthRequestParameters_oAuthParameters :: Lens' UpdateConnectionAuthRequestParameters (Maybe UpdateConnectionOAuthRequestParameters)
- data UpdateConnectionBasicAuthRequestParameters = UpdateConnectionBasicAuthRequestParameters' {}
- newUpdateConnectionBasicAuthRequestParameters :: UpdateConnectionBasicAuthRequestParameters
- updateConnectionBasicAuthRequestParameters_password :: Lens' UpdateConnectionBasicAuthRequestParameters (Maybe Text)
- updateConnectionBasicAuthRequestParameters_username :: Lens' UpdateConnectionBasicAuthRequestParameters (Maybe Text)
- data UpdateConnectionOAuthClientRequestParameters = UpdateConnectionOAuthClientRequestParameters' {}
- newUpdateConnectionOAuthClientRequestParameters :: UpdateConnectionOAuthClientRequestParameters
- updateConnectionOAuthClientRequestParameters_clientID :: Lens' UpdateConnectionOAuthClientRequestParameters (Maybe Text)
- updateConnectionOAuthClientRequestParameters_clientSecret :: Lens' UpdateConnectionOAuthClientRequestParameters (Maybe Text)
- data UpdateConnectionOAuthRequestParameters = UpdateConnectionOAuthRequestParameters' {}
- newUpdateConnectionOAuthRequestParameters :: UpdateConnectionOAuthRequestParameters
- updateConnectionOAuthRequestParameters_authorizationEndpoint :: Lens' UpdateConnectionOAuthRequestParameters (Maybe Text)
- updateConnectionOAuthRequestParameters_clientParameters :: Lens' UpdateConnectionOAuthRequestParameters (Maybe UpdateConnectionOAuthClientRequestParameters)
- updateConnectionOAuthRequestParameters_httpMethod :: Lens' UpdateConnectionOAuthRequestParameters (Maybe ConnectionOAuthHttpMethod)
- updateConnectionOAuthRequestParameters_oAuthHttpParameters :: Lens' UpdateConnectionOAuthRequestParameters (Maybe ConnectionHttpParameters)
Service Configuration
defaultService :: Service Source #
API version 2015-10-07 of the Amazon EventBridge SDK configuration.
Errors
_ConcurrentModificationException :: AsError a => Fold a ServiceError Source #
There is concurrent modification on a rule, target, archive, or replay.
_IllegalStatusException :: AsError a => Fold a ServiceError Source #
An error occurred because a replay can be canceled only when the state is Running or Starting.
_InternalException :: AsError a => Fold a ServiceError Source #
This exception occurs due to unexpected causes.
_InvalidEventPatternException :: AsError a => Fold a ServiceError Source #
The event pattern is not valid.
_InvalidStateException :: AsError a => Fold a ServiceError Source #
The specified state is not a valid state for an event source.
_LimitExceededException :: AsError a => Fold a ServiceError Source #
The request failed because it attempted to create resource beyond the allowed service quota.
_ManagedRuleException :: AsError a => Fold 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.
_OperationDisabledException :: AsError a => Fold a ServiceError Source #
The operation you are attempting is not available in this region.
_PolicyLengthExceededException :: AsError a => Fold a ServiceError Source #
The event bus policy is too long. For more information, see the limits.
_ResourceAlreadyExistsException :: AsError a => Fold a ServiceError Source #
The resource you are trying to create already exists.
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
An entity that you specified does not exist.
ApiDestinationHttpMethod
newtype ApiDestinationHttpMethod Source #
Constructors
| ApiDestinationHttpMethod' | |
Fields | |
Bundled Patterns
Instances
ApiDestinationState
newtype ApiDestinationState Source #
Constructors
| ApiDestinationState' | |
Fields | |
Bundled Patterns
| pattern ApiDestinationState_ACTIVE :: ApiDestinationState | |
| pattern ApiDestinationState_INACTIVE :: ApiDestinationState |
Instances
ArchiveState
newtype ArchiveState Source #
Constructors
| ArchiveState' | |
Fields | |
Bundled Patterns
| 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 #
Constructors
| AssignPublicIp' | |
Fields | |
Bundled Patterns
| pattern AssignPublicIp_DISABLED :: AssignPublicIp | |
| pattern AssignPublicIp_ENABLED :: AssignPublicIp |
Instances
ConnectionAuthorizationType
newtype ConnectionAuthorizationType Source #
Constructors
| ConnectionAuthorizationType' | |
Fields | |
Bundled Patterns
Instances
ConnectionOAuthHttpMethod
newtype ConnectionOAuthHttpMethod Source #
Constructors
| ConnectionOAuthHttpMethod' | |
Fields | |
Bundled Patterns
Instances
ConnectionState
newtype ConnectionState Source #
Constructors
| ConnectionState' | |
Fields | |
Bundled Patterns
| 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
EndpointState
newtype EndpointState Source #
Constructors
| EndpointState' | |
Fields | |
Bundled Patterns
| pattern EndpointState_ACTIVE :: EndpointState | |
| pattern EndpointState_CREATE_FAILED :: EndpointState | |
| pattern EndpointState_CREATING :: EndpointState | |
| pattern EndpointState_DELETE_FAILED :: EndpointState | |
| pattern EndpointState_DELETING :: EndpointState | |
| pattern EndpointState_UPDATE_FAILED :: EndpointState | |
| pattern EndpointState_UPDATING :: EndpointState |
Instances
EventSourceState
newtype EventSourceState Source #
Constructors
| EventSourceState' | |
Fields | |
Bundled Patterns
| pattern EventSourceState_ACTIVE :: EventSourceState | |
| pattern EventSourceState_DELETED :: EventSourceState | |
| pattern EventSourceState_PENDING :: EventSourceState |
Instances
LaunchType
newtype LaunchType Source #
Constructors
| LaunchType' | |
Fields | |
Bundled Patterns
| pattern LaunchType_EC2 :: LaunchType | |
| pattern LaunchType_EXTERNAL :: LaunchType | |
| pattern LaunchType_FARGATE :: LaunchType |
Instances
PlacementConstraintType
newtype PlacementConstraintType Source #
Constructors
| PlacementConstraintType' | |
Fields | |
Bundled Patterns
| pattern PlacementConstraintType_DistinctInstance :: PlacementConstraintType | |
| pattern PlacementConstraintType_MemberOf :: PlacementConstraintType |
Instances
PlacementStrategyType
newtype PlacementStrategyType Source #
Constructors
| PlacementStrategyType' | |
Fields | |
Bundled Patterns
| pattern PlacementStrategyType_Binpack :: PlacementStrategyType | |
| pattern PlacementStrategyType_Random :: PlacementStrategyType | |
| pattern PlacementStrategyType_Spread :: PlacementStrategyType |
Instances
PropagateTags
newtype PropagateTags Source #
Constructors
| PropagateTags' | |
Fields | |
Bundled Patterns
| pattern PropagateTags_TASK_DEFINITION :: PropagateTags |
Instances
ReplayState
newtype ReplayState Source #
Constructors
| ReplayState' | |
Fields | |
Bundled Patterns
| 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
ReplicationState
newtype ReplicationState Source #
Constructors
| ReplicationState' | |
Fields | |
Bundled Patterns
| pattern ReplicationState_DISABLED :: ReplicationState | |
| pattern ReplicationState_ENABLED :: ReplicationState |
Instances
RuleState
Constructors
| RuleState' | |
Fields | |
Bundled Patterns
| pattern RuleState_DISABLED :: RuleState | |
| pattern RuleState_ENABLED :: RuleState |
Instances
ApiDestination
data ApiDestination Source #
Contains details about an API destination.
See: newApiDestination smart constructor.
Constructors
| ApiDestination' | |
Fields
| |
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:apiDestinationArn:ApiDestination', apiDestination_apiDestinationArn - The ARN of the API destination.
$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: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:invocationRateLimitPerSecond:ApiDestination', apiDestination_invocationRateLimitPerSecond - The maximum number of invocations per second to send to the HTTP
endpoint.
$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.
apiDestination_apiDestinationArn :: Lens' ApiDestination (Maybe Text) Source #
The ARN of the API destination.
apiDestination_apiDestinationState :: Lens' ApiDestination (Maybe ApiDestinationState) Source #
The state of the API destination.
apiDestination_connectionArn :: Lens' ApiDestination (Maybe Text) Source #
The ARN of the connection specified for the API destination.
apiDestination_creationTime :: Lens' ApiDestination (Maybe UTCTime) Source #
A time stamp for the time that the API destination was created.
apiDestination_httpMethod :: Lens' ApiDestination (Maybe ApiDestinationHttpMethod) Source #
The method to use to connect to the HTTP endpoint.
apiDestination_invocationEndpoint :: Lens' ApiDestination (Maybe Text) Source #
The URL to the endpoint for the API destination.
apiDestination_invocationRateLimitPerSecond :: Lens' ApiDestination (Maybe Natural) Source #
The maximum number of invocations per second to send to the HTTP endpoint.
apiDestination_lastModifiedTime :: Lens' ApiDestination (Maybe UTCTime) Source #
A time stamp for the time that the API destination was last modified.
apiDestination_name :: Lens' ApiDestination (Maybe Text) Source #
The name of the API destination.
Archive
An Archive object that contains details about an archive.
See: newArchive smart constructor.
Constructors
| Archive' | |
Fields
| |
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:archiveName:Archive', archive_archiveName - The name of the archive.
$sel:creationTime:Archive', archive_creationTime - The time stamp for the time that the archive was created.
$sel:eventCount:Archive', archive_eventCount - The number of events in the archive.
$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:retentionDays:Archive', archive_retentionDays - The number of days to retain events in the archive before they are
deleted.
$sel:sizeBytes:Archive', archive_sizeBytes - The size of the archive, in bytes.
$sel:state:Archive', archive_state - The current state of the archive.
$sel:stateReason:Archive', archive_stateReason - A description for the reason that the archive is in the current state.
archive_creationTime :: Lens' Archive (Maybe UTCTime) Source #
The time stamp for the time that the archive was created.
archive_eventSourceArn :: Lens' Archive (Maybe Text) Source #
The ARN of the event bus associated with the archive. Only events from this event bus are sent to the archive.
archive_retentionDays :: Lens' Archive (Maybe Natural) Source #
The number of days to retain events in the archive before they are deleted.
archive_state :: Lens' Archive (Maybe ArchiveState) Source #
The current state of the archive.
archive_stateReason :: Lens' Archive (Maybe Text) Source #
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.
Constructors
| AwsVpcConfiguration' | |
Fields
| |
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:assignPublicIp:AwsVpcConfiguration', awsVpcConfiguration_assignPublicIp - Specifies whether the task's elastic network interface receives a
public IP address. You can specify ENABLED only when LaunchType in
EcsParameters is set to FARGATE.
$sel:securityGroups:AwsVpcConfiguration', awsVpcConfiguration_securityGroups - Specifies the security groups associated with the task. These security
groups must all be in the same VPC. You can specify as many as five
security groups. If you do not specify a security group, the default
security group for the VPC is used.
$sel:subnets:AwsVpcConfiguration', awsVpcConfiguration_subnets - Specifies the subnets associated with the task. These subnets must all
be in the same VPC. You can specify as many as 16 subnets.
awsVpcConfiguration_assignPublicIp :: Lens' AwsVpcConfiguration (Maybe AssignPublicIp) Source #
Specifies whether the task's elastic network interface receives a
public IP address. You can specify ENABLED only when LaunchType in
EcsParameters is set to FARGATE.
awsVpcConfiguration_securityGroups :: Lens' AwsVpcConfiguration (Maybe [Text]) Source #
Specifies the security groups associated with the task. These security groups must all be in the same VPC. You can specify as many as five security groups. If you do not specify a security group, the default security group for the VPC is used.
awsVpcConfiguration_subnets :: Lens' AwsVpcConfiguration [Text] Source #
Specifies the subnets associated with the task. These subnets must all be in the same VPC. You can specify as many as 16 subnets.
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.
Constructors
| BatchArrayProperties' | |
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.
batchArrayProperties_size :: Lens' BatchArrayProperties (Maybe Int) Source #
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.
Constructors
| BatchParameters' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> BatchParameters |
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: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: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: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.
batchParameters_arrayProperties :: Lens' BatchParameters (Maybe 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.
batchParameters_retryStrategy :: Lens' BatchParameters (Maybe BatchRetryStrategy) Source #
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.
batchParameters_jobDefinition :: Lens' BatchParameters Text Source #
The ARN or name of the job definition to use if the event target is an Batch job. This job definition must already exist.
batchParameters_jobName :: Lens' BatchParameters Text Source #
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.
Constructors
| BatchRetryStrategy' | |
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.
batchRetryStrategy_attempts :: Lens' BatchRetryStrategy (Maybe Int) Source #
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.
Constructors
| CapacityProviderStrategyItem' | |
Fields
| |
Instances
newCapacityProviderStrategyItem Source #
Create a value of CapacityProviderStrategyItem with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:base:CapacityProviderStrategyItem', capacityProviderStrategyItem_base - The base value designates how many tasks, at a minimum, to run on the
specified capacity provider. Only one capacity provider in a capacity
provider strategy can have a base defined. If no value is specified, the
default value of 0 is used.
$sel:weight:CapacityProviderStrategyItem', capacityProviderStrategyItem_weight - The weight value designates the relative percentage of the total number
of tasks launched that should use the specified capacity provider. The
weight value is taken into consideration after the base value, if
defined, is satisfied.
$sel:capacityProvider:CapacityProviderStrategyItem', capacityProviderStrategyItem_capacityProvider - The short name of the capacity provider.
capacityProviderStrategyItem_base :: Lens' CapacityProviderStrategyItem (Maybe Natural) Source #
The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of 0 is used.
capacityProviderStrategyItem_weight :: Lens' CapacityProviderStrategyItem (Maybe Natural) Source #
The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The weight value is taken into consideration after the base value, if defined, is satisfied.
capacityProviderStrategyItem_capacityProvider :: Lens' CapacityProviderStrategyItem Text Source #
The short name of the capacity provider.
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.
Constructors
| Condition' | |
Fields | |
Instances
| ToJSON Condition Source # | |
Defined in Amazonka.CloudWatchEvents.Types.Condition | |
| Generic Condition Source # | |
| Read Condition Source # | |
| Show Condition Source # | |
| NFData Condition Source # | |
Defined in Amazonka.CloudWatchEvents.Types.Condition | |
| Eq Condition Source # | |
| Hashable 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" "amazonka-cloudwatch-events-2.0-GJzRBos1CnlE3BT39axMc5" '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.
condition_type :: Lens' Condition Text Source #
Specifies the type of condition. Currently the only supported value is
StringEquals.
condition_key :: Lens' Condition Text Source #
Specifies the key for the condition. Currently the only supported key is
aws:PrincipalOrgID.
condition_value :: Lens' Condition Text Source #
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.
Constructors
| Connection' | |
Fields
| |
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:authorizationType:Connection', connection_authorizationType - The authorization type specified for the connection.
$sel:connectionArn:Connection', connection_connectionArn - The ARN of the connection.
$sel:connectionState:Connection', connection_connectionState - The state of the connection.
$sel:creationTime:Connection', connection_creationTime - A time stamp for the time that the connection was created.
$sel:lastAuthorizedTime:Connection', connection_lastAuthorizedTime - A time stamp for the time that the connection was last authorized.
$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:stateReason:Connection', connection_stateReason - The reason that the connection is in the connection state.
connection_authorizationType :: Lens' Connection (Maybe ConnectionAuthorizationType) Source #
The authorization type specified for the connection.
connection_connectionArn :: Lens' Connection (Maybe Text) Source #
The ARN of the connection.
connection_connectionState :: Lens' Connection (Maybe ConnectionState) Source #
The state of the connection.
connection_creationTime :: Lens' Connection (Maybe UTCTime) Source #
A time stamp for the time that the connection was created.
connection_lastAuthorizedTime :: Lens' Connection (Maybe UTCTime) Source #
A time stamp for the time that the connection was last authorized.
connection_lastModifiedTime :: Lens' Connection (Maybe UTCTime) Source #
A time stamp for the time that the connection was last modified.
connection_name :: Lens' Connection (Maybe Text) Source #
The name of the connection.
connection_stateReason :: Lens' Connection (Maybe Text) Source #
The reason that the connection is in the connection state.
ConnectionApiKeyAuthResponseParameters
data ConnectionApiKeyAuthResponseParameters Source #
Contains the authorization parameters for the connection if API Key is specified as the authorization type.
See: newConnectionApiKeyAuthResponseParameters smart constructor.
Constructors
| ConnectionApiKeyAuthResponseParameters' | |
Fields
| |
Instances
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.
connectionApiKeyAuthResponseParameters_apiKeyName :: Lens' ConnectionApiKeyAuthResponseParameters (Maybe Text) Source #
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.
Constructors
| ConnectionAuthResponseParameters' | |
Fields
| |
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:apiKeyAuthParameters:ConnectionAuthResponseParameters', connectionAuthResponseParameters_apiKeyAuthParameters - The API Key parameters to use for authorization.
$sel:basicAuthParameters:ConnectionAuthResponseParameters', connectionAuthResponseParameters_basicAuthParameters - The authorization parameters for Basic authorization.
$sel:invocationHttpParameters:ConnectionAuthResponseParameters', connectionAuthResponseParameters_invocationHttpParameters - Additional parameters for the connection that are passed through with
every invocation to the HTTP endpoint.
$sel:oAuthParameters:ConnectionAuthResponseParameters', connectionAuthResponseParameters_oAuthParameters - The OAuth parameters to use for authorization.
connectionAuthResponseParameters_apiKeyAuthParameters :: Lens' ConnectionAuthResponseParameters (Maybe ConnectionApiKeyAuthResponseParameters) Source #
The API Key parameters to use for authorization.
connectionAuthResponseParameters_basicAuthParameters :: Lens' ConnectionAuthResponseParameters (Maybe ConnectionBasicAuthResponseParameters) Source #
The authorization parameters for Basic authorization.
connectionAuthResponseParameters_invocationHttpParameters :: Lens' ConnectionAuthResponseParameters (Maybe ConnectionHttpParameters) Source #
Additional parameters for the connection that are passed through with every invocation to the HTTP endpoint.
connectionAuthResponseParameters_oAuthParameters :: Lens' ConnectionAuthResponseParameters (Maybe ConnectionOAuthResponseParameters) Source #
The OAuth parameters to use for authorization.
ConnectionBasicAuthResponseParameters
data ConnectionBasicAuthResponseParameters Source #
Contains the authorization parameters for the connection if Basic is specified as the authorization type.
See: newConnectionBasicAuthResponseParameters smart constructor.
Constructors
| ConnectionBasicAuthResponseParameters' | |
Instances
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.
connectionBasicAuthResponseParameters_username :: Lens' ConnectionBasicAuthResponseParameters (Maybe Text) Source #
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.
Constructors
| ConnectionBodyParameter' | |
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:key:ConnectionBodyParameter', connectionBodyParameter_key - The key for the parameter.
$sel:value:ConnectionBodyParameter', connectionBodyParameter_value - The value associated with the key.
connectionBodyParameter_isValueSecret :: Lens' ConnectionBodyParameter (Maybe Bool) Source #
Specified whether the value is secret.
connectionBodyParameter_key :: Lens' ConnectionBodyParameter (Maybe Text) Source #
The key for the parameter.
connectionBodyParameter_value :: Lens' ConnectionBodyParameter (Maybe Text) Source #
The value associated with the key.
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.
Constructors
| ConnectionHeaderParameter' | |
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:key:ConnectionHeaderParameter', connectionHeaderParameter_key - The key for the parameter.
$sel:value:ConnectionHeaderParameter', connectionHeaderParameter_value - The value associated with the key.
connectionHeaderParameter_isValueSecret :: Lens' ConnectionHeaderParameter (Maybe Bool) Source #
Specified whether the value is a secret.
connectionHeaderParameter_key :: Lens' ConnectionHeaderParameter (Maybe Text) Source #
The key for the parameter.
connectionHeaderParameter_value :: Lens' ConnectionHeaderParameter (Maybe Text) Source #
The value associated with the key.
ConnectionHttpParameters
data ConnectionHttpParameters Source #
Contains additional parameters for the connection.
See: newConnectionHttpParameters smart constructor.
Constructors
| ConnectionHttpParameters' | |
Fields
| |
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:bodyParameters:ConnectionHttpParameters', connectionHttpParameters_bodyParameters - Contains additional body string parameters for the connection.
$sel:headerParameters:ConnectionHttpParameters', connectionHttpParameters_headerParameters - Contains additional header parameters for the connection.
$sel:queryStringParameters:ConnectionHttpParameters', connectionHttpParameters_queryStringParameters - Contains additional query string parameters for the connection.
connectionHttpParameters_bodyParameters :: Lens' ConnectionHttpParameters (Maybe [ConnectionBodyParameter]) Source #
Contains additional body string parameters for the connection.
connectionHttpParameters_headerParameters :: Lens' ConnectionHttpParameters (Maybe [ConnectionHeaderParameter]) Source #
Contains additional header parameters for the connection.
connectionHttpParameters_queryStringParameters :: Lens' ConnectionHttpParameters (Maybe [ConnectionQueryStringParameter]) Source #
Contains additional query 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.
Constructors
| ConnectionOAuthClientResponseParameters' | |
Instances
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.
connectionOAuthClientResponseParameters_clientID :: Lens' ConnectionOAuthClientResponseParameters (Maybe Text) Source #
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.
Constructors
| ConnectionOAuthResponseParameters' | |
Fields
| |
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:authorizationEndpoint:ConnectionOAuthResponseParameters', connectionOAuthResponseParameters_authorizationEndpoint - The URL to the HTTP endpoint that authorized the request.
$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:httpMethod:ConnectionOAuthResponseParameters', connectionOAuthResponseParameters_httpMethod - The method used to connect to the HTTP endpoint.
$sel:oAuthHttpParameters:ConnectionOAuthResponseParameters', connectionOAuthResponseParameters_oAuthHttpParameters - The additional HTTP parameters used for the OAuth authorization request.
connectionOAuthResponseParameters_authorizationEndpoint :: Lens' ConnectionOAuthResponseParameters (Maybe Text) Source #
The URL to the HTTP endpoint that authorized the request.
connectionOAuthResponseParameters_clientParameters :: Lens' ConnectionOAuthResponseParameters (Maybe ConnectionOAuthClientResponseParameters) Source #
A ConnectionOAuthClientResponseParameters object that contains details
about the client parameters returned when OAuth is specified as the
authorization type.
connectionOAuthResponseParameters_httpMethod :: Lens' ConnectionOAuthResponseParameters (Maybe ConnectionOAuthHttpMethod) Source #
The method used to connect to the HTTP endpoint.
connectionOAuthResponseParameters_oAuthHttpParameters :: Lens' ConnectionOAuthResponseParameters (Maybe ConnectionHttpParameters) Source #
The additional HTTP parameters used for the OAuth authorization 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.
Constructors
| ConnectionQueryStringParameter' | |
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:key:ConnectionQueryStringParameter', connectionQueryStringParameter_key - The key for a query string parameter.
$sel:value:ConnectionQueryStringParameter', connectionQueryStringParameter_value - The value associated with the key for the query string parameter.
connectionQueryStringParameter_isValueSecret :: Lens' ConnectionQueryStringParameter (Maybe Bool) Source #
Specifies whether the value is secret.
connectionQueryStringParameter_key :: Lens' ConnectionQueryStringParameter (Maybe Text) Source #
The key for a query string parameter.
connectionQueryStringParameter_value :: Lens' ConnectionQueryStringParameter (Maybe Text) Source #
The value associated with the key for the query string parameter.
CreateConnectionApiKeyAuthRequestParameters
data CreateConnectionApiKeyAuthRequestParameters Source #
Contains the API key authorization parameters for the connection.
See: newCreateConnectionApiKeyAuthRequestParameters smart constructor.
Constructors
| CreateConnectionApiKeyAuthRequestParameters' | |
Fields
| |
Instances
newCreateConnectionApiKeyAuthRequestParameters Source #
Arguments
| :: 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.
createConnectionApiKeyAuthRequestParameters_apiKeyName :: Lens' CreateConnectionApiKeyAuthRequestParameters Text Source #
The name of the API key to use for authorization.
createConnectionApiKeyAuthRequestParameters_apiKeyValue :: Lens' CreateConnectionApiKeyAuthRequestParameters Text Source #
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.
Constructors
| CreateConnectionAuthRequestParameters' | |
Fields
| |
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: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.
$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:oAuthParameters:CreateConnectionAuthRequestParameters', createConnectionAuthRequestParameters_oAuthParameters - A CreateConnectionOAuthRequestParameters object that contains the
OAuth authorization parameters to use for the connection.
createConnectionAuthRequestParameters_apiKeyAuthParameters :: Lens' CreateConnectionAuthRequestParameters (Maybe CreateConnectionApiKeyAuthRequestParameters) Source #
A CreateConnectionApiKeyAuthRequestParameters object that contains the
API key authorization parameters to use for the connection.
createConnectionAuthRequestParameters_basicAuthParameters :: Lens' CreateConnectionAuthRequestParameters (Maybe CreateConnectionBasicAuthRequestParameters) Source #
A CreateConnectionBasicAuthRequestParameters object that contains the
Basic authorization parameters to use for the connection.
createConnectionAuthRequestParameters_invocationHttpParameters :: Lens' CreateConnectionAuthRequestParameters (Maybe ConnectionHttpParameters) Source #
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.
createConnectionAuthRequestParameters_oAuthParameters :: Lens' CreateConnectionAuthRequestParameters (Maybe CreateConnectionOAuthRequestParameters) Source #
A CreateConnectionOAuthRequestParameters object that contains the
OAuth 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.
Constructors
| CreateConnectionBasicAuthRequestParameters' | |
Instances
newCreateConnectionBasicAuthRequestParameters Source #
Arguments
| :: Text | |
| -> Text | |
| -> CreateConnectionBasicAuthRequestParameters |
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.
createConnectionBasicAuthRequestParameters_username :: Lens' CreateConnectionBasicAuthRequestParameters Text Source #
The user name to use for Basic authorization.
createConnectionBasicAuthRequestParameters_password :: Lens' CreateConnectionBasicAuthRequestParameters Text Source #
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.
Constructors
| CreateConnectionOAuthClientRequestParameters' | |
Fields
| |
Instances
newCreateConnectionOAuthClientRequestParameters Source #
Arguments
| :: 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.
createConnectionOAuthClientRequestParameters_clientID :: Lens' CreateConnectionOAuthClientRequestParameters Text Source #
The client ID to use for OAuth authorization for the connection.
createConnectionOAuthClientRequestParameters_clientSecret :: Lens' CreateConnectionOAuthClientRequestParameters Text Source #
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.
Constructors
| CreateConnectionOAuthRequestParameters' | |
Fields
| |
Instances
newCreateConnectionOAuthRequestParameters Source #
Arguments
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.
createConnectionOAuthRequestParameters_oAuthHttpParameters :: Lens' CreateConnectionOAuthRequestParameters (Maybe ConnectionHttpParameters) Source #
A ConnectionHttpParameters object that contains details about the
additional parameters to use for the connection.
createConnectionOAuthRequestParameters_clientParameters :: Lens' CreateConnectionOAuthRequestParameters CreateConnectionOAuthClientRequestParameters Source #
A CreateConnectionOAuthClientRequestParameters object that contains
the client parameters for OAuth authorization.
createConnectionOAuthRequestParameters_authorizationEndpoint :: Lens' CreateConnectionOAuthRequestParameters Text Source #
The URL to the authorization endpoint when OAuth is specified as the authorization type.
createConnectionOAuthRequestParameters_httpMethod :: Lens' CreateConnectionOAuthRequestParameters ConnectionOAuthHttpMethod Source #
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.
Constructors
| DeadLetterConfig' | |
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.
deadLetterConfig_arn :: Lens' DeadLetterConfig (Maybe Text) Source #
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.
Constructors
| EcsParameters' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> EcsParameters |
Create a value of EcsParameters with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:capacityProviderStrategy:EcsParameters', ecsParameters_capacityProviderStrategy - The capacity provider strategy to use for the task.
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: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:enableExecuteCommand:EcsParameters', ecsParameters_enableExecuteCommand - Whether or not to enable the execute command functionality for the
containers in this task. If true, this enables execute command
functionality on all containers in the task.
$sel:group':EcsParameters', ecsParameters_group - Specifies an ECS task group for the task. The maximum length is 255
characters.
$sel:launchType:EcsParameters', ecsParameters_launchType - Specifies the launch type on which your task is running. The launch type
that you specify here must match one of the launch type
(compatibilities) of the target task. The FARGATE value is supported
only in the Regions where Fargate with Amazon ECS is supported. For more
information, see
Fargate on Amazon ECS
in the Amazon Elastic Container Service Developer Guide.
$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: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: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: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:referenceId:EcsParameters', ecsParameters_referenceId - The reference ID to use for the task.
$sel:tags:EcsParameters', ecsParameters_tags - The metadata that you apply to the task to help you categorize and
organize them. Each tag consists of a key and an optional value, both of
which you define. To learn more, see
RunTask
in the Amazon ECS API Reference.
$sel:taskCount:EcsParameters', ecsParameters_taskCount - The number of tasks to create based on TaskDefinition. The default is
1.
$sel:taskDefinitionArn:EcsParameters', ecsParameters_taskDefinitionArn - The ARN of the task definition to use if the event target is an Amazon
ECS task.
ecsParameters_capacityProviderStrategy :: Lens' EcsParameters (Maybe [CapacityProviderStrategyItem]) Source #
The capacity provider strategy to use for the task.
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.
ecsParameters_enableECSManagedTags :: Lens' EcsParameters (Maybe Bool) Source #
Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.
ecsParameters_enableExecuteCommand :: Lens' EcsParameters (Maybe Bool) Source #
Whether or not to enable the execute command functionality for the containers in this task. If true, this enables execute command functionality on all containers in the task.
ecsParameters_group :: Lens' EcsParameters (Maybe Text) Source #
Specifies an ECS task group for the task. The maximum length is 255 characters.
ecsParameters_launchType :: Lens' EcsParameters (Maybe LaunchType) Source #
Specifies the launch type on which your task is running. The launch type
that you specify here must match one of the launch type
(compatibilities) of the target task. The FARGATE value is supported
only in the Regions where Fargate with Amazon ECS is supported. For more
information, see
Fargate on Amazon ECS
in the Amazon Elastic Container Service Developer Guide.
ecsParameters_networkConfiguration :: Lens' EcsParameters (Maybe NetworkConfiguration) Source #
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.
ecsParameters_placementConstraints :: Lens' EcsParameters (Maybe [PlacementConstraint]) Source #
An array of placement constraint objects to use for the task. You can specify up to 10 constraints per task (including constraints in the task definition and those specified at runtime).
ecsParameters_placementStrategy :: Lens' EcsParameters (Maybe [PlacementStrategy]) Source #
The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.
ecsParameters_platformVersion :: Lens' EcsParameters (Maybe Text) Source #
Specifies the platform version for the task. Specify only the numeric
portion of the platform version, such as 1.1.0.
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.
ecsParameters_propagateTags :: Lens' EcsParameters (Maybe PropagateTags) Source #
Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags are not propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the TagResource API action.
ecsParameters_referenceId :: Lens' EcsParameters (Maybe Text) Source #
The reference ID to use for the task.
ecsParameters_tags :: Lens' EcsParameters (Maybe [Tag]) Source #
The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. To learn more, see RunTask in the Amazon ECS API Reference.
ecsParameters_taskCount :: Lens' EcsParameters (Maybe Natural) Source #
The number of tasks to create based on TaskDefinition. The default is
1.
ecsParameters_taskDefinitionArn :: Lens' EcsParameters Text Source #
The ARN of the task definition to use if the event target is an Amazon ECS task.
Endpoint
An global endpoint used to improve your application's availability by making it regional-fault tolerant. For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide..
See: newEndpoint smart constructor.
Constructors
| Endpoint' | |
Fields
| |
Instances
newEndpoint :: Endpoint Source #
Create a value of Endpoint 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:Endpoint', endpoint_arn - The ARN of the endpoint.
$sel:creationTime:Endpoint', endpoint_creationTime - The time the endpoint was created.
$sel:description:Endpoint', endpoint_description - A description for the endpoint.
$sel:endpointId:Endpoint', endpoint_endpointId - The URL subdomain of the endpoint. For example, if the URL for Endpoint
is abcde.veo.endpoints.event.amazonaws.com, then the EndpointId is
abcde.veo.
$sel:endpointUrl:Endpoint', endpoint_endpointUrl - The URL of the endpoint.
$sel:eventBuses:Endpoint', endpoint_eventBuses - The event buses being used by the endpoint.
$sel:lastModifiedTime:Endpoint', endpoint_lastModifiedTime - The last time the endpoint was modified.
$sel:name:Endpoint', endpoint_name - The name of the endpoint.
$sel:replicationConfig:Endpoint', endpoint_replicationConfig - Whether event replication was enabled or disabled for this endpoint.
$sel:roleArn:Endpoint', endpoint_roleArn - The ARN of the role used by event replication for the endpoint.
$sel:routingConfig:Endpoint', endpoint_routingConfig - The routing configuration of the endpoint.
Endpoint, endpoint_state - The current state of the endpoint.
$sel:stateReason:Endpoint', endpoint_stateReason - The reason the endpoint is in its current state.
endpoint_endpointId :: Lens' Endpoint (Maybe Text) Source #
The URL subdomain of the endpoint. For example, if the URL for Endpoint
is abcde.veo.endpoints.event.amazonaws.com, then the EndpointId is
abcde.veo.
endpoint_eventBuses :: Lens' Endpoint (Maybe (NonEmpty EndpointEventBus)) Source #
The event buses being used by the endpoint.
endpoint_lastModifiedTime :: Lens' Endpoint (Maybe UTCTime) Source #
The last time the endpoint was modified.
endpoint_replicationConfig :: Lens' Endpoint (Maybe ReplicationConfig) Source #
Whether event replication was enabled or disabled for this endpoint.
endpoint_roleArn :: Lens' Endpoint (Maybe Text) Source #
The ARN of the role used by event replication for the endpoint.
endpoint_routingConfig :: Lens' Endpoint (Maybe RoutingConfig) Source #
The routing configuration of the endpoint.
endpoint_state :: Lens' Endpoint (Maybe EndpointState) Source #
The current state of the endpoint.
endpoint_stateReason :: Lens' Endpoint (Maybe Text) Source #
The reason the endpoint is in its current state.
EndpointEventBus
data EndpointEventBus Source #
The event buses the endpoint is associated with.
See: newEndpointEventBus smart constructor.
Constructors
| EndpointEventBus' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> EndpointEventBus |
Create a value of EndpointEventBus 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:EndpointEventBus', endpointEventBus_eventBusArn - The ARN of the event bus the endpoint is associated with.
endpointEventBus_eventBusArn :: Lens' EndpointEventBus Text Source #
The ARN of the event bus the endpoint is associated with.
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.
Constructors
| EventBus' | |
Instances
| FromJSON EventBus Source # | |
| Generic EventBus Source # | |
| Read EventBus Source # | |
| Show EventBus Source # | |
| NFData EventBus Source # | |
Defined in Amazonka.CloudWatchEvents.Types.EventBus | |
| Eq EventBus Source # | |
| Hashable EventBus Source # | |
Defined in Amazonka.CloudWatchEvents.Types.EventBus | |
| type Rep EventBus Source # | |
Defined in Amazonka.CloudWatchEvents.Types.EventBus type Rep EventBus = D1 ('MetaData "EventBus" "Amazonka.CloudWatchEvents.Types.EventBus" "amazonka-cloudwatch-events-2.0-GJzRBos1CnlE3BT39axMc5" '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.
eventBus_policy :: Lens' EventBus (Maybe Text) Source #
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.
Constructors
| EventSource' | |
Fields
| |
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: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:creationTime:EventSource', eventSource_creationTime - The date and time the event source was created.
$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.
$sel:name:EventSource', eventSource_name - The name of the event source.
$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.
eventSource_arn :: Lens' EventSource (Maybe Text) Source #
The ARN of the event source.
eventSource_createdBy :: Lens' EventSource (Maybe Text) Source #
The name of the partner that created the event source.
eventSource_creationTime :: Lens' EventSource (Maybe UTCTime) Source #
The date and time the event source was created.
eventSource_expirationTime :: Lens' EventSource (Maybe UTCTime) Source #
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.
eventSource_name :: Lens' EventSource (Maybe Text) Source #
The name of the event source.
eventSource_state :: Lens' EventSource (Maybe EventSourceState) Source #
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.
FailoverConfig
data FailoverConfig Source #
The failover configuration for an endpoint. This includes what triggers failover and what happens when it's triggered.
See: newFailoverConfig smart constructor.
Constructors
| FailoverConfig' | |
Instances
Arguments
| :: Primary | |
| -> Secondary | |
| -> FailoverConfig |
Create a value of FailoverConfig 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:primary:FailoverConfig', failoverConfig_primary - The main Region of the endpoint.
$sel:secondary:FailoverConfig', failoverConfig_secondary - The Region that events are routed to when failover is triggered or event
replication is enabled.
failoverConfig_primary :: Lens' FailoverConfig Primary Source #
The main Region of the endpoint.
failoverConfig_secondary :: Lens' FailoverConfig Secondary Source #
The Region that events are routed to when failover is triggered or event replication is enabled.
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.
Constructors
| HttpParameters' | |
Fields
| |
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:headerParameters:HttpParameters', httpParameters_headerParameters - The headers that need to be sent as part of request invoking the API
Gateway REST API or EventBridge ApiDestination.
$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.
httpParameters_headerParameters :: Lens' HttpParameters (Maybe (HashMap Text Text)) Source #
The headers that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.
httpParameters_pathParameterValues :: Lens' HttpParameters (Maybe [Text]) Source #
The path parameter values to be used to populate API Gateway REST API or EventBridge ApiDestination path wildcards ("*").
httpParameters_queryStringParameters :: Lens' HttpParameters (Maybe (HashMap Text Text)) Source #
The query string keys/values 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.
Constructors
| InputTransformer' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> InputTransformer |
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>\""}'}
inputTransformer_inputPathsMap :: Lens' InputTransformer (Maybe (HashMap Text Text)) Source #
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."
inputTransformer_inputTemplate :: Lens' InputTransformer Text Source #
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.
Constructors
| KinesisParameters' | |
Fields
| |
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.
kinesisParameters_partitionKeyPath :: Lens' KinesisParameters Text Source #
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.
Constructors
| NetworkConfiguration' | |
Fields
| |
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.
networkConfiguration_awsvpcConfiguration :: Lens' NetworkConfiguration (Maybe AwsVpcConfiguration) Source #
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.
Constructors
| PartnerEventSource' | |
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.
partnerEventSource_arn :: Lens' PartnerEventSource (Maybe Text) Source #
The ARN of the partner event source.
partnerEventSource_name :: Lens' PartnerEventSource (Maybe Text) Source #
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.
Constructors
| PartnerEventSourceAccount' | |
Fields
| |
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:account:PartnerEventSourceAccount', partnerEventSourceAccount_account - The Amazon Web Services account ID that the partner event source was
offered to.
$sel:creationTime:PartnerEventSourceAccount', partnerEventSourceAccount_creationTime - The date and time the event source was created.
$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.
$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.
partnerEventSourceAccount_account :: Lens' PartnerEventSourceAccount (Maybe Text) Source #
The Amazon Web Services account ID that the partner event source was offered to.
partnerEventSourceAccount_creationTime :: Lens' PartnerEventSourceAccount (Maybe UTCTime) Source #
The date and time the event source was created.
partnerEventSourceAccount_expirationTime :: Lens' PartnerEventSourceAccount (Maybe UTCTime) Source #
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.
partnerEventSourceAccount_state :: Lens' PartnerEventSourceAccount (Maybe EventSourceState) Source #
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.
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.
Constructors
| PlacementConstraint' | |
Fields
| |
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.
placementConstraint_expression :: Lens' PlacementConstraint (Maybe Text) Source #
A cluster query language expression to apply to the constraint. You
cannot specify an expression if the constraint type is
distinctInstance. To learn more, see
Cluster Query Language
in the Amazon Elastic Container Service Developer Guide.
placementConstraint_type :: Lens' PlacementConstraint (Maybe PlacementConstraintType) Source #
The type of constraint. Use distinctInstance to ensure that each task in a particular group is running on a different container instance. Use memberOf to restrict the selection to a group of valid candidates.
PlacementStrategy
data PlacementStrategy Source #
The task placement strategy for a task or service. To learn more, see Task Placement Strategies in the Amazon Elastic Container Service Service Developer Guide.
See: newPlacementStrategy smart constructor.
Constructors
| PlacementStrategy' | |
Fields
| |
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).
placementStrategy_field :: Lens' PlacementStrategy (Maybe Text) Source #
The field to apply the placement strategy against. For the spread placement strategy, valid values are instanceId (or 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.
placementStrategy_type :: Lens' PlacementStrategy (Maybe PlacementStrategyType) Source #
The type of placement strategy. The random placement strategy randomly places tasks on available candidates. The spread placement strategy spreads placement across available candidates evenly based on the field parameter. The binpack strategy places tasks on available candidates that have the least available amount of the resource that is specified with the field parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory (but still enough to run the task).
Primary
The primary Region of the endpoint.
See: newPrimary smart constructor.
Constructors
| Primary' | |
Fields
| |
Instances
| FromJSON Primary Source # | |
| ToJSON Primary Source # | |
Defined in Amazonka.CloudWatchEvents.Types.Primary | |
| Generic Primary Source # | |
| Read Primary Source # | |
| Show Primary Source # | |
| NFData Primary Source # | |
Defined in Amazonka.CloudWatchEvents.Types.Primary | |
| Eq Primary Source # | |
| Hashable Primary Source # | |
Defined in Amazonka.CloudWatchEvents.Types.Primary | |
| type Rep Primary Source # | |
Defined in Amazonka.CloudWatchEvents.Types.Primary | |
Create a value of Primary 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:healthCheck:Primary', primary_healthCheck - The ARN of the health check used by the endpoint to determine whether
failover is triggered.
primary_healthCheck :: Lens' Primary Text Source #
The ARN of the health check used by the endpoint to determine whether failover is triggered.
PutEventsRequestEntry
data PutEventsRequestEntry Source #
Represents an event to be submitted.
See: newPutEventsRequestEntry smart constructor.
Constructors
| PutEventsRequestEntry' | |
Fields
| |
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:detail:PutEventsRequestEntry', putEventsRequestEntry_detail - A valid JSON object. There is no other schema imposed. The JSON object
may contain fields and nested subobjects.
$sel:detailType:PutEventsRequestEntry', putEventsRequestEntry_detailType - Free-form string used to decide what fields to expect in the event
detail.
$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.
If you're using a global endpoint with a custom bus, you must enter the
name, not the ARN, of the event bus in either the primary or secondary
Region here and the corresponding event bus in the other Region will be
determined based on the endpoint referenced by the EndpointId.
$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:source:PutEventsRequestEntry', putEventsRequestEntry_source - The source of the event.
$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:traceHeader:PutEventsRequestEntry', putEventsRequestEntry_traceHeader - An X-Ray trace 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.
putEventsRequestEntry_detail :: Lens' PutEventsRequestEntry (Maybe Text) Source #
A valid JSON object. There is no other schema imposed. The JSON object may contain fields and nested subobjects.
putEventsRequestEntry_detailType :: Lens' PutEventsRequestEntry (Maybe Text) Source #
Free-form string used to decide what fields to expect in the event detail.
putEventsRequestEntry_eventBusName :: Lens' PutEventsRequestEntry (Maybe Text) Source #
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.
If you're using a global endpoint with a custom bus, you must enter the
name, not the ARN, of the event bus in either the primary or secondary
Region here and the corresponding event bus in the other Region will be
determined based on the endpoint referenced by the EndpointId.
putEventsRequestEntry_resources :: Lens' PutEventsRequestEntry (Maybe [Text]) Source #
Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily concerns. Any number, including zero, may be present.
putEventsRequestEntry_source :: Lens' PutEventsRequestEntry (Maybe Text) Source #
The source of the event.
putEventsRequestEntry_traceHeader :: Lens' PutEventsRequestEntry (Maybe Text) Source #
An X-Ray trace 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.
PutEventsResultEntry
data PutEventsResultEntry Source #
Represents an event that failed to be submitted. For information about the errors that are common to all actions, see Common Errors.
See: newPutEventsResultEntry smart constructor.
Constructors
| PutEventsResultEntry' | |
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.
putEventsResultEntry_errorCode :: Lens' PutEventsResultEntry (Maybe Text) Source #
The error code that indicates why the event submission failed.
putEventsResultEntry_errorMessage :: Lens' PutEventsResultEntry (Maybe Text) Source #
The error message that explains why the event submission failed.
putEventsResultEntry_eventId :: Lens' PutEventsResultEntry (Maybe Text) Source #
The ID of the event.
PutPartnerEventsRequestEntry
data PutPartnerEventsRequestEntry Source #
The details about an event generated by an SaaS partner.
See: newPutPartnerEventsRequestEntry smart constructor.
Constructors
| PutPartnerEventsRequestEntry' | |
Fields
| |
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:detail:PutPartnerEventsRequestEntry', putPartnerEventsRequestEntry_detail - A valid JSON string. There is no other schema imposed. The JSON string
may contain fields and nested subobjects.
$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:time:PutPartnerEventsRequestEntry', putPartnerEventsRequestEntry_time - The date and time of the event.
putPartnerEventsRequestEntry_detail :: Lens' PutPartnerEventsRequestEntry (Maybe Text) Source #
A valid JSON string. There is no other schema imposed. The JSON string may contain fields and nested subobjects.
putPartnerEventsRequestEntry_detailType :: Lens' PutPartnerEventsRequestEntry (Maybe Text) Source #
A free-form string used to decide what fields to expect in the event detail.
putPartnerEventsRequestEntry_resources :: Lens' PutPartnerEventsRequestEntry (Maybe [Text]) Source #
Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily concerns. Any number, including zero, may be present.
putPartnerEventsRequestEntry_source :: Lens' PutPartnerEventsRequestEntry (Maybe Text) Source #
The event source that is generating the entry.
putPartnerEventsRequestEntry_time :: Lens' PutPartnerEventsRequestEntry (Maybe UTCTime) Source #
The date and time of the event.
PutPartnerEventsResultEntry
data PutPartnerEventsResultEntry Source #
Represents an event that a partner tried to generate, but failed.
See: newPutPartnerEventsResultEntry smart constructor.
Constructors
| PutPartnerEventsResultEntry' | |
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.
putPartnerEventsResultEntry_errorCode :: Lens' PutPartnerEventsResultEntry (Maybe Text) Source #
The error code that indicates why the event submission failed.
putPartnerEventsResultEntry_errorMessage :: Lens' PutPartnerEventsResultEntry (Maybe Text) Source #
The error message that explains why the event submission failed.
putPartnerEventsResultEntry_eventId :: Lens' PutPartnerEventsResultEntry (Maybe Text) Source #
The ID of the event.
PutTargetsResultEntry
data PutTargetsResultEntry Source #
Represents a target that failed to be added to a rule.
See: newPutTargetsResultEntry smart constructor.
Constructors
| PutTargetsResultEntry' | |
Fields
| |
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: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.
$sel:targetId:PutTargetsResultEntry', putTargetsResultEntry_targetId - The ID of the target.
putTargetsResultEntry_errorCode :: Lens' PutTargetsResultEntry (Maybe Text) Source #
The error code that indicates why the target addition failed. If the
value is ConcurrentModificationException, too many requests were made
at the same time.
putTargetsResultEntry_errorMessage :: Lens' PutTargetsResultEntry (Maybe Text) Source #
The error message that explains why the target addition failed.
putTargetsResultEntry_targetId :: Lens' PutTargetsResultEntry (Maybe Text) Source #
The ID of the target.
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.
Constructors
| RedshiftDataParameters' | |
Fields
| |
Instances
newRedshiftDataParameters Source #
Arguments
| :: 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.
redshiftDataParameters_dbUser :: Lens' RedshiftDataParameters (Maybe Text) Source #
The database user name. Required when authenticating using temporary credentials.
redshiftDataParameters_secretManagerArn :: Lens' RedshiftDataParameters (Maybe Text) Source #
The name or ARN of the secret that enables access to the database. Required when authenticating using Amazon Web Services Secrets Manager.
redshiftDataParameters_statementName :: Lens' RedshiftDataParameters (Maybe Text) Source #
The name of the SQL statement. You can name the SQL statement when you create it to identify the query.
redshiftDataParameters_withEvent :: Lens' RedshiftDataParameters (Maybe Bool) Source #
Indicates whether to send an event back to EventBridge after the SQL statement runs.
redshiftDataParameters_database :: Lens' RedshiftDataParameters Text Source #
The name of the database. Required when authenticating using temporary credentials.
redshiftDataParameters_sql :: Lens' RedshiftDataParameters Text Source #
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.
Constructors
| RemoveTargetsResultEntry' | |
Fields
| |
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: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.
$sel:targetId:RemoveTargetsResultEntry', removeTargetsResultEntry_targetId - The ID of the target.
removeTargetsResultEntry_errorCode :: Lens' RemoveTargetsResultEntry (Maybe Text) Source #
The error code that indicates why the target removal failed. If the
value is ConcurrentModificationException, too many requests were made
at the same time.
removeTargetsResultEntry_errorMessage :: Lens' RemoveTargetsResultEntry (Maybe Text) Source #
The error message that explains why the target removal failed.
removeTargetsResultEntry_targetId :: Lens' RemoveTargetsResultEntry (Maybe Text) Source #
The ID of the target.
Replay
A Replay object that contains details about a replay.
See: newReplay smart constructor.
Constructors
| Replay' | |
Fields
| |
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: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:eventLastReplayedTime:Replay', replay_eventLastReplayedTime - A time stamp for the time that the last event was replayed.
$sel:eventSourceArn:Replay', replay_eventSourceArn - The ARN of the archive to replay event from.
$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:replayEndTime:Replay', replay_replayEndTime - A time stamp for the time that the replay completed.
$sel:replayName:Replay', replay_replayName - The name of the replay.
$sel:replayStartTime:Replay', replay_replayStartTime - A time stamp for the time that the replay started.
$sel:state:Replay', replay_state - The current state of the replay.
$sel:stateReason:Replay', replay_stateReason - A description of why the replay is in the current state.
replay_eventEndTime :: Lens' Replay (Maybe UTCTime) Source #
A time stamp for the time to start replaying events. Any event with a
creation time prior to the EventEndTime specified is replayed.
replay_eventLastReplayedTime :: Lens' Replay (Maybe UTCTime) Source #
A time stamp for the time that the last event was replayed.
replay_eventSourceArn :: Lens' Replay (Maybe Text) Source #
The ARN of the archive to replay event from.
replay_eventStartTime :: Lens' Replay (Maybe UTCTime) Source #
A time stamp for the time to start replaying events. This is determined by the time in the event as described in Time.
replay_replayEndTime :: Lens' Replay (Maybe UTCTime) Source #
A time stamp for the time that the replay completed.
replay_replayStartTime :: Lens' Replay (Maybe UTCTime) Source #
A time stamp for the time that the replay started.
replay_state :: Lens' Replay (Maybe ReplayState) Source #
The current state of the replay.
replay_stateReason :: Lens' Replay (Maybe Text) Source #
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.
Constructors
| ReplayDestination' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> ReplayDestination |
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.
replayDestination_filterArns :: Lens' ReplayDestination (Maybe [Text]) Source #
A list of ARNs for rules to replay events to.
replayDestination_arn :: Lens' ReplayDestination Text Source #
The ARN of the event bus to replay event to. You can replay events only to the event bus specified to create the archive.
ReplicationConfig
data ReplicationConfig Source #
Endpoints can replicate all events to the secondary Region.
See: newReplicationConfig smart constructor.
Constructors
| ReplicationConfig' | |
Fields
| |
Instances
newReplicationConfig :: ReplicationConfig Source #
Create a value of ReplicationConfig 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:ReplicationConfig', replicationConfig_state - The state of event replication.
replicationConfig_state :: Lens' ReplicationConfig (Maybe ReplicationState) Source #
The state of event replication.
RetryPolicy
data RetryPolicy Source #
A RetryPolicy object that includes information about the retry policy
settings.
See: newRetryPolicy smart constructor.
Constructors
| RetryPolicy' | |
Fields
| |
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.
retryPolicy_maximumEventAgeInSeconds :: Lens' RetryPolicy (Maybe Natural) Source #
The maximum amount of time, in seconds, to continue to make retry attempts.
retryPolicy_maximumRetryAttempts :: Lens' RetryPolicy (Maybe Natural) Source #
The maximum number of retry attempts to make before the request fails.
Retry attempts continue until either the maximum number of attempts is
made or until the duration of the MaximumEventAgeInSeconds is met.
RoutingConfig
data RoutingConfig Source #
The routing configuration of the endpoint.
See: newRoutingConfig smart constructor.
Constructors
| RoutingConfig' | |
Fields
| |
Instances
Create a value of RoutingConfig 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:failoverConfig:RoutingConfig', routingConfig_failoverConfig - The failover configuration for an endpoint. This includes what triggers
failover and what happens when it's triggered.
routingConfig_failoverConfig :: Lens' RoutingConfig FailoverConfig Source #
The failover configuration for an endpoint. This includes what triggers failover and what happens when it's triggered.
Rule
Contains information about a rule in Amazon EventBridge.
See: newRule smart constructor.
Constructors
| Rule' | |
Fields
| |
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:arn:Rule', rule_arn - The Amazon Resource Name (ARN) of the rule.
$sel:description:Rule', rule_description - The description 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: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: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:name:Rule', rule_name - The name of 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.
$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:state:Rule', rule_state - The state of the rule.
rule_eventBusName :: Lens' Rule (Maybe Text) Source #
The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.
rule_eventPattern :: Lens' Rule (Maybe Text) Source #
The event pattern of the rule. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.
rule_managedBy :: Lens' Rule (Maybe Text) Source #
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.
rule_roleArn :: Lens' Rule (Maybe Text) Source #
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.
rule_scheduleExpression :: Lens' Rule (Maybe Text) Source #
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.
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.
Constructors
| RunCommandParameters' | |
Fields
| |
Instances
newRunCommandParameters Source #
Arguments
| :: NonEmpty RunCommandTarget | |
| -> RunCommandParameters |
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.
runCommandParameters_runCommandTargets :: Lens' RunCommandParameters (NonEmpty RunCommandTarget) Source #
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.
Constructors
| RunCommandTarget' | |
Instances
Arguments
| :: Text | |
| -> NonEmpty Text | |
| -> RunCommandTarget |
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.
runCommandTarget_key :: Lens' RunCommandTarget Text Source #
Can be either tag: tag-key or InstanceIds.
runCommandTarget_values :: Lens' RunCommandTarget (NonEmpty Text) Source #
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.
Constructors
| SageMakerPipelineParameter' | |
Instances
newSageMakerPipelineParameter Source #
Arguments
| :: Text | |
| -> Text | |
| -> SageMakerPipelineParameter |
Create a value of SageMakerPipelineParameter with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:SageMakerPipelineParameter', sageMakerPipelineParameter_name - Name of parameter to start execution of a SageMaker Model Building
Pipeline.
$sel:value:SageMakerPipelineParameter', sageMakerPipelineParameter_value - Value of parameter to start execution of a SageMaker Model Building
Pipeline.
sageMakerPipelineParameter_name :: Lens' SageMakerPipelineParameter Text Source #
Name of parameter to start execution of a SageMaker Model Building Pipeline.
sageMakerPipelineParameter_value :: Lens' SageMakerPipelineParameter Text Source #
Value of parameter to start execution of a SageMaker Model Building Pipeline.
SageMakerPipelineParameters
data SageMakerPipelineParameters Source #
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.
Constructors
| SageMakerPipelineParameters' | |
Fields
| |
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.
sageMakerPipelineParameters_pipelineParameterList :: Lens' SageMakerPipelineParameters (Maybe [SageMakerPipelineParameter]) Source #
List of Parameter names and values for SageMaker Model Building Pipeline execution.
Secondary
The secondary Region that processes events when failover is triggered or replication is enabled.
See: newSecondary smart constructor.
Constructors
| Secondary' | |
Instances
| FromJSON Secondary Source # | |
| ToJSON Secondary Source # | |
Defined in Amazonka.CloudWatchEvents.Types.Secondary | |
| Generic Secondary Source # | |
| Read Secondary Source # | |
| Show Secondary Source # | |
| NFData Secondary Source # | |
Defined in Amazonka.CloudWatchEvents.Types.Secondary | |
| Eq Secondary Source # | |
| Hashable Secondary Source # | |
Defined in Amazonka.CloudWatchEvents.Types.Secondary | |
| type Rep Secondary Source # | |
Defined in Amazonka.CloudWatchEvents.Types.Secondary type Rep Secondary = D1 ('MetaData "Secondary" "Amazonka.CloudWatchEvents.Types.Secondary" "amazonka-cloudwatch-events-2.0-GJzRBos1CnlE3BT39axMc5" 'False) (C1 ('MetaCons "Secondary'" 'PrefixI 'True) (S1 ('MetaSel ('Just "route") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) | |
Create a value of Secondary 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:route:Secondary', secondary_route - Defines the secondary Region.
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.
Constructors
| SqsParameters' | |
Fields
| |
Instances
newSqsParameters :: SqsParameters Source #
Create a value of SqsParameters with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:messageGroupId:SqsParameters', sqsParameters_messageGroupId - The FIFO message group ID to use as the target.
sqsParameters_messageGroupId :: Lens' SqsParameters (Maybe Text) Source #
The FIFO message group ID to use as the target.
Tag
A key-value pair associated with an Amazon Web Services resource. In EventBridge, rules and event buses support tagging.
See: newTag smart constructor.
Constructors
| Tag' | |
Instances
| FromJSON Tag Source # | |
| ToJSON Tag Source # | |
Defined in Amazonka.CloudWatchEvents.Types.Tag | |
| Generic Tag Source # | |
| Read Tag Source # | |
| Show Tag Source # | |
| NFData Tag Source # | |
Defined in Amazonka.CloudWatchEvents.Types.Tag | |
| Eq Tag Source # | |
| Hashable Tag Source # | |
Defined in Amazonka.CloudWatchEvents.Types.Tag | |
| type Rep Tag Source # | |
Defined in Amazonka.CloudWatchEvents.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.CloudWatchEvents.Types.Tag" "amazonka-cloudwatch-events-2.0-GJzRBos1CnlE3BT39axMc5" '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.
tag_key :: Lens' Tag Text Source #
A string you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources.
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.
Constructors
| Target' | |
Fields
| |
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: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:deadLetterConfig:Target', target_deadLetterConfig - The DeadLetterConfig that defines the target queue to send dead-letter
queue events to.
$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: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: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: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: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: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: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:retryPolicy:Target', target_retryPolicy - The RetryPolicy object that contains the retry policy configuration to
use for the dead-letter queue.
$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:runCommandParameters:Target', target_runCommandParameters - Parameters used when you are using the rule to invoke Amazon EC2 Run
Command.
$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:id:Target', target_id - The ID of the target within the specified rule. Use this ID to reference
the target when updating the rule. We recommend using a memorable and
unique string.
Target, target_arn - The Amazon Resource Name (ARN) of the target.
target_batchParameters :: Lens' Target (Maybe BatchParameters) Source #
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.
target_deadLetterConfig :: Lens' Target (Maybe DeadLetterConfig) Source #
The DeadLetterConfig that defines the target queue to send dead-letter
queue events to.
target_ecsParameters :: Lens' Target (Maybe EcsParameters) Source #
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.
target_httpParameters :: Lens' Target (Maybe HttpParameters) Source #
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.
target_input :: Lens' Target (Maybe Text) Source #
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.
target_inputPath :: Lens' Target (Maybe Text) Source #
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.
target_inputTransformer :: Lens' Target (Maybe InputTransformer) Source #
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.
target_kinesisParameters :: Lens' Target (Maybe KinesisParameters) Source #
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.
target_redshiftDataParameters :: Lens' Target (Maybe RedshiftDataParameters) Source #
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.
target_retryPolicy :: Lens' Target (Maybe RetryPolicy) Source #
The RetryPolicy object that contains the retry policy configuration to
use for the dead-letter queue.
target_roleArn :: Lens' Target (Maybe Text) Source #
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.
target_runCommandParameters :: Lens' Target (Maybe RunCommandParameters) Source #
Parameters used when you are using the rule to invoke Amazon EC2 Run Command.
target_sageMakerPipelineParameters :: Lens' Target (Maybe SageMakerPipelineParameters) Source #
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.
target_sqsParameters :: Lens' Target (Maybe SqsParameters) Source #
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.
target_id :: Lens' Target Text Source #
The ID of the target within the specified rule. Use this ID to reference the target when updating the rule. We recommend using a memorable and unique string.
UpdateConnectionApiKeyAuthRequestParameters
data UpdateConnectionApiKeyAuthRequestParameters Source #
Contains the API key authorization parameters to use to update the connection.
See: newUpdateConnectionApiKeyAuthRequestParameters smart constructor.
Constructors
| UpdateConnectionApiKeyAuthRequestParameters' | |
Fields
| |
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:apiKeyName:UpdateConnectionApiKeyAuthRequestParameters', updateConnectionApiKeyAuthRequestParameters_apiKeyName - The name of the API key to use for authorization.
$sel:apiKeyValue:UpdateConnectionApiKeyAuthRequestParameters', updateConnectionApiKeyAuthRequestParameters_apiKeyValue - The value associated with teh API key to use for authorization.
updateConnectionApiKeyAuthRequestParameters_apiKeyName :: Lens' UpdateConnectionApiKeyAuthRequestParameters (Maybe Text) Source #
The name of the API key to use for authorization.
updateConnectionApiKeyAuthRequestParameters_apiKeyValue :: Lens' UpdateConnectionApiKeyAuthRequestParameters (Maybe Text) Source #
The value associated with teh API key to use for authorization.
UpdateConnectionAuthRequestParameters
data UpdateConnectionAuthRequestParameters Source #
Contains the additional parameters to use for the connection.
See: newUpdateConnectionAuthRequestParameters smart constructor.
Constructors
| UpdateConnectionAuthRequestParameters' | |
Fields
| |
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: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.
$sel:invocationHttpParameters:UpdateConnectionAuthRequestParameters', updateConnectionAuthRequestParameters_invocationHttpParameters - A ConnectionHttpParameters object that contains the additional
parameters to use for the connection.
$sel:oAuthParameters:UpdateConnectionAuthRequestParameters', updateConnectionAuthRequestParameters_oAuthParameters - A UpdateConnectionOAuthRequestParameters object that contains the
authorization parameters for OAuth authorization.
updateConnectionAuthRequestParameters_apiKeyAuthParameters :: Lens' UpdateConnectionAuthRequestParameters (Maybe UpdateConnectionApiKeyAuthRequestParameters) Source #
A UpdateConnectionApiKeyAuthRequestParameters object that contains the
authorization parameters for API key authorization.
updateConnectionAuthRequestParameters_basicAuthParameters :: Lens' UpdateConnectionAuthRequestParameters (Maybe UpdateConnectionBasicAuthRequestParameters) Source #
A UpdateConnectionBasicAuthRequestParameters object that contains the
authorization parameters for Basic authorization.
updateConnectionAuthRequestParameters_invocationHttpParameters :: Lens' UpdateConnectionAuthRequestParameters (Maybe ConnectionHttpParameters) Source #
A ConnectionHttpParameters object that contains the additional
parameters to use for the connection.
updateConnectionAuthRequestParameters_oAuthParameters :: Lens' UpdateConnectionAuthRequestParameters (Maybe UpdateConnectionOAuthRequestParameters) Source #
A UpdateConnectionOAuthRequestParameters object that contains the
authorization parameters for OAuth authorization.
UpdateConnectionBasicAuthRequestParameters
data UpdateConnectionBasicAuthRequestParameters Source #
Contains the Basic authorization parameters for the connection.
See: newUpdateConnectionBasicAuthRequestParameters smart constructor.
Constructors
| UpdateConnectionBasicAuthRequestParameters' | |
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:password:UpdateConnectionBasicAuthRequestParameters', updateConnectionBasicAuthRequestParameters_password - The password associated with the user name to use for Basic
authorization.
$sel:username:UpdateConnectionBasicAuthRequestParameters', updateConnectionBasicAuthRequestParameters_username - The user name to use for Basic authorization.
updateConnectionBasicAuthRequestParameters_password :: Lens' UpdateConnectionBasicAuthRequestParameters (Maybe Text) Source #
The password associated with the user name to use for Basic authorization.
updateConnectionBasicAuthRequestParameters_username :: Lens' UpdateConnectionBasicAuthRequestParameters (Maybe Text) Source #
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.
Constructors
| UpdateConnectionOAuthClientRequestParameters' | |
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.
updateConnectionOAuthClientRequestParameters_clientID :: Lens' UpdateConnectionOAuthClientRequestParameters (Maybe Text) Source #
The client ID to use for OAuth authorization.
updateConnectionOAuthClientRequestParameters_clientSecret :: Lens' UpdateConnectionOAuthClientRequestParameters (Maybe Text) Source #
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.
Constructors
| UpdateConnectionOAuthRequestParameters' | |
Fields
| |
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:authorizationEndpoint:UpdateConnectionOAuthRequestParameters', updateConnectionOAuthRequestParameters_authorizationEndpoint - The URL to the authorization endpoint when OAuth is specified as the
authorization type.
$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:httpMethod:UpdateConnectionOAuthRequestParameters', updateConnectionOAuthRequestParameters_httpMethod - The method used to connect to the HTTP endpoint.
$sel:oAuthHttpParameters:UpdateConnectionOAuthRequestParameters', updateConnectionOAuthRequestParameters_oAuthHttpParameters - The additional HTTP parameters used for the OAuth authorization request.
updateConnectionOAuthRequestParameters_authorizationEndpoint :: Lens' UpdateConnectionOAuthRequestParameters (Maybe Text) Source #
The URL to the authorization endpoint when OAuth is specified as the authorization type.
updateConnectionOAuthRequestParameters_clientParameters :: Lens' UpdateConnectionOAuthRequestParameters (Maybe UpdateConnectionOAuthClientRequestParameters) Source #
A UpdateConnectionOAuthClientRequestParameters object that contains
the client parameters to use for the connection when OAuth is specified
as the authorization type.
updateConnectionOAuthRequestParameters_httpMethod :: Lens' UpdateConnectionOAuthRequestParameters (Maybe ConnectionOAuthHttpMethod) Source #
The method used to connect to the HTTP endpoint.
updateConnectionOAuthRequestParameters_oAuthHttpParameters :: Lens' UpdateConnectionOAuthRequestParameters (Maybe ConnectionHttpParameters) Source #
The additional HTTP parameters used for the OAuth authorization request.