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.Lens

Contents

Operations
Types

Description

Synopsis

Operations

ActivateEventSource

activateEventSource_name :: Lens' ActivateEventSource Text Source #

The name of the partner event source to activate.

CancelReplay

cancelReplay_replayName :: Lens' CancelReplay Text Source #

The name of the replay to cancel.

cancelReplayResponse_replayArn :: Lens' CancelReplayResponse (Maybe Text) Source #

The ARN of the replay to cancel.

cancelReplayResponse_state :: Lens' CancelReplayResponse (Maybe ReplayState) Source #

The current state of the replay.

cancelReplayResponse_stateReason :: Lens' CancelReplayResponse (Maybe Text) Source #

The reason that the replay is in the current state.

cancelReplayResponse_httpStatus :: Lens' CancelReplayResponse Int Source #

The response's http status code.

CreateApiDestination

createApiDestination_description :: Lens' CreateApiDestination (Maybe Text) Source #

A description for the API destination to create.

createApiDestination_invocationRateLimitPerSecond :: Lens' CreateApiDestination (Maybe Natural) Source #

The maximum number of requests per second to send to the HTTP invocation endpoint.

createApiDestination_name :: Lens' CreateApiDestination Text Source #

The name for the API destination to create.

createApiDestination_connectionArn :: Lens' CreateApiDestination Text Source #

The ARN of the connection to use for the API destination. The destination endpoint must support the authorization type specified for the connection.

createApiDestination_invocationEndpoint :: Lens' CreateApiDestination Text Source #

The URL to the HTTP invocation endpoint for the API destination.

createApiDestination_httpMethod :: Lens' CreateApiDestination ApiDestinationHttpMethod Source #

The method to use for the request to the HTTP invocation endpoint.

createApiDestinationResponse_apiDestinationArn :: Lens' CreateApiDestinationResponse (Maybe Text) Source #

The ARN of the API destination that was created by the request.

createApiDestinationResponse_apiDestinationState :: Lens' CreateApiDestinationResponse (Maybe ApiDestinationState) Source #

The state of the API destination that was created by the request.

createApiDestinationResponse_creationTime :: Lens' CreateApiDestinationResponse (Maybe UTCTime) Source #

A time stamp indicating the time that the API destination was created.

createApiDestinationResponse_lastModifiedTime :: Lens' CreateApiDestinationResponse (Maybe UTCTime) Source #

A time stamp indicating the time that the API destination was last modified.

createApiDestinationResponse_httpStatus :: Lens' CreateApiDestinationResponse Int Source #

The response's http status code.

CreateArchive

createArchive_description :: Lens' CreateArchive (Maybe Text) Source #

A description for the archive.

createArchive_eventPattern :: Lens' CreateArchive (Maybe Text) Source #

An event pattern to use to filter events sent to the archive.

createArchive_retentionDays :: Lens' CreateArchive (Maybe Natural) Source #

The number of days to retain events for. Default value is 0. If set to 0, events are retained indefinitely

createArchive_archiveName :: Lens' CreateArchive Text Source #

The name for the archive to create.

createArchive_eventSourceArn :: Lens' CreateArchive Text Source #

The ARN of the event bus that sends events to the archive.

createArchiveResponse_archiveArn :: Lens' CreateArchiveResponse (Maybe Text) Source #

The ARN of the archive that was created.

createArchiveResponse_creationTime :: Lens' CreateArchiveResponse (Maybe UTCTime) Source #

The time at which the archive was created.

createArchiveResponse_state :: Lens' CreateArchiveResponse (Maybe ArchiveState) Source #

The state of the archive that was created.

createArchiveResponse_stateReason :: Lens' CreateArchiveResponse (Maybe Text) Source #

The reason that the archive is in the state.

createArchiveResponse_httpStatus :: Lens' CreateArchiveResponse Int Source #

The response's http status code.

CreateConnection

createConnection_description :: Lens' CreateConnection (Maybe Text) Source #

A description for the connection to create.

createConnection_name :: Lens' CreateConnection Text Source #

The name for the connection to create.

createConnection_authorizationType :: Lens' CreateConnection ConnectionAuthorizationType Source #

The type of authorization to use for the connection.

createConnection_authParameters :: Lens' CreateConnection CreateConnectionAuthRequestParameters Source #

A CreateConnectionAuthRequestParameters object that contains the authorization parameters to use to authorize with the endpoint.

createConnectionResponse_connectionArn :: Lens' CreateConnectionResponse (Maybe Text) Source #

The ARN of the connection that was created by the request.

createConnectionResponse_connectionState :: Lens' CreateConnectionResponse (Maybe ConnectionState) Source #

The state of the connection that was created by the request.

createConnectionResponse_creationTime :: Lens' CreateConnectionResponse (Maybe UTCTime) Source #

A time stamp for the time that the connection was created.

createConnectionResponse_lastModifiedTime :: Lens' CreateConnectionResponse (Maybe UTCTime) Source #

A time stamp for the time that the connection was last updated.

createConnectionResponse_httpStatus :: Lens' CreateConnectionResponse Int Source #

The response's http status code.

CreateEndpoint

createEndpoint_description :: Lens' CreateEndpoint (Maybe Text) Source #

A description of the global endpoint.

createEndpoint_replicationConfig :: Lens' CreateEndpoint (Maybe ReplicationConfig) Source #

Enable or disable event replication.

createEndpoint_roleArn :: Lens' CreateEndpoint (Maybe Text) Source #

The ARN of the role used for replication.

createEndpoint_name :: Lens' CreateEndpoint Text Source #

The name of the global endpoint. For example, "Name":"us-east-2-custom_bus_A-endpoint".

createEndpoint_routingConfig :: Lens' CreateEndpoint RoutingConfig Source #

Configure the routing policy, including the health check and secondary Region..

createEndpoint_eventBuses :: Lens' CreateEndpoint (NonEmpty EndpointEventBus) Source #

Define the event buses used.

The names of the event buses must be identical in each Region.

createEndpointResponse_arn :: Lens' CreateEndpointResponse (Maybe Text) Source #

The ARN of the endpoint that was created by this request.

createEndpointResponse_eventBuses :: Lens' CreateEndpointResponse (Maybe (NonEmpty EndpointEventBus)) Source #

The event buses used by this request.

createEndpointResponse_name :: Lens' CreateEndpointResponse (Maybe Text) Source #

The name of the endpoint that was created by this request.

createEndpointResponse_replicationConfig :: Lens' CreateEndpointResponse (Maybe ReplicationConfig) Source #

Whether event replication was enabled or disabled by this request.

createEndpointResponse_roleArn :: Lens' CreateEndpointResponse (Maybe Text) Source #

The ARN of the role used by event replication for this request.

createEndpointResponse_routingConfig :: Lens' CreateEndpointResponse (Maybe RoutingConfig) Source #

The routing configuration defined by this request.

createEndpointResponse_state :: Lens' CreateEndpointResponse (Maybe EndpointState) Source #

The state of the endpoint that was created by this request.

createEndpointResponse_httpStatus :: Lens' CreateEndpointResponse Int Source #

The response's http status code.

CreateEventBus

createEventBus_eventSourceName :: Lens' CreateEventBus (Maybe Text) Source #

If you are creating a partner event bus, this specifies the partner event source that the new event bus will be matched with.

createEventBus_tags :: Lens' CreateEventBus (Maybe [Tag]) Source #

Tags to associate with the event bus.

createEventBus_name :: Lens' CreateEventBus Text Source #

The name of the new event bus.

Event bus names cannot contain the / character. You can't use the name default for a custom event bus, as this name is already used for your account's default event bus.

If this is a partner event bus, the name must exactly match the name of the partner event source that this event bus is matched to.

createEventBusResponse_eventBusArn :: Lens' CreateEventBusResponse (Maybe Text) Source #

The ARN of the new event bus.

createEventBusResponse_httpStatus :: Lens' CreateEventBusResponse Int Source #

The response's http status code.

CreatePartnerEventSource

createPartnerEventSource_name :: Lens' CreatePartnerEventSource Text Source #

The name of the partner event source. This name must be unique and must be in the format partner_name/event_namespace/event_name . The Amazon Web Services account that wants to use this partner event source must create a partner event bus with a name that matches the name of the partner event source.

createPartnerEventSource_account :: Lens' CreatePartnerEventSource Text Source #

The Amazon Web Services account ID that is permitted to create a matching partner event bus for this partner event source.

createPartnerEventSourceResponse_eventSourceArn :: Lens' CreatePartnerEventSourceResponse (Maybe Text) Source #

The ARN of the partner event source.

createPartnerEventSourceResponse_httpStatus :: Lens' CreatePartnerEventSourceResponse Int Source #

The response's http status code.

DeactivateEventSource

deactivateEventSource_name :: Lens' DeactivateEventSource Text Source #

The name of the partner event source to deactivate.

DeauthorizeConnection

deauthorizeConnection_name :: Lens' DeauthorizeConnection Text Source #

The name of the connection to remove authorization from.

deauthorizeConnectionResponse_connectionArn :: Lens' DeauthorizeConnectionResponse (Maybe Text) Source #

The ARN of the connection that authorization was removed from.

deauthorizeConnectionResponse_connectionState :: Lens' DeauthorizeConnectionResponse (Maybe ConnectionState) Source #

The state of the connection.

deauthorizeConnectionResponse_creationTime :: Lens' DeauthorizeConnectionResponse (Maybe UTCTime) Source #

A time stamp for the time that the connection was created.

deauthorizeConnectionResponse_lastAuthorizedTime :: Lens' DeauthorizeConnectionResponse (Maybe UTCTime) Source #

A time stamp for the time that the connection was last authorized.

deauthorizeConnectionResponse_lastModifiedTime :: Lens' DeauthorizeConnectionResponse (Maybe UTCTime) Source #

A time stamp for the time that the connection was last updated.

deauthorizeConnectionResponse_httpStatus :: Lens' DeauthorizeConnectionResponse Int Source #

The response's http status code.

DeleteApiDestination

deleteApiDestination_name :: Lens' DeleteApiDestination Text Source #

The name of the destination to delete.

deleteApiDestinationResponse_httpStatus :: Lens' DeleteApiDestinationResponse Int Source #

The response's http status code.

DeleteArchive

deleteArchive_archiveName :: Lens' DeleteArchive Text Source #

The name of the archive to delete.

deleteArchiveResponse_httpStatus :: Lens' DeleteArchiveResponse Int Source #

The response's http status code.

DeleteConnection

deleteConnection_name :: Lens' DeleteConnection Text Source #

The name of the connection to delete.

deleteConnectionResponse_connectionArn :: Lens' DeleteConnectionResponse (Maybe Text) Source #

The ARN of the connection that was deleted.

deleteConnectionResponse_connectionState :: Lens' DeleteConnectionResponse (Maybe ConnectionState) Source #

The state of the connection before it was deleted.

deleteConnectionResponse_creationTime :: Lens' DeleteConnectionResponse (Maybe UTCTime) Source #

A time stamp for the time that the connection was created.

deleteConnectionResponse_lastAuthorizedTime :: Lens' DeleteConnectionResponse (Maybe UTCTime) Source #

A time stamp for the time that the connection was last authorized before it wa deleted.

deleteConnectionResponse_lastModifiedTime :: Lens' DeleteConnectionResponse (Maybe UTCTime) Source #

A time stamp for the time that the connection was last modified before it was deleted.

deleteConnectionResponse_httpStatus :: Lens' DeleteConnectionResponse Int Source #

The response's http status code.

DeleteEndpoint

deleteEndpoint_name :: Lens' DeleteEndpoint Text Source #

The name of the endpoint you want to delete. For example, "Name":"us-east-2-custom_bus_A-endpoint"..

deleteEndpointResponse_httpStatus :: Lens' DeleteEndpointResponse Int Source #

The response's http status code.

DeleteEventBus

deleteEventBus_name :: Lens' DeleteEventBus Text Source #

The name of the event bus to delete.

DeletePartnerEventSource

deletePartnerEventSource_name :: Lens' DeletePartnerEventSource Text Source #

The name of the event source to delete.

deletePartnerEventSource_account :: Lens' DeletePartnerEventSource Text Source #

The Amazon Web Services account ID of the Amazon Web Services customer that the event source was created for.

DeleteRule

deleteRule_eventBusName :: Lens' DeleteRule (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.

deleteRule_force :: Lens' DeleteRule (Maybe Bool) Source #

If this is a managed rule, created by an Amazon Web Services service on your behalf, you must specify Force as True to delete the rule. This parameter is ignored for rules that are not managed rules. You can check whether a rule is a managed rule by using DescribeRule or ListRules and checking the ManagedBy field of the response.

deleteRule_name :: Lens' DeleteRule Text Source #

The name of the rule.

DescribeApiDestination

describeApiDestination_name :: Lens' DescribeApiDestination Text Source #

The name of the API destination to retrieve.

describeApiDestinationResponse_apiDestinationArn :: Lens' DescribeApiDestinationResponse (Maybe Text) Source #

The ARN of the API destination retrieved.

describeApiDestinationResponse_apiDestinationState :: Lens' DescribeApiDestinationResponse (Maybe ApiDestinationState) Source #

The state of the API destination retrieved.

describeApiDestinationResponse_connectionArn :: Lens' DescribeApiDestinationResponse (Maybe Text) Source #

The ARN of the connection specified for the API destination retrieved.

describeApiDestinationResponse_creationTime :: Lens' DescribeApiDestinationResponse (Maybe UTCTime) Source #

A time stamp for the time that the API destination was created.

describeApiDestinationResponse_description :: Lens' DescribeApiDestinationResponse (Maybe Text) Source #

The description for the API destination retrieved.

describeApiDestinationResponse_httpMethod :: Lens' DescribeApiDestinationResponse (Maybe ApiDestinationHttpMethod) Source #

The method to use to connect to the HTTP endpoint.

describeApiDestinationResponse_invocationEndpoint :: Lens' DescribeApiDestinationResponse (Maybe Text) Source #

The URL to use to connect to the HTTP endpoint.

describeApiDestinationResponse_invocationRateLimitPerSecond :: Lens' DescribeApiDestinationResponse (Maybe Natural) Source #

The maximum number of invocations per second to specified for the API destination. Note that if you set the invocation rate maximum to a value lower the rate necessary to send all events received on to the destination HTTP endpoint, some events may not be delivered within the 24-hour retry window. If you plan to set the rate lower than the rate necessary to deliver all events, consider using a dead-letter queue to catch events that are not delivered within 24 hours.

describeApiDestinationResponse_lastModifiedTime :: Lens' DescribeApiDestinationResponse (Maybe UTCTime) Source #

A time stamp for the time that the API destination was last modified.

describeApiDestinationResponse_name :: Lens' DescribeApiDestinationResponse (Maybe Text) Source #

The name of the API destination retrieved.

describeApiDestinationResponse_httpStatus :: Lens' DescribeApiDestinationResponse Int Source #

The response's http status code.

DescribeArchive

describeArchive_archiveName :: Lens' DescribeArchive Text Source #

The name of the archive to retrieve.

describeArchiveResponse_archiveArn :: Lens' DescribeArchiveResponse (Maybe Text) Source #

The ARN of the archive.

describeArchiveResponse_archiveName :: Lens' DescribeArchiveResponse (Maybe Text) Source #

The name of the archive.

describeArchiveResponse_creationTime :: Lens' DescribeArchiveResponse (Maybe UTCTime) Source #

The time at which the archive was created.

describeArchiveResponse_description :: Lens' DescribeArchiveResponse (Maybe Text) Source #

The description of the archive.

describeArchiveResponse_eventCount :: Lens' DescribeArchiveResponse (Maybe Integer) Source #

The number of events in the archive.

describeArchiveResponse_eventPattern :: Lens' DescribeArchiveResponse (Maybe Text) Source #

The event pattern used to filter events sent to the archive.

describeArchiveResponse_eventSourceArn :: Lens' DescribeArchiveResponse (Maybe Text) Source #

The ARN of the event source associated with the archive.

describeArchiveResponse_retentionDays :: Lens' DescribeArchiveResponse (Maybe Natural) Source #

The number of days to retain events for in the archive.

describeArchiveResponse_sizeBytes :: Lens' DescribeArchiveResponse (Maybe Integer) Source #

The size of the archive in bytes.

describeArchiveResponse_state :: Lens' DescribeArchiveResponse (Maybe ArchiveState) Source #

The state of the archive.

describeArchiveResponse_stateReason :: Lens' DescribeArchiveResponse (Maybe Text) Source #

The reason that the archive is in the state.

describeArchiveResponse_httpStatus :: Lens' DescribeArchiveResponse Int Source #

The response's http status code.

DescribeConnection

describeConnection_name :: Lens' DescribeConnection Text Source #

The name of the connection to retrieve.

describeConnectionResponse_authParameters :: Lens' DescribeConnectionResponse (Maybe ConnectionAuthResponseParameters) Source #

The parameters to use for authorization for the connection.

describeConnectionResponse_authorizationType :: Lens' DescribeConnectionResponse (Maybe ConnectionAuthorizationType) Source #

The type of authorization specified for the connection.

describeConnectionResponse_connectionArn :: Lens' DescribeConnectionResponse (Maybe Text) Source #

The ARN of the connection retrieved.

describeConnectionResponse_connectionState :: Lens' DescribeConnectionResponse (Maybe ConnectionState) Source #

The state of the connection retrieved.

describeConnectionResponse_creationTime :: Lens' DescribeConnectionResponse (Maybe UTCTime) Source #

A time stamp for the time that the connection was created.

describeConnectionResponse_description :: Lens' DescribeConnectionResponse (Maybe Text) Source #

The description for the connection retrieved.

describeConnectionResponse_lastAuthorizedTime :: Lens' DescribeConnectionResponse (Maybe UTCTime) Source #

A time stamp for the time that the connection was last authorized.

describeConnectionResponse_lastModifiedTime :: Lens' DescribeConnectionResponse (Maybe UTCTime) Source #

A time stamp for the time that the connection was last modified.

describeConnectionResponse_name :: Lens' DescribeConnectionResponse (Maybe Text) Source #

The name of the connection retrieved.

describeConnectionResponse_secretArn :: Lens' DescribeConnectionResponse (Maybe Text) Source #

The ARN of the secret created from the authorization parameters specified for the connection.

describeConnectionResponse_stateReason :: Lens' DescribeConnectionResponse (Maybe Text) Source #

The reason that the connection is in the current connection state.

describeConnectionResponse_httpStatus :: Lens' DescribeConnectionResponse Int Source #

The response's http status code.

DescribeEndpoint

describeEndpoint_homeRegion :: Lens' DescribeEndpoint (Maybe Text) Source #

The primary Region of the endpoint you want to get information about. For example "HomeRegion": "us-east-1".

describeEndpoint_name :: Lens' DescribeEndpoint Text Source #

The name of the endpoint you want to get information about. For example, "Name":"us-east-2-custom_bus_A-endpoint".

describeEndpointResponse_arn :: Lens' DescribeEndpointResponse (Maybe Text) Source #

The ARN of the endpoint you asked for information about.

describeEndpointResponse_creationTime :: Lens' DescribeEndpointResponse (Maybe UTCTime) Source #

The time the endpoint you asked for information about was created.

describeEndpointResponse_description :: Lens' DescribeEndpointResponse (Maybe Text) Source #

The description of the endpoint you asked for information about.

describeEndpointResponse_endpointId :: Lens' DescribeEndpointResponse (Maybe Text) Source #

The ID of the endpoint you asked for information about.

describeEndpointResponse_endpointUrl :: Lens' DescribeEndpointResponse (Maybe Text) Source #

The URL of the endpoint you asked for information about.

describeEndpointResponse_eventBuses :: Lens' DescribeEndpointResponse (Maybe (NonEmpty EndpointEventBus)) Source #

The event buses being used by the endpoint you asked for information about.

describeEndpointResponse_lastModifiedTime :: Lens' DescribeEndpointResponse (Maybe UTCTime) Source #

The last time the endpoint you asked for information about was modified.

describeEndpointResponse_name :: Lens' DescribeEndpointResponse (Maybe Text) Source #

The name of the endpoint you asked for information about.

describeEndpointResponse_replicationConfig :: Lens' DescribeEndpointResponse (Maybe ReplicationConfig) Source #

Whether replication is enabled or disabled for the endpoint you asked for information about.

describeEndpointResponse_roleArn :: Lens' DescribeEndpointResponse (Maybe Text) Source #

The ARN of the role used by the endpoint you asked for information about.

describeEndpointResponse_routingConfig :: Lens' DescribeEndpointResponse (Maybe RoutingConfig) Source #

The routing configuration of the endpoint you asked for information about.

describeEndpointResponse_state :: Lens' DescribeEndpointResponse (Maybe EndpointState) Source #

The current state of the endpoint you asked for information about.

describeEndpointResponse_stateReason :: Lens' DescribeEndpointResponse (Maybe Text) Source #

The reason the endpoint you asked for information about is in its current state.

describeEndpointResponse_httpStatus :: Lens' DescribeEndpointResponse Int Source #

The response's http status code.

DescribeEventBus

describeEventBus_name :: Lens' DescribeEventBus (Maybe Text) Source #

The name or ARN of the event bus to show details for. If you omit this, the default event bus is displayed.

describeEventBusResponse_arn :: Lens' DescribeEventBusResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the account permitted to write events to the current account.

describeEventBusResponse_name :: Lens' DescribeEventBusResponse (Maybe Text) Source #

The name of the event bus. Currently, this is always default.

describeEventBusResponse_policy :: Lens' DescribeEventBusResponse (Maybe Text) Source #

The policy that enables the external account to send events to your account.

describeEventBusResponse_httpStatus :: Lens' DescribeEventBusResponse Int Source #

The response's http status code.

DescribeEventSource

describeEventSource_name :: Lens' DescribeEventSource Text Source #

The name of the partner event source to display the details of.

describeEventSourceResponse_arn :: Lens' DescribeEventSourceResponse (Maybe Text) Source #

The ARN of the partner event source.

describeEventSourceResponse_createdBy :: Lens' DescribeEventSourceResponse (Maybe Text) Source #

The name of the SaaS partner that created the event source.

describeEventSourceResponse_creationTime :: Lens' DescribeEventSourceResponse (Maybe UTCTime) Source #

The date and time that the event source was created.

describeEventSourceResponse_expirationTime :: Lens' DescribeEventSourceResponse (Maybe UTCTime) Source #

The date and time that the event source will expire if you do not create a matching event bus.

describeEventSourceResponse_name :: Lens' DescribeEventSourceResponse (Maybe Text) Source #

The name of the partner event source.

describeEventSourceResponse_state :: Lens' DescribeEventSourceResponse (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.

describeEventSourceResponse_httpStatus :: Lens' DescribeEventSourceResponse Int Source #

The response's http status code.

DescribePartnerEventSource

describePartnerEventSource_name :: Lens' DescribePartnerEventSource Text Source #

The name of the event source to display.

describePartnerEventSourceResponse_arn :: Lens' DescribePartnerEventSourceResponse (Maybe Text) Source #

The ARN of the event source.

describePartnerEventSourceResponse_name :: Lens' DescribePartnerEventSourceResponse (Maybe Text) Source #

The name of the event source.

describePartnerEventSourceResponse_httpStatus :: Lens' DescribePartnerEventSourceResponse Int Source #

The response's http status code.

DescribeReplay

describeReplay_replayName :: Lens' DescribeReplay Text Source #

The name of the replay to retrieve.

describeReplayResponse_description :: Lens' DescribeReplayResponse (Maybe Text) Source #

The description of the replay.

describeReplayResponse_destination :: Lens' DescribeReplayResponse (Maybe ReplayDestination) Source #

A ReplayDestination object that contains details about the replay.

describeReplayResponse_eventEndTime :: Lens' DescribeReplayResponse (Maybe UTCTime) Source #

The time stamp for the last event that was replayed from the archive.

describeReplayResponse_eventLastReplayedTime :: Lens' DescribeReplayResponse (Maybe UTCTime) Source #

The time that the event was last replayed.

describeReplayResponse_eventSourceArn :: Lens' DescribeReplayResponse (Maybe Text) Source #

The ARN of the archive events were replayed from.

describeReplayResponse_eventStartTime :: Lens' DescribeReplayResponse (Maybe UTCTime) Source #

The time stamp of the first event that was last replayed from the archive.

describeReplayResponse_replayArn :: Lens' DescribeReplayResponse (Maybe Text) Source #

The ARN of the replay.

describeReplayResponse_replayEndTime :: Lens' DescribeReplayResponse (Maybe UTCTime) Source #

A time stamp for the time that the replay stopped.

describeReplayResponse_replayName :: Lens' DescribeReplayResponse (Maybe Text) Source #

The name of the replay.

describeReplayResponse_replayStartTime :: Lens' DescribeReplayResponse (Maybe UTCTime) Source #

A time stamp for the time that the replay started.

describeReplayResponse_state :: Lens' DescribeReplayResponse (Maybe ReplayState) Source #

The current state of the replay.

describeReplayResponse_stateReason :: Lens' DescribeReplayResponse (Maybe Text) Source #

The reason that the replay is in the current state.

describeReplayResponse_httpStatus :: Lens' DescribeReplayResponse Int Source #

The response's http status code.

DescribeRule

describeRule_eventBusName :: Lens' DescribeRule (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.

describeRule_name :: Lens' DescribeRule Text Source #

The name of the rule.

describeRuleResponse_arn :: Lens' DescribeRuleResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the rule.

describeRuleResponse_createdBy :: Lens' DescribeRuleResponse (Maybe Text) Source #

The account ID of the user that created the rule. If you use PutRule to put a rule on an event bus in another account, the other account is the owner of the rule, and the rule ARN includes the account ID for that account. However, the value for CreatedBy is the account ID as the account that created the rule in the other account.

describeRuleResponse_description :: Lens' DescribeRuleResponse (Maybe Text) Source #

The description of the rule.

describeRuleResponse_eventBusName :: Lens' DescribeRuleResponse (Maybe Text) Source #

The name of the event bus associated with the rule.

describeRuleResponse_eventPattern :: Lens' DescribeRuleResponse (Maybe Text) Source #

The event pattern. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.

describeRuleResponse_managedBy :: Lens' DescribeRuleResponse (Maybe Text) Source #

If this is a managed rule, created by an Amazon Web Services service on your behalf, this field displays the principal name of the Amazon Web Services service that created the rule.

describeRuleResponse_name :: Lens' DescribeRuleResponse (Maybe Text) Source #

The name of the rule.

describeRuleResponse_roleArn :: Lens' DescribeRuleResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the IAM role associated with the rule.

describeRuleResponse_scheduleExpression :: Lens' DescribeRuleResponse (Maybe Text) Source #

The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)".

describeRuleResponse_state :: Lens' DescribeRuleResponse (Maybe RuleState) Source #

Specifies whether the rule is enabled or disabled.

describeRuleResponse_httpStatus :: Lens' DescribeRuleResponse Int Source #

The response's http status code.

DisableRule

disableRule_eventBusName :: Lens' DisableRule (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.

disableRule_name :: Lens' DisableRule Text Source #

The name of the rule.

EnableRule

enableRule_eventBusName :: Lens' EnableRule (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.

enableRule_name :: Lens' EnableRule Text Source #

The name of the rule.

ListApiDestinations

listApiDestinations_connectionArn :: Lens' ListApiDestinations (Maybe Text) Source #

The ARN of the connection specified for the API destination.

listApiDestinations_limit :: Lens' ListApiDestinations (Maybe Natural) Source #

The maximum number of API destinations to include in the response.

listApiDestinations_namePrefix :: Lens' ListApiDestinations (Maybe Text) Source #

A name prefix to filter results returned. Only API destinations with a name that starts with the prefix are returned.

listApiDestinations_nextToken :: Lens' ListApiDestinations (Maybe Text) Source #

The token returned by a previous call to retrieve the next set of results.

listApiDestinationsResponse_apiDestinations :: Lens' ListApiDestinationsResponse (Maybe [ApiDestination]) Source #

An array of ApiDestination objects that include information about an API destination.

listApiDestinationsResponse_nextToken :: Lens' ListApiDestinationsResponse (Maybe Text) Source #

A token you can use in a subsequent request to retrieve the next set of results.

listApiDestinationsResponse_httpStatus :: Lens' ListApiDestinationsResponse Int Source #

The response's http status code.

ListArchives

listArchives_eventSourceArn :: Lens' ListArchives (Maybe Text) Source #

The ARN of the event source associated with the archive.

listArchives_limit :: Lens' ListArchives (Maybe Natural) Source #

The maximum number of results to return.

listArchives_namePrefix :: Lens' ListArchives (Maybe Text) Source #

A name prefix to filter the archives returned. Only archives with name that match the prefix are returned.

listArchives_nextToken :: Lens' ListArchives (Maybe Text) Source #

The token returned by a previous call to retrieve the next set of results.

listArchives_state :: Lens' ListArchives (Maybe ArchiveState) Source #

The state of the archive.

listArchivesResponse_archives :: Lens' ListArchivesResponse (Maybe [Archive]) Source #

An array of Archive objects that include details about an archive.

listArchivesResponse_nextToken :: Lens' ListArchivesResponse (Maybe Text) Source #

The token returned by a previous call to retrieve the next set of results.

listArchivesResponse_httpStatus :: Lens' ListArchivesResponse Int Source #

The response's http status code.

ListConnections

listConnections_connectionState :: Lens' ListConnections (Maybe ConnectionState) Source #

The state of the connection.

listConnections_limit :: Lens' ListConnections (Maybe Natural) Source #

The maximum number of connections to return.

listConnections_namePrefix :: Lens' ListConnections (Maybe Text) Source #

A name prefix to filter results returned. Only connections with a name that starts with the prefix are returned.

listConnections_nextToken :: Lens' ListConnections (Maybe Text) Source #

The token returned by a previous call to retrieve the next set of results.

listConnectionsResponse_connections :: Lens' ListConnectionsResponse (Maybe [Connection]) Source #

An array of connections objects that include details about the connections.

listConnectionsResponse_nextToken :: Lens' ListConnectionsResponse (Maybe Text) Source #

A token you can use in a subsequent request to retrieve the next set of results.

listConnectionsResponse_httpStatus :: Lens' ListConnectionsResponse Int Source #

The response's http status code.

ListEndpoints

listEndpoints_homeRegion :: Lens' ListEndpoints (Maybe Text) Source #

The primary Region of the endpoints associated with this account. For example "HomeRegion": "us-east-1".

listEndpoints_maxResults :: Lens' ListEndpoints (Maybe Natural) Source #

The maximum number of results returned by the call.

listEndpoints_namePrefix :: Lens' ListEndpoints (Maybe Text) Source #

A value that will return a subset of the endpoints associated with this account. For example, "NamePrefix": "ABC" will return all endpoints with "ABC" in the name.

listEndpoints_nextToken :: Lens' ListEndpoints (Maybe Text) Source #

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

listEndpointsResponse_endpoints :: Lens' ListEndpointsResponse (Maybe [Endpoint]) Source #

The endpoints returned by the call.

listEndpointsResponse_nextToken :: Lens' ListEndpointsResponse (Maybe Text) Source #

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

listEndpointsResponse_httpStatus :: Lens' ListEndpointsResponse Int Source #

The response's http status code.

ListEventBuses

listEventBuses_limit :: Lens' ListEventBuses (Maybe Natural) Source #

Specifying this limits the number of results returned by this operation. The operation also returns a NextToken which you can use in a subsequent operation to retrieve the next set of results.

listEventBuses_namePrefix :: Lens' ListEventBuses (Maybe Text) Source #

Specifying this limits the results to only those event buses with names that start with the specified prefix.

listEventBuses_nextToken :: Lens' ListEventBuses (Maybe Text) Source #

The token returned by a previous call to retrieve the next set of results.

listEventBusesResponse_eventBuses :: Lens' ListEventBusesResponse (Maybe [EventBus]) Source #

This list of event buses.

listEventBusesResponse_nextToken :: Lens' ListEventBusesResponse (Maybe Text) Source #

A token you can use in a subsequent operation to retrieve the next set of results.

listEventBusesResponse_httpStatus :: Lens' ListEventBusesResponse Int Source #

The response's http status code.

ListEventSources

listEventSources_limit :: Lens' ListEventSources (Maybe Natural) Source #

Specifying this limits the number of results returned by this operation. The operation also returns a NextToken which you can use in a subsequent operation to retrieve the next set of results.

listEventSources_namePrefix :: Lens' ListEventSources (Maybe Text) Source #

Specifying this limits the results to only those partner event sources with names that start with the specified prefix.

listEventSources_nextToken :: Lens' ListEventSources (Maybe Text) Source #

The token returned by a previous call to retrieve the next set of results.

listEventSourcesResponse_eventSources :: Lens' ListEventSourcesResponse (Maybe [EventSource]) Source #

The list of event sources.

listEventSourcesResponse_nextToken :: Lens' ListEventSourcesResponse (Maybe Text) Source #

A token you can use in a subsequent operation to retrieve the next set of results.

listEventSourcesResponse_httpStatus :: Lens' ListEventSourcesResponse Int Source #

The response's http status code.

ListPartnerEventSourceAccounts

listPartnerEventSourceAccounts_limit :: Lens' ListPartnerEventSourceAccounts (Maybe Natural) Source #

Specifying this limits the number of results returned by this operation. The operation also returns a NextToken which you can use in a subsequent operation to retrieve the next set of results.

listPartnerEventSourceAccounts_nextToken :: Lens' ListPartnerEventSourceAccounts (Maybe Text) Source #

The token returned by a previous call to this operation. Specifying this retrieves the next set of results.

listPartnerEventSourceAccounts_eventSourceName :: Lens' ListPartnerEventSourceAccounts Text Source #

The name of the partner event source to display account information about.

listPartnerEventSourceAccountsResponse_nextToken :: Lens' ListPartnerEventSourceAccountsResponse (Maybe Text) Source #

A token you can use in a subsequent operation to retrieve the next set of results.

listPartnerEventSourceAccountsResponse_partnerEventSourceAccounts :: Lens' ListPartnerEventSourceAccountsResponse (Maybe [PartnerEventSourceAccount]) Source #

The list of partner event sources returned by the operation.

listPartnerEventSourceAccountsResponse_httpStatus :: Lens' ListPartnerEventSourceAccountsResponse Int Source #

The response's http status code.

ListPartnerEventSources

listPartnerEventSources_limit :: Lens' ListPartnerEventSources (Maybe Natural) Source #

pecifying this limits the number of results returned by this operation. The operation also returns a NextToken which you can use in a subsequent operation to retrieve the next set of results.

listPartnerEventSources_nextToken :: Lens' ListPartnerEventSources (Maybe Text) Source #

The token returned by a previous call to this operation. Specifying this retrieves the next set of results.

listPartnerEventSources_namePrefix :: Lens' ListPartnerEventSources Text Source #

If you specify this, the results are limited to only those partner event sources that start with the string you specify.

listPartnerEventSourcesResponse_nextToken :: Lens' ListPartnerEventSourcesResponse (Maybe Text) Source #

A token you can use in a subsequent operation to retrieve the next set of results.

listPartnerEventSourcesResponse_partnerEventSources :: Lens' ListPartnerEventSourcesResponse (Maybe [PartnerEventSource]) Source #

The list of partner event sources returned by the operation.

listPartnerEventSourcesResponse_httpStatus :: Lens' ListPartnerEventSourcesResponse Int Source #

The response's http status code.

ListReplays

listReplays_eventSourceArn :: Lens' ListReplays (Maybe Text) Source #

The ARN of the archive from which the events are replayed.

listReplays_limit :: Lens' ListReplays (Maybe Natural) Source #

The maximum number of replays to retrieve.

listReplays_namePrefix :: Lens' ListReplays (Maybe Text) Source #

A name prefix to filter the replays returned. Only replays with name that match the prefix are returned.

listReplays_nextToken :: Lens' ListReplays (Maybe Text) Source #

The token returned by a previous call to retrieve the next set of results.

listReplays_state :: Lens' ListReplays (Maybe ReplayState) Source #

The state of the replay.

listReplaysResponse_nextToken :: Lens' ListReplaysResponse (Maybe Text) Source #

The token returned by a previous call to retrieve the next set of results.

listReplaysResponse_replays :: Lens' ListReplaysResponse (Maybe [Replay]) Source #

An array of Replay objects that contain information about the replay.

listReplaysResponse_httpStatus :: Lens' ListReplaysResponse Int Source #

The response's http status code.

ListRuleNamesByTarget

listRuleNamesByTarget_eventBusName :: Lens' ListRuleNamesByTarget (Maybe Text) Source #

The name or ARN of the event bus to list rules for. If you omit this, the default event bus is used.

listRuleNamesByTarget_limit :: Lens' ListRuleNamesByTarget (Maybe Natural) Source #

The maximum number of results to return.

listRuleNamesByTarget_nextToken :: Lens' ListRuleNamesByTarget (Maybe Text) Source #

The token returned by a previous call to retrieve the next set of results.

listRuleNamesByTarget_targetArn :: Lens' ListRuleNamesByTarget Text Source #

The Amazon Resource Name (ARN) of the target resource.

listRuleNamesByTargetResponse_nextToken :: Lens' ListRuleNamesByTargetResponse (Maybe Text) Source #

Indicates whether there are additional results to retrieve. If there are no more results, the value is null.

listRuleNamesByTargetResponse_ruleNames :: Lens' ListRuleNamesByTargetResponse (Maybe [Text]) Source #

The names of the rules that can invoke the given target.

listRuleNamesByTargetResponse_httpStatus :: Lens' ListRuleNamesByTargetResponse Int Source #

The response's http status code.

ListRules

listRules_eventBusName :: Lens' ListRules (Maybe Text) Source #

The name or ARN of the event bus to list the rules for. If you omit this, the default event bus is used.

listRules_limit :: Lens' ListRules (Maybe Natural) Source #

The maximum number of results to return.

listRules_namePrefix :: Lens' ListRules (Maybe Text) Source #

The prefix matching the rule name.

listRules_nextToken :: Lens' ListRules (Maybe Text) Source #

The token returned by a previous call to retrieve the next set of results.

listRulesResponse_nextToken :: Lens' ListRulesResponse (Maybe Text) Source #

Indicates whether there are additional results to retrieve. If there are no more results, the value is null.

listRulesResponse_rules :: Lens' ListRulesResponse (Maybe [Rule]) Source #

The rules that match the specified criteria.

listRulesResponse_httpStatus :: Lens' ListRulesResponse Int Source #

The response's http status code.

ListTagsForResource

listTagsForResource_resourceARN :: Lens' ListTagsForResource Text Source #

The ARN of the EventBridge resource for which you want to view tags.

listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe [Tag]) Source #

The list of tag keys and values associated with the resource you specified

listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int Source #

The response's http status code.

ListTargetsByRule

listTargetsByRule_eventBusName :: Lens' ListTargetsByRule (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.

listTargetsByRule_limit :: Lens' ListTargetsByRule (Maybe Natural) Source #

The maximum number of results to return.

listTargetsByRule_nextToken :: Lens' ListTargetsByRule (Maybe Text) Source #

The token returned by a previous call to retrieve the next set of results.

listTargetsByRule_rule :: Lens' ListTargetsByRule Text Source #

The name of the rule.

listTargetsByRuleResponse_nextToken :: Lens' ListTargetsByRuleResponse (Maybe Text) Source #

Indicates whether there are additional results to retrieve. If there are no more results, the value is null.

listTargetsByRuleResponse_targets :: Lens' ListTargetsByRuleResponse (Maybe (NonEmpty Target)) Source #

The targets assigned to the rule.

listTargetsByRuleResponse_httpStatus :: Lens' ListTargetsByRuleResponse Int Source #

The response's http status code.

PutEvents

putEvents_endpointId :: Lens' PutEvents (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.

When using Java, you must include auth-crt on the class path.

putEvents_entries :: Lens' PutEvents (NonEmpty PutEventsRequestEntry) Source #

The entry that defines an event in your system. You can specify several parameters for the entry such as the source and type of the event, resources associated with the event, and so on.

putEventsResponse_entries :: Lens' PutEventsResponse (Maybe [PutEventsResultEntry]) Source #

The successfully and unsuccessfully ingested events results. If the ingestion was successful, the entry has the event ID in it. Otherwise, you can use the error code and error message to identify the problem with the entry.

putEventsResponse_failedEntryCount :: Lens' PutEventsResponse (Maybe Int) Source #

The number of failed entries.

putEventsResponse_httpStatus :: Lens' PutEventsResponse Int Source #

The response's http status code.

PutPartnerEvents

putPartnerEvents_entries :: Lens' PutPartnerEvents (NonEmpty PutPartnerEventsRequestEntry) Source #

The list of events to write to the event bus.

putPartnerEventsResponse_entries :: Lens' PutPartnerEventsResponse (Maybe [PutPartnerEventsResultEntry]) Source #

The list of events from this operation that were successfully written to the partner event bus.

putPartnerEventsResponse_failedEntryCount :: Lens' PutPartnerEventsResponse (Maybe Int) Source #

The number of events from this operation that could not be written to the partner event bus.

putPartnerEventsResponse_httpStatus :: Lens' PutPartnerEventsResponse Int Source #

The response's http status code.

PutPermission

putPermission_action :: Lens' PutPermission (Maybe Text) Source #

The action that you are enabling the other account to perform.

putPermission_condition :: Lens' PutPermission (Maybe Condition) Source #

This parameter enables you to limit the permission to accounts that fulfill a certain condition, such as being a member of a certain Amazon Web Services organization. For more information about Amazon Web Services Organizations, see What Is Amazon Web Services Organizations in the Amazon Web Services Organizations User Guide.

If you specify Condition with an Amazon Web Services organization ID, and specify "*" as the value for Principal, you grant permission to all the accounts in the named organization.

The Condition is a JSON string which must contain Type, Key, and Value fields.

putPermission_eventBusName :: Lens' PutPermission (Maybe Text) Source #

The name of the event bus associated with the rule. If you omit this, the default event bus is used.

putPermission_policy :: Lens' PutPermission (Maybe Text) Source #

A JSON string that describes the permission policy statement. You can include a Policy parameter in the request instead of using the StatementId, Action, Principal, or Condition parameters.

putPermission_principal :: Lens' PutPermission (Maybe Text) Source #

The 12-digit Amazon Web Services account ID that you are permitting to put events to your default event bus. Specify "*" to permit any account to put events to your default event bus.

If you specify "*" without specifying Condition, avoid creating rules that may match undesirable events. To create more secure rules, make sure that the event pattern for each rule contains an account field with a specific account ID from which to receive events. Rules with an account field do not match any events sent from other accounts.

putPermission_statementId :: Lens' PutPermission (Maybe Text) Source #

An identifier string for the external account that you are granting permissions to. If you later want to revoke the permission for this external account, specify this StatementId when you run RemovePermission.

Each StatementId must be unique.

PutRule

putRule_description :: Lens' PutRule (Maybe Text) Source #

A description of the rule.

putRule_eventBusName :: Lens' PutRule (Maybe Text) Source #

The name or ARN of the event bus to associate with this rule. If you omit this, the default event bus is used.

putRule_eventPattern :: Lens' PutRule (Maybe Text) Source #

The event pattern. For more information, see EventBridge event patterns in the Amazon EventBridge User Guide.

putRule_roleArn :: Lens' PutRule (Maybe Text) Source #

The Amazon Resource Name (ARN) of the IAM role associated with the rule.

If you're setting an event bus in another account as the target and that account granted permission to your account through an organization instead of directly by the account ID, you must specify a RoleArn with proper permissions in the Target structure, instead of here in this parameter.

putRule_scheduleExpression :: Lens' PutRule (Maybe Text) Source #

The scheduling expression. For example, "cron(0 20 * * ? *)" or "rate(5 minutes)".

putRule_state :: Lens' PutRule (Maybe RuleState) Source #

Indicates whether the rule is enabled or disabled.

putRule_tags :: Lens' PutRule (Maybe [Tag]) Source #

The list of key-value pairs to associate with the rule.

putRule_name :: Lens' PutRule Text Source #

The name of the rule that you are creating or updating.

putRuleResponse_ruleArn :: Lens' PutRuleResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the rule.

putRuleResponse_httpStatus :: Lens' PutRuleResponse Int Source #

The response's http status code.

PutTargets

putTargets_eventBusName :: Lens' PutTargets (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.

putTargets_rule :: Lens' PutTargets Text Source #

The name of the rule.

putTargets_targets :: Lens' PutTargets (NonEmpty Target) Source #

The targets to update or add to the rule.

putTargetsResponse_failedEntries :: Lens' PutTargetsResponse (Maybe [PutTargetsResultEntry]) Source #

The failed target entries.

putTargetsResponse_failedEntryCount :: Lens' PutTargetsResponse (Maybe Int) Source #

The number of failed entries.

putTargetsResponse_httpStatus :: Lens' PutTargetsResponse Int Source #

The response's http status code.

RemovePermission

removePermission_eventBusName :: Lens' RemovePermission (Maybe Text) Source #

The name of the event bus to revoke permissions for. If you omit this, the default event bus is used.

removePermission_removeAllPermissions :: Lens' RemovePermission (Maybe Bool) Source #

Specifies whether to remove all permissions.

removePermission_statementId :: Lens' RemovePermission (Maybe Text) Source #

The statement ID corresponding to the account that is no longer allowed to put events to the default event bus.

RemoveTargets

removeTargets_eventBusName :: Lens' RemoveTargets (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.

removeTargets_force :: Lens' RemoveTargets (Maybe Bool) Source #

If this is a managed rule, created by an Amazon Web Services service on your behalf, you must specify Force as True to remove targets. This parameter is ignored for rules that are not managed rules. You can check whether a rule is a managed rule by using DescribeRule or ListRules and checking the ManagedBy field of the response.

removeTargets_rule :: Lens' RemoveTargets Text Source #

The name of the rule.

removeTargets_ids :: Lens' RemoveTargets (NonEmpty Text) Source #

The IDs of the targets to remove from the rule.

removeTargetsResponse_failedEntries :: Lens' RemoveTargetsResponse (Maybe [RemoveTargetsResultEntry]) Source #

The failed target entries.

removeTargetsResponse_failedEntryCount :: Lens' RemoveTargetsResponse (Maybe Int) Source #

The number of failed entries.

removeTargetsResponse_httpStatus :: Lens' RemoveTargetsResponse Int Source #

The response's http status code.

StartReplay

startReplay_description :: Lens' StartReplay (Maybe Text) Source #

A description for the replay to start.

startReplay_replayName :: Lens' StartReplay Text Source #

The name of the replay to start.

startReplay_eventSourceArn :: Lens' StartReplay Text Source #

The ARN of the archive to replay events from.

startReplay_eventStartTime :: Lens' StartReplay UTCTime Source #

A time stamp for the time to start replaying events. Only events that occurred between the EventStartTime and EventEndTime are replayed.

startReplay_eventEndTime :: Lens' StartReplay UTCTime Source #

A time stamp for the time to stop replaying events. Only events that occurred between the EventStartTime and EventEndTime are replayed.

startReplay_destination :: Lens' StartReplay ReplayDestination Source #

A ReplayDestination object that includes details about the destination for the replay.

startReplayResponse_replayArn :: Lens' StartReplayResponse (Maybe Text) Source #

The ARN of the replay.

startReplayResponse_replayStartTime :: Lens' StartReplayResponse (Maybe UTCTime) Source #

The time at which the replay started.

startReplayResponse_state :: Lens' StartReplayResponse (Maybe ReplayState) Source #

The state of the replay.

startReplayResponse_stateReason :: Lens' StartReplayResponse (Maybe Text) Source #

The reason that the replay is in the state.

startReplayResponse_httpStatus :: Lens' StartReplayResponse Int Source #

The response's http status code.

TagResource

tagResource_resourceARN :: Lens' TagResource Text Source #

The ARN of the EventBridge resource that you're adding tags to.

tagResource_tags :: Lens' TagResource [Tag] Source #

The list of key-value pairs to associate with the resource.

tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int Source #

The response's http status code.

TestEventPattern

testEventPattern_eventPattern :: Lens' TestEventPattern Text Source #

The event pattern. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.

testEventPattern_event :: Lens' TestEventPattern Text Source #

The event, in JSON format, to test against the event pattern. The JSON must follow the format specified in Amazon Web Services Events, and the following fields are mandatory:

```
id
```
```
account
```
```
source
```
```
time
```
```
region
```
```
resources
```
```
detail-type
```

testEventPatternResponse_result :: Lens' TestEventPatternResponse (Maybe Bool) Source #

Indicates whether the event matches the event pattern.

testEventPatternResponse_httpStatus :: Lens' TestEventPatternResponse Int Source #

The response's http status code.

UntagResource

untagResource_resourceARN :: Lens' UntagResource Text Source #

The ARN of the EventBridge resource from which you are removing tags.

untagResource_tagKeys :: Lens' UntagResource [Text] Source #

The list of tag keys to remove from the resource.

untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int Source #

The response's http status code.

UpdateApiDestination

updateApiDestination_connectionArn :: Lens' UpdateApiDestination (Maybe Text) Source #

The ARN of the connection to use for the API destination.

updateApiDestination_description :: Lens' UpdateApiDestination (Maybe Text) Source #

The name of the API destination to update.

updateApiDestination_httpMethod :: Lens' UpdateApiDestination (Maybe ApiDestinationHttpMethod) Source #

The method to use for the API destination.

updateApiDestination_invocationEndpoint :: Lens' UpdateApiDestination (Maybe Text) Source #

The URL to the endpoint to use for the API destination.

updateApiDestination_invocationRateLimitPerSecond :: Lens' UpdateApiDestination (Maybe Natural) Source #

The maximum number of invocations per second to send to the API destination.

updateApiDestination_name :: Lens' UpdateApiDestination Text Source #

The name of the API destination to update.

updateApiDestinationResponse_apiDestinationArn :: Lens' UpdateApiDestinationResponse (Maybe Text) Source #

The ARN of the API destination that was updated.

updateApiDestinationResponse_apiDestinationState :: Lens' UpdateApiDestinationResponse (Maybe ApiDestinationState) Source #

The state of the API destination that was updated.

updateApiDestinationResponse_creationTime :: Lens' UpdateApiDestinationResponse (Maybe UTCTime) Source #

A time stamp for the time that the API destination was created.

updateApiDestinationResponse_lastModifiedTime :: Lens' UpdateApiDestinationResponse (Maybe UTCTime) Source #

A time stamp for the time that the API destination was last modified.

updateApiDestinationResponse_httpStatus :: Lens' UpdateApiDestinationResponse Int Source #

The response's http status code.

UpdateArchive

updateArchive_description :: Lens' UpdateArchive (Maybe Text) Source #

The description for the archive.

updateArchive_eventPattern :: Lens' UpdateArchive (Maybe Text) Source #

The event pattern to use to filter events sent to the archive.

updateArchive_retentionDays :: Lens' UpdateArchive (Maybe Natural) Source #

The number of days to retain events in the archive.

updateArchive_archiveName :: Lens' UpdateArchive Text Source #

The name of the archive to update.

updateArchiveResponse_archiveArn :: Lens' UpdateArchiveResponse (Maybe Text) Source #

The ARN of the archive.

updateArchiveResponse_creationTime :: Lens' UpdateArchiveResponse (Maybe UTCTime) Source #

The time at which the archive was updated.

updateArchiveResponse_state :: Lens' UpdateArchiveResponse (Maybe ArchiveState) Source #

The state of the archive.

updateArchiveResponse_stateReason :: Lens' UpdateArchiveResponse (Maybe Text) Source #

The reason that the archive is in the current state.

updateArchiveResponse_httpStatus :: Lens' UpdateArchiveResponse Int Source #

The response's http status code.

UpdateConnection

updateConnection_authParameters :: Lens' UpdateConnection (Maybe UpdateConnectionAuthRequestParameters) Source #

The authorization parameters to use for the connection.

updateConnection_authorizationType :: Lens' UpdateConnection (Maybe ConnectionAuthorizationType) Source #

The type of authorization to use for the connection.

updateConnection_description :: Lens' UpdateConnection (Maybe Text) Source #

A description for the connection.

updateConnection_name :: Lens' UpdateConnection Text Source #

The name of the connection to update.

updateConnectionResponse_connectionArn :: Lens' UpdateConnectionResponse (Maybe Text) Source #

The ARN of the connection that was updated.

updateConnectionResponse_connectionState :: Lens' UpdateConnectionResponse (Maybe ConnectionState) Source #

The state of the connection that was updated.

updateConnectionResponse_creationTime :: Lens' UpdateConnectionResponse (Maybe UTCTime) Source #

A time stamp for the time that the connection was created.

updateConnectionResponse_lastAuthorizedTime :: Lens' UpdateConnectionResponse (Maybe UTCTime) Source #

A time stamp for the time that the connection was last authorized.

updateConnectionResponse_lastModifiedTime :: Lens' UpdateConnectionResponse (Maybe UTCTime) Source #

A time stamp for the time that the connection was last modified.

updateConnectionResponse_httpStatus :: Lens' UpdateConnectionResponse Int Source #

The response's http status code.

UpdateEndpoint

updateEndpoint_description :: Lens' UpdateEndpoint (Maybe Text) Source #

A description for the endpoint.

updateEndpoint_eventBuses :: Lens' UpdateEndpoint (Maybe (NonEmpty EndpointEventBus)) Source #

Define event buses used for replication.

updateEndpoint_replicationConfig :: Lens' UpdateEndpoint (Maybe ReplicationConfig) Source #

Whether event replication was enabled or disabled by this request.

updateEndpoint_roleArn :: Lens' UpdateEndpoint (Maybe Text) Source #

The ARN of the role used by event replication for this request.

updateEndpoint_routingConfig :: Lens' UpdateEndpoint (Maybe RoutingConfig) Source #

Configure the routing policy, including the health check and secondary Region..

updateEndpoint_name :: Lens' UpdateEndpoint Text Source #

The name of the endpoint you want to update.

updateEndpointResponse_arn :: Lens' UpdateEndpointResponse (Maybe Text) Source #

The ARN of the endpoint you updated in this request.

updateEndpointResponse_endpointId :: Lens' UpdateEndpointResponse (Maybe Text) Source #

The ID of the endpoint you updated in this request.

updateEndpointResponse_endpointUrl :: Lens' UpdateEndpointResponse (Maybe Text) Source #

The URL of the endpoint you updated in this request.

updateEndpointResponse_eventBuses :: Lens' UpdateEndpointResponse (Maybe (NonEmpty EndpointEventBus)) Source #

The event buses used for replication for the endpoint you updated in this request.

updateEndpointResponse_name :: Lens' UpdateEndpointResponse (Maybe Text) Source #

The name of the endpoint you updated in this request.

updateEndpointResponse_replicationConfig :: Lens' UpdateEndpointResponse (Maybe ReplicationConfig) Source #

Whether event replication was enabled or disabled for the endpoint you updated in this request.

updateEndpointResponse_roleArn :: Lens' UpdateEndpointResponse (Maybe Text) Source #

The ARN of the role used by event replication for the endpoint you updated in this request.

updateEndpointResponse_routingConfig :: Lens' UpdateEndpointResponse (Maybe RoutingConfig) Source #

The routing configuration you updated in this request.

updateEndpointResponse_state :: Lens' UpdateEndpointResponse (Maybe EndpointState) Source #

The state of the endpoint you updated in this request.

updateEndpointResponse_httpStatus :: Lens' UpdateEndpointResponse Int Source #

The response's http status code.

Types

ApiDestination

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.

AwsVpcConfiguration

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

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

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

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

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

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

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

connectionApiKeyAuthResponseParameters_apiKeyName :: Lens' ConnectionApiKeyAuthResponseParameters (Maybe Text) Source #

The name of the header to use for the APIKeyValue used for authorization.

ConnectionAuthResponseParameters

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

connectionBasicAuthResponseParameters_username :: Lens' ConnectionBasicAuthResponseParameters (Maybe Text) Source #

The user name to use for Basic authorization.

ConnectionBodyParameter

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

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

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

connectionOAuthClientResponseParameters_clientID :: Lens' ConnectionOAuthClientResponseParameters (Maybe Text) Source #

The client ID associated with the response to the connection request.

ConnectionOAuthResponseParameters

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

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

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

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

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

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

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

deadLetterConfig_arn :: Lens' DeadLetterConfig (Maybe Text) Source #

The ARN of the SQS queue specified as the target for the dead-letter queue.

EcsParameters

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

endpoint_arn :: Lens' Endpoint (Maybe Text) Source #

The ARN of the endpoint.

endpoint_creationTime :: Lens' Endpoint (Maybe UTCTime) Source #

The time the endpoint was created.

endpoint_description :: Lens' Endpoint (Maybe Text) Source #

A description for the endpoint.

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_endpointUrl :: Lens' Endpoint (Maybe Text) Source #

The URL of the endpoint.

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_name :: Lens' Endpoint (Maybe Text) Source #

The name of the endpoint.

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

endpointEventBus_eventBusArn :: Lens' EndpointEventBus Text Source #

The ARN of the event bus the endpoint is associated with.

EventBus

eventBus_arn :: Lens' EventBus (Maybe Text) Source #

The ARN of the event bus.

eventBus_name :: Lens' EventBus (Maybe Text) Source #

The name of the 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

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

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

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

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

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

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

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

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

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

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

primary_healthCheck :: Lens' Primary Text Source #

The ARN of the health check used by the endpoint to determine whether failover is triggered.

PutEventsRequestEntry

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_time :: Lens' PutEventsRequestEntry (Maybe UTCTime) Source #

The time stamp of the event, per RFC3339. If no time stamp is provided, the time stamp of the PutEvents call is used.

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

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

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

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

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

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

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

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_replayName :: Lens' Replay (Maybe Text) Source #

The name of the replay.

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

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

replicationConfig_state :: Lens' ReplicationConfig (Maybe ReplicationState) Source #

The state of event replication.

RetryPolicy

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

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

rule_arn :: Lens' Rule (Maybe Text) Source #

The Amazon Resource Name (ARN) of the rule.

rule_description :: Lens' Rule (Maybe Text) Source #

The description 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_name :: Lens' Rule (Maybe Text) Source #

The name of 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.

rule_state :: Lens' Rule (Maybe RuleState) Source #

The state of the rule.

RunCommandParameters

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

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

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

sageMakerPipelineParameters_pipelineParameterList :: Lens' SageMakerPipelineParameters (Maybe [SageMakerPipelineParameter]) Source #

List of Parameter names and values for SageMaker Model Building Pipeline execution.

Secondary

secondary_route :: Lens' Secondary Text Source #

Defines the secondary Region.

SqsParameters

sqsParameters_messageGroupId :: Lens' SqsParameters (Maybe Text) Source #

The FIFO message group ID to use as the target.

Tag

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.

tag_value :: Lens' Tag Text Source #

The value for the specified tag key.

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.

target_arn :: Lens' Target Text Source #

The Amazon Resource Name (ARN) of the target.

UpdateConnectionApiKeyAuthRequestParameters

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

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

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

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

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.