/ cloudformation-templates / node_modules / aws-cdk / node_modules / aws-sdk / clients / eventbridge.d.ts
eventbridge.d.ts
1 import {Request} from '../lib/request'; 2 import {Response} from '../lib/response'; 3 import {AWSError} from '../lib/error'; 4 import {Service} from '../lib/service'; 5 import {ServiceConfigurationOptions} from '../lib/service'; 6 import {ConfigBase as Config} from '../lib/config-base'; 7 interface Blob {} 8 declare class EventBridge extends Service { 9 /** 10 * Constructs a service object. This object has one method for each API operation. 11 */ 12 constructor(options?: EventBridge.Types.ClientConfiguration) 13 config: Config & EventBridge.Types.ClientConfiguration; 14 /** 15 * Activates a partner event source that has been deactivated. Once activated, your matching event bus will start receiving events from the event source. 16 */ 17 activateEventSource(params: EventBridge.Types.ActivateEventSourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 18 /** 19 * Activates a partner event source that has been deactivated. Once activated, your matching event bus will start receiving events from the event source. 20 */ 21 activateEventSource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 22 /** 23 * Cancels the specified replay. 24 */ 25 cancelReplay(params: EventBridge.Types.CancelReplayRequest, callback?: (err: AWSError, data: EventBridge.Types.CancelReplayResponse) => void): Request<EventBridge.Types.CancelReplayResponse, AWSError>; 26 /** 27 * Cancels the specified replay. 28 */ 29 cancelReplay(callback?: (err: AWSError, data: EventBridge.Types.CancelReplayResponse) => void): Request<EventBridge.Types.CancelReplayResponse, AWSError>; 30 /** 31 * Creates an API destination, which is an HTTP invocation endpoint configured as a target for events. 32 */ 33 createApiDestination(params: EventBridge.Types.CreateApiDestinationRequest, callback?: (err: AWSError, data: EventBridge.Types.CreateApiDestinationResponse) => void): Request<EventBridge.Types.CreateApiDestinationResponse, AWSError>; 34 /** 35 * Creates an API destination, which is an HTTP invocation endpoint configured as a target for events. 36 */ 37 createApiDestination(callback?: (err: AWSError, data: EventBridge.Types.CreateApiDestinationResponse) => void): Request<EventBridge.Types.CreateApiDestinationResponse, AWSError>; 38 /** 39 * Creates an archive of events with the specified settings. When you create an archive, incoming events might not immediately start being sent to the archive. Allow a short period of time for changes to take effect. If you do not specify a pattern to filter events sent to the archive, all events are sent to the archive except replayed events. Replayed events are not sent to an archive. 40 */ 41 createArchive(params: EventBridge.Types.CreateArchiveRequest, callback?: (err: AWSError, data: EventBridge.Types.CreateArchiveResponse) => void): Request<EventBridge.Types.CreateArchiveResponse, AWSError>; 42 /** 43 * Creates an archive of events with the specified settings. When you create an archive, incoming events might not immediately start being sent to the archive. Allow a short period of time for changes to take effect. If you do not specify a pattern to filter events sent to the archive, all events are sent to the archive except replayed events. Replayed events are not sent to an archive. 44 */ 45 createArchive(callback?: (err: AWSError, data: EventBridge.Types.CreateArchiveResponse) => void): Request<EventBridge.Types.CreateArchiveResponse, AWSError>; 46 /** 47 * Creates a connection. A connection defines the authorization type and credentials to use for authorization with an API destination HTTP endpoint. 48 */ 49 createConnection(params: EventBridge.Types.CreateConnectionRequest, callback?: (err: AWSError, data: EventBridge.Types.CreateConnectionResponse) => void): Request<EventBridge.Types.CreateConnectionResponse, AWSError>; 50 /** 51 * Creates a connection. A connection defines the authorization type and credentials to use for authorization with an API destination HTTP endpoint. 52 */ 53 createConnection(callback?: (err: AWSError, data: EventBridge.Types.CreateConnectionResponse) => void): Request<EventBridge.Types.CreateConnectionResponse, AWSError>; 54 /** 55 * Creates a new event bus within your account. This can be a custom event bus which you can use to receive events from your custom applications and services, or it can be a partner event bus which can be matched to a partner event source. 56 */ 57 createEventBus(params: EventBridge.Types.CreateEventBusRequest, callback?: (err: AWSError, data: EventBridge.Types.CreateEventBusResponse) => void): Request<EventBridge.Types.CreateEventBusResponse, AWSError>; 58 /** 59 * Creates a new event bus within your account. This can be a custom event bus which you can use to receive events from your custom applications and services, or it can be a partner event bus which can be matched to a partner event source. 60 */ 61 createEventBus(callback?: (err: AWSError, data: EventBridge.Types.CreateEventBusResponse) => void): Request<EventBridge.Types.CreateEventBusResponse, AWSError>; 62 /** 63 * Called by an SaaS partner to create a partner event source. This operation is not used by Amazon Web Services customers. Each partner event source can be used by one Amazon Web Services account to create a matching partner event bus in that Amazon Web Services account. A SaaS partner must create one partner event source for each Amazon Web Services account that wants to receive those event types. A partner event source creates events based on resources within the SaaS partner's service or application. An Amazon Web Services account that creates a partner event bus that matches the partner event source can use that event bus to receive events from the partner, and then process them using Amazon Web Services Events rules and targets. Partner event source names follow this format: partner_name/event_namespace/event_name partner_name is determined during partner registration and identifies the partner to Amazon Web Services customers. event_namespace is determined by the partner and is a way for the partner to categorize their events. event_name is determined by the partner, and should uniquely identify an event-generating resource within the partner system. The combination of event_namespace and event_name should help Amazon Web Services customers decide whether to create an event bus to receive these events. 64 */ 65 createPartnerEventSource(params: EventBridge.Types.CreatePartnerEventSourceRequest, callback?: (err: AWSError, data: EventBridge.Types.CreatePartnerEventSourceResponse) => void): Request<EventBridge.Types.CreatePartnerEventSourceResponse, AWSError>; 66 /** 67 * Called by an SaaS partner to create a partner event source. This operation is not used by Amazon Web Services customers. Each partner event source can be used by one Amazon Web Services account to create a matching partner event bus in that Amazon Web Services account. A SaaS partner must create one partner event source for each Amazon Web Services account that wants to receive those event types. A partner event source creates events based on resources within the SaaS partner's service or application. An Amazon Web Services account that creates a partner event bus that matches the partner event source can use that event bus to receive events from the partner, and then process them using Amazon Web Services Events rules and targets. Partner event source names follow this format: partner_name/event_namespace/event_name partner_name is determined during partner registration and identifies the partner to Amazon Web Services customers. event_namespace is determined by the partner and is a way for the partner to categorize their events. event_name is determined by the partner, and should uniquely identify an event-generating resource within the partner system. The combination of event_namespace and event_name should help Amazon Web Services customers decide whether to create an event bus to receive these events. 68 */ 69 createPartnerEventSource(callback?: (err: AWSError, data: EventBridge.Types.CreatePartnerEventSourceResponse) => void): Request<EventBridge.Types.CreatePartnerEventSourceResponse, AWSError>; 70 /** 71 * You can use this operation to temporarily stop receiving events from the specified partner event source. The matching event bus is not deleted. When you deactivate a partner event source, the source goes into PENDING state. If it remains in PENDING state for more than two weeks, it is deleted. To activate a deactivated partner event source, use ActivateEventSource. 72 */ 73 deactivateEventSource(params: EventBridge.Types.DeactivateEventSourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 74 /** 75 * You can use this operation to temporarily stop receiving events from the specified partner event source. The matching event bus is not deleted. When you deactivate a partner event source, the source goes into PENDING state. If it remains in PENDING state for more than two weeks, it is deleted. To activate a deactivated partner event source, use ActivateEventSource. 76 */ 77 deactivateEventSource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 78 /** 79 * Removes all authorization parameters from the connection. This lets you remove the secret from the connection so you can reuse it without having to create a new connection. 80 */ 81 deauthorizeConnection(params: EventBridge.Types.DeauthorizeConnectionRequest, callback?: (err: AWSError, data: EventBridge.Types.DeauthorizeConnectionResponse) => void): Request<EventBridge.Types.DeauthorizeConnectionResponse, AWSError>; 82 /** 83 * Removes all authorization parameters from the connection. This lets you remove the secret from the connection so you can reuse it without having to create a new connection. 84 */ 85 deauthorizeConnection(callback?: (err: AWSError, data: EventBridge.Types.DeauthorizeConnectionResponse) => void): Request<EventBridge.Types.DeauthorizeConnectionResponse, AWSError>; 86 /** 87 * Deletes the specified API destination. 88 */ 89 deleteApiDestination(params: EventBridge.Types.DeleteApiDestinationRequest, callback?: (err: AWSError, data: EventBridge.Types.DeleteApiDestinationResponse) => void): Request<EventBridge.Types.DeleteApiDestinationResponse, AWSError>; 90 /** 91 * Deletes the specified API destination. 92 */ 93 deleteApiDestination(callback?: (err: AWSError, data: EventBridge.Types.DeleteApiDestinationResponse) => void): Request<EventBridge.Types.DeleteApiDestinationResponse, AWSError>; 94 /** 95 * Deletes the specified archive. 96 */ 97 deleteArchive(params: EventBridge.Types.DeleteArchiveRequest, callback?: (err: AWSError, data: EventBridge.Types.DeleteArchiveResponse) => void): Request<EventBridge.Types.DeleteArchiveResponse, AWSError>; 98 /** 99 * Deletes the specified archive. 100 */ 101 deleteArchive(callback?: (err: AWSError, data: EventBridge.Types.DeleteArchiveResponse) => void): Request<EventBridge.Types.DeleteArchiveResponse, AWSError>; 102 /** 103 * Deletes a connection. 104 */ 105 deleteConnection(params: EventBridge.Types.DeleteConnectionRequest, callback?: (err: AWSError, data: EventBridge.Types.DeleteConnectionResponse) => void): Request<EventBridge.Types.DeleteConnectionResponse, AWSError>; 106 /** 107 * Deletes a connection. 108 */ 109 deleteConnection(callback?: (err: AWSError, data: EventBridge.Types.DeleteConnectionResponse) => void): Request<EventBridge.Types.DeleteConnectionResponse, AWSError>; 110 /** 111 * Deletes the specified custom event bus or partner event bus. All rules associated with this event bus need to be deleted. You can't delete your account's default event bus. 112 */ 113 deleteEventBus(params: EventBridge.Types.DeleteEventBusRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 114 /** 115 * Deletes the specified custom event bus or partner event bus. All rules associated with this event bus need to be deleted. You can't delete your account's default event bus. 116 */ 117 deleteEventBus(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 118 /** 119 * This operation is used by SaaS partners to delete a partner event source. This operation is not used by Amazon Web Services customers. When you delete an event source, the status of the corresponding partner event bus in the Amazon Web Services customer account becomes DELETED. 120 */ 121 deletePartnerEventSource(params: EventBridge.Types.DeletePartnerEventSourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 122 /** 123 * This operation is used by SaaS partners to delete a partner event source. This operation is not used by Amazon Web Services customers. When you delete an event source, the status of the corresponding partner event bus in the Amazon Web Services customer account becomes DELETED. 124 */ 125 deletePartnerEventSource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 126 /** 127 * Deletes the specified rule. Before you can delete the rule, you must remove all targets, using RemoveTargets. When you delete a rule, incoming events might continue to match to the deleted rule. Allow a short period of time for changes to take effect. If you call delete rule multiple times for the same rule, all calls will succeed. When you call delete rule for a non-existent custom eventbus, ResourceNotFoundException is returned. Managed rules are rules created and managed by another Amazon Web Services service on your behalf. These rules are created by those other Amazon Web Services services to support functionality in those services. You can delete these rules using the Force option, but you should do so only if you are sure the other service is not still using that rule. 128 */ 129 deleteRule(params: EventBridge.Types.DeleteRuleRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 130 /** 131 * Deletes the specified rule. Before you can delete the rule, you must remove all targets, using RemoveTargets. When you delete a rule, incoming events might continue to match to the deleted rule. Allow a short period of time for changes to take effect. If you call delete rule multiple times for the same rule, all calls will succeed. When you call delete rule for a non-existent custom eventbus, ResourceNotFoundException is returned. Managed rules are rules created and managed by another Amazon Web Services service on your behalf. These rules are created by those other Amazon Web Services services to support functionality in those services. You can delete these rules using the Force option, but you should do so only if you are sure the other service is not still using that rule. 132 */ 133 deleteRule(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 134 /** 135 * Retrieves details about an API destination. 136 */ 137 describeApiDestination(params: EventBridge.Types.DescribeApiDestinationRequest, callback?: (err: AWSError, data: EventBridge.Types.DescribeApiDestinationResponse) => void): Request<EventBridge.Types.DescribeApiDestinationResponse, AWSError>; 138 /** 139 * Retrieves details about an API destination. 140 */ 141 describeApiDestination(callback?: (err: AWSError, data: EventBridge.Types.DescribeApiDestinationResponse) => void): Request<EventBridge.Types.DescribeApiDestinationResponse, AWSError>; 142 /** 143 * Retrieves details about an archive. 144 */ 145 describeArchive(params: EventBridge.Types.DescribeArchiveRequest, callback?: (err: AWSError, data: EventBridge.Types.DescribeArchiveResponse) => void): Request<EventBridge.Types.DescribeArchiveResponse, AWSError>; 146 /** 147 * Retrieves details about an archive. 148 */ 149 describeArchive(callback?: (err: AWSError, data: EventBridge.Types.DescribeArchiveResponse) => void): Request<EventBridge.Types.DescribeArchiveResponse, AWSError>; 150 /** 151 * Retrieves details about a connection. 152 */ 153 describeConnection(params: EventBridge.Types.DescribeConnectionRequest, callback?: (err: AWSError, data: EventBridge.Types.DescribeConnectionResponse) => void): Request<EventBridge.Types.DescribeConnectionResponse, AWSError>; 154 /** 155 * Retrieves details about a connection. 156 */ 157 describeConnection(callback?: (err: AWSError, data: EventBridge.Types.DescribeConnectionResponse) => void): Request<EventBridge.Types.DescribeConnectionResponse, AWSError>; 158 /** 159 * Displays details about an event bus in your account. This can include the external Amazon Web Services accounts that are permitted to write events to your default event bus, and the associated policy. For custom event buses and partner event buses, it displays the name, ARN, policy, state, and creation time. To enable your account to receive events from other accounts on its default event bus, use PutPermission. For more information about partner event buses, see CreateEventBus. 160 */ 161 describeEventBus(params: EventBridge.Types.DescribeEventBusRequest, callback?: (err: AWSError, data: EventBridge.Types.DescribeEventBusResponse) => void): Request<EventBridge.Types.DescribeEventBusResponse, AWSError>; 162 /** 163 * Displays details about an event bus in your account. This can include the external Amazon Web Services accounts that are permitted to write events to your default event bus, and the associated policy. For custom event buses and partner event buses, it displays the name, ARN, policy, state, and creation time. To enable your account to receive events from other accounts on its default event bus, use PutPermission. For more information about partner event buses, see CreateEventBus. 164 */ 165 describeEventBus(callback?: (err: AWSError, data: EventBridge.Types.DescribeEventBusResponse) => void): Request<EventBridge.Types.DescribeEventBusResponse, AWSError>; 166 /** 167 * This operation lists details about a partner event source that is shared with your account. 168 */ 169 describeEventSource(params: EventBridge.Types.DescribeEventSourceRequest, callback?: (err: AWSError, data: EventBridge.Types.DescribeEventSourceResponse) => void): Request<EventBridge.Types.DescribeEventSourceResponse, AWSError>; 170 /** 171 * This operation lists details about a partner event source that is shared with your account. 172 */ 173 describeEventSource(callback?: (err: AWSError, data: EventBridge.Types.DescribeEventSourceResponse) => void): Request<EventBridge.Types.DescribeEventSourceResponse, AWSError>; 174 /** 175 * An SaaS partner can use this operation to list details about a partner event source that they have created. Amazon Web Services customers do not use this operation. Instead, Amazon Web Services customers can use DescribeEventSource to see details about a partner event source that is shared with them. 176 */ 177 describePartnerEventSource(params: EventBridge.Types.DescribePartnerEventSourceRequest, callback?: (err: AWSError, data: EventBridge.Types.DescribePartnerEventSourceResponse) => void): Request<EventBridge.Types.DescribePartnerEventSourceResponse, AWSError>; 178 /** 179 * An SaaS partner can use this operation to list details about a partner event source that they have created. Amazon Web Services customers do not use this operation. Instead, Amazon Web Services customers can use DescribeEventSource to see details about a partner event source that is shared with them. 180 */ 181 describePartnerEventSource(callback?: (err: AWSError, data: EventBridge.Types.DescribePartnerEventSourceResponse) => void): Request<EventBridge.Types.DescribePartnerEventSourceResponse, AWSError>; 182 /** 183 * Retrieves details about a replay. Use DescribeReplay to determine the progress of a running replay. A replay processes events to replay based on the time in the event, and replays them using 1 minute intervals. If you use StartReplay and specify an EventStartTime and an EventEndTime that covers a 20 minute time range, the events are replayed from the first minute of that 20 minute range first. Then the events from the second minute are replayed. You can use DescribeReplay to determine the progress of a replay. The value returned for EventLastReplayedTime indicates the time within the specified time range associated with the last event replayed. 184 */ 185 describeReplay(params: EventBridge.Types.DescribeReplayRequest, callback?: (err: AWSError, data: EventBridge.Types.DescribeReplayResponse) => void): Request<EventBridge.Types.DescribeReplayResponse, AWSError>; 186 /** 187 * Retrieves details about a replay. Use DescribeReplay to determine the progress of a running replay. A replay processes events to replay based on the time in the event, and replays them using 1 minute intervals. If you use StartReplay and specify an EventStartTime and an EventEndTime that covers a 20 minute time range, the events are replayed from the first minute of that 20 minute range first. Then the events from the second minute are replayed. You can use DescribeReplay to determine the progress of a replay. The value returned for EventLastReplayedTime indicates the time within the specified time range associated with the last event replayed. 188 */ 189 describeReplay(callback?: (err: AWSError, data: EventBridge.Types.DescribeReplayResponse) => void): Request<EventBridge.Types.DescribeReplayResponse, AWSError>; 190 /** 191 * Describes the specified rule. DescribeRule does not list the targets of a rule. To see the targets associated with a rule, use ListTargetsByRule. 192 */ 193 describeRule(params: EventBridge.Types.DescribeRuleRequest, callback?: (err: AWSError, data: EventBridge.Types.DescribeRuleResponse) => void): Request<EventBridge.Types.DescribeRuleResponse, AWSError>; 194 /** 195 * Describes the specified rule. DescribeRule does not list the targets of a rule. To see the targets associated with a rule, use ListTargetsByRule. 196 */ 197 describeRule(callback?: (err: AWSError, data: EventBridge.Types.DescribeRuleResponse) => void): Request<EventBridge.Types.DescribeRuleResponse, AWSError>; 198 /** 199 * Disables the specified rule. A disabled rule won't match any events, and won't self-trigger if it has a schedule expression. When you disable a rule, incoming events might continue to match to the disabled rule. Allow a short period of time for changes to take effect. 200 */ 201 disableRule(params: EventBridge.Types.DisableRuleRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 202 /** 203 * Disables the specified rule. A disabled rule won't match any events, and won't self-trigger if it has a schedule expression. When you disable a rule, incoming events might continue to match to the disabled rule. Allow a short period of time for changes to take effect. 204 */ 205 disableRule(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 206 /** 207 * Enables the specified rule. If the rule does not exist, the operation fails. When you enable a rule, incoming events might not immediately start matching to a newly enabled rule. Allow a short period of time for changes to take effect. 208 */ 209 enableRule(params: EventBridge.Types.EnableRuleRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 210 /** 211 * Enables the specified rule. If the rule does not exist, the operation fails. When you enable a rule, incoming events might not immediately start matching to a newly enabled rule. Allow a short period of time for changes to take effect. 212 */ 213 enableRule(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 214 /** 215 * Retrieves a list of API destination in the account in the current Region. 216 */ 217 listApiDestinations(params: EventBridge.Types.ListApiDestinationsRequest, callback?: (err: AWSError, data: EventBridge.Types.ListApiDestinationsResponse) => void): Request<EventBridge.Types.ListApiDestinationsResponse, AWSError>; 218 /** 219 * Retrieves a list of API destination in the account in the current Region. 220 */ 221 listApiDestinations(callback?: (err: AWSError, data: EventBridge.Types.ListApiDestinationsResponse) => void): Request<EventBridge.Types.ListApiDestinationsResponse, AWSError>; 222 /** 223 * Lists your archives. You can either list all the archives or you can provide a prefix to match to the archive names. Filter parameters are exclusive. 224 */ 225 listArchives(params: EventBridge.Types.ListArchivesRequest, callback?: (err: AWSError, data: EventBridge.Types.ListArchivesResponse) => void): Request<EventBridge.Types.ListArchivesResponse, AWSError>; 226 /** 227 * Lists your archives. You can either list all the archives or you can provide a prefix to match to the archive names. Filter parameters are exclusive. 228 */ 229 listArchives(callback?: (err: AWSError, data: EventBridge.Types.ListArchivesResponse) => void): Request<EventBridge.Types.ListArchivesResponse, AWSError>; 230 /** 231 * Retrieves a list of connections from the account. 232 */ 233 listConnections(params: EventBridge.Types.ListConnectionsRequest, callback?: (err: AWSError, data: EventBridge.Types.ListConnectionsResponse) => void): Request<EventBridge.Types.ListConnectionsResponse, AWSError>; 234 /** 235 * Retrieves a list of connections from the account. 236 */ 237 listConnections(callback?: (err: AWSError, data: EventBridge.Types.ListConnectionsResponse) => void): Request<EventBridge.Types.ListConnectionsResponse, AWSError>; 238 /** 239 * Lists all the event buses in your account, including the default event bus, custom event buses, and partner event buses. 240 */ 241 listEventBuses(params: EventBridge.Types.ListEventBusesRequest, callback?: (err: AWSError, data: EventBridge.Types.ListEventBusesResponse) => void): Request<EventBridge.Types.ListEventBusesResponse, AWSError>; 242 /** 243 * Lists all the event buses in your account, including the default event bus, custom event buses, and partner event buses. 244 */ 245 listEventBuses(callback?: (err: AWSError, data: EventBridge.Types.ListEventBusesResponse) => void): Request<EventBridge.Types.ListEventBusesResponse, AWSError>; 246 /** 247 * You can use this to see all the partner event sources that have been shared with your Amazon Web Services account. For more information about partner event sources, see CreateEventBus. 248 */ 249 listEventSources(params: EventBridge.Types.ListEventSourcesRequest, callback?: (err: AWSError, data: EventBridge.Types.ListEventSourcesResponse) => void): Request<EventBridge.Types.ListEventSourcesResponse, AWSError>; 250 /** 251 * You can use this to see all the partner event sources that have been shared with your Amazon Web Services account. For more information about partner event sources, see CreateEventBus. 252 */ 253 listEventSources(callback?: (err: AWSError, data: EventBridge.Types.ListEventSourcesResponse) => void): Request<EventBridge.Types.ListEventSourcesResponse, AWSError>; 254 /** 255 * An SaaS partner can use this operation to display the Amazon Web Services account ID that a particular partner event source name is associated with. This operation is not used by Amazon Web Services customers. 256 */ 257 listPartnerEventSourceAccounts(params: EventBridge.Types.ListPartnerEventSourceAccountsRequest, callback?: (err: AWSError, data: EventBridge.Types.ListPartnerEventSourceAccountsResponse) => void): Request<EventBridge.Types.ListPartnerEventSourceAccountsResponse, AWSError>; 258 /** 259 * An SaaS partner can use this operation to display the Amazon Web Services account ID that a particular partner event source name is associated with. This operation is not used by Amazon Web Services customers. 260 */ 261 listPartnerEventSourceAccounts(callback?: (err: AWSError, data: EventBridge.Types.ListPartnerEventSourceAccountsResponse) => void): Request<EventBridge.Types.ListPartnerEventSourceAccountsResponse, AWSError>; 262 /** 263 * An SaaS partner can use this operation to list all the partner event source names that they have created. This operation is not used by Amazon Web Services customers. 264 */ 265 listPartnerEventSources(params: EventBridge.Types.ListPartnerEventSourcesRequest, callback?: (err: AWSError, data: EventBridge.Types.ListPartnerEventSourcesResponse) => void): Request<EventBridge.Types.ListPartnerEventSourcesResponse, AWSError>; 266 /** 267 * An SaaS partner can use this operation to list all the partner event source names that they have created. This operation is not used by Amazon Web Services customers. 268 */ 269 listPartnerEventSources(callback?: (err: AWSError, data: EventBridge.Types.ListPartnerEventSourcesResponse) => void): Request<EventBridge.Types.ListPartnerEventSourcesResponse, AWSError>; 270 /** 271 * Lists your replays. You can either list all the replays or you can provide a prefix to match to the replay names. Filter parameters are exclusive. 272 */ 273 listReplays(params: EventBridge.Types.ListReplaysRequest, callback?: (err: AWSError, data: EventBridge.Types.ListReplaysResponse) => void): Request<EventBridge.Types.ListReplaysResponse, AWSError>; 274 /** 275 * Lists your replays. You can either list all the replays or you can provide a prefix to match to the replay names. Filter parameters are exclusive. 276 */ 277 listReplays(callback?: (err: AWSError, data: EventBridge.Types.ListReplaysResponse) => void): Request<EventBridge.Types.ListReplaysResponse, AWSError>; 278 /** 279 * Lists the rules for the specified target. You can see which of the rules in Amazon EventBridge can invoke a specific target in your account. 280 */ 281 listRuleNamesByTarget(params: EventBridge.Types.ListRuleNamesByTargetRequest, callback?: (err: AWSError, data: EventBridge.Types.ListRuleNamesByTargetResponse) => void): Request<EventBridge.Types.ListRuleNamesByTargetResponse, AWSError>; 282 /** 283 * Lists the rules for the specified target. You can see which of the rules in Amazon EventBridge can invoke a specific target in your account. 284 */ 285 listRuleNamesByTarget(callback?: (err: AWSError, data: EventBridge.Types.ListRuleNamesByTargetResponse) => void): Request<EventBridge.Types.ListRuleNamesByTargetResponse, AWSError>; 286 /** 287 * Lists your Amazon EventBridge rules. You can either list all the rules or you can provide a prefix to match to the rule names. ListRules does not list the targets of a rule. To see the targets associated with a rule, use ListTargetsByRule. 288 */ 289 listRules(params: EventBridge.Types.ListRulesRequest, callback?: (err: AWSError, data: EventBridge.Types.ListRulesResponse) => void): Request<EventBridge.Types.ListRulesResponse, AWSError>; 290 /** 291 * Lists your Amazon EventBridge rules. You can either list all the rules or you can provide a prefix to match to the rule names. ListRules does not list the targets of a rule. To see the targets associated with a rule, use ListTargetsByRule. 292 */ 293 listRules(callback?: (err: AWSError, data: EventBridge.Types.ListRulesResponse) => void): Request<EventBridge.Types.ListRulesResponse, AWSError>; 294 /** 295 * Displays the tags associated with an EventBridge resource. In EventBridge, rules and event buses can be tagged. 296 */ 297 listTagsForResource(params: EventBridge.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: EventBridge.Types.ListTagsForResourceResponse) => void): Request<EventBridge.Types.ListTagsForResourceResponse, AWSError>; 298 /** 299 * Displays the tags associated with an EventBridge resource. In EventBridge, rules and event buses can be tagged. 300 */ 301 listTagsForResource(callback?: (err: AWSError, data: EventBridge.Types.ListTagsForResourceResponse) => void): Request<EventBridge.Types.ListTagsForResourceResponse, AWSError>; 302 /** 303 * Lists the targets assigned to the specified rule. 304 */ 305 listTargetsByRule(params: EventBridge.Types.ListTargetsByRuleRequest, callback?: (err: AWSError, data: EventBridge.Types.ListTargetsByRuleResponse) => void): Request<EventBridge.Types.ListTargetsByRuleResponse, AWSError>; 306 /** 307 * Lists the targets assigned to the specified rule. 308 */ 309 listTargetsByRule(callback?: (err: AWSError, data: EventBridge.Types.ListTargetsByRuleResponse) => void): Request<EventBridge.Types.ListTargetsByRuleResponse, AWSError>; 310 /** 311 * Sends custom events to Amazon EventBridge so that they can be matched to rules. 312 */ 313 putEvents(params: EventBridge.Types.PutEventsRequest, callback?: (err: AWSError, data: EventBridge.Types.PutEventsResponse) => void): Request<EventBridge.Types.PutEventsResponse, AWSError>; 314 /** 315 * Sends custom events to Amazon EventBridge so that they can be matched to rules. 316 */ 317 putEvents(callback?: (err: AWSError, data: EventBridge.Types.PutEventsResponse) => void): Request<EventBridge.Types.PutEventsResponse, AWSError>; 318 /** 319 * This is used by SaaS partners to write events to a customer's partner event bus. Amazon Web Services customers do not use this operation. 320 */ 321 putPartnerEvents(params: EventBridge.Types.PutPartnerEventsRequest, callback?: (err: AWSError, data: EventBridge.Types.PutPartnerEventsResponse) => void): Request<EventBridge.Types.PutPartnerEventsResponse, AWSError>; 322 /** 323 * This is used by SaaS partners to write events to a customer's partner event bus. Amazon Web Services customers do not use this operation. 324 */ 325 putPartnerEvents(callback?: (err: AWSError, data: EventBridge.Types.PutPartnerEventsResponse) => void): Request<EventBridge.Types.PutPartnerEventsResponse, AWSError>; 326 /** 327 * Running PutPermission permits the specified Amazon Web Services account or Amazon Web Services organization to put events to the specified event bus. Amazon EventBridge (CloudWatch Events) rules in your account are triggered by these events arriving to an event bus in your account. For another account to send events to your account, that external account must have an EventBridge rule with your account's event bus as a target. To enable multiple Amazon Web Services accounts to put events to your event bus, run PutPermission once for each of these accounts. Or, if all the accounts are members of the same Amazon Web Services organization, you can run PutPermission once specifying Principal as "*" and specifying the Amazon Web Services organization ID in Condition, to grant permissions to all accounts in that organization. If you grant permissions using an organization, then accounts in that organization must specify a RoleArn with proper permissions when they use PutTarget to add your account's event bus as a target. For more information, see Sending and Receiving Events Between Amazon Web Services Accounts in the Amazon EventBridge User Guide. The permission policy on the event bus cannot exceed 10 KB in size. 328 */ 329 putPermission(params: EventBridge.Types.PutPermissionRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 330 /** 331 * Running PutPermission permits the specified Amazon Web Services account or Amazon Web Services organization to put events to the specified event bus. Amazon EventBridge (CloudWatch Events) rules in your account are triggered by these events arriving to an event bus in your account. For another account to send events to your account, that external account must have an EventBridge rule with your account's event bus as a target. To enable multiple Amazon Web Services accounts to put events to your event bus, run PutPermission once for each of these accounts. Or, if all the accounts are members of the same Amazon Web Services organization, you can run PutPermission once specifying Principal as "*" and specifying the Amazon Web Services organization ID in Condition, to grant permissions to all accounts in that organization. If you grant permissions using an organization, then accounts in that organization must specify a RoleArn with proper permissions when they use PutTarget to add your account's event bus as a target. For more information, see Sending and Receiving Events Between Amazon Web Services Accounts in the Amazon EventBridge User Guide. The permission policy on the event bus cannot exceed 10 KB in size. 332 */ 333 putPermission(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 334 /** 335 * Creates or updates the specified rule. Rules are enabled by default, or based on value of the state. You can disable a rule using DisableRule. A single rule watches for events from a single event bus. Events generated by Amazon Web Services services go to your account's default event bus. Events generated by SaaS partner services or applications go to the matching partner event bus. If you have custom applications or services, you can specify whether their events go to your default event bus or a custom event bus that you have created. For more information, see CreateEventBus. If you are updating an existing rule, the rule is replaced with what you specify in this PutRule command. If you omit arguments in PutRule, the old values for those arguments are not kept. Instead, they are replaced with null values. When you create or update a rule, incoming events might not immediately start matching to new or updated rules. Allow a short period of time for changes to take effect. A rule must contain at least an EventPattern or ScheduleExpression. Rules with EventPatterns are triggered when a matching event is observed. Rules with ScheduleExpressions self-trigger based on the given schedule. A rule can have both an EventPattern and a ScheduleExpression, in which case the rule triggers on matching events as well as on a schedule. When you initially create a rule, you can optionally assign one or more tags to the rule. Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only rules with certain tag values. To use the PutRule operation and assign tags, you must have both the events:PutRule and events:TagResource permissions. If you are updating an existing rule, any tags you specify in the PutRule operation are ignored. To update the tags of an existing rule, use TagResource and UntagResource. Most services in Amazon Web Services treat : or / as the same character in Amazon Resource Names (ARNs). However, EventBridge uses an exact match in event patterns and rules. Be sure to use the correct ARN characters when creating event patterns so that they match the ARN syntax in the event you want to match. In EventBridge, it is possible to create rules that lead to infinite loops, where a rule is fired repeatedly. For example, a rule might detect that ACLs have changed on an S3 bucket, and trigger software to change them to the desired state. If the rule is not written carefully, the subsequent change to the ACLs fires the rule again, creating an infinite loop. To prevent this, write the rules so that the triggered actions do not re-fire the same rule. For example, your rule could fire only if ACLs are found to be in a bad state, instead of after any change. An infinite loop can quickly cause higher than expected charges. We recommend that you use budgeting, which alerts you when charges exceed your specified limit. For more information, see Managing Your Costs with Budgets. 336 */ 337 putRule(params: EventBridge.Types.PutRuleRequest, callback?: (err: AWSError, data: EventBridge.Types.PutRuleResponse) => void): Request<EventBridge.Types.PutRuleResponse, AWSError>; 338 /** 339 * Creates or updates the specified rule. Rules are enabled by default, or based on value of the state. You can disable a rule using DisableRule. A single rule watches for events from a single event bus. Events generated by Amazon Web Services services go to your account's default event bus. Events generated by SaaS partner services or applications go to the matching partner event bus. If you have custom applications or services, you can specify whether their events go to your default event bus or a custom event bus that you have created. For more information, see CreateEventBus. If you are updating an existing rule, the rule is replaced with what you specify in this PutRule command. If you omit arguments in PutRule, the old values for those arguments are not kept. Instead, they are replaced with null values. When you create or update a rule, incoming events might not immediately start matching to new or updated rules. Allow a short period of time for changes to take effect. A rule must contain at least an EventPattern or ScheduleExpression. Rules with EventPatterns are triggered when a matching event is observed. Rules with ScheduleExpressions self-trigger based on the given schedule. A rule can have both an EventPattern and a ScheduleExpression, in which case the rule triggers on matching events as well as on a schedule. When you initially create a rule, you can optionally assign one or more tags to the rule. Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only rules with certain tag values. To use the PutRule operation and assign tags, you must have both the events:PutRule and events:TagResource permissions. If you are updating an existing rule, any tags you specify in the PutRule operation are ignored. To update the tags of an existing rule, use TagResource and UntagResource. Most services in Amazon Web Services treat : or / as the same character in Amazon Resource Names (ARNs). However, EventBridge uses an exact match in event patterns and rules. Be sure to use the correct ARN characters when creating event patterns so that they match the ARN syntax in the event you want to match. In EventBridge, it is possible to create rules that lead to infinite loops, where a rule is fired repeatedly. For example, a rule might detect that ACLs have changed on an S3 bucket, and trigger software to change them to the desired state. If the rule is not written carefully, the subsequent change to the ACLs fires the rule again, creating an infinite loop. To prevent this, write the rules so that the triggered actions do not re-fire the same rule. For example, your rule could fire only if ACLs are found to be in a bad state, instead of after any change. An infinite loop can quickly cause higher than expected charges. We recommend that you use budgeting, which alerts you when charges exceed your specified limit. For more information, see Managing Your Costs with Budgets. 340 */ 341 putRule(callback?: (err: AWSError, data: EventBridge.Types.PutRuleResponse) => void): Request<EventBridge.Types.PutRuleResponse, AWSError>; 342 /** 343 * Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule. Targets are the resources that are invoked when a rule is triggered. You can configure the following as targets for Events: API destination Amazon API Gateway REST API endpoints API Gateway Batch job queue CloudWatch Logs group CodeBuild project CodePipeline Amazon EC2 CreateSnapshot API call Amazon EC2 RebootInstances API call Amazon EC2 StopInstances API call Amazon EC2 TerminateInstances API call Amazon ECS tasks Event bus in a different Amazon Web Services account or Region. You can use an event bus in the US East (N. Virginia) us-east-1, US West (Oregon) us-west-2, or Europe (Ireland) eu-west-1 Regions as a target for a rule. Firehose delivery stream (Kinesis Data Firehose) Inspector assessment template (Amazon Inspector) Kinesis stream (Kinesis Data Stream) Lambda function Redshift clusters (Data API statement execution) Amazon SNS topic Amazon SQS queues (includes FIFO queues SSM Automation SSM OpsItem SSM Run Command Step Functions state machines Creating rules with built-in targets is supported only in the Amazon Web Services Management Console. The built-in targets are EC2 CreateSnapshot API call, EC2 RebootInstances API call, EC2 StopInstances API call, and EC2 TerminateInstances API call. For some target types, PutTargets provides target-specific parameters. If the target is a Kinesis data stream, you can optionally specify which shard the event goes to by using the KinesisParameters argument. To invoke a command on multiple EC2 instances with one rule, you can use the RunCommandParameters field. To be able to make API calls against the resources that you own, Amazon EventBridge needs the appropriate permissions. For Lambda and Amazon SNS resources, EventBridge relies on resource-based policies. For EC2 instances, Kinesis Data Streams, Step Functions state machines and API Gateway REST APIs, EventBridge relies on IAM roles that you specify in the RoleARN argument in PutTargets. For more information, see Authentication and Access Control in the Amazon EventBridge User Guide. If another Amazon Web Services account is in the same region and has granted you permission (using PutPermission), you can send events to that account. Set that account's event bus as a target of the rules in your account. To send the matched events to the other account, specify that account's event bus as the Arn value when you run PutTargets. If your account sends events to another account, your account is charged for each sent event. Each event sent to another account is charged as a custom event. The account receiving the event is not charged. For more information, see Amazon EventBridge Pricing. Input, InputPath, and InputTransformer are not available with PutTarget if the target is an event bus of a different Amazon Web Services account. If you are setting the event bus of another account as the target, and that account granted permission to your account through an organization instead of directly by the account ID, then you must specify a RoleArn with proper permissions in the Target structure. For more information, see Sending and Receiving Events Between Amazon Web Services Accounts in the Amazon EventBridge User Guide. For more information about enabling cross-account events, see PutPermission. Input, InputPath, and InputTransformer are mutually exclusive and optional parameters of a target. When a rule is triggered due to a matched event: If none of the following arguments are specified for a target, then the entire event is passed to the target in JSON format (unless the target is Amazon EC2 Run Command or Amazon ECS task, in which case nothing from the event is passed to the target). If Input is specified in the form of valid JSON, then the matched event is overridden with this constant. If InputPath is specified in the form of JSONPath (for example, $.detail), then only the part of the event specified in the path is passed to the target (for example, only the detail part of the event is passed). If InputTransformer is specified, then one or more specified JSONPaths are extracted from the event and used as values in a template that you specify as the input to the target. When you specify InputPath or InputTransformer, you must use JSON dot notation, not bracket notation. When you add targets to a rule and the associated rule triggers soon after, new or updated targets might not be immediately invoked. Allow a short period of time for changes to take effect. This action can partially fail if too many requests are made at the same time. If that happens, FailedEntryCount is non-zero in the response and each entry in FailedEntries provides the ID of the failed target and the error code. 344 */ 345 putTargets(params: EventBridge.Types.PutTargetsRequest, callback?: (err: AWSError, data: EventBridge.Types.PutTargetsResponse) => void): Request<EventBridge.Types.PutTargetsResponse, AWSError>; 346 /** 347 * Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule. Targets are the resources that are invoked when a rule is triggered. You can configure the following as targets for Events: API destination Amazon API Gateway REST API endpoints API Gateway Batch job queue CloudWatch Logs group CodeBuild project CodePipeline Amazon EC2 CreateSnapshot API call Amazon EC2 RebootInstances API call Amazon EC2 StopInstances API call Amazon EC2 TerminateInstances API call Amazon ECS tasks Event bus in a different Amazon Web Services account or Region. You can use an event bus in the US East (N. Virginia) us-east-1, US West (Oregon) us-west-2, or Europe (Ireland) eu-west-1 Regions as a target for a rule. Firehose delivery stream (Kinesis Data Firehose) Inspector assessment template (Amazon Inspector) Kinesis stream (Kinesis Data Stream) Lambda function Redshift clusters (Data API statement execution) Amazon SNS topic Amazon SQS queues (includes FIFO queues SSM Automation SSM OpsItem SSM Run Command Step Functions state machines Creating rules with built-in targets is supported only in the Amazon Web Services Management Console. The built-in targets are EC2 CreateSnapshot API call, EC2 RebootInstances API call, EC2 StopInstances API call, and EC2 TerminateInstances API call. For some target types, PutTargets provides target-specific parameters. If the target is a Kinesis data stream, you can optionally specify which shard the event goes to by using the KinesisParameters argument. To invoke a command on multiple EC2 instances with one rule, you can use the RunCommandParameters field. To be able to make API calls against the resources that you own, Amazon EventBridge needs the appropriate permissions. For Lambda and Amazon SNS resources, EventBridge relies on resource-based policies. For EC2 instances, Kinesis Data Streams, Step Functions state machines and API Gateway REST APIs, EventBridge relies on IAM roles that you specify in the RoleARN argument in PutTargets. For more information, see Authentication and Access Control in the Amazon EventBridge User Guide. If another Amazon Web Services account is in the same region and has granted you permission (using PutPermission), you can send events to that account. Set that account's event bus as a target of the rules in your account. To send the matched events to the other account, specify that account's event bus as the Arn value when you run PutTargets. If your account sends events to another account, your account is charged for each sent event. Each event sent to another account is charged as a custom event. The account receiving the event is not charged. For more information, see Amazon EventBridge Pricing. Input, InputPath, and InputTransformer are not available with PutTarget if the target is an event bus of a different Amazon Web Services account. If you are setting the event bus of another account as the target, and that account granted permission to your account through an organization instead of directly by the account ID, then you must specify a RoleArn with proper permissions in the Target structure. For more information, see Sending and Receiving Events Between Amazon Web Services Accounts in the Amazon EventBridge User Guide. For more information about enabling cross-account events, see PutPermission. Input, InputPath, and InputTransformer are mutually exclusive and optional parameters of a target. When a rule is triggered due to a matched event: If none of the following arguments are specified for a target, then the entire event is passed to the target in JSON format (unless the target is Amazon EC2 Run Command or Amazon ECS task, in which case nothing from the event is passed to the target). If Input is specified in the form of valid JSON, then the matched event is overridden with this constant. If InputPath is specified in the form of JSONPath (for example, $.detail), then only the part of the event specified in the path is passed to the target (for example, only the detail part of the event is passed). If InputTransformer is specified, then one or more specified JSONPaths are extracted from the event and used as values in a template that you specify as the input to the target. When you specify InputPath or InputTransformer, you must use JSON dot notation, not bracket notation. When you add targets to a rule and the associated rule triggers soon after, new or updated targets might not be immediately invoked. Allow a short period of time for changes to take effect. This action can partially fail if too many requests are made at the same time. If that happens, FailedEntryCount is non-zero in the response and each entry in FailedEntries provides the ID of the failed target and the error code. 348 */ 349 putTargets(callback?: (err: AWSError, data: EventBridge.Types.PutTargetsResponse) => void): Request<EventBridge.Types.PutTargetsResponse, AWSError>; 350 /** 351 * Revokes the permission of another Amazon Web Services account to be able to put events to the specified event bus. Specify the account to revoke by the StatementId value that you associated with the account when you granted it permission with PutPermission. You can find the StatementId by using DescribeEventBus. 352 */ 353 removePermission(params: EventBridge.Types.RemovePermissionRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 354 /** 355 * Revokes the permission of another Amazon Web Services account to be able to put events to the specified event bus. Specify the account to revoke by the StatementId value that you associated with the account when you granted it permission with PutPermission. You can find the StatementId by using DescribeEventBus. 356 */ 357 removePermission(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 358 /** 359 * Removes the specified targets from the specified rule. When the rule is triggered, those targets are no longer be invoked. When you remove a target, when the associated rule triggers, removed targets might continue to be invoked. Allow a short period of time for changes to take effect. This action can partially fail if too many requests are made at the same time. If that happens, FailedEntryCount is non-zero in the response and each entry in FailedEntries provides the ID of the failed target and the error code. 360 */ 361 removeTargets(params: EventBridge.Types.RemoveTargetsRequest, callback?: (err: AWSError, data: EventBridge.Types.RemoveTargetsResponse) => void): Request<EventBridge.Types.RemoveTargetsResponse, AWSError>; 362 /** 363 * Removes the specified targets from the specified rule. When the rule is triggered, those targets are no longer be invoked. When you remove a target, when the associated rule triggers, removed targets might continue to be invoked. Allow a short period of time for changes to take effect. This action can partially fail if too many requests are made at the same time. If that happens, FailedEntryCount is non-zero in the response and each entry in FailedEntries provides the ID of the failed target and the error code. 364 */ 365 removeTargets(callback?: (err: AWSError, data: EventBridge.Types.RemoveTargetsResponse) => void): Request<EventBridge.Types.RemoveTargetsResponse, AWSError>; 366 /** 367 * Starts the specified replay. Events are not necessarily replayed in the exact same order that they were added to the archive. A replay processes events to replay based on the time in the event, and replays them using 1 minute intervals. If you specify an EventStartTime and an EventEndTime that covers a 20 minute time range, the events are replayed from the first minute of that 20 minute range first. Then the events from the second minute are replayed. You can use DescribeReplay to determine the progress of a replay. The value returned for EventLastReplayedTime indicates the time within the specified time range associated with the last event replayed. 368 */ 369 startReplay(params: EventBridge.Types.StartReplayRequest, callback?: (err: AWSError, data: EventBridge.Types.StartReplayResponse) => void): Request<EventBridge.Types.StartReplayResponse, AWSError>; 370 /** 371 * Starts the specified replay. Events are not necessarily replayed in the exact same order that they were added to the archive. A replay processes events to replay based on the time in the event, and replays them using 1 minute intervals. If you specify an EventStartTime and an EventEndTime that covers a 20 minute time range, the events are replayed from the first minute of that 20 minute range first. Then the events from the second minute are replayed. You can use DescribeReplay to determine the progress of a replay. The value returned for EventLastReplayedTime indicates the time within the specified time range associated with the last event replayed. 372 */ 373 startReplay(callback?: (err: AWSError, data: EventBridge.Types.StartReplayResponse) => void): Request<EventBridge.Types.StartReplayResponse, AWSError>; 374 /** 375 * Assigns one or more tags (key-value pairs) to the specified EventBridge resource. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. In EventBridge, rules and event buses can be tagged. Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters. You can use the TagResource action with a resource that already has tags. If you specify a new tag key, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag. You can associate as many as 50 tags with a resource. 376 */ 377 tagResource(params: EventBridge.Types.TagResourceRequest, callback?: (err: AWSError, data: EventBridge.Types.TagResourceResponse) => void): Request<EventBridge.Types.TagResourceResponse, AWSError>; 378 /** 379 * Assigns one or more tags (key-value pairs) to the specified EventBridge resource. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. In EventBridge, rules and event buses can be tagged. Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters. You can use the TagResource action with a resource that already has tags. If you specify a new tag key, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag. You can associate as many as 50 tags with a resource. 380 */ 381 tagResource(callback?: (err: AWSError, data: EventBridge.Types.TagResourceResponse) => void): Request<EventBridge.Types.TagResourceResponse, AWSError>; 382 /** 383 * Tests whether the specified event pattern matches the provided event. Most services in Amazon Web Services treat : or / as the same character in Amazon Resource Names (ARNs). However, EventBridge uses an exact match in event patterns and rules. Be sure to use the correct ARN characters when creating event patterns so that they match the ARN syntax in the event you want to match. 384 */ 385 testEventPattern(params: EventBridge.Types.TestEventPatternRequest, callback?: (err: AWSError, data: EventBridge.Types.TestEventPatternResponse) => void): Request<EventBridge.Types.TestEventPatternResponse, AWSError>; 386 /** 387 * Tests whether the specified event pattern matches the provided event. Most services in Amazon Web Services treat : or / as the same character in Amazon Resource Names (ARNs). However, EventBridge uses an exact match in event patterns and rules. Be sure to use the correct ARN characters when creating event patterns so that they match the ARN syntax in the event you want to match. 388 */ 389 testEventPattern(callback?: (err: AWSError, data: EventBridge.Types.TestEventPatternResponse) => void): Request<EventBridge.Types.TestEventPatternResponse, AWSError>; 390 /** 391 * Removes one or more tags from the specified EventBridge resource. In Amazon EventBridge (CloudWatch Events), rules and event buses can be tagged. 392 */ 393 untagResource(params: EventBridge.Types.UntagResourceRequest, callback?: (err: AWSError, data: EventBridge.Types.UntagResourceResponse) => void): Request<EventBridge.Types.UntagResourceResponse, AWSError>; 394 /** 395 * Removes one or more tags from the specified EventBridge resource. In Amazon EventBridge (CloudWatch Events), rules and event buses can be tagged. 396 */ 397 untagResource(callback?: (err: AWSError, data: EventBridge.Types.UntagResourceResponse) => void): Request<EventBridge.Types.UntagResourceResponse, AWSError>; 398 /** 399 * Updates an API destination. 400 */ 401 updateApiDestination(params: EventBridge.Types.UpdateApiDestinationRequest, callback?: (err: AWSError, data: EventBridge.Types.UpdateApiDestinationResponse) => void): Request<EventBridge.Types.UpdateApiDestinationResponse, AWSError>; 402 /** 403 * Updates an API destination. 404 */ 405 updateApiDestination(callback?: (err: AWSError, data: EventBridge.Types.UpdateApiDestinationResponse) => void): Request<EventBridge.Types.UpdateApiDestinationResponse, AWSError>; 406 /** 407 * Updates the specified archive. 408 */ 409 updateArchive(params: EventBridge.Types.UpdateArchiveRequest, callback?: (err: AWSError, data: EventBridge.Types.UpdateArchiveResponse) => void): Request<EventBridge.Types.UpdateArchiveResponse, AWSError>; 410 /** 411 * Updates the specified archive. 412 */ 413 updateArchive(callback?: (err: AWSError, data: EventBridge.Types.UpdateArchiveResponse) => void): Request<EventBridge.Types.UpdateArchiveResponse, AWSError>; 414 /** 415 * Updates settings for a connection. 416 */ 417 updateConnection(params: EventBridge.Types.UpdateConnectionRequest, callback?: (err: AWSError, data: EventBridge.Types.UpdateConnectionResponse) => void): Request<EventBridge.Types.UpdateConnectionResponse, AWSError>; 418 /** 419 * Updates settings for a connection. 420 */ 421 updateConnection(callback?: (err: AWSError, data: EventBridge.Types.UpdateConnectionResponse) => void): Request<EventBridge.Types.UpdateConnectionResponse, AWSError>; 422 } 423 declare namespace EventBridge { 424 export type AccountId = string; 425 export type Action = string; 426 export interface ActivateEventSourceRequest { 427 /** 428 * The name of the partner event source to activate. 429 */ 430 Name: EventSourceName; 431 } 432 export interface ApiDestination { 433 /** 434 * The ARN of the API destination. 435 */ 436 ApiDestinationArn?: ApiDestinationArn; 437 /** 438 * The name of the API destination. 439 */ 440 Name?: ApiDestinationName; 441 /** 442 * The state of the API destination. 443 */ 444 ApiDestinationState?: ApiDestinationState; 445 /** 446 * The ARN of the connection specified for the API destination. 447 */ 448 ConnectionArn?: ConnectionArn; 449 /** 450 * The URL to the endpoint for the API destination. 451 */ 452 InvocationEndpoint?: HttpsEndpoint; 453 /** 454 * The method to use to connect to the HTTP endpoint. 455 */ 456 HttpMethod?: ApiDestinationHttpMethod; 457 /** 458 * The maximum number of invocations per second to send to the HTTP endpoint. 459 */ 460 InvocationRateLimitPerSecond?: ApiDestinationInvocationRateLimitPerSecond; 461 /** 462 * A time stamp for the time that the API destination was created. 463 */ 464 CreationTime?: Timestamp; 465 /** 466 * A time stamp for the time that the API destination was last modified. 467 */ 468 LastModifiedTime?: Timestamp; 469 } 470 export type ApiDestinationArn = string; 471 export type ApiDestinationDescription = string; 472 export type ApiDestinationHttpMethod = "POST"|"GET"|"HEAD"|"OPTIONS"|"PUT"|"PATCH"|"DELETE"|string; 473 export type ApiDestinationInvocationRateLimitPerSecond = number; 474 export type ApiDestinationName = string; 475 export type ApiDestinationResponseList = ApiDestination[]; 476 export type ApiDestinationState = "ACTIVE"|"INACTIVE"|string; 477 export interface Archive { 478 /** 479 * The name of the archive. 480 */ 481 ArchiveName?: ArchiveName; 482 /** 483 * The ARN of the event bus associated with the archive. Only events from this event bus are sent to the archive. 484 */ 485 EventSourceArn?: Arn; 486 /** 487 * The current state of the archive. 488 */ 489 State?: ArchiveState; 490 /** 491 * A description for the reason that the archive is in the current state. 492 */ 493 StateReason?: ArchiveStateReason; 494 /** 495 * The number of days to retain events in the archive before they are deleted. 496 */ 497 RetentionDays?: RetentionDays; 498 /** 499 * The size of the archive, in bytes. 500 */ 501 SizeBytes?: Long; 502 /** 503 * The number of events in the archive. 504 */ 505 EventCount?: Long; 506 /** 507 * The time stamp for the time that the archive was created. 508 */ 509 CreationTime?: Timestamp; 510 } 511 export type ArchiveArn = string; 512 export type ArchiveDescription = string; 513 export type ArchiveName = string; 514 export type ArchiveResponseList = Archive[]; 515 export type ArchiveState = "ENABLED"|"DISABLED"|"CREATING"|"UPDATING"|"CREATE_FAILED"|"UPDATE_FAILED"|string; 516 export type ArchiveStateReason = string; 517 export type Arn = string; 518 export type AssignPublicIp = "ENABLED"|"DISABLED"|string; 519 export type AuthHeaderParameters = string; 520 export interface AwsVpcConfiguration { 521 /** 522 * Specifies the subnets associated with the task. These subnets must all be in the same VPC. You can specify as many as 16 subnets. 523 */ 524 Subnets: StringList; 525 /** 526 * 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. 527 */ 528 SecurityGroups?: StringList; 529 /** 530 * 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. 531 */ 532 AssignPublicIp?: AssignPublicIp; 533 } 534 export interface BatchArrayProperties { 535 /** 536 * The size of the array, if this is an array batch job. Valid values are integers between 2 and 10,000. 537 */ 538 Size?: Integer; 539 } 540 export interface BatchParameters { 541 /** 542 * The ARN or name of the job definition to use if the event target is an Batch job. This job definition must already exist. 543 */ 544 JobDefinition: String; 545 /** 546 * The name to use for this execution of the job, if the target is an Batch job. 547 */ 548 JobName: String; 549 /** 550 * 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. 551 */ 552 ArrayProperties?: BatchArrayProperties; 553 /** 554 * 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. 555 */ 556 RetryStrategy?: BatchRetryStrategy; 557 } 558 export interface BatchRetryStrategy { 559 /** 560 * The number of times to attempt to retry, if the job fails. Valid values are 1–10. 561 */ 562 Attempts?: Integer; 563 } 564 export type Boolean = boolean; 565 export interface CancelReplayRequest { 566 /** 567 * The name of the replay to cancel. 568 */ 569 ReplayName: ReplayName; 570 } 571 export interface CancelReplayResponse { 572 /** 573 * The ARN of the replay to cancel. 574 */ 575 ReplayArn?: ReplayArn; 576 /** 577 * The current state of the replay. 578 */ 579 State?: ReplayState; 580 /** 581 * The reason that the replay is in the current state. 582 */ 583 StateReason?: ReplayStateReason; 584 } 585 export type CapacityProvider = string; 586 export type CapacityProviderStrategy = CapacityProviderStrategyItem[]; 587 export interface CapacityProviderStrategyItem { 588 /** 589 * The short name of the capacity provider. 590 */ 591 capacityProvider: CapacityProvider; 592 /** 593 * 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. 594 */ 595 weight?: CapacityProviderStrategyItemWeight; 596 /** 597 * 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. 598 */ 599 base?: CapacityProviderStrategyItemBase; 600 } 601 export type CapacityProviderStrategyItemBase = number; 602 export type CapacityProviderStrategyItemWeight = number; 603 export interface Condition { 604 /** 605 * Specifies the type of condition. Currently the only supported value is StringEquals. 606 */ 607 Type: String; 608 /** 609 * Specifies the key for the condition. Currently the only supported key is aws:PrincipalOrgID. 610 */ 611 Key: String; 612 /** 613 * Specifies the value for the key. Currently, this must be the ID of the organization. 614 */ 615 Value: String; 616 } 617 export interface Connection { 618 /** 619 * The ARN of the connection. 620 */ 621 ConnectionArn?: ConnectionArn; 622 /** 623 * The name of the connection. 624 */ 625 Name?: ConnectionName; 626 /** 627 * The state of the connection. 628 */ 629 ConnectionState?: ConnectionState; 630 /** 631 * The reason that the connection is in the connection state. 632 */ 633 StateReason?: ConnectionStateReason; 634 /** 635 * The authorization type specified for the connection. 636 */ 637 AuthorizationType?: ConnectionAuthorizationType; 638 /** 639 * A time stamp for the time that the connection was created. 640 */ 641 CreationTime?: Timestamp; 642 /** 643 * A time stamp for the time that the connection was last modified. 644 */ 645 LastModifiedTime?: Timestamp; 646 /** 647 * A time stamp for the time that the connection was last authorized. 648 */ 649 LastAuthorizedTime?: Timestamp; 650 } 651 export interface ConnectionApiKeyAuthResponseParameters { 652 /** 653 * The name of the header to use for the APIKeyValue used for authorization. 654 */ 655 ApiKeyName?: AuthHeaderParameters; 656 } 657 export type ConnectionArn = string; 658 export interface ConnectionAuthResponseParameters { 659 /** 660 * The authorization parameters for Basic authorization. 661 */ 662 BasicAuthParameters?: ConnectionBasicAuthResponseParameters; 663 /** 664 * The OAuth parameters to use for authorization. 665 */ 666 OAuthParameters?: ConnectionOAuthResponseParameters; 667 /** 668 * The API Key parameters to use for authorization. 669 */ 670 ApiKeyAuthParameters?: ConnectionApiKeyAuthResponseParameters; 671 /** 672 * Additional parameters for the connection that are passed through with every invocation to the HTTP endpoint. 673 */ 674 InvocationHttpParameters?: ConnectionHttpParameters; 675 } 676 export type ConnectionAuthorizationType = "BASIC"|"OAUTH_CLIENT_CREDENTIALS"|"API_KEY"|string; 677 export interface ConnectionBasicAuthResponseParameters { 678 /** 679 * The user name to use for Basic authorization. 680 */ 681 Username?: AuthHeaderParameters; 682 } 683 export interface ConnectionBodyParameter { 684 /** 685 * The key for the parameter. 686 */ 687 Key?: String; 688 /** 689 * The value associated with the key. 690 */ 691 Value?: String; 692 /** 693 * Specified whether the value is secret. 694 */ 695 IsValueSecret?: Boolean; 696 } 697 export type ConnectionBodyParametersList = ConnectionBodyParameter[]; 698 export type ConnectionDescription = string; 699 export interface ConnectionHeaderParameter { 700 /** 701 * The key for the parameter. 702 */ 703 Key?: HeaderKey; 704 /** 705 * The value associated with the key. 706 */ 707 Value?: HeaderValue; 708 /** 709 * Specified whether the value is a secret. 710 */ 711 IsValueSecret?: Boolean; 712 } 713 export type ConnectionHeaderParametersList = ConnectionHeaderParameter[]; 714 export interface ConnectionHttpParameters { 715 /** 716 * Contains additional header parameters for the connection. 717 */ 718 HeaderParameters?: ConnectionHeaderParametersList; 719 /** 720 * Contains additional query string parameters for the connection. 721 */ 722 QueryStringParameters?: ConnectionQueryStringParametersList; 723 /** 724 * Contains additional body string parameters for the connection. 725 */ 726 BodyParameters?: ConnectionBodyParametersList; 727 } 728 export type ConnectionName = string; 729 export interface ConnectionOAuthClientResponseParameters { 730 /** 731 * The client ID associated with the response to the connection request. 732 */ 733 ClientID?: AuthHeaderParameters; 734 } 735 export type ConnectionOAuthHttpMethod = "GET"|"POST"|"PUT"|string; 736 export interface ConnectionOAuthResponseParameters { 737 /** 738 * A ConnectionOAuthClientResponseParameters object that contains details about the client parameters returned when OAuth is specified as the authorization type. 739 */ 740 ClientParameters?: ConnectionOAuthClientResponseParameters; 741 /** 742 * The URL to the HTTP endpoint that authorized the request. 743 */ 744 AuthorizationEndpoint?: HttpsEndpoint; 745 /** 746 * The method used to connect to the HTTP endpoint. 747 */ 748 HttpMethod?: ConnectionOAuthHttpMethod; 749 /** 750 * The additional HTTP parameters used for the OAuth authorization request. 751 */ 752 OAuthHttpParameters?: ConnectionHttpParameters; 753 } 754 export interface ConnectionQueryStringParameter { 755 /** 756 * The key for a query string parameter. 757 */ 758 Key?: QueryStringKey; 759 /** 760 * The value associated with the key for the query string parameter. 761 */ 762 Value?: QueryStringValue; 763 /** 764 * Specifies whether the value is secret. 765 */ 766 IsValueSecret?: Boolean; 767 } 768 export type ConnectionQueryStringParametersList = ConnectionQueryStringParameter[]; 769 export type ConnectionResponseList = Connection[]; 770 export type ConnectionState = "CREATING"|"UPDATING"|"DELETING"|"AUTHORIZED"|"DEAUTHORIZED"|"AUTHORIZING"|"DEAUTHORIZING"|string; 771 export type ConnectionStateReason = string; 772 export interface CreateApiDestinationRequest { 773 /** 774 * The name for the API destination to create. 775 */ 776 Name: ApiDestinationName; 777 /** 778 * A description for the API destination to create. 779 */ 780 Description?: ApiDestinationDescription; 781 /** 782 * The ARN of the connection to use for the API destination. The destination endpoint must support the authorization type specified for the connection. 783 */ 784 ConnectionArn: ConnectionArn; 785 /** 786 * The URL to the HTTP invocation endpoint for the API destination. 787 */ 788 InvocationEndpoint: HttpsEndpoint; 789 /** 790 * The method to use for the request to the HTTP invocation endpoint. 791 */ 792 HttpMethod: ApiDestinationHttpMethod; 793 /** 794 * The maximum number of requests per second to send to the HTTP invocation endpoint. 795 */ 796 InvocationRateLimitPerSecond?: ApiDestinationInvocationRateLimitPerSecond; 797 } 798 export interface CreateApiDestinationResponse { 799 /** 800 * The ARN of the API destination that was created by the request. 801 */ 802 ApiDestinationArn?: ApiDestinationArn; 803 /** 804 * The state of the API destination that was created by the request. 805 */ 806 ApiDestinationState?: ApiDestinationState; 807 /** 808 * A time stamp indicating the time that the API destination was created. 809 */ 810 CreationTime?: Timestamp; 811 /** 812 * A time stamp indicating the time that the API destination was last modified. 813 */ 814 LastModifiedTime?: Timestamp; 815 } 816 export interface CreateArchiveRequest { 817 /** 818 * The name for the archive to create. 819 */ 820 ArchiveName: ArchiveName; 821 /** 822 * The ARN of the event bus that sends events to the archive. 823 */ 824 EventSourceArn: Arn; 825 /** 826 * A description for the archive. 827 */ 828 Description?: ArchiveDescription; 829 /** 830 * An event pattern to use to filter events sent to the archive. 831 */ 832 EventPattern?: EventPattern; 833 /** 834 * The number of days to retain events for. Default value is 0. If set to 0, events are retained indefinitely 835 */ 836 RetentionDays?: RetentionDays; 837 } 838 export interface CreateArchiveResponse { 839 /** 840 * The ARN of the archive that was created. 841 */ 842 ArchiveArn?: ArchiveArn; 843 /** 844 * The state of the archive that was created. 845 */ 846 State?: ArchiveState; 847 /** 848 * The reason that the archive is in the state. 849 */ 850 StateReason?: ArchiveStateReason; 851 /** 852 * The time at which the archive was created. 853 */ 854 CreationTime?: Timestamp; 855 } 856 export interface CreateConnectionApiKeyAuthRequestParameters { 857 /** 858 * The name of the API key to use for authorization. 859 */ 860 ApiKeyName: AuthHeaderParameters; 861 /** 862 * The value for the API key to use for authorization. 863 */ 864 ApiKeyValue: AuthHeaderParameters; 865 } 866 export interface CreateConnectionAuthRequestParameters { 867 /** 868 * A CreateConnectionBasicAuthRequestParameters object that contains the Basic authorization parameters to use for the connection. 869 */ 870 BasicAuthParameters?: CreateConnectionBasicAuthRequestParameters; 871 /** 872 * A CreateConnectionOAuthRequestParameters object that contains the OAuth authorization parameters to use for the connection. 873 */ 874 OAuthParameters?: CreateConnectionOAuthRequestParameters; 875 /** 876 * A CreateConnectionApiKeyAuthRequestParameters object that contains the API key authorization parameters to use for the connection. 877 */ 878 ApiKeyAuthParameters?: CreateConnectionApiKeyAuthRequestParameters; 879 /** 880 * 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. 881 */ 882 InvocationHttpParameters?: ConnectionHttpParameters; 883 } 884 export interface CreateConnectionBasicAuthRequestParameters { 885 /** 886 * The user name to use for Basic authorization. 887 */ 888 Username: AuthHeaderParameters; 889 /** 890 * The password associated with the user name to use for Basic authorization. 891 */ 892 Password: AuthHeaderParameters; 893 } 894 export interface CreateConnectionOAuthClientRequestParameters { 895 /** 896 * The client ID to use for OAuth authorization for the connection. 897 */ 898 ClientID: AuthHeaderParameters; 899 /** 900 * The client secret associated with the client ID to use for OAuth authorization for the connection. 901 */ 902 ClientSecret: AuthHeaderParameters; 903 } 904 export interface CreateConnectionOAuthRequestParameters { 905 /** 906 * A CreateConnectionOAuthClientRequestParameters object that contains the client parameters for OAuth authorization. 907 */ 908 ClientParameters: CreateConnectionOAuthClientRequestParameters; 909 /** 910 * The URL to the authorization endpoint when OAuth is specified as the authorization type. 911 */ 912 AuthorizationEndpoint: HttpsEndpoint; 913 /** 914 * The method to use for the authorization request. 915 */ 916 HttpMethod: ConnectionOAuthHttpMethod; 917 /** 918 * A ConnectionHttpParameters object that contains details about the additional parameters to use for the connection. 919 */ 920 OAuthHttpParameters?: ConnectionHttpParameters; 921 } 922 export interface CreateConnectionRequest { 923 /** 924 * The name for the connection to create. 925 */ 926 Name: ConnectionName; 927 /** 928 * A description for the connection to create. 929 */ 930 Description?: ConnectionDescription; 931 /** 932 * The type of authorization to use for the connection. 933 */ 934 AuthorizationType: ConnectionAuthorizationType; 935 /** 936 * A CreateConnectionAuthRequestParameters object that contains the authorization parameters to use to authorize with the endpoint. 937 */ 938 AuthParameters: CreateConnectionAuthRequestParameters; 939 } 940 export interface CreateConnectionResponse { 941 /** 942 * The ARN of the connection that was created by the request. 943 */ 944 ConnectionArn?: ConnectionArn; 945 /** 946 * The state of the connection that was created by the request. 947 */ 948 ConnectionState?: ConnectionState; 949 /** 950 * A time stamp for the time that the connection was created. 951 */ 952 CreationTime?: Timestamp; 953 /** 954 * A time stamp for the time that the connection was last updated. 955 */ 956 LastModifiedTime?: Timestamp; 957 } 958 export interface CreateEventBusRequest { 959 /** 960 * 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. 961 */ 962 Name: EventBusName; 963 /** 964 * If you are creating a partner event bus, this specifies the partner event source that the new event bus will be matched with. 965 */ 966 EventSourceName?: EventSourceName; 967 /** 968 * Tags to associate with the event bus. 969 */ 970 Tags?: TagList; 971 } 972 export interface CreateEventBusResponse { 973 /** 974 * The ARN of the new event bus. 975 */ 976 EventBusArn?: String; 977 } 978 export interface CreatePartnerEventSourceRequest { 979 /** 980 * 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. 981 */ 982 Name: EventSourceName; 983 /** 984 * The Amazon Web Services account ID that is permitted to create a matching partner event bus for this partner event source. 985 */ 986 Account: AccountId; 987 } 988 export interface CreatePartnerEventSourceResponse { 989 /** 990 * The ARN of the partner event source. 991 */ 992 EventSourceArn?: String; 993 } 994 export type CreatedBy = string; 995 export type Database = string; 996 export type DbUser = string; 997 export interface DeactivateEventSourceRequest { 998 /** 999 * The name of the partner event source to deactivate. 1000 */ 1001 Name: EventSourceName; 1002 } 1003 export interface DeadLetterConfig { 1004 /** 1005 * The ARN of the SQS queue specified as the target for the dead-letter queue. 1006 */ 1007 Arn?: ResourceArn; 1008 } 1009 export interface DeauthorizeConnectionRequest { 1010 /** 1011 * The name of the connection to remove authorization from. 1012 */ 1013 Name: ConnectionName; 1014 } 1015 export interface DeauthorizeConnectionResponse { 1016 /** 1017 * The ARN of the connection that authorization was removed from. 1018 */ 1019 ConnectionArn?: ConnectionArn; 1020 /** 1021 * The state of the connection. 1022 */ 1023 ConnectionState?: ConnectionState; 1024 /** 1025 * A time stamp for the time that the connection was created. 1026 */ 1027 CreationTime?: Timestamp; 1028 /** 1029 * A time stamp for the time that the connection was last updated. 1030 */ 1031 LastModifiedTime?: Timestamp; 1032 /** 1033 * A time stamp for the time that the connection was last authorized. 1034 */ 1035 LastAuthorizedTime?: Timestamp; 1036 } 1037 export interface DeleteApiDestinationRequest { 1038 /** 1039 * The name of the destination to delete. 1040 */ 1041 Name: ApiDestinationName; 1042 } 1043 export interface DeleteApiDestinationResponse { 1044 } 1045 export interface DeleteArchiveRequest { 1046 /** 1047 * The name of the archive to delete. 1048 */ 1049 ArchiveName: ArchiveName; 1050 } 1051 export interface DeleteArchiveResponse { 1052 } 1053 export interface DeleteConnectionRequest { 1054 /** 1055 * The name of the connection to delete. 1056 */ 1057 Name: ConnectionName; 1058 } 1059 export interface DeleteConnectionResponse { 1060 /** 1061 * The ARN of the connection that was deleted. 1062 */ 1063 ConnectionArn?: ConnectionArn; 1064 /** 1065 * The state of the connection before it was deleted. 1066 */ 1067 ConnectionState?: ConnectionState; 1068 /** 1069 * A time stamp for the time that the connection was created. 1070 */ 1071 CreationTime?: Timestamp; 1072 /** 1073 * A time stamp for the time that the connection was last modified before it was deleted. 1074 */ 1075 LastModifiedTime?: Timestamp; 1076 /** 1077 * A time stamp for the time that the connection was last authorized before it wa deleted. 1078 */ 1079 LastAuthorizedTime?: Timestamp; 1080 } 1081 export interface DeleteEventBusRequest { 1082 /** 1083 * The name of the event bus to delete. 1084 */ 1085 Name: EventBusName; 1086 } 1087 export interface DeletePartnerEventSourceRequest { 1088 /** 1089 * The name of the event source to delete. 1090 */ 1091 Name: EventSourceName; 1092 /** 1093 * The Amazon Web Services account ID of the Amazon Web Services customer that the event source was created for. 1094 */ 1095 Account: AccountId; 1096 } 1097 export interface DeleteRuleRequest { 1098 /** 1099 * The name of the rule. 1100 */ 1101 Name: RuleName; 1102 /** 1103 * The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used. 1104 */ 1105 EventBusName?: EventBusNameOrArn; 1106 /** 1107 * 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. 1108 */ 1109 Force?: Boolean; 1110 } 1111 export interface DescribeApiDestinationRequest { 1112 /** 1113 * The name of the API destination to retrieve. 1114 */ 1115 Name: ApiDestinationName; 1116 } 1117 export interface DescribeApiDestinationResponse { 1118 /** 1119 * The ARN of the API destination retrieved. 1120 */ 1121 ApiDestinationArn?: ApiDestinationArn; 1122 /** 1123 * The name of the API destination retrieved. 1124 */ 1125 Name?: ApiDestinationName; 1126 /** 1127 * The description for the API destination retrieved. 1128 */ 1129 Description?: ApiDestinationDescription; 1130 /** 1131 * The state of the API destination retrieved. 1132 */ 1133 ApiDestinationState?: ApiDestinationState; 1134 /** 1135 * The ARN of the connection specified for the API destination retrieved. 1136 */ 1137 ConnectionArn?: ConnectionArn; 1138 /** 1139 * The URL to use to connect to the HTTP endpoint. 1140 */ 1141 InvocationEndpoint?: HttpsEndpoint; 1142 /** 1143 * The method to use to connect to the HTTP endpoint. 1144 */ 1145 HttpMethod?: ApiDestinationHttpMethod; 1146 /** 1147 * 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. 1148 */ 1149 InvocationRateLimitPerSecond?: ApiDestinationInvocationRateLimitPerSecond; 1150 /** 1151 * A time stamp for the time that the API destination was created. 1152 */ 1153 CreationTime?: Timestamp; 1154 /** 1155 * A time stamp for the time that the API destination was last modified. 1156 */ 1157 LastModifiedTime?: Timestamp; 1158 } 1159 export interface DescribeArchiveRequest { 1160 /** 1161 * The name of the archive to retrieve. 1162 */ 1163 ArchiveName: ArchiveName; 1164 } 1165 export interface DescribeArchiveResponse { 1166 /** 1167 * The ARN of the archive. 1168 */ 1169 ArchiveArn?: ArchiveArn; 1170 /** 1171 * The name of the archive. 1172 */ 1173 ArchiveName?: ArchiveName; 1174 /** 1175 * The ARN of the event source associated with the archive. 1176 */ 1177 EventSourceArn?: Arn; 1178 /** 1179 * The description of the archive. 1180 */ 1181 Description?: ArchiveDescription; 1182 /** 1183 * The event pattern used to filter events sent to the archive. 1184 */ 1185 EventPattern?: EventPattern; 1186 /** 1187 * The state of the archive. 1188 */ 1189 State?: ArchiveState; 1190 /** 1191 * The reason that the archive is in the state. 1192 */ 1193 StateReason?: ArchiveStateReason; 1194 /** 1195 * The number of days to retain events for in the archive. 1196 */ 1197 RetentionDays?: RetentionDays; 1198 /** 1199 * The size of the archive in bytes. 1200 */ 1201 SizeBytes?: Long; 1202 /** 1203 * The number of events in the archive. 1204 */ 1205 EventCount?: Long; 1206 /** 1207 * The time at which the archive was created. 1208 */ 1209 CreationTime?: Timestamp; 1210 } 1211 export interface DescribeConnectionRequest { 1212 /** 1213 * The name of the connection to retrieve. 1214 */ 1215 Name: ConnectionName; 1216 } 1217 export interface DescribeConnectionResponse { 1218 /** 1219 * The ARN of the connection retrieved. 1220 */ 1221 ConnectionArn?: ConnectionArn; 1222 /** 1223 * The name of the connection retrieved. 1224 */ 1225 Name?: ConnectionName; 1226 /** 1227 * The description for the connection retrieved. 1228 */ 1229 Description?: ConnectionDescription; 1230 /** 1231 * The state of the connection retrieved. 1232 */ 1233 ConnectionState?: ConnectionState; 1234 /** 1235 * The reason that the connection is in the current connection state. 1236 */ 1237 StateReason?: ConnectionStateReason; 1238 /** 1239 * The type of authorization specified for the connection. 1240 */ 1241 AuthorizationType?: ConnectionAuthorizationType; 1242 /** 1243 * The ARN of the secret created from the authorization parameters specified for the connection. 1244 */ 1245 SecretArn?: SecretsManagerSecretArn; 1246 /** 1247 * The parameters to use for authorization for the connection. 1248 */ 1249 AuthParameters?: ConnectionAuthResponseParameters; 1250 /** 1251 * A time stamp for the time that the connection was created. 1252 */ 1253 CreationTime?: Timestamp; 1254 /** 1255 * A time stamp for the time that the connection was last modified. 1256 */ 1257 LastModifiedTime?: Timestamp; 1258 /** 1259 * A time stamp for the time that the connection was last authorized. 1260 */ 1261 LastAuthorizedTime?: Timestamp; 1262 } 1263 export interface DescribeEventBusRequest { 1264 /** 1265 * The name or ARN of the event bus to show details for. If you omit this, the default event bus is displayed. 1266 */ 1267 Name?: EventBusNameOrArn; 1268 } 1269 export interface DescribeEventBusResponse { 1270 /** 1271 * The name of the event bus. Currently, this is always default. 1272 */ 1273 Name?: String; 1274 /** 1275 * The Amazon Resource Name (ARN) of the account permitted to write events to the current account. 1276 */ 1277 Arn?: String; 1278 /** 1279 * The policy that enables the external account to send events to your account. 1280 */ 1281 Policy?: String; 1282 } 1283 export interface DescribeEventSourceRequest { 1284 /** 1285 * The name of the partner event source to display the details of. 1286 */ 1287 Name: EventSourceName; 1288 } 1289 export interface DescribeEventSourceResponse { 1290 /** 1291 * The ARN of the partner event source. 1292 */ 1293 Arn?: String; 1294 /** 1295 * The name of the SaaS partner that created the event source. 1296 */ 1297 CreatedBy?: String; 1298 /** 1299 * The date and time that the event source was created. 1300 */ 1301 CreationTime?: Timestamp; 1302 /** 1303 * The date and time that the event source will expire if you do not create a matching event bus. 1304 */ 1305 ExpirationTime?: Timestamp; 1306 /** 1307 * The name of the partner event source. 1308 */ 1309 Name?: String; 1310 /** 1311 * 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. 1312 */ 1313 State?: EventSourceState; 1314 } 1315 export interface DescribePartnerEventSourceRequest { 1316 /** 1317 * The name of the event source to display. 1318 */ 1319 Name: EventSourceName; 1320 } 1321 export interface DescribePartnerEventSourceResponse { 1322 /** 1323 * The ARN of the event source. 1324 */ 1325 Arn?: String; 1326 /** 1327 * The name of the event source. 1328 */ 1329 Name?: String; 1330 } 1331 export interface DescribeReplayRequest { 1332 /** 1333 * The name of the replay to retrieve. 1334 */ 1335 ReplayName: ReplayName; 1336 } 1337 export interface DescribeReplayResponse { 1338 /** 1339 * The name of the replay. 1340 */ 1341 ReplayName?: ReplayName; 1342 /** 1343 * The ARN of the replay. 1344 */ 1345 ReplayArn?: ReplayArn; 1346 /** 1347 * The description of the replay. 1348 */ 1349 Description?: ReplayDescription; 1350 /** 1351 * The current state of the replay. 1352 */ 1353 State?: ReplayState; 1354 /** 1355 * The reason that the replay is in the current state. 1356 */ 1357 StateReason?: ReplayStateReason; 1358 /** 1359 * The ARN of the archive events were replayed from. 1360 */ 1361 EventSourceArn?: Arn; 1362 /** 1363 * A ReplayDestination object that contains details about the replay. 1364 */ 1365 Destination?: ReplayDestination; 1366 /** 1367 * The time stamp of the first event that was last replayed from the archive. 1368 */ 1369 EventStartTime?: Timestamp; 1370 /** 1371 * The time stamp for the last event that was replayed from the archive. 1372 */ 1373 EventEndTime?: Timestamp; 1374 /** 1375 * The time that the event was last replayed. 1376 */ 1377 EventLastReplayedTime?: Timestamp; 1378 /** 1379 * A time stamp for the time that the replay started. 1380 */ 1381 ReplayStartTime?: Timestamp; 1382 /** 1383 * A time stamp for the time that the replay stopped. 1384 */ 1385 ReplayEndTime?: Timestamp; 1386 } 1387 export interface DescribeRuleRequest { 1388 /** 1389 * The name of the rule. 1390 */ 1391 Name: RuleName; 1392 /** 1393 * The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used. 1394 */ 1395 EventBusName?: EventBusNameOrArn; 1396 } 1397 export interface DescribeRuleResponse { 1398 /** 1399 * The name of the rule. 1400 */ 1401 Name?: RuleName; 1402 /** 1403 * The Amazon Resource Name (ARN) of the rule. 1404 */ 1405 Arn?: RuleArn; 1406 /** 1407 * The event pattern. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide. 1408 */ 1409 EventPattern?: EventPattern; 1410 /** 1411 * The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)". 1412 */ 1413 ScheduleExpression?: ScheduleExpression; 1414 /** 1415 * Specifies whether the rule is enabled or disabled. 1416 */ 1417 State?: RuleState; 1418 /** 1419 * The description of the rule. 1420 */ 1421 Description?: RuleDescription; 1422 /** 1423 * The Amazon Resource Name (ARN) of the IAM role associated with the rule. 1424 */ 1425 RoleArn?: RoleArn; 1426 /** 1427 * 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. 1428 */ 1429 ManagedBy?: ManagedBy; 1430 /** 1431 * The name of the event bus associated with the rule. 1432 */ 1433 EventBusName?: EventBusName; 1434 /** 1435 * 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. 1436 */ 1437 CreatedBy?: CreatedBy; 1438 } 1439 export interface DisableRuleRequest { 1440 /** 1441 * The name of the rule. 1442 */ 1443 Name: RuleName; 1444 /** 1445 * The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used. 1446 */ 1447 EventBusName?: EventBusNameOrArn; 1448 } 1449 export interface EcsParameters { 1450 /** 1451 * The ARN of the task definition to use if the event target is an Amazon ECS task. 1452 */ 1453 TaskDefinitionArn: Arn; 1454 /** 1455 * The number of tasks to create based on TaskDefinition. The default is 1. 1456 */ 1457 TaskCount?: LimitMin1; 1458 /** 1459 * Specifies the launch type on which your task is running. The launch type that you specify here must match one of the launch type (compatibilities) of the target task. The FARGATE value is supported only in the Regions where Fargate witt Amazon ECS is supported. For more information, see Fargate on Amazon ECS in the Amazon Elastic Container Service Developer Guide. 1460 */ 1461 LaunchType?: LaunchType; 1462 /** 1463 * 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. 1464 */ 1465 NetworkConfiguration?: NetworkConfiguration; 1466 /** 1467 * 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. 1468 */ 1469 PlatformVersion?: String; 1470 /** 1471 * Specifies an ECS task group for the task. The maximum length is 255 characters. 1472 */ 1473 Group?: String; 1474 /** 1475 * 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. 1476 */ 1477 CapacityProviderStrategy?: CapacityProviderStrategy; 1478 /** 1479 * 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. 1480 */ 1481 EnableECSManagedTags?: Boolean; 1482 /** 1483 * 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. 1484 */ 1485 EnableExecuteCommand?: Boolean; 1486 /** 1487 * 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). 1488 */ 1489 PlacementConstraints?: PlacementConstraints; 1490 /** 1491 * The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task. 1492 */ 1493 PlacementStrategy?: PlacementStrategies; 1494 /** 1495 * 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. 1496 */ 1497 PropagateTags?: PropagateTags; 1498 /** 1499 * The reference ID to use for the task. 1500 */ 1501 ReferenceId?: ReferenceId; 1502 /** 1503 * 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. 1504 */ 1505 Tags?: TagList; 1506 } 1507 export interface EnableRuleRequest { 1508 /** 1509 * The name of the rule. 1510 */ 1511 Name: RuleName; 1512 /** 1513 * The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used. 1514 */ 1515 EventBusName?: EventBusNameOrArn; 1516 } 1517 export type ErrorCode = string; 1518 export type ErrorMessage = string; 1519 export interface EventBus { 1520 /** 1521 * The name of the event bus. 1522 */ 1523 Name?: String; 1524 /** 1525 * The ARN of the event bus. 1526 */ 1527 Arn?: String; 1528 /** 1529 * The permissions policy of the event bus, describing which other Amazon Web Services accounts can write events to this event bus. 1530 */ 1531 Policy?: String; 1532 } 1533 export type EventBusList = EventBus[]; 1534 export type EventBusName = string; 1535 export type EventBusNameOrArn = string; 1536 export type EventId = string; 1537 export type EventPattern = string; 1538 export type EventResource = string; 1539 export type EventResourceList = EventResource[]; 1540 export interface EventSource { 1541 /** 1542 * The ARN of the event source. 1543 */ 1544 Arn?: String; 1545 /** 1546 * The name of the partner that created the event source. 1547 */ 1548 CreatedBy?: String; 1549 /** 1550 * The date and time the event source was created. 1551 */ 1552 CreationTime?: Timestamp; 1553 /** 1554 * 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. 1555 */ 1556 ExpirationTime?: Timestamp; 1557 /** 1558 * The name of the event source. 1559 */ 1560 Name?: String; 1561 /** 1562 * 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. 1563 */ 1564 State?: EventSourceState; 1565 } 1566 export type EventSourceList = EventSource[]; 1567 export type EventSourceName = string; 1568 export type EventSourceNamePrefix = string; 1569 export type EventSourceState = "PENDING"|"ACTIVE"|"DELETED"|string; 1570 export type EventTime = Date; 1571 export type HeaderKey = string; 1572 export type HeaderParametersMap = {[key: string]: HeaderValue}; 1573 export type HeaderValue = string; 1574 export interface HttpParameters { 1575 /** 1576 * The path parameter values to be used to populate API Gateway REST API or EventBridge ApiDestination path wildcards ("*"). 1577 */ 1578 PathParameterValues?: PathParameterList; 1579 /** 1580 * The headers that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination. 1581 */ 1582 HeaderParameters?: HeaderParametersMap; 1583 /** 1584 * The query string keys/values that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination. 1585 */ 1586 QueryStringParameters?: QueryStringParametersMap; 1587 } 1588 export type HttpsEndpoint = string; 1589 export interface InputTransformer { 1590 /** 1591 * 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." 1592 */ 1593 InputPathsMap?: TransformerPaths; 1594 /** 1595 * 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>\""}' } 1596 */ 1597 InputTemplate: TransformerInput; 1598 } 1599 export type InputTransformerPathKey = string; 1600 export type Integer = number; 1601 export interface KinesisParameters { 1602 /** 1603 * 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. 1604 */ 1605 PartitionKeyPath: TargetPartitionKeyPath; 1606 } 1607 export type LaunchType = "EC2"|"FARGATE"|"EXTERNAL"|string; 1608 export type LimitMax100 = number; 1609 export type LimitMin1 = number; 1610 export interface ListApiDestinationsRequest { 1611 /** 1612 * A name prefix to filter results returned. Only API destinations with a name that starts with the prefix are returned. 1613 */ 1614 NamePrefix?: ApiDestinationName; 1615 /** 1616 * The ARN of the connection specified for the API destination. 1617 */ 1618 ConnectionArn?: ConnectionArn; 1619 /** 1620 * The token returned by a previous call to retrieve the next set of results. 1621 */ 1622 NextToken?: NextToken; 1623 /** 1624 * The maximum number of API destinations to include in the response. 1625 */ 1626 Limit?: LimitMax100; 1627 } 1628 export interface ListApiDestinationsResponse { 1629 /** 1630 * An array of ApiDestination objects that include information about an API destination. 1631 */ 1632 ApiDestinations?: ApiDestinationResponseList; 1633 /** 1634 * A token you can use in a subsequent request to retrieve the next set of results. 1635 */ 1636 NextToken?: NextToken; 1637 } 1638 export interface ListArchivesRequest { 1639 /** 1640 * A name prefix to filter the archives returned. Only archives with name that match the prefix are returned. 1641 */ 1642 NamePrefix?: ArchiveName; 1643 /** 1644 * The ARN of the event source associated with the archive. 1645 */ 1646 EventSourceArn?: Arn; 1647 /** 1648 * The state of the archive. 1649 */ 1650 State?: ArchiveState; 1651 /** 1652 * The token returned by a previous call to retrieve the next set of results. 1653 */ 1654 NextToken?: NextToken; 1655 /** 1656 * The maximum number of results to return. 1657 */ 1658 Limit?: LimitMax100; 1659 } 1660 export interface ListArchivesResponse { 1661 /** 1662 * An array of Archive objects that include details about an archive. 1663 */ 1664 Archives?: ArchiveResponseList; 1665 /** 1666 * The token returned by a previous call to retrieve the next set of results. 1667 */ 1668 NextToken?: NextToken; 1669 } 1670 export interface ListConnectionsRequest { 1671 /** 1672 * A name prefix to filter results returned. Only connections with a name that starts with the prefix are returned. 1673 */ 1674 NamePrefix?: ConnectionName; 1675 /** 1676 * The state of the connection. 1677 */ 1678 ConnectionState?: ConnectionState; 1679 /** 1680 * The token returned by a previous call to retrieve the next set of results. 1681 */ 1682 NextToken?: NextToken; 1683 /** 1684 * The maximum number of connections to return. 1685 */ 1686 Limit?: LimitMax100; 1687 } 1688 export interface ListConnectionsResponse { 1689 /** 1690 * An array of connections objects that include details about the connections. 1691 */ 1692 Connections?: ConnectionResponseList; 1693 /** 1694 * A token you can use in a subsequent request to retrieve the next set of results. 1695 */ 1696 NextToken?: NextToken; 1697 } 1698 export interface ListEventBusesRequest { 1699 /** 1700 * Specifying this limits the results to only those event buses with names that start with the specified prefix. 1701 */ 1702 NamePrefix?: EventBusName; 1703 /** 1704 * The token returned by a previous call to retrieve the next set of results. 1705 */ 1706 NextToken?: NextToken; 1707 /** 1708 * 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. 1709 */ 1710 Limit?: LimitMax100; 1711 } 1712 export interface ListEventBusesResponse { 1713 /** 1714 * This list of event buses. 1715 */ 1716 EventBuses?: EventBusList; 1717 /** 1718 * A token you can use in a subsequent operation to retrieve the next set of results. 1719 */ 1720 NextToken?: NextToken; 1721 } 1722 export interface ListEventSourcesRequest { 1723 /** 1724 * Specifying this limits the results to only those partner event sources with names that start with the specified prefix. 1725 */ 1726 NamePrefix?: EventSourceNamePrefix; 1727 /** 1728 * The token returned by a previous call to retrieve the next set of results. 1729 */ 1730 NextToken?: NextToken; 1731 /** 1732 * 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. 1733 */ 1734 Limit?: LimitMax100; 1735 } 1736 export interface ListEventSourcesResponse { 1737 /** 1738 * The list of event sources. 1739 */ 1740 EventSources?: EventSourceList; 1741 /** 1742 * A token you can use in a subsequent operation to retrieve the next set of results. 1743 */ 1744 NextToken?: NextToken; 1745 } 1746 export interface ListPartnerEventSourceAccountsRequest { 1747 /** 1748 * The name of the partner event source to display account information about. 1749 */ 1750 EventSourceName: EventSourceName; 1751 /** 1752 * The token returned by a previous call to this operation. Specifying this retrieves the next set of results. 1753 */ 1754 NextToken?: NextToken; 1755 /** 1756 * 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. 1757 */ 1758 Limit?: LimitMax100; 1759 } 1760 export interface ListPartnerEventSourceAccountsResponse { 1761 /** 1762 * The list of partner event sources returned by the operation. 1763 */ 1764 PartnerEventSourceAccounts?: PartnerEventSourceAccountList; 1765 /** 1766 * A token you can use in a subsequent operation to retrieve the next set of results. 1767 */ 1768 NextToken?: NextToken; 1769 } 1770 export interface ListPartnerEventSourcesRequest { 1771 /** 1772 * If you specify this, the results are limited to only those partner event sources that start with the string you specify. 1773 */ 1774 NamePrefix: PartnerEventSourceNamePrefix; 1775 /** 1776 * The token returned by a previous call to this operation. Specifying this retrieves the next set of results. 1777 */ 1778 NextToken?: NextToken; 1779 /** 1780 * 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. 1781 */ 1782 Limit?: LimitMax100; 1783 } 1784 export interface ListPartnerEventSourcesResponse { 1785 /** 1786 * The list of partner event sources returned by the operation. 1787 */ 1788 PartnerEventSources?: PartnerEventSourceList; 1789 /** 1790 * A token you can use in a subsequent operation to retrieve the next set of results. 1791 */ 1792 NextToken?: NextToken; 1793 } 1794 export interface ListReplaysRequest { 1795 /** 1796 * A name prefix to filter the replays returned. Only replays with name that match the prefix are returned. 1797 */ 1798 NamePrefix?: ReplayName; 1799 /** 1800 * The state of the replay. 1801 */ 1802 State?: ReplayState; 1803 /** 1804 * The ARN of the archive from which the events are replayed. 1805 */ 1806 EventSourceArn?: Arn; 1807 /** 1808 * The token returned by a previous call to retrieve the next set of results. 1809 */ 1810 NextToken?: NextToken; 1811 /** 1812 * The maximum number of replays to retrieve. 1813 */ 1814 Limit?: LimitMax100; 1815 } 1816 export interface ListReplaysResponse { 1817 /** 1818 * An array of Replay objects that contain information about the replay. 1819 */ 1820 Replays?: ReplayList; 1821 /** 1822 * The token returned by a previous call to retrieve the next set of results. 1823 */ 1824 NextToken?: NextToken; 1825 } 1826 export interface ListRuleNamesByTargetRequest { 1827 /** 1828 * The Amazon Resource Name (ARN) of the target resource. 1829 */ 1830 TargetArn: TargetArn; 1831 /** 1832 * The name or ARN of the event bus to list rules for. If you omit this, the default event bus is used. 1833 */ 1834 EventBusName?: EventBusNameOrArn; 1835 /** 1836 * The token returned by a previous call to retrieve the next set of results. 1837 */ 1838 NextToken?: NextToken; 1839 /** 1840 * The maximum number of results to return. 1841 */ 1842 Limit?: LimitMax100; 1843 } 1844 export interface ListRuleNamesByTargetResponse { 1845 /** 1846 * The names of the rules that can invoke the given target. 1847 */ 1848 RuleNames?: RuleNameList; 1849 /** 1850 * Indicates whether there are additional results to retrieve. If there are no more results, the value is null. 1851 */ 1852 NextToken?: NextToken; 1853 } 1854 export interface ListRulesRequest { 1855 /** 1856 * The prefix matching the rule name. 1857 */ 1858 NamePrefix?: RuleName; 1859 /** 1860 * The name or ARN of the event bus to list the rules for. If you omit this, the default event bus is used. 1861 */ 1862 EventBusName?: EventBusNameOrArn; 1863 /** 1864 * The token returned by a previous call to retrieve the next set of results. 1865 */ 1866 NextToken?: NextToken; 1867 /** 1868 * The maximum number of results to return. 1869 */ 1870 Limit?: LimitMax100; 1871 } 1872 export interface ListRulesResponse { 1873 /** 1874 * The rules that match the specified criteria. 1875 */ 1876 Rules?: RuleResponseList; 1877 /** 1878 * Indicates whether there are additional results to retrieve. If there are no more results, the value is null. 1879 */ 1880 NextToken?: NextToken; 1881 } 1882 export interface ListTagsForResourceRequest { 1883 /** 1884 * The ARN of the EventBridge resource for which you want to view tags. 1885 */ 1886 ResourceARN: Arn; 1887 } 1888 export interface ListTagsForResourceResponse { 1889 /** 1890 * The list of tag keys and values associated with the resource you specified 1891 */ 1892 Tags?: TagList; 1893 } 1894 export interface ListTargetsByRuleRequest { 1895 /** 1896 * The name of the rule. 1897 */ 1898 Rule: RuleName; 1899 /** 1900 * The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used. 1901 */ 1902 EventBusName?: EventBusNameOrArn; 1903 /** 1904 * The token returned by a previous call to retrieve the next set of results. 1905 */ 1906 NextToken?: NextToken; 1907 /** 1908 * The maximum number of results to return. 1909 */ 1910 Limit?: LimitMax100; 1911 } 1912 export interface ListTargetsByRuleResponse { 1913 /** 1914 * The targets assigned to the rule. 1915 */ 1916 Targets?: TargetList; 1917 /** 1918 * Indicates whether there are additional results to retrieve. If there are no more results, the value is null. 1919 */ 1920 NextToken?: NextToken; 1921 } 1922 export type Long = number; 1923 export type ManagedBy = string; 1924 export type MaximumEventAgeInSeconds = number; 1925 export type MaximumRetryAttempts = number; 1926 export type MessageGroupId = string; 1927 export interface NetworkConfiguration { 1928 /** 1929 * 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. 1930 */ 1931 awsvpcConfiguration?: AwsVpcConfiguration; 1932 } 1933 export type NextToken = string; 1934 export type NonPartnerEventBusName = string; 1935 export type NonPartnerEventBusNameOrArn = string; 1936 export interface PartnerEventSource { 1937 /** 1938 * The ARN of the partner event source. 1939 */ 1940 Arn?: String; 1941 /** 1942 * The name of the partner event source. 1943 */ 1944 Name?: String; 1945 } 1946 export interface PartnerEventSourceAccount { 1947 /** 1948 * The Amazon Web Services account ID that the partner event source was offered to. 1949 */ 1950 Account?: AccountId; 1951 /** 1952 * The date and time the event source was created. 1953 */ 1954 CreationTime?: Timestamp; 1955 /** 1956 * 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. 1957 */ 1958 ExpirationTime?: Timestamp; 1959 /** 1960 * 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. 1961 */ 1962 State?: EventSourceState; 1963 } 1964 export type PartnerEventSourceAccountList = PartnerEventSourceAccount[]; 1965 export type PartnerEventSourceList = PartnerEventSource[]; 1966 export type PartnerEventSourceNamePrefix = string; 1967 export type PathParameter = string; 1968 export type PathParameterList = PathParameter[]; 1969 export interface PlacementConstraint { 1970 /** 1971 * 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. 1972 */ 1973 type?: PlacementConstraintType; 1974 /** 1975 * 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. 1976 */ 1977 expression?: PlacementConstraintExpression; 1978 } 1979 export type PlacementConstraintExpression = string; 1980 export type PlacementConstraintType = "distinctInstance"|"memberOf"|string; 1981 export type PlacementConstraints = PlacementConstraint[]; 1982 export type PlacementStrategies = PlacementStrategy[]; 1983 export interface PlacementStrategy { 1984 /** 1985 * 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). 1986 */ 1987 type?: PlacementStrategyType; 1988 /** 1989 * 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. 1990 */ 1991 field?: PlacementStrategyField; 1992 } 1993 export type PlacementStrategyField = string; 1994 export type PlacementStrategyType = "random"|"spread"|"binpack"|string; 1995 export type Principal = string; 1996 export type PropagateTags = "TASK_DEFINITION"|string; 1997 export interface PutEventsRequest { 1998 /** 1999 * 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. 2000 */ 2001 Entries: PutEventsRequestEntryList; 2002 } 2003 export interface PutEventsRequestEntry { 2004 /** 2005 * The time stamp of the event, per RFC3339. If no time stamp is provided, the time stamp of the PutEvents call is used. 2006 */ 2007 Time?: EventTime; 2008 /** 2009 * The source of the event. 2010 */ 2011 Source?: String; 2012 /** 2013 * Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily concerns. Any number, including zero, may be present. 2014 */ 2015 Resources?: EventResourceList; 2016 /** 2017 * Free-form string used to decide what fields to expect in the event detail. 2018 */ 2019 DetailType?: String; 2020 /** 2021 * A valid JSON string. There is no other schema imposed. The JSON string may contain fields and nested subobjects. 2022 */ 2023 Detail?: String; 2024 /** 2025 * 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. 2026 */ 2027 EventBusName?: NonPartnerEventBusNameOrArn; 2028 /** 2029 * An X-Ray trade header, which is an http header (X-Amzn-Trace-Id) that contains the trace-id associated with the event. To learn more about X-Ray trace headers, see Tracing header in the X-Ray Developer Guide. 2030 */ 2031 TraceHeader?: TraceHeader; 2032 } 2033 export type PutEventsRequestEntryList = PutEventsRequestEntry[]; 2034 export interface PutEventsResponse { 2035 /** 2036 * The number of failed entries. 2037 */ 2038 FailedEntryCount?: Integer; 2039 /** 2040 * 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. 2041 */ 2042 Entries?: PutEventsResultEntryList; 2043 } 2044 export interface PutEventsResultEntry { 2045 /** 2046 * The ID of the event. 2047 */ 2048 EventId?: EventId; 2049 /** 2050 * The error code that indicates why the event submission failed. 2051 */ 2052 ErrorCode?: ErrorCode; 2053 /** 2054 * The error message that explains why the event submission failed. 2055 */ 2056 ErrorMessage?: ErrorMessage; 2057 } 2058 export type PutEventsResultEntryList = PutEventsResultEntry[]; 2059 export interface PutPartnerEventsRequest { 2060 /** 2061 * The list of events to write to the event bus. 2062 */ 2063 Entries: PutPartnerEventsRequestEntryList; 2064 } 2065 export interface PutPartnerEventsRequestEntry { 2066 /** 2067 * The date and time of the event. 2068 */ 2069 Time?: EventTime; 2070 /** 2071 * The event source that is generating the entry. 2072 */ 2073 Source?: EventSourceName; 2074 /** 2075 * Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily concerns. Any number, including zero, may be present. 2076 */ 2077 Resources?: EventResourceList; 2078 /** 2079 * A free-form string used to decide what fields to expect in the event detail. 2080 */ 2081 DetailType?: String; 2082 /** 2083 * A valid JSON string. There is no other schema imposed. The JSON string may contain fields and nested subobjects. 2084 */ 2085 Detail?: String; 2086 } 2087 export type PutPartnerEventsRequestEntryList = PutPartnerEventsRequestEntry[]; 2088 export interface PutPartnerEventsResponse { 2089 /** 2090 * The number of events from this operation that could not be written to the partner event bus. 2091 */ 2092 FailedEntryCount?: Integer; 2093 /** 2094 * The list of events from this operation that were successfully written to the partner event bus. 2095 */ 2096 Entries?: PutPartnerEventsResultEntryList; 2097 } 2098 export interface PutPartnerEventsResultEntry { 2099 /** 2100 * The ID of the event. 2101 */ 2102 EventId?: EventId; 2103 /** 2104 * The error code that indicates why the event submission failed. 2105 */ 2106 ErrorCode?: ErrorCode; 2107 /** 2108 * The error message that explains why the event submission failed. 2109 */ 2110 ErrorMessage?: ErrorMessage; 2111 } 2112 export type PutPartnerEventsResultEntryList = PutPartnerEventsResultEntry[]; 2113 export interface PutPermissionRequest { 2114 /** 2115 * The name of the event bus associated with the rule. If you omit this, the default event bus is used. 2116 */ 2117 EventBusName?: NonPartnerEventBusName; 2118 /** 2119 * The action that you are enabling the other account to perform. 2120 */ 2121 Action?: Action; 2122 /** 2123 * 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. 2124 */ 2125 Principal?: Principal; 2126 /** 2127 * 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. 2128 */ 2129 StatementId?: StatementId; 2130 /** 2131 * 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. 2132 */ 2133 Condition?: Condition; 2134 /** 2135 * 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. 2136 */ 2137 Policy?: String; 2138 } 2139 export interface PutRuleRequest { 2140 /** 2141 * The name of the rule that you are creating or updating. 2142 */ 2143 Name: RuleName; 2144 /** 2145 * The scheduling expression. For example, "cron(0 20 * * ? *)" or "rate(5 minutes)". 2146 */ 2147 ScheduleExpression?: ScheduleExpression; 2148 /** 2149 * The event pattern. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide. 2150 */ 2151 EventPattern?: EventPattern; 2152 /** 2153 * Indicates whether the rule is enabled or disabled. 2154 */ 2155 State?: RuleState; 2156 /** 2157 * A description of the rule. 2158 */ 2159 Description?: RuleDescription; 2160 /** 2161 * 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. 2162 */ 2163 RoleArn?: RoleArn; 2164 /** 2165 * The list of key-value pairs to associate with the rule. 2166 */ 2167 Tags?: TagList; 2168 /** 2169 * The name or ARN of the event bus to associate with this rule. If you omit this, the default event bus is used. 2170 */ 2171 EventBusName?: EventBusNameOrArn; 2172 } 2173 export interface PutRuleResponse { 2174 /** 2175 * The Amazon Resource Name (ARN) of the rule. 2176 */ 2177 RuleArn?: RuleArn; 2178 } 2179 export interface PutTargetsRequest { 2180 /** 2181 * The name of the rule. 2182 */ 2183 Rule: RuleName; 2184 /** 2185 * The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used. 2186 */ 2187 EventBusName?: EventBusNameOrArn; 2188 /** 2189 * The targets to update or add to the rule. 2190 */ 2191 Targets: TargetList; 2192 } 2193 export interface PutTargetsResponse { 2194 /** 2195 * The number of failed entries. 2196 */ 2197 FailedEntryCount?: Integer; 2198 /** 2199 * The failed target entries. 2200 */ 2201 FailedEntries?: PutTargetsResultEntryList; 2202 } 2203 export interface PutTargetsResultEntry { 2204 /** 2205 * The ID of the target. 2206 */ 2207 TargetId?: TargetId; 2208 /** 2209 * The error code that indicates why the target addition failed. If the value is ConcurrentModificationException, too many requests were made at the same time. 2210 */ 2211 ErrorCode?: ErrorCode; 2212 /** 2213 * The error message that explains why the target addition failed. 2214 */ 2215 ErrorMessage?: ErrorMessage; 2216 } 2217 export type PutTargetsResultEntryList = PutTargetsResultEntry[]; 2218 export type QueryStringKey = string; 2219 export type QueryStringParametersMap = {[key: string]: QueryStringValue}; 2220 export type QueryStringValue = string; 2221 export interface RedshiftDataParameters { 2222 /** 2223 * The name or ARN of the secret that enables access to the database. Required when authenticating using Amazon Web Services Secrets Manager. 2224 */ 2225 SecretManagerArn?: RedshiftSecretManagerArn; 2226 /** 2227 * The name of the database. Required when authenticating using temporary credentials. 2228 */ 2229 Database: Database; 2230 /** 2231 * The database user name. Required when authenticating using temporary credentials. 2232 */ 2233 DbUser?: DbUser; 2234 /** 2235 * The SQL statement text to run. 2236 */ 2237 Sql: Sql; 2238 /** 2239 * The name of the SQL statement. You can name the SQL statement when you create it to identify the query. 2240 */ 2241 StatementName?: StatementName; 2242 /** 2243 * Indicates whether to send an event back to EventBridge after the SQL statement runs. 2244 */ 2245 WithEvent?: Boolean; 2246 } 2247 export type RedshiftSecretManagerArn = string; 2248 export type ReferenceId = string; 2249 export interface RemovePermissionRequest { 2250 /** 2251 * The statement ID corresponding to the account that is no longer allowed to put events to the default event bus. 2252 */ 2253 StatementId?: StatementId; 2254 /** 2255 * Specifies whether to remove all permissions. 2256 */ 2257 RemoveAllPermissions?: Boolean; 2258 /** 2259 * The name of the event bus to revoke permissions for. If you omit this, the default event bus is used. 2260 */ 2261 EventBusName?: NonPartnerEventBusName; 2262 } 2263 export interface RemoveTargetsRequest { 2264 /** 2265 * The name of the rule. 2266 */ 2267 Rule: RuleName; 2268 /** 2269 * The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used. 2270 */ 2271 EventBusName?: EventBusNameOrArn; 2272 /** 2273 * The IDs of the targets to remove from the rule. 2274 */ 2275 Ids: TargetIdList; 2276 /** 2277 * 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. 2278 */ 2279 Force?: Boolean; 2280 } 2281 export interface RemoveTargetsResponse { 2282 /** 2283 * The number of failed entries. 2284 */ 2285 FailedEntryCount?: Integer; 2286 /** 2287 * The failed target entries. 2288 */ 2289 FailedEntries?: RemoveTargetsResultEntryList; 2290 } 2291 export interface RemoveTargetsResultEntry { 2292 /** 2293 * The ID of the target. 2294 */ 2295 TargetId?: TargetId; 2296 /** 2297 * The error code that indicates why the target removal failed. If the value is ConcurrentModificationException, too many requests were made at the same time. 2298 */ 2299 ErrorCode?: ErrorCode; 2300 /** 2301 * The error message that explains why the target removal failed. 2302 */ 2303 ErrorMessage?: ErrorMessage; 2304 } 2305 export type RemoveTargetsResultEntryList = RemoveTargetsResultEntry[]; 2306 export interface Replay { 2307 /** 2308 * The name of the replay. 2309 */ 2310 ReplayName?: ReplayName; 2311 /** 2312 * The ARN of the archive to replay event from. 2313 */ 2314 EventSourceArn?: Arn; 2315 /** 2316 * The current state of the replay. 2317 */ 2318 State?: ReplayState; 2319 /** 2320 * A description of why the replay is in the current state. 2321 */ 2322 StateReason?: ReplayStateReason; 2323 /** 2324 * A time stamp for the time to start replaying events. This is determined by the time in the event as described in Time. 2325 */ 2326 EventStartTime?: Timestamp; 2327 /** 2328 * A time stamp for the time to start replaying events. Any event with a creation time prior to the EventEndTime specified is replayed. 2329 */ 2330 EventEndTime?: Timestamp; 2331 /** 2332 * A time stamp for the time that the last event was replayed. 2333 */ 2334 EventLastReplayedTime?: Timestamp; 2335 /** 2336 * A time stamp for the time that the replay started. 2337 */ 2338 ReplayStartTime?: Timestamp; 2339 /** 2340 * A time stamp for the time that the replay completed. 2341 */ 2342 ReplayEndTime?: Timestamp; 2343 } 2344 export type ReplayArn = string; 2345 export type ReplayDescription = string; 2346 export interface ReplayDestination { 2347 /** 2348 * The ARN of the event bus to replay event to. You can replay events only to the event bus specified to create the archive. 2349 */ 2350 Arn: Arn; 2351 /** 2352 * A list of ARNs for rules to replay events to. 2353 */ 2354 FilterArns?: ReplayDestinationFilters; 2355 } 2356 export type ReplayDestinationFilters = Arn[]; 2357 export type ReplayList = Replay[]; 2358 export type ReplayName = string; 2359 export type ReplayState = "STARTING"|"RUNNING"|"CANCELLING"|"COMPLETED"|"CANCELLED"|"FAILED"|string; 2360 export type ReplayStateReason = string; 2361 export type ResourceArn = string; 2362 export type RetentionDays = number; 2363 export interface RetryPolicy { 2364 /** 2365 * 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. 2366 */ 2367 MaximumRetryAttempts?: MaximumRetryAttempts; 2368 /** 2369 * The maximum amount of time, in seconds, to continue to make retry attempts. 2370 */ 2371 MaximumEventAgeInSeconds?: MaximumEventAgeInSeconds; 2372 } 2373 export type RoleArn = string; 2374 export interface Rule { 2375 /** 2376 * The name of the rule. 2377 */ 2378 Name?: RuleName; 2379 /** 2380 * The Amazon Resource Name (ARN) of the rule. 2381 */ 2382 Arn?: RuleArn; 2383 /** 2384 * The event pattern of the rule. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide. 2385 */ 2386 EventPattern?: EventPattern; 2387 /** 2388 * The state of the rule. 2389 */ 2390 State?: RuleState; 2391 /** 2392 * The description of the rule. 2393 */ 2394 Description?: RuleDescription; 2395 /** 2396 * 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. 2397 */ 2398 ScheduleExpression?: ScheduleExpression; 2399 /** 2400 * 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. 2401 */ 2402 RoleArn?: RoleArn; 2403 /** 2404 * 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. 2405 */ 2406 ManagedBy?: ManagedBy; 2407 /** 2408 * The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used. 2409 */ 2410 EventBusName?: EventBusName; 2411 } 2412 export type RuleArn = string; 2413 export type RuleDescription = string; 2414 export type RuleName = string; 2415 export type RuleNameList = RuleName[]; 2416 export type RuleResponseList = Rule[]; 2417 export type RuleState = "ENABLED"|"DISABLED"|string; 2418 export interface RunCommandParameters { 2419 /** 2420 * Currently, we support including only one RunCommandTarget block, which specifies either an array of InstanceIds or a tag. 2421 */ 2422 RunCommandTargets: RunCommandTargets; 2423 } 2424 export interface RunCommandTarget { 2425 /** 2426 * Can be either tag: tag-key or InstanceIds. 2427 */ 2428 Key: RunCommandTargetKey; 2429 /** 2430 * 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. 2431 */ 2432 Values: RunCommandTargetValues; 2433 } 2434 export type RunCommandTargetKey = string; 2435 export type RunCommandTargetValue = string; 2436 export type RunCommandTargetValues = RunCommandTargetValue[]; 2437 export type RunCommandTargets = RunCommandTarget[]; 2438 export interface SageMakerPipelineParameter { 2439 /** 2440 * Name of parameter to start execution of a SageMaker Model Building Pipeline. 2441 */ 2442 Name: SageMakerPipelineParameterName; 2443 /** 2444 * Value of parameter to start execution of a SageMaker Model Building Pipeline. 2445 */ 2446 Value: SageMakerPipelineParameterValue; 2447 } 2448 export type SageMakerPipelineParameterList = SageMakerPipelineParameter[]; 2449 export type SageMakerPipelineParameterName = string; 2450 export type SageMakerPipelineParameterValue = string; 2451 export interface SageMakerPipelineParameters { 2452 /** 2453 * List of Parameter names and values for SageMaker Model Building Pipeline execution. 2454 */ 2455 PipelineParameterList?: SageMakerPipelineParameterList; 2456 } 2457 export type ScheduleExpression = string; 2458 export type SecretsManagerSecretArn = string; 2459 export type Sql = string; 2460 export interface SqsParameters { 2461 /** 2462 * The FIFO message group ID to use as the target. 2463 */ 2464 MessageGroupId?: MessageGroupId; 2465 } 2466 export interface StartReplayRequest { 2467 /** 2468 * The name of the replay to start. 2469 */ 2470 ReplayName: ReplayName; 2471 /** 2472 * A description for the replay to start. 2473 */ 2474 Description?: ReplayDescription; 2475 /** 2476 * The ARN of the archive to replay events from. 2477 */ 2478 EventSourceArn: Arn; 2479 /** 2480 * A time stamp for the time to start replaying events. Only events that occurred between the EventStartTime and EventEndTime are replayed. 2481 */ 2482 EventStartTime: Timestamp; 2483 /** 2484 * A time stamp for the time to stop replaying events. Only events that occurred between the EventStartTime and EventEndTime are replayed. 2485 */ 2486 EventEndTime: Timestamp; 2487 /** 2488 * A ReplayDestination object that includes details about the destination for the replay. 2489 */ 2490 Destination: ReplayDestination; 2491 } 2492 export interface StartReplayResponse { 2493 /** 2494 * The ARN of the replay. 2495 */ 2496 ReplayArn?: ReplayArn; 2497 /** 2498 * The state of the replay. 2499 */ 2500 State?: ReplayState; 2501 /** 2502 * The reason that the replay is in the state. 2503 */ 2504 StateReason?: ReplayStateReason; 2505 /** 2506 * The time at which the replay started. 2507 */ 2508 ReplayStartTime?: Timestamp; 2509 } 2510 export type StatementId = string; 2511 export type StatementName = string; 2512 export type String = string; 2513 export type StringList = String[]; 2514 export interface Tag { 2515 /** 2516 * A string you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources. 2517 */ 2518 Key: TagKey; 2519 /** 2520 * The value for the specified tag key. 2521 */ 2522 Value: TagValue; 2523 } 2524 export type TagKey = string; 2525 export type TagKeyList = TagKey[]; 2526 export type TagList = Tag[]; 2527 export interface TagResourceRequest { 2528 /** 2529 * The ARN of the EventBridge resource that you're adding tags to. 2530 */ 2531 ResourceARN: Arn; 2532 /** 2533 * The list of key-value pairs to associate with the resource. 2534 */ 2535 Tags: TagList; 2536 } 2537 export interface TagResourceResponse { 2538 } 2539 export type TagValue = string; 2540 export interface Target { 2541 /** 2542 * The ID of the target. We recommend using a memorable and unique string. 2543 */ 2544 Id: TargetId; 2545 /** 2546 * The Amazon Resource Name (ARN) of the target. 2547 */ 2548 Arn: TargetArn; 2549 /** 2550 * 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. 2551 */ 2552 RoleArn?: RoleArn; 2553 /** 2554 * 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. 2555 */ 2556 Input?: TargetInput; 2557 /** 2558 * 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. 2559 */ 2560 InputPath?: TargetInputPath; 2561 /** 2562 * 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. 2563 */ 2564 InputTransformer?: InputTransformer; 2565 /** 2566 * 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. 2567 */ 2568 KinesisParameters?: KinesisParameters; 2569 /** 2570 * Parameters used when you are using the rule to invoke Amazon EC2 Run Command. 2571 */ 2572 RunCommandParameters?: RunCommandParameters; 2573 /** 2574 * 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. 2575 */ 2576 EcsParameters?: EcsParameters; 2577 /** 2578 * 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. 2579 */ 2580 BatchParameters?: BatchParameters; 2581 /** 2582 * 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. 2583 */ 2584 SqsParameters?: SqsParameters; 2585 /** 2586 * 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. 2587 */ 2588 HttpParameters?: HttpParameters; 2589 /** 2590 * 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. 2591 */ 2592 RedshiftDataParameters?: RedshiftDataParameters; 2593 /** 2594 * 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. 2595 */ 2596 SageMakerPipelineParameters?: SageMakerPipelineParameters; 2597 /** 2598 * The DeadLetterConfig that defines the target queue to send dead-letter queue events to. 2599 */ 2600 DeadLetterConfig?: DeadLetterConfig; 2601 /** 2602 * The RetryPolicy object that contains the retry policy configuration to use for the dead-letter queue. 2603 */ 2604 RetryPolicy?: RetryPolicy; 2605 } 2606 export type TargetArn = string; 2607 export type TargetId = string; 2608 export type TargetIdList = TargetId[]; 2609 export type TargetInput = string; 2610 export type TargetInputPath = string; 2611 export type TargetList = Target[]; 2612 export type TargetPartitionKeyPath = string; 2613 export interface TestEventPatternRequest { 2614 /** 2615 * The event pattern. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide. 2616 */ 2617 EventPattern: EventPattern; 2618 /** 2619 * 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 2620 */ 2621 Event: String; 2622 } 2623 export interface TestEventPatternResponse { 2624 /** 2625 * Indicates whether the event matches the event pattern. 2626 */ 2627 Result?: Boolean; 2628 } 2629 export type Timestamp = Date; 2630 export type TraceHeader = string; 2631 export type TransformerInput = string; 2632 export type TransformerPaths = {[key: string]: TargetInputPath}; 2633 export interface UntagResourceRequest { 2634 /** 2635 * The ARN of the EventBridge resource from which you are removing tags. 2636 */ 2637 ResourceARN: Arn; 2638 /** 2639 * The list of tag keys to remove from the resource. 2640 */ 2641 TagKeys: TagKeyList; 2642 } 2643 export interface UntagResourceResponse { 2644 } 2645 export interface UpdateApiDestinationRequest { 2646 /** 2647 * The name of the API destination to update. 2648 */ 2649 Name: ApiDestinationName; 2650 /** 2651 * The name of the API destination to update. 2652 */ 2653 Description?: ApiDestinationDescription; 2654 /** 2655 * The ARN of the connection to use for the API destination. 2656 */ 2657 ConnectionArn?: ConnectionArn; 2658 /** 2659 * The URL to the endpoint to use for the API destination. 2660 */ 2661 InvocationEndpoint?: HttpsEndpoint; 2662 /** 2663 * The method to use for the API destination. 2664 */ 2665 HttpMethod?: ApiDestinationHttpMethod; 2666 /** 2667 * The maximum number of invocations per second to send to the API destination. 2668 */ 2669 InvocationRateLimitPerSecond?: ApiDestinationInvocationRateLimitPerSecond; 2670 } 2671 export interface UpdateApiDestinationResponse { 2672 /** 2673 * The ARN of the API destination that was updated. 2674 */ 2675 ApiDestinationArn?: ApiDestinationArn; 2676 /** 2677 * The state of the API destination that was updated. 2678 */ 2679 ApiDestinationState?: ApiDestinationState; 2680 /** 2681 * A time stamp for the time that the API destination was created. 2682 */ 2683 CreationTime?: Timestamp; 2684 /** 2685 * A time stamp for the time that the API destination was last modified. 2686 */ 2687 LastModifiedTime?: Timestamp; 2688 } 2689 export interface UpdateArchiveRequest { 2690 /** 2691 * The name of the archive to update. 2692 */ 2693 ArchiveName: ArchiveName; 2694 /** 2695 * The description for the archive. 2696 */ 2697 Description?: ArchiveDescription; 2698 /** 2699 * The event pattern to use to filter events sent to the archive. 2700 */ 2701 EventPattern?: EventPattern; 2702 /** 2703 * The number of days to retain events in the archive. 2704 */ 2705 RetentionDays?: RetentionDays; 2706 } 2707 export interface UpdateArchiveResponse { 2708 /** 2709 * The ARN of the archive. 2710 */ 2711 ArchiveArn?: ArchiveArn; 2712 /** 2713 * The state of the archive. 2714 */ 2715 State?: ArchiveState; 2716 /** 2717 * The reason that the archive is in the current state. 2718 */ 2719 StateReason?: ArchiveStateReason; 2720 /** 2721 * The time at which the archive was updated. 2722 */ 2723 CreationTime?: Timestamp; 2724 } 2725 export interface UpdateConnectionApiKeyAuthRequestParameters { 2726 /** 2727 * The name of the API key to use for authorization. 2728 */ 2729 ApiKeyName?: AuthHeaderParameters; 2730 /** 2731 * The value associated with teh API key to use for authorization. 2732 */ 2733 ApiKeyValue?: AuthHeaderParameters; 2734 } 2735 export interface UpdateConnectionAuthRequestParameters { 2736 /** 2737 * A UpdateConnectionBasicAuthRequestParameters object that contains the authorization parameters for Basic authorization. 2738 */ 2739 BasicAuthParameters?: UpdateConnectionBasicAuthRequestParameters; 2740 /** 2741 * A UpdateConnectionOAuthRequestParameters object that contains the authorization parameters for OAuth authorization. 2742 */ 2743 OAuthParameters?: UpdateConnectionOAuthRequestParameters; 2744 /** 2745 * A UpdateConnectionApiKeyAuthRequestParameters object that contains the authorization parameters for API key authorization. 2746 */ 2747 ApiKeyAuthParameters?: UpdateConnectionApiKeyAuthRequestParameters; 2748 /** 2749 * A ConnectionHttpParameters object that contains the additional parameters to use for the connection. 2750 */ 2751 InvocationHttpParameters?: ConnectionHttpParameters; 2752 } 2753 export interface UpdateConnectionBasicAuthRequestParameters { 2754 /** 2755 * The user name to use for Basic authorization. 2756 */ 2757 Username?: AuthHeaderParameters; 2758 /** 2759 * The password associated with the user name to use for Basic authorization. 2760 */ 2761 Password?: AuthHeaderParameters; 2762 } 2763 export interface UpdateConnectionOAuthClientRequestParameters { 2764 /** 2765 * The client ID to use for OAuth authorization. 2766 */ 2767 ClientID?: AuthHeaderParameters; 2768 /** 2769 * The client secret assciated with the client ID to use for OAuth authorization. 2770 */ 2771 ClientSecret?: AuthHeaderParameters; 2772 } 2773 export interface UpdateConnectionOAuthRequestParameters { 2774 /** 2775 * A UpdateConnectionOAuthClientRequestParameters object that contains the client parameters to use for the connection when OAuth is specified as the authorization type. 2776 */ 2777 ClientParameters?: UpdateConnectionOAuthClientRequestParameters; 2778 /** 2779 * The URL to the authorization endpoint when OAuth is specified as the authorization type. 2780 */ 2781 AuthorizationEndpoint?: HttpsEndpoint; 2782 /** 2783 * The method used to connect to the HTTP endpoint. 2784 */ 2785 HttpMethod?: ConnectionOAuthHttpMethod; 2786 /** 2787 * The additional HTTP parameters used for the OAuth authorization request. 2788 */ 2789 OAuthHttpParameters?: ConnectionHttpParameters; 2790 } 2791 export interface UpdateConnectionRequest { 2792 /** 2793 * The name of the connection to update. 2794 */ 2795 Name: ConnectionName; 2796 /** 2797 * A description for the connection. 2798 */ 2799 Description?: ConnectionDescription; 2800 /** 2801 * The type of authorization to use for the connection. 2802 */ 2803 AuthorizationType?: ConnectionAuthorizationType; 2804 /** 2805 * The authorization parameters to use for the connection. 2806 */ 2807 AuthParameters?: UpdateConnectionAuthRequestParameters; 2808 } 2809 export interface UpdateConnectionResponse { 2810 /** 2811 * The ARN of the connection that was updated. 2812 */ 2813 ConnectionArn?: ConnectionArn; 2814 /** 2815 * The state of the connection that was updated. 2816 */ 2817 ConnectionState?: ConnectionState; 2818 /** 2819 * A time stamp for the time that the connection was created. 2820 */ 2821 CreationTime?: Timestamp; 2822 /** 2823 * A time stamp for the time that the connection was last modified. 2824 */ 2825 LastModifiedTime?: Timestamp; 2826 /** 2827 * A time stamp for the time that the connection was last authorized. 2828 */ 2829 LastAuthorizedTime?: Timestamp; 2830 } 2831 /** 2832 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. 2833 */ 2834 export type apiVersion = "2015-10-07"|"latest"|string; 2835 export interface ClientApiVersions { 2836 /** 2837 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. 2838 */ 2839 apiVersion?: apiVersion; 2840 } 2841 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; 2842 /** 2843 * Contains interfaces for use with the EventBridge client. 2844 */ 2845 export import Types = EventBridge; 2846 } 2847 export = EventBridge;