@aws-sdk/client-eventbridge 3.572.0 → 3.575.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +17 -9
- package/dist-cjs/index.js +76 -3
- package/dist-es/EventBridge.js +2 -0
- package/dist-es/commands/UpdateEventBusCommand.js +24 -0
- package/dist-es/commands/index.js +1 -0
- package/dist-es/protocols/Aws_json1_1.js +57 -2
- package/dist-types/EventBridge.d.ts +17 -9
- package/dist-types/EventBridgeClient.d.ts +12 -11
- package/dist-types/commands/CreateApiDestinationCommand.d.ts +4 -2
- package/dist-types/commands/CreateArchiveCommand.d.ts +23 -0
- package/dist-types/commands/CreateEndpointCommand.d.ts +6 -3
- package/dist-types/commands/CreateEventBusCommand.d.ts +10 -0
- package/dist-types/commands/CreatePartnerEventSourceCommand.d.ts +16 -14
- package/dist-types/commands/DeleteEndpointCommand.d.ts +5 -1
- package/dist-types/commands/DeletePartnerEventSourceCommand.d.ts +1 -1
- package/dist-types/commands/DeleteRuleCommand.d.ts +7 -6
- package/dist-types/commands/DescribeEndpointCommand.d.ts +6 -1
- package/dist-types/commands/DescribeEventBusCommand.d.ts +10 -4
- package/dist-types/commands/DescribePartnerEventSourceCommand.d.ts +2 -3
- package/dist-types/commands/DisableRuleCommand.d.ts +2 -2
- package/dist-types/commands/EnableRuleCommand.d.ts +2 -2
- package/dist-types/commands/ListEndpointsCommand.d.ts +6 -1
- package/dist-types/commands/ListEventBusesCommand.d.ts +3 -0
- package/dist-types/commands/ListEventSourcesCommand.d.ts +2 -2
- package/dist-types/commands/ListPartnerEventSourceAccountsCommand.d.ts +2 -3
- package/dist-types/commands/ListRulesCommand.d.ts +2 -2
- package/dist-types/commands/PutEventsCommand.d.ts +9 -6
- package/dist-types/commands/PutPartnerEventsCommand.d.ts +3 -5
- package/dist-types/commands/PutPermissionCommand.d.ts +9 -9
- package/dist-types/commands/PutRuleCommand.d.ts +10 -11
- package/dist-types/commands/PutTargetsCommand.d.ts +28 -28
- package/dist-types/commands/RemovePermissionCommand.d.ts +4 -4
- package/dist-types/commands/RemoveTargetsCommand.d.ts +4 -3
- package/dist-types/commands/TagResourceCommand.d.ts +4 -4
- package/dist-types/commands/TestEventPatternCommand.d.ts +4 -4
- package/dist-types/commands/UntagResourceCommand.d.ts +2 -2
- package/dist-types/commands/UpdateEndpointCommand.d.ts +5 -1
- package/dist-types/commands/UpdateEventBusCommand.d.ts +82 -0
- package/dist-types/commands/index.d.ts +1 -0
- package/dist-types/index.d.ts +9 -9
- package/dist-types/models/models_0.d.ts +524 -200
- package/dist-types/protocols/Aws_json1_1.d.ts +9 -0
- package/dist-types/ts3.4/EventBridge.d.ts +18 -0
- package/dist-types/ts3.4/EventBridgeClient.d.ts +8 -2
- package/dist-types/ts3.4/commands/UpdateEventBusCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +30 -3
- package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +12 -0
- package/package.json +40 -40
|
@@ -151,12 +151,14 @@ export interface ApiDestination {
|
|
|
151
151
|
LastModifiedTime?: Date;
|
|
152
152
|
}
|
|
153
153
|
/**
|
|
154
|
-
* <p>Contains the GraphQL operation to be parsed and executed, if the event target is an
|
|
154
|
+
* <p>Contains the GraphQL operation to be parsed and executed, if the event target is an
|
|
155
|
+
* AppSync API.</p>
|
|
155
156
|
* @public
|
|
156
157
|
*/
|
|
157
158
|
export interface AppSyncParameters {
|
|
158
159
|
/**
|
|
159
|
-
* <p>The GraphQL operation; that is, the query, mutation, or subscription to be parsed and
|
|
160
|
+
* <p>The GraphQL operation; that is, the query, mutation, or subscription to be parsed and
|
|
161
|
+
* executed by the GraphQL service.</p>
|
|
160
162
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/appsync/latest/devguide/graphql-architecture.html#graphql-operations">Operations</a> in the <i>AppSync User Guide</i>.</p>
|
|
161
163
|
* @public
|
|
162
164
|
*/
|
|
@@ -785,13 +787,15 @@ export interface ReplicationConfig {
|
|
|
785
787
|
*/
|
|
786
788
|
export interface Primary {
|
|
787
789
|
/**
|
|
788
|
-
* <p>The ARN of the health check used by the endpoint to determine whether failover is
|
|
790
|
+
* <p>The ARN of the health check used by the endpoint to determine whether failover is
|
|
791
|
+
* triggered.</p>
|
|
789
792
|
* @public
|
|
790
793
|
*/
|
|
791
794
|
HealthCheck: string | undefined;
|
|
792
795
|
}
|
|
793
796
|
/**
|
|
794
|
-
* <p>The secondary Region that processes events when failover is triggered or replication is
|
|
797
|
+
* <p>The secondary Region that processes events when failover is triggered or replication is
|
|
798
|
+
* enabled.</p>
|
|
795
799
|
* @public
|
|
796
800
|
*/
|
|
797
801
|
export interface Secondary {
|
|
@@ -802,7 +806,8 @@ export interface Secondary {
|
|
|
802
806
|
Route: string | undefined;
|
|
803
807
|
}
|
|
804
808
|
/**
|
|
805
|
-
* <p>The failover configuration for an endpoint. This includes what triggers failover and what
|
|
809
|
+
* <p>The failover configuration for an endpoint. This includes what triggers failover and what
|
|
810
|
+
* happens when it's triggered.</p>
|
|
806
811
|
* @public
|
|
807
812
|
*/
|
|
808
813
|
export interface FailoverConfig {
|
|
@@ -812,7 +817,8 @@ export interface FailoverConfig {
|
|
|
812
817
|
*/
|
|
813
818
|
Primary: Primary | undefined;
|
|
814
819
|
/**
|
|
815
|
-
* <p>The Region that events are routed to when failover is triggered or event replication is
|
|
820
|
+
* <p>The Region that events are routed to when failover is triggered or event replication is
|
|
821
|
+
* enabled.</p>
|
|
816
822
|
* @public
|
|
817
823
|
*/
|
|
818
824
|
Secondary: Secondary | undefined;
|
|
@@ -823,7 +829,8 @@ export interface FailoverConfig {
|
|
|
823
829
|
*/
|
|
824
830
|
export interface RoutingConfig {
|
|
825
831
|
/**
|
|
826
|
-
* <p>The failover configuration for an endpoint. This includes what triggers failover and what
|
|
832
|
+
* <p>The failover configuration for an endpoint. This includes what triggers failover and what
|
|
833
|
+
* happens when it's triggered.</p>
|
|
827
834
|
* @public
|
|
828
835
|
*/
|
|
829
836
|
FailoverConfig: FailoverConfig | undefined;
|
|
@@ -833,7 +840,8 @@ export interface RoutingConfig {
|
|
|
833
840
|
*/
|
|
834
841
|
export interface CreateEndpointRequest {
|
|
835
842
|
/**
|
|
836
|
-
* <p>The name of the global endpoint. For example,
|
|
843
|
+
* <p>The name of the global endpoint. For example,
|
|
844
|
+
* <code>"Name":"us-east-2-custom_bus_A-endpoint"</code>.</p>
|
|
837
845
|
* @public
|
|
838
846
|
*/
|
|
839
847
|
Name: string | undefined;
|
|
@@ -848,8 +856,9 @@ export interface CreateEndpointRequest {
|
|
|
848
856
|
*/
|
|
849
857
|
RoutingConfig: RoutingConfig | undefined;
|
|
850
858
|
/**
|
|
851
|
-
* <p>Enable or disable event replication. The default state is <code>ENABLED</code> which means
|
|
852
|
-
* <code>RoleArn</code
|
|
859
|
+
* <p>Enable or disable event replication. The default state is <code>ENABLED</code> which means
|
|
860
|
+
* you must supply a <code>RoleArn</code>. If you don't have a <code>RoleArn</code> or you don't
|
|
861
|
+
* want event replication enabled, set the state to <code>DISABLED</code>.</p>
|
|
853
862
|
* @public
|
|
854
863
|
*/
|
|
855
864
|
ReplicationConfig?: ReplicationConfig;
|
|
@@ -925,8 +934,23 @@ export interface CreateEndpointResponse {
|
|
|
925
934
|
State?: EndpointState;
|
|
926
935
|
}
|
|
927
936
|
/**
|
|
928
|
-
* <p>
|
|
929
|
-
*
|
|
937
|
+
* <p>Configuration details of the Amazon SQS queue for EventBridge to use as a
|
|
938
|
+
* dead-letter queue (DLQ).</p>
|
|
939
|
+
* <p>For more information, see <a href="eventbridge/latest/userguide/eb-rule-dlq.html">Event
|
|
940
|
+
* retry policy and using dead-letter queues</a> in the <i>EventBridge User
|
|
941
|
+
* Guide</i>.</p>
|
|
942
|
+
* @public
|
|
943
|
+
*/
|
|
944
|
+
export interface DeadLetterConfig {
|
|
945
|
+
/**
|
|
946
|
+
* <p>The ARN of the SQS queue specified as the target for the dead-letter queue.</p>
|
|
947
|
+
* @public
|
|
948
|
+
*/
|
|
949
|
+
Arn?: string;
|
|
950
|
+
}
|
|
951
|
+
/**
|
|
952
|
+
* <p>A key-value pair associated with an Amazon Web Services resource. In EventBridge,
|
|
953
|
+
* rules and event buses support tagging.</p>
|
|
930
954
|
* @public
|
|
931
955
|
*/
|
|
932
956
|
export interface Tag {
|
|
@@ -948,10 +972,12 @@ export interface Tag {
|
|
|
948
972
|
export interface CreateEventBusRequest {
|
|
949
973
|
/**
|
|
950
974
|
* <p>The name of the new event bus. </p>
|
|
951
|
-
* <p>Custom event bus names can't contain the <code>/</code> character, but you can use the
|
|
952
|
-
*
|
|
953
|
-
*
|
|
954
|
-
*
|
|
975
|
+
* <p>Custom event bus names can't contain the <code>/</code> character, but you can use the
|
|
976
|
+
* <code>/</code> character in partner event bus names. In addition, for partner event buses,
|
|
977
|
+
* the name must exactly match the name of the partner event source that this event bus is
|
|
978
|
+
* matched to.</p>
|
|
979
|
+
* <p>You can't use the name <code>default</code> for a custom event bus, as this name is
|
|
980
|
+
* already used for your account's default event bus.</p>
|
|
955
981
|
* @public
|
|
956
982
|
*/
|
|
957
983
|
Name: string | undefined;
|
|
@@ -961,6 +987,54 @@ export interface CreateEventBusRequest {
|
|
|
961
987
|
* @public
|
|
962
988
|
*/
|
|
963
989
|
EventSourceName?: string;
|
|
990
|
+
/**
|
|
991
|
+
* <p>The event bus description.</p>
|
|
992
|
+
* @public
|
|
993
|
+
*/
|
|
994
|
+
Description?: string;
|
|
995
|
+
/**
|
|
996
|
+
* <p>The identifier of the KMS
|
|
997
|
+
* customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt events on this event bus. The identifier can be the key
|
|
998
|
+
* Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.</p>
|
|
999
|
+
* <p>If you do not specify a customer managed key identifier, EventBridge uses an
|
|
1000
|
+
* Amazon Web Services owned key to encrypt events on the event bus.</p>
|
|
1001
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/getting-started.html">Managing keys</a> in the <i>Key Management Service
|
|
1002
|
+
* Developer Guide</i>. </p>
|
|
1003
|
+
* <note>
|
|
1004
|
+
* <p>Archives and schema discovery are not supported for event buses encrypted using a
|
|
1005
|
+
* customer managed key. EventBridge returns an error if:</p>
|
|
1006
|
+
* <ul>
|
|
1007
|
+
* <li>
|
|
1008
|
+
* <p>You call <code>
|
|
1009
|
+
* <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_CreateArchive.html">CreateArchive</a>
|
|
1010
|
+
* </code> on an event bus set to use a customer managed key for encryption.</p>
|
|
1011
|
+
* </li>
|
|
1012
|
+
* <li>
|
|
1013
|
+
* <p>You call <code>
|
|
1014
|
+
* <a href="https://docs.aws.amazon.com/eventbridge/latest/schema-reference/v1-discoverers.html#CreateDiscoverer">CreateDiscoverer</a>
|
|
1015
|
+
* </code> on an event bus set to use a customer managed key for encryption.</p>
|
|
1016
|
+
* </li>
|
|
1017
|
+
* <li>
|
|
1018
|
+
* <p>You call <code>
|
|
1019
|
+
* <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_UpdatedEventBus.html">UpdatedEventBus</a>
|
|
1020
|
+
* </code> to set a customer managed key on an event bus with an archives or schema discovery enabled.</p>
|
|
1021
|
+
* </li>
|
|
1022
|
+
* </ul>
|
|
1023
|
+
* <p>To enable archives or schema discovery on an event bus, choose to
|
|
1024
|
+
* use an Amazon Web Services owned key. For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-encryption.html">Data encryption in EventBridge</a> in the <i>Amazon EventBridge User Guide</i>.</p>
|
|
1025
|
+
* </note>
|
|
1026
|
+
* @public
|
|
1027
|
+
*/
|
|
1028
|
+
KmsKeyIdentifier?: string;
|
|
1029
|
+
/**
|
|
1030
|
+
* <p>Configuration details of the Amazon SQS queue for EventBridge to use as a
|
|
1031
|
+
* dead-letter queue (DLQ).</p>
|
|
1032
|
+
* <p>For more information, see <a href="eventbridge/latest/userguide/eb-rule-dlq.html">Event
|
|
1033
|
+
* retry policy and using dead-letter queues</a> in the <i>EventBridge User
|
|
1034
|
+
* Guide</i>.</p>
|
|
1035
|
+
* @public
|
|
1036
|
+
*/
|
|
1037
|
+
DeadLetterConfig?: DeadLetterConfig;
|
|
964
1038
|
/**
|
|
965
1039
|
* <p>Tags to associate with the event bus.</p>
|
|
966
1040
|
* @public
|
|
@@ -976,6 +1050,27 @@ export interface CreateEventBusResponse {
|
|
|
976
1050
|
* @public
|
|
977
1051
|
*/
|
|
978
1052
|
EventBusArn?: string;
|
|
1053
|
+
/**
|
|
1054
|
+
* <p>The event bus description.</p>
|
|
1055
|
+
* @public
|
|
1056
|
+
*/
|
|
1057
|
+
Description?: string;
|
|
1058
|
+
/**
|
|
1059
|
+
* <p>The identifier of the KMS
|
|
1060
|
+
* customer managed key for EventBridge to use to encrypt events on this event bus, if one has been specified.</p>
|
|
1061
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-encryption.html">Data encryption in EventBridge</a> in the <i>Amazon EventBridge User Guide</i>.</p>
|
|
1062
|
+
* @public
|
|
1063
|
+
*/
|
|
1064
|
+
KmsKeyIdentifier?: string;
|
|
1065
|
+
/**
|
|
1066
|
+
* <p>Configuration details of the Amazon SQS queue for EventBridge to use as a
|
|
1067
|
+
* dead-letter queue (DLQ).</p>
|
|
1068
|
+
* <p>For more information, see <a href="eventbridge/latest/userguide/eb-rule-dlq.html">Event
|
|
1069
|
+
* retry policy and using dead-letter queues</a> in the <i>EventBridge User
|
|
1070
|
+
* Guide</i>.</p>
|
|
1071
|
+
* @public
|
|
1072
|
+
*/
|
|
1073
|
+
DeadLetterConfig?: DeadLetterConfig;
|
|
979
1074
|
}
|
|
980
1075
|
/**
|
|
981
1076
|
* @public
|
|
@@ -986,14 +1081,14 @@ export interface CreatePartnerEventSourceRequest {
|
|
|
986
1081
|
* <code>
|
|
987
1082
|
* <i>partner_name</i>/<i>event_namespace</i>/<i>event_name</i>
|
|
988
1083
|
* </code>.
|
|
989
|
-
* The Amazon Web Services account that wants to use this partner event source must create a
|
|
990
|
-
* with a name that matches the name of the partner event source.</p>
|
|
1084
|
+
* The Amazon Web Services account that wants to use this partner event source must create a
|
|
1085
|
+
* partner event bus with a name that matches the name of the partner event source.</p>
|
|
991
1086
|
* @public
|
|
992
1087
|
*/
|
|
993
1088
|
Name: string | undefined;
|
|
994
1089
|
/**
|
|
995
|
-
* <p>The Amazon Web Services account ID that is permitted to create a matching partner event bus
|
|
996
|
-
* partner event source.</p>
|
|
1090
|
+
* <p>The Amazon Web Services account ID that is permitted to create a matching partner event bus
|
|
1091
|
+
* for this partner event source.</p>
|
|
997
1092
|
* @public
|
|
998
1093
|
*/
|
|
999
1094
|
Account: string | undefined;
|
|
@@ -1135,7 +1230,8 @@ export interface DeleteConnectionResponse {
|
|
|
1135
1230
|
*/
|
|
1136
1231
|
export interface DeleteEndpointRequest {
|
|
1137
1232
|
/**
|
|
1138
|
-
* <p>The name of the endpoint you want to delete. For example,
|
|
1233
|
+
* <p>The name of the endpoint you want to delete. For example,
|
|
1234
|
+
* <code>"Name":"us-east-2-custom_bus_A-endpoint"</code>..</p>
|
|
1139
1235
|
* @public
|
|
1140
1236
|
*/
|
|
1141
1237
|
Name: string | undefined;
|
|
@@ -1165,7 +1261,8 @@ export interface DeletePartnerEventSourceRequest {
|
|
|
1165
1261
|
*/
|
|
1166
1262
|
Name: string | undefined;
|
|
1167
1263
|
/**
|
|
1168
|
-
* <p>The Amazon Web Services account ID of the Amazon Web Services customer that the event source
|
|
1264
|
+
* <p>The Amazon Web Services account ID of the Amazon Web Services customer that the event source
|
|
1265
|
+
* was created for.</p>
|
|
1169
1266
|
* @public
|
|
1170
1267
|
*/
|
|
1171
1268
|
Account: string | undefined;
|
|
@@ -1186,18 +1283,18 @@ export interface DeleteRuleRequest {
|
|
|
1186
1283
|
*/
|
|
1187
1284
|
EventBusName?: string;
|
|
1188
1285
|
/**
|
|
1189
|
-
* <p>If this is a managed rule, created by an Amazon Web Services service on your behalf, you
|
|
1190
|
-
*
|
|
1191
|
-
* rules that are not managed rules. You can check whether a rule is a managed rule
|
|
1192
|
-
*
|
|
1193
|
-
*
|
|
1286
|
+
* <p>If this is a managed rule, created by an Amazon Web Services service on your behalf, you
|
|
1287
|
+
* must specify <code>Force</code> as <code>True</code> to delete the rule. This parameter is
|
|
1288
|
+
* ignored for rules that are not managed rules. You can check whether a rule is a managed rule
|
|
1289
|
+
* by using <code>DescribeRule</code> or <code>ListRules</code> and checking the
|
|
1290
|
+
* <code>ManagedBy</code> field of the response.</p>
|
|
1194
1291
|
* @public
|
|
1195
1292
|
*/
|
|
1196
1293
|
Force?: boolean;
|
|
1197
1294
|
}
|
|
1198
1295
|
/**
|
|
1199
|
-
* <p>This rule was created by an Amazon Web Services service on behalf of your account. It is
|
|
1200
|
-
* service. If you see this error in response to <code>DeleteRule</code> or
|
|
1296
|
+
* <p>This rule was created by an Amazon Web Services service on behalf of your account. It is
|
|
1297
|
+
* managed by that service. If you see this error in response to <code>DeleteRule</code> or
|
|
1201
1298
|
* <code>RemoveTargets</code>, you can use the <code>Force</code> parameter in those calls to
|
|
1202
1299
|
* delete the rule or remove targets from the rule. You cannot modify these managed rules by
|
|
1203
1300
|
* using <code>DisableRule</code>, <code>EnableRule</code>, <code>PutTargets</code>,
|
|
@@ -1519,12 +1616,14 @@ export interface DescribeConnectionResponse {
|
|
|
1519
1616
|
*/
|
|
1520
1617
|
export interface DescribeEndpointRequest {
|
|
1521
1618
|
/**
|
|
1522
|
-
* <p>The name of the endpoint you want to get information about. For example,
|
|
1619
|
+
* <p>The name of the endpoint you want to get information about. For example,
|
|
1620
|
+
* <code>"Name":"us-east-2-custom_bus_A-endpoint"</code>.</p>
|
|
1523
1621
|
* @public
|
|
1524
1622
|
*/
|
|
1525
1623
|
Name: string | undefined;
|
|
1526
1624
|
/**
|
|
1527
|
-
* <p>The primary Region of the endpoint you want to get information about. For example
|
|
1625
|
+
* <p>The primary Region of the endpoint you want to get information about. For example
|
|
1626
|
+
* <code>"HomeRegion": "us-east-1"</code>.</p>
|
|
1528
1627
|
* @public
|
|
1529
1628
|
*/
|
|
1530
1629
|
HomeRegion?: string;
|
|
@@ -1554,7 +1653,8 @@ export interface DescribeEndpointResponse {
|
|
|
1554
1653
|
*/
|
|
1555
1654
|
RoutingConfig?: RoutingConfig;
|
|
1556
1655
|
/**
|
|
1557
|
-
* <p>Whether replication is enabled or disabled for the endpoint you asked for information
|
|
1656
|
+
* <p>Whether replication is enabled or disabled for the endpoint you asked for information
|
|
1657
|
+
* about.</p>
|
|
1558
1658
|
* @public
|
|
1559
1659
|
*/
|
|
1560
1660
|
ReplicationConfig?: ReplicationConfig;
|
|
@@ -1620,16 +1720,46 @@ export interface DescribeEventBusResponse {
|
|
|
1620
1720
|
*/
|
|
1621
1721
|
Name?: string;
|
|
1622
1722
|
/**
|
|
1623
|
-
* <p>The Amazon Resource Name (ARN) of the account permitted to write events to the current
|
|
1624
|
-
* account.</p>
|
|
1723
|
+
* <p>The Amazon Resource Name (ARN) of the account permitted to write events to the current account.</p>
|
|
1625
1724
|
* @public
|
|
1626
1725
|
*/
|
|
1627
1726
|
Arn?: string;
|
|
1727
|
+
/**
|
|
1728
|
+
* <p>The event bus description.</p>
|
|
1729
|
+
* @public
|
|
1730
|
+
*/
|
|
1731
|
+
Description?: string;
|
|
1732
|
+
/**
|
|
1733
|
+
* <p>The identifier of the KMS
|
|
1734
|
+
* customer managed key for EventBridge to use to encrypt events on this event bus, if one has been specified.</p>
|
|
1735
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-encryption.html">Data encryption in EventBridge</a> in the <i>Amazon EventBridge User Guide</i>.</p>
|
|
1736
|
+
* @public
|
|
1737
|
+
*/
|
|
1738
|
+
KmsKeyIdentifier?: string;
|
|
1739
|
+
/**
|
|
1740
|
+
* <p>Configuration details of the Amazon SQS queue for EventBridge to use as a
|
|
1741
|
+
* dead-letter queue (DLQ).</p>
|
|
1742
|
+
* <p>For more information, see <a href="eventbridge/latest/userguide/eb-rule-dlq.html">Event
|
|
1743
|
+
* retry policy and using dead-letter queues</a> in the <i>EventBridge User
|
|
1744
|
+
* Guide</i>.</p>
|
|
1745
|
+
* @public
|
|
1746
|
+
*/
|
|
1747
|
+
DeadLetterConfig?: DeadLetterConfig;
|
|
1628
1748
|
/**
|
|
1629
1749
|
* <p>The policy that enables the external account to send events to your account.</p>
|
|
1630
1750
|
* @public
|
|
1631
1751
|
*/
|
|
1632
1752
|
Policy?: string;
|
|
1753
|
+
/**
|
|
1754
|
+
* <p>The time the event bus was created.</p>
|
|
1755
|
+
* @public
|
|
1756
|
+
*/
|
|
1757
|
+
CreationTime?: Date;
|
|
1758
|
+
/**
|
|
1759
|
+
* <p>The time the event bus was last modified.</p>
|
|
1760
|
+
* @public
|
|
1761
|
+
*/
|
|
1762
|
+
LastModifiedTime?: Date;
|
|
1633
1763
|
}
|
|
1634
1764
|
/**
|
|
1635
1765
|
* @public
|
|
@@ -1855,7 +1985,9 @@ export interface DescribeRuleResponse {
|
|
|
1855
1985
|
Arn?: string;
|
|
1856
1986
|
/**
|
|
1857
1987
|
* <p>The event pattern. For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html">Events and Event
|
|
1858
|
-
*
|
|
1988
|
+
* Patterns</a> in the <i>
|
|
1989
|
+
* <i>Amazon EventBridge User Guide</i>
|
|
1990
|
+
* </i>.</p>
|
|
1859
1991
|
* @public
|
|
1860
1992
|
*/
|
|
1861
1993
|
EventPattern?: string;
|
|
@@ -1880,8 +2012,9 @@ export interface DescribeRuleResponse {
|
|
|
1880
2012
|
*/
|
|
1881
2013
|
RoleArn?: string;
|
|
1882
2014
|
/**
|
|
1883
|
-
* <p>If this is a managed rule, created by an Amazon Web Services service on your behalf, this
|
|
1884
|
-
* the principal name of the Amazon Web Services service that created the
|
|
2015
|
+
* <p>If this is a managed rule, created by an Amazon Web Services service on your behalf, this
|
|
2016
|
+
* field displays the principal name of the Amazon Web Services service that created the
|
|
2017
|
+
* rule.</p>
|
|
1885
2018
|
* @public
|
|
1886
2019
|
*/
|
|
1887
2020
|
ManagedBy?: string;
|
|
@@ -2115,19 +2248,24 @@ export interface ListConnectionsResponse {
|
|
|
2115
2248
|
*/
|
|
2116
2249
|
export interface ListEndpointsRequest {
|
|
2117
2250
|
/**
|
|
2118
|
-
* <p>A value that will return a subset of the endpoints associated with this account. For
|
|
2251
|
+
* <p>A value that will return a subset of the endpoints associated with this account. For
|
|
2252
|
+
* example, <code>"NamePrefix": "ABC"</code> will return all endpoints with "ABC" in the
|
|
2253
|
+
* name.</p>
|
|
2119
2254
|
* @public
|
|
2120
2255
|
*/
|
|
2121
2256
|
NamePrefix?: string;
|
|
2122
2257
|
/**
|
|
2123
|
-
* <p>The primary Region of the endpoints associated with this account. For example
|
|
2258
|
+
* <p>The primary Region of the endpoints associated with this account. For example
|
|
2259
|
+
* <code>"HomeRegion": "us-east-1"</code>.</p>
|
|
2124
2260
|
* @public
|
|
2125
2261
|
*/
|
|
2126
2262
|
HomeRegion?: string;
|
|
2127
2263
|
/**
|
|
2128
|
-
* <p>If <code>nextToken</code> is returned, there are more results available. The value of
|
|
2129
|
-
*
|
|
2130
|
-
*
|
|
2264
|
+
* <p>If <code>nextToken</code> is returned, there are more results available. The value of
|
|
2265
|
+
* <code>nextToken</code> is a unique pagination token for each page. Make the call again using
|
|
2266
|
+
* the returned token to retrieve the next page. Keep all other arguments unchanged. Each
|
|
2267
|
+
* pagination token expires after 24 hours. Using an expired pagination token will return an HTTP
|
|
2268
|
+
* 400 InvalidToken error.</p>
|
|
2131
2269
|
* @public
|
|
2132
2270
|
*/
|
|
2133
2271
|
NextToken?: string;
|
|
@@ -2138,7 +2276,12 @@ export interface ListEndpointsRequest {
|
|
|
2138
2276
|
MaxResults?: number;
|
|
2139
2277
|
}
|
|
2140
2278
|
/**
|
|
2141
|
-
* <p>A global endpoint used to improve your application's availability by making it
|
|
2279
|
+
* <p>A global endpoint used to improve your application's availability by making it
|
|
2280
|
+
* regional-fault tolerant. For more information about global endpoints, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-global-endpoints.html">Making
|
|
2281
|
+
* applications Regional-fault tolerant with global endpoints and event replication</a> in
|
|
2282
|
+
* the <i>
|
|
2283
|
+
* <i>Amazon EventBridge User Guide</i>
|
|
2284
|
+
* </i>.</p>
|
|
2142
2285
|
* @public
|
|
2143
2286
|
*/
|
|
2144
2287
|
export interface Endpoint {
|
|
@@ -2163,8 +2306,10 @@ export interface Endpoint {
|
|
|
2163
2306
|
*/
|
|
2164
2307
|
RoutingConfig?: RoutingConfig;
|
|
2165
2308
|
/**
|
|
2166
|
-
* <p>Whether event replication was enabled or disabled for this endpoint. The default state is
|
|
2167
|
-
*
|
|
2309
|
+
* <p>Whether event replication was enabled or disabled for this endpoint. The default state is
|
|
2310
|
+
* <code>ENABLED</code> which means you must supply a <code>RoleArn</code>. If you don't have a
|
|
2311
|
+
* <code>RoleArn</code> or you don't want event replication enabled, set the state to
|
|
2312
|
+
* <code>DISABLED</code>.</p>
|
|
2168
2313
|
* @public
|
|
2169
2314
|
*/
|
|
2170
2315
|
ReplicationConfig?: ReplicationConfig;
|
|
@@ -2179,7 +2324,9 @@ export interface Endpoint {
|
|
|
2179
2324
|
*/
|
|
2180
2325
|
RoleArn?: string;
|
|
2181
2326
|
/**
|
|
2182
|
-
* <p>The URL subdomain of the endpoint. For example, if the URL for Endpoint is
|
|
2327
|
+
* <p>The URL subdomain of the endpoint. For example, if the URL for Endpoint is
|
|
2328
|
+
* https://abcde.veo.endpoints.event.amazonaws.com, then the EndpointId is
|
|
2329
|
+
* <code>abcde.veo</code>.</p>
|
|
2183
2330
|
* @public
|
|
2184
2331
|
*/
|
|
2185
2332
|
EndpointId?: string;
|
|
@@ -2219,9 +2366,11 @@ export interface ListEndpointsResponse {
|
|
|
2219
2366
|
*/
|
|
2220
2367
|
Endpoints?: Endpoint[];
|
|
2221
2368
|
/**
|
|
2222
|
-
* <p>If <code>nextToken</code> is returned, there are more results available. The value of
|
|
2223
|
-
*
|
|
2224
|
-
*
|
|
2369
|
+
* <p>If <code>nextToken</code> is returned, there are more results available. The value of
|
|
2370
|
+
* <code>nextToken</code> is a unique pagination token for each page. Make the call again using
|
|
2371
|
+
* the returned token to retrieve the next page. Keep all other arguments unchanged. Each
|
|
2372
|
+
* pagination token expires after 24 hours. Using an expired pagination token will return an HTTP
|
|
2373
|
+
* 400 InvalidToken error.</p>
|
|
2225
2374
|
* @public
|
|
2226
2375
|
*/
|
|
2227
2376
|
NextToken?: string;
|
|
@@ -2250,11 +2399,12 @@ export interface ListEventBusesRequest {
|
|
|
2250
2399
|
Limit?: number;
|
|
2251
2400
|
}
|
|
2252
2401
|
/**
|
|
2253
|
-
* <p>An event bus receives events from a source, uses rules to evaluate them, applies any
|
|
2254
|
-
*
|
|
2255
|
-
* bus
|
|
2256
|
-
*
|
|
2257
|
-
* partners services
|
|
2402
|
+
* <p>An event bus receives events from a source, uses rules to evaluate them, applies any
|
|
2403
|
+
* configured input transformation, and routes them to the appropriate target(s). Your account's
|
|
2404
|
+
* default event bus receives events from Amazon Web Services services. A custom event bus can
|
|
2405
|
+
* receive events from your custom applications and services. A partner event bus receives events
|
|
2406
|
+
* from an event source created by an SaaS partner. These events come from the partners services
|
|
2407
|
+
* or applications.</p>
|
|
2258
2408
|
* @public
|
|
2259
2409
|
*/
|
|
2260
2410
|
export interface EventBus {
|
|
@@ -2269,11 +2419,26 @@ export interface EventBus {
|
|
|
2269
2419
|
*/
|
|
2270
2420
|
Arn?: string;
|
|
2271
2421
|
/**
|
|
2272
|
-
* <p>The
|
|
2273
|
-
*
|
|
2422
|
+
* <p>The event bus description.</p>
|
|
2423
|
+
* @public
|
|
2424
|
+
*/
|
|
2425
|
+
Description?: string;
|
|
2426
|
+
/**
|
|
2427
|
+
* <p>The permissions policy of the event bus, describing which other Amazon Web Services
|
|
2428
|
+
* accounts can write events to this event bus.</p>
|
|
2274
2429
|
* @public
|
|
2275
2430
|
*/
|
|
2276
2431
|
Policy?: string;
|
|
2432
|
+
/**
|
|
2433
|
+
* <p>The time the event bus was created.</p>
|
|
2434
|
+
* @public
|
|
2435
|
+
*/
|
|
2436
|
+
CreationTime?: Date;
|
|
2437
|
+
/**
|
|
2438
|
+
* <p>The time the event bus was last modified.</p>
|
|
2439
|
+
* @public
|
|
2440
|
+
*/
|
|
2441
|
+
LastModifiedTime?: Date;
|
|
2277
2442
|
}
|
|
2278
2443
|
/**
|
|
2279
2444
|
* @public
|
|
@@ -2315,8 +2480,8 @@ export interface ListEventSourcesRequest {
|
|
|
2315
2480
|
}
|
|
2316
2481
|
/**
|
|
2317
2482
|
* <p>A partner event source is created by an SaaS partner. If a customer creates a partner
|
|
2318
|
-
* event bus that matches this event source, that Amazon Web Services account can receive events
|
|
2319
|
-
* partner's applications or services.</p>
|
|
2483
|
+
* event bus that matches this event source, that Amazon Web Services account can receive events
|
|
2484
|
+
* from the partner's applications or services.</p>
|
|
2320
2485
|
* @public
|
|
2321
2486
|
*/
|
|
2322
2487
|
export interface EventSource {
|
|
@@ -2336,8 +2501,8 @@ export interface EventSource {
|
|
|
2336
2501
|
*/
|
|
2337
2502
|
CreationTime?: Date;
|
|
2338
2503
|
/**
|
|
2339
|
-
* <p>The date and time that the event source will expire, if the Amazon Web Services account
|
|
2340
|
-
* matching event bus for it.</p>
|
|
2504
|
+
* <p>The date and time that the event source will expire, if the Amazon Web Services account
|
|
2505
|
+
* doesn't create a matching event bus for it.</p>
|
|
2341
2506
|
* @public
|
|
2342
2507
|
*/
|
|
2343
2508
|
ExpirationTime?: Date;
|
|
@@ -2409,8 +2574,8 @@ export interface PartnerEventSourceAccount {
|
|
|
2409
2574
|
*/
|
|
2410
2575
|
CreationTime?: Date;
|
|
2411
2576
|
/**
|
|
2412
|
-
* <p>The date and time that the event source will expire, if the Amazon Web Services account
|
|
2413
|
-
* matching event bus for it.</p>
|
|
2577
|
+
* <p>The date and time that the event source will expire, if the Amazon Web Services account
|
|
2578
|
+
* doesn't create a matching event bus for it.</p>
|
|
2414
2579
|
* @public
|
|
2415
2580
|
*/
|
|
2416
2581
|
ExpirationTime?: Date;
|
|
@@ -2464,8 +2629,8 @@ export interface ListPartnerEventSourcesRequest {
|
|
|
2464
2629
|
}
|
|
2465
2630
|
/**
|
|
2466
2631
|
* <p>A partner event source is created by an SaaS partner. If a customer creates a partner
|
|
2467
|
-
* event bus that matches this event source, that Amazon Web Services account can receive events
|
|
2468
|
-
* partner's applications or services.</p>
|
|
2632
|
+
* event bus that matches this event source, that Amazon Web Services account can receive events
|
|
2633
|
+
* from the partner's applications or services.</p>
|
|
2469
2634
|
* @public
|
|
2470
2635
|
*/
|
|
2471
2636
|
export interface PartnerEventSource {
|
|
@@ -2679,12 +2844,41 @@ export interface Rule {
|
|
|
2679
2844
|
Arn?: string;
|
|
2680
2845
|
/**
|
|
2681
2846
|
* <p>The event pattern of the rule. For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html">Events and Event
|
|
2682
|
-
*
|
|
2847
|
+
* Patterns</a> in the <i>
|
|
2848
|
+
* <i>Amazon EventBridge User Guide</i>
|
|
2849
|
+
* </i>.</p>
|
|
2683
2850
|
* @public
|
|
2684
2851
|
*/
|
|
2685
2852
|
EventPattern?: string;
|
|
2686
2853
|
/**
|
|
2687
2854
|
* <p>The state of the rule.</p>
|
|
2855
|
+
* <p>Valid values include:</p>
|
|
2856
|
+
* <ul>
|
|
2857
|
+
* <li>
|
|
2858
|
+
* <p>
|
|
2859
|
+
* <code>DISABLED</code>: The rule is disabled. EventBridge does not match any events against the rule.</p>
|
|
2860
|
+
* </li>
|
|
2861
|
+
* <li>
|
|
2862
|
+
* <p>
|
|
2863
|
+
* <code>ENABLED</code>: The rule is enabled.
|
|
2864
|
+
* EventBridge matches events against the rule, <i>except</i> for Amazon Web Services management events delivered through CloudTrail.</p>
|
|
2865
|
+
* </li>
|
|
2866
|
+
* <li>
|
|
2867
|
+
* <p>
|
|
2868
|
+
* <code>ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS</code>: The rule is enabled for all
|
|
2869
|
+
* events, including Amazon Web Services management events delivered through CloudTrail.</p>
|
|
2870
|
+
* <p>Management events provide visibility into management operations that are performed on
|
|
2871
|
+
* resources in your Amazon Web Services account. These are also known as control plane
|
|
2872
|
+
* operations. For more information, see <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-events-with-cloudtrail.html#logging-management-events">Logging management events</a> in the <i>CloudTrail User
|
|
2873
|
+
* Guide</i>, and <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-service-event.html#eb-service-event-cloudtrail">Filtering management events from Amazon Web Services services</a> in the
|
|
2874
|
+
* <i>
|
|
2875
|
+
* <i>Amazon EventBridge User Guide</i>
|
|
2876
|
+
* </i>.</p>
|
|
2877
|
+
* <p>This value is only valid for rules on the <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-what-is-how-it-works-concepts.html#eb-bus-concepts-buses">default</a> event bus
|
|
2878
|
+
* or <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-create-event-bus.html">custom event buses</a>.
|
|
2879
|
+
* It does not apply to <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-saas.html">partner event buses</a>.</p>
|
|
2880
|
+
* </li>
|
|
2881
|
+
* </ul>
|
|
2688
2882
|
* @public
|
|
2689
2883
|
*/
|
|
2690
2884
|
State?: RuleState;
|
|
@@ -2694,7 +2888,9 @@ export interface Rule {
|
|
|
2694
2888
|
*/
|
|
2695
2889
|
Description?: string;
|
|
2696
2890
|
/**
|
|
2697
|
-
* <p>The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)". For more
|
|
2891
|
+
* <p>The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)". For more
|
|
2892
|
+
* information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-create-rule-schedule.html">Creating an Amazon EventBridge rule
|
|
2893
|
+
* that runs on a schedule</a>.</p>
|
|
2698
2894
|
* @public
|
|
2699
2895
|
*/
|
|
2700
2896
|
ScheduleExpression?: string;
|
|
@@ -2708,8 +2904,8 @@ export interface Rule {
|
|
|
2708
2904
|
*/
|
|
2709
2905
|
RoleArn?: string;
|
|
2710
2906
|
/**
|
|
2711
|
-
* <p>If the rule was created on behalf of your account by an Amazon Web Services service, this
|
|
2712
|
-
* the principal name of the service that created the rule.</p>
|
|
2907
|
+
* <p>If the rule was created on behalf of your account by an Amazon Web Services service, this
|
|
2908
|
+
* field displays the principal name of the service that created the rule.</p>
|
|
2713
2909
|
* @public
|
|
2714
2910
|
*/
|
|
2715
2911
|
ManagedBy?: string;
|
|
@@ -2797,8 +2993,8 @@ export interface BatchArrayProperties {
|
|
|
2797
2993
|
Size?: number;
|
|
2798
2994
|
}
|
|
2799
2995
|
/**
|
|
2800
|
-
* <p>The retry strategy to use for failed jobs, if the target is an Batch job.
|
|
2801
|
-
* specify a retry strategy here, it overrides the retry strategy defined in the job
|
|
2996
|
+
* <p>The retry strategy to use for failed jobs, if the target is an Batch job.
|
|
2997
|
+
* If you specify a retry strategy here, it overrides the retry strategy defined in the job
|
|
2802
2998
|
* definition.</p>
|
|
2803
2999
|
* @public
|
|
2804
3000
|
*/
|
|
@@ -2815,13 +3011,13 @@ export interface BatchRetryStrategy {
|
|
|
2815
3011
|
*/
|
|
2816
3012
|
export interface BatchParameters {
|
|
2817
3013
|
/**
|
|
2818
|
-
* <p>The ARN or name of the job definition to use if the event target is an Batch job. This
|
|
2819
|
-
* job definition must already exist.</p>
|
|
3014
|
+
* <p>The ARN or name of the job definition to use if the event target is an Batch job. This job definition must already exist.</p>
|
|
2820
3015
|
* @public
|
|
2821
3016
|
*/
|
|
2822
3017
|
JobDefinition: string | undefined;
|
|
2823
3018
|
/**
|
|
2824
|
-
* <p>The name to use for this execution of the job, if the target is an Batch
|
|
3019
|
+
* <p>The name to use for this execution of the job, if the target is an Batch
|
|
3020
|
+
* job.</p>
|
|
2825
3021
|
* @public
|
|
2826
3022
|
*/
|
|
2827
3023
|
JobName: string | undefined;
|
|
@@ -2833,26 +3029,14 @@ export interface BatchParameters {
|
|
|
2833
3029
|
*/
|
|
2834
3030
|
ArrayProperties?: BatchArrayProperties;
|
|
2835
3031
|
/**
|
|
2836
|
-
* <p>The retry strategy to use for failed jobs, if the target is an Batch job.
|
|
2837
|
-
* strategy is the number of times to retry the failed job execution. Valid values are
|
|
2838
|
-
* you specify a retry strategy here, it overrides the retry strategy defined in the
|
|
2839
|
-
* definition.</p>
|
|
3032
|
+
* <p>The retry strategy to use for failed jobs, if the target is an Batch job.
|
|
3033
|
+
* The retry strategy is the number of times to retry the failed job execution. Valid values are
|
|
3034
|
+
* 1–10. When you specify a retry strategy here, it overrides the retry strategy defined in the
|
|
3035
|
+
* job definition.</p>
|
|
2840
3036
|
* @public
|
|
2841
3037
|
*/
|
|
2842
3038
|
RetryStrategy?: BatchRetryStrategy;
|
|
2843
3039
|
}
|
|
2844
|
-
/**
|
|
2845
|
-
* <p>A <code>DeadLetterConfig</code> object that contains information about a dead-letter queue
|
|
2846
|
-
* configuration.</p>
|
|
2847
|
-
* @public
|
|
2848
|
-
*/
|
|
2849
|
-
export interface DeadLetterConfig {
|
|
2850
|
-
/**
|
|
2851
|
-
* <p>The ARN of the SQS queue specified as the target for the dead-letter queue.</p>
|
|
2852
|
-
* @public
|
|
2853
|
-
*/
|
|
2854
|
-
Arn?: string;
|
|
2855
|
-
}
|
|
2856
3040
|
/**
|
|
2857
3041
|
* <p>The details of a capacity provider strategy. To learn more, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CapacityProviderStrategyItem.html">CapacityProviderStrategyItem</a> in the Amazon ECS API Reference.</p>
|
|
2858
3042
|
* @public
|
|
@@ -2945,8 +3129,7 @@ export declare const PlacementConstraintType: {
|
|
|
2945
3129
|
*/
|
|
2946
3130
|
export type PlacementConstraintType = (typeof PlacementConstraintType)[keyof typeof PlacementConstraintType];
|
|
2947
3131
|
/**
|
|
2948
|
-
* <p>An object representing a constraint on task placement. To learn more, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html">Task Placement Constraints</a> in the Amazon Elastic Container Service Developer
|
|
2949
|
-
* Guide.</p>
|
|
3132
|
+
* <p>An object representing a constraint on task placement. To learn more, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html">Task Placement Constraints</a> in the Amazon Elastic Container Service Developer Guide.</p>
|
|
2950
3133
|
* @public
|
|
2951
3134
|
*/
|
|
2952
3135
|
export interface PlacementConstraint {
|
|
@@ -2959,8 +3142,7 @@ export interface PlacementConstraint {
|
|
|
2959
3142
|
type?: PlacementConstraintType;
|
|
2960
3143
|
/**
|
|
2961
3144
|
* <p>A cluster query language expression to apply to the constraint. You cannot specify an
|
|
2962
|
-
* expression if the constraint type is <code>distinctInstance</code>. To learn more, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html">Cluster Query Language</a> in the Amazon Elastic Container Service Developer Guide.
|
|
2963
|
-
* </p>
|
|
3145
|
+
* expression if the constraint type is <code>distinctInstance</code>. To learn more, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html">Cluster Query Language</a> in the Amazon Elastic Container Service Developer Guide. </p>
|
|
2964
3146
|
* @public
|
|
2965
3147
|
*/
|
|
2966
3148
|
expression?: string;
|
|
@@ -3034,18 +3216,18 @@ export interface EcsParameters {
|
|
|
3034
3216
|
/**
|
|
3035
3217
|
* <p>Specifies the launch type on which your task is running. The launch type that you specify
|
|
3036
3218
|
* here must match one of the launch type (compatibilities) of the target task. The
|
|
3037
|
-
*
|
|
3038
|
-
*
|
|
3039
|
-
*
|
|
3219
|
+
* <code>FARGATE</code> value is supported only in the Regions where Fargate
|
|
3220
|
+
* with Amazon ECS is supported. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/AWS-Fargate.html">Fargate on Amazon ECS</a> in the <i>Amazon Elastic Container Service Developer
|
|
3221
|
+
* Guide</i>.</p>
|
|
3040
3222
|
* @public
|
|
3041
3223
|
*/
|
|
3042
3224
|
LaunchType?: LaunchType;
|
|
3043
3225
|
/**
|
|
3044
|
-
* <p>Use this structure if the Amazon ECS task uses the <code>awsvpc</code> network
|
|
3045
|
-
* structure specifies the VPC subnets and security groups associated with the task,
|
|
3046
|
-
* a public IP address is to be used. This structure is required if
|
|
3047
|
-
* <code>FARGATE</code> because the <code>awsvpc</code> mode is
|
|
3048
|
-
* tasks.</p>
|
|
3226
|
+
* <p>Use this structure if the Amazon ECS task uses the <code>awsvpc</code> network
|
|
3227
|
+
* mode. This structure specifies the VPC subnets and security groups associated with the task,
|
|
3228
|
+
* and whether a public IP address is to be used. This structure is required if
|
|
3229
|
+
* <code>LaunchType</code> is <code>FARGATE</code> because the <code>awsvpc</code> mode is
|
|
3230
|
+
* required for Fargate tasks.</p>
|
|
3049
3231
|
* <p>If you specify <code>NetworkConfiguration</code> when the target ECS task does not use the
|
|
3050
3232
|
* <code>awsvpc</code> network mode, the task fails.</p>
|
|
3051
3233
|
* @public
|
|
@@ -3055,9 +3237,9 @@ export interface EcsParameters {
|
|
|
3055
3237
|
* <p>Specifies the platform version for the task. Specify only the numeric portion of the
|
|
3056
3238
|
* platform version, such as <code>1.1.0</code>.</p>
|
|
3057
3239
|
* <p>This structure is used only if <code>LaunchType</code> is <code>FARGATE</code>. For more
|
|
3058
|
-
* information about valid platform versions, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html">Fargate
|
|
3059
|
-
* Versions</a> in the <i>Amazon Elastic Container Service Developer
|
|
3060
|
-
*
|
|
3240
|
+
* information about valid platform versions, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html">Fargate
|
|
3241
|
+
* Platform Versions</a> in the <i>Amazon Elastic Container Service Developer
|
|
3242
|
+
* Guide</i>.</p>
|
|
3061
3243
|
* @public
|
|
3062
3244
|
*/
|
|
3063
3245
|
PlatformVersion?: string;
|
|
@@ -3075,9 +3257,9 @@ export interface EcsParameters {
|
|
|
3075
3257
|
*/
|
|
3076
3258
|
CapacityProviderStrategy?: CapacityProviderStrategyItem[];
|
|
3077
3259
|
/**
|
|
3078
|
-
* <p>Specifies whether to enable Amazon ECS managed tags for the task. For more
|
|
3079
|
-
* see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html">Tagging Your Amazon ECS
|
|
3080
|
-
*
|
|
3260
|
+
* <p>Specifies whether to enable Amazon ECS managed tags for the task. For more
|
|
3261
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html">Tagging Your Amazon ECS
|
|
3262
|
+
* Resources</a> in the Amazon Elastic Container Service Developer Guide. </p>
|
|
3081
3263
|
* @public
|
|
3082
3264
|
*/
|
|
3083
3265
|
EnableECSManagedTags?: boolean;
|
|
@@ -3122,27 +3304,25 @@ export interface EcsParameters {
|
|
|
3122
3304
|
}
|
|
3123
3305
|
/**
|
|
3124
3306
|
* <p>These are custom parameter to be used when the target is an API Gateway APIs or
|
|
3125
|
-
*
|
|
3307
|
+
* EventBridge ApiDestinations. In the latter case, these are merged with any
|
|
3126
3308
|
* InvocationParameters specified on the Connection, with any values from the Connection taking
|
|
3127
3309
|
* precedence.</p>
|
|
3128
3310
|
* @public
|
|
3129
3311
|
*/
|
|
3130
3312
|
export interface HttpParameters {
|
|
3131
3313
|
/**
|
|
3132
|
-
* <p>The path parameter values to be used to populate API Gateway API or EventBridge
|
|
3133
|
-
* ApiDestination path wildcards ("*").</p>
|
|
3314
|
+
* <p>The path parameter values to be used to populate API Gateway API or EventBridge ApiDestination path wildcards ("*").</p>
|
|
3134
3315
|
* @public
|
|
3135
3316
|
*/
|
|
3136
3317
|
PathParameterValues?: string[];
|
|
3137
3318
|
/**
|
|
3138
3319
|
* <p>The headers that need to be sent as part of request invoking the API Gateway API or
|
|
3139
|
-
*
|
|
3320
|
+
* EventBridge ApiDestination.</p>
|
|
3140
3321
|
* @public
|
|
3141
3322
|
*/
|
|
3142
3323
|
HeaderParameters?: Record<string, string>;
|
|
3143
3324
|
/**
|
|
3144
|
-
* <p>The query string keys/values that need to be sent as part of request invoking the API Gateway
|
|
3145
|
-
* API or EventBridge ApiDestination.</p>
|
|
3325
|
+
* <p>The query string keys/values that need to be sent as part of request invoking the API Gateway API or EventBridge ApiDestination.</p>
|
|
3146
3326
|
* @public
|
|
3147
3327
|
*/
|
|
3148
3328
|
QueryStringParameters?: Record<string, string>;
|
|
@@ -3168,8 +3348,7 @@ export interface InputTransformer {
|
|
|
3168
3348
|
/**
|
|
3169
3349
|
* <p>Input template where you specify placeholders that will be filled with the values of the
|
|
3170
3350
|
* keys from <code>InputPathsMap</code> to customize the data sent to the target. Enclose each
|
|
3171
|
-
* <code>InputPathsMaps</code> value in brackets: <<i>value</i>>
|
|
3172
|
-
* </p>
|
|
3351
|
+
* <code>InputPathsMaps</code> value in brackets: <<i>value</i>> </p>
|
|
3173
3352
|
* <p>If <code>InputTemplate</code> is a JSON object (surrounded by curly braces), the following
|
|
3174
3353
|
* restrictions apply:</p>
|
|
3175
3354
|
* <ul>
|
|
@@ -3253,8 +3432,9 @@ export interface KinesisParameters {
|
|
|
3253
3432
|
PartitionKeyPath: string | undefined;
|
|
3254
3433
|
}
|
|
3255
3434
|
/**
|
|
3256
|
-
* <p>These are custom parameters to be used when the target is a Amazon Redshift cluster
|
|
3257
|
-
*
|
|
3435
|
+
* <p>These are custom parameters to be used when the target is a Amazon Redshift cluster
|
|
3436
|
+
* to invoke the Amazon Redshift Data API
|
|
3437
|
+
* ExecuteStatement based on EventBridge events.</p>
|
|
3258
3438
|
* @public
|
|
3259
3439
|
*/
|
|
3260
3440
|
export interface RedshiftDataParameters {
|
|
@@ -3292,9 +3472,10 @@ export interface RedshiftDataParameters {
|
|
|
3292
3472
|
*/
|
|
3293
3473
|
WithEvent?: boolean;
|
|
3294
3474
|
/**
|
|
3295
|
-
* <p>One or more SQL statements to run. The SQL statements are run as a single transaction.
|
|
3296
|
-
* Subsequent SQL statements don't start until the
|
|
3297
|
-
* If any SQL statement fails, then because they are
|
|
3475
|
+
* <p>One or more SQL statements to run. The SQL statements are run as a single transaction.
|
|
3476
|
+
* They run serially in the order of the array. Subsequent SQL statements don't start until the
|
|
3477
|
+
* previous statement in the array completes. If any SQL statement fails, then because they are
|
|
3478
|
+
* run as one transaction, all work is rolled back.</p>
|
|
3298
3479
|
* @public
|
|
3299
3480
|
*/
|
|
3300
3481
|
Sqls?: string[];
|
|
@@ -3361,24 +3542,27 @@ export interface RunCommandParameters {
|
|
|
3361
3542
|
*/
|
|
3362
3543
|
export interface SageMakerPipelineParameter {
|
|
3363
3544
|
/**
|
|
3364
|
-
* <p>Name of parameter to start execution of a SageMaker Model Building
|
|
3545
|
+
* <p>Name of parameter to start execution of a SageMaker Model Building
|
|
3546
|
+
* Pipeline.</p>
|
|
3365
3547
|
* @public
|
|
3366
3548
|
*/
|
|
3367
3549
|
Name: string | undefined;
|
|
3368
3550
|
/**
|
|
3369
|
-
* <p>Value of parameter to start execution of a SageMaker Model Building
|
|
3551
|
+
* <p>Value of parameter to start execution of a SageMaker Model Building
|
|
3552
|
+
* Pipeline.</p>
|
|
3370
3553
|
* @public
|
|
3371
3554
|
*/
|
|
3372
3555
|
Value: string | undefined;
|
|
3373
3556
|
}
|
|
3374
3557
|
/**
|
|
3375
|
-
* <p>These are custom parameters to use when the target is a SageMaker Model Building
|
|
3376
|
-
* that starts based on EventBridge events.</p>
|
|
3558
|
+
* <p>These are custom parameters to use when the target is a SageMaker Model Building
|
|
3559
|
+
* Pipeline that starts based on EventBridge events.</p>
|
|
3377
3560
|
* @public
|
|
3378
3561
|
*/
|
|
3379
3562
|
export interface SageMakerPipelineParameters {
|
|
3380
3563
|
/**
|
|
3381
|
-
* <p>List of Parameter names and values for SageMaker Model Building Pipeline
|
|
3564
|
+
* <p>List of Parameter names and values for SageMaker Model Building Pipeline
|
|
3565
|
+
* execution.</p>
|
|
3382
3566
|
* @public
|
|
3383
3567
|
*/
|
|
3384
3568
|
PipelineParameterList?: SageMakerPipelineParameter[];
|
|
@@ -3402,13 +3586,13 @@ export interface SqsParameters {
|
|
|
3402
3586
|
* granted permission to your account through an organization instead of directly by the account
|
|
3403
3587
|
* ID, then you must specify a <code>RoleArn</code> with proper permissions in the
|
|
3404
3588
|
* <code>Target</code> structure. For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html">Sending and
|
|
3405
|
-
*
|
|
3406
|
-
* Guide</i>.</p>
|
|
3589
|
+
* Receiving Events Between Amazon Web Services Accounts</a> in the <i>Amazon EventBridge User Guide</i>.</p>
|
|
3407
3590
|
* @public
|
|
3408
3591
|
*/
|
|
3409
3592
|
export interface Target {
|
|
3410
3593
|
/**
|
|
3411
|
-
* <p>The ID of the target within the specified rule. Use this ID to reference the target when
|
|
3594
|
+
* <p>The ID of the target within the specified rule. Use this ID to reference the target when
|
|
3595
|
+
* updating the rule. We recommend using a memorable and unique string.</p>
|
|
3412
3596
|
* @public
|
|
3413
3597
|
*/
|
|
3414
3598
|
Id: string | undefined;
|
|
@@ -3418,9 +3602,8 @@ export interface Target {
|
|
|
3418
3602
|
*/
|
|
3419
3603
|
Arn: string | undefined;
|
|
3420
3604
|
/**
|
|
3421
|
-
* <p>The Amazon Resource Name (ARN) of the IAM role to be used for this target when the rule is
|
|
3422
|
-
*
|
|
3423
|
-
* target.</p>
|
|
3605
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role to be used for this target when the rule is triggered. If
|
|
3606
|
+
* one rule triggers multiple targets, you can use a different IAM role for each target.</p>
|
|
3424
3607
|
* @public
|
|
3425
3608
|
*/
|
|
3426
3609
|
RoleArn?: string;
|
|
@@ -3466,9 +3649,9 @@ export interface Target {
|
|
|
3466
3649
|
*/
|
|
3467
3650
|
EcsParameters?: EcsParameters;
|
|
3468
3651
|
/**
|
|
3469
|
-
* <p>If the event target is an Batch job, this contains the job definition, job
|
|
3470
|
-
* other parameters. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/jobs.html">Jobs</a> in the <i>Batch
|
|
3471
|
-
* Guide</i>.</p>
|
|
3652
|
+
* <p>If the event target is an Batch job, this contains the job definition, job
|
|
3653
|
+
* name, and other parameters. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/jobs.html">Jobs</a> in the <i>Batch
|
|
3654
|
+
* User Guide</i>.</p>
|
|
3472
3655
|
* @public
|
|
3473
3656
|
*/
|
|
3474
3657
|
BatchParameters?: BatchParameters;
|
|
@@ -3481,28 +3664,27 @@ export interface Target {
|
|
|
3481
3664
|
SqsParameters?: SqsParameters;
|
|
3482
3665
|
/**
|
|
3483
3666
|
* <p>Contains the HTTP parameters to use when the target is a API Gateway endpoint or
|
|
3484
|
-
*
|
|
3485
|
-
* <p>If you specify an API Gateway API or EventBridge ApiDestination as a target,
|
|
3486
|
-
* use this parameter to specify headers, path parameters, and query string keys/values
|
|
3487
|
-
* of your target invoking request. If you're using ApiDestinations, the corresponding
|
|
3488
|
-
* can also have these values configured. In case of any conflicting keys, values from
|
|
3489
|
-
* Connection take precedence.</p>
|
|
3667
|
+
* EventBridge ApiDestination.</p>
|
|
3668
|
+
* <p>If you specify an API Gateway API or EventBridge ApiDestination as a target,
|
|
3669
|
+
* you can use this parameter to specify headers, path parameters, and query string keys/values
|
|
3670
|
+
* as part of your target invoking request. If you're using ApiDestinations, the corresponding
|
|
3671
|
+
* Connection can also have these values configured. In case of any conflicting keys, values from
|
|
3672
|
+
* the Connection take precedence.</p>
|
|
3490
3673
|
* @public
|
|
3491
3674
|
*/
|
|
3492
3675
|
HttpParameters?: HttpParameters;
|
|
3493
3676
|
/**
|
|
3494
|
-
* <p>Contains the Amazon Redshift Data API parameters to use when the target is a Amazon Redshift
|
|
3495
|
-
*
|
|
3496
|
-
*
|
|
3497
|
-
* invoke the Amazon Redshift Data API ExecuteStatement based on EventBridge events.</p>
|
|
3677
|
+
* <p>Contains the Amazon Redshift Data API parameters to use when the target is a Amazon Redshift cluster.</p>
|
|
3678
|
+
* <p>If you specify a Amazon Redshift Cluster as a Target, you can use this to specify
|
|
3679
|
+
* parameters to invoke the Amazon Redshift Data API ExecuteStatement based on EventBridge events.</p>
|
|
3498
3680
|
* @public
|
|
3499
3681
|
*/
|
|
3500
3682
|
RedshiftDataParameters?: RedshiftDataParameters;
|
|
3501
3683
|
/**
|
|
3502
3684
|
* <p>Contains the SageMaker Model Building Pipeline parameters to start execution of a
|
|
3503
|
-
*
|
|
3504
|
-
* <p>If you specify a SageMaker Model Building Pipeline as a target, you can use this
|
|
3505
|
-
* specify parameters to start a pipeline execution based on EventBridge events.</p>
|
|
3685
|
+
* SageMaker Model Building Pipeline.</p>
|
|
3686
|
+
* <p>If you specify a SageMaker Model Building Pipeline as a target, you can use this
|
|
3687
|
+
* to specify parameters to start a pipeline execution based on EventBridge events.</p>
|
|
3506
3688
|
* @public
|
|
3507
3689
|
*/
|
|
3508
3690
|
SageMakerPipelineParameters?: SageMakerPipelineParameters;
|
|
@@ -3519,7 +3701,8 @@ export interface Target {
|
|
|
3519
3701
|
*/
|
|
3520
3702
|
RetryPolicy?: RetryPolicy;
|
|
3521
3703
|
/**
|
|
3522
|
-
* <p>Contains the GraphQL operation to be parsed and executed, if the event target is an
|
|
3704
|
+
* <p>Contains the GraphQL operation to be parsed and executed, if the event target is an
|
|
3705
|
+
* AppSync API.</p>
|
|
3523
3706
|
* @public
|
|
3524
3707
|
*/
|
|
3525
3708
|
AppSyncParameters?: AppSyncParameters;
|
|
@@ -3563,13 +3746,14 @@ export interface PutEventsRequestEntry {
|
|
|
3563
3746
|
*/
|
|
3564
3747
|
Source?: string;
|
|
3565
3748
|
/**
|
|
3566
|
-
* <p>Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily
|
|
3567
|
-
*
|
|
3749
|
+
* <p>Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily concerns.
|
|
3750
|
+
* Any number, including zero, may be present.</p>
|
|
3568
3751
|
* @public
|
|
3569
3752
|
*/
|
|
3570
3753
|
Resources?: string[];
|
|
3571
3754
|
/**
|
|
3572
|
-
* <p>Free-form string, with a maximum of 128 characters, used to decide what fields to expect
|
|
3755
|
+
* <p>Free-form string, with a maximum of 128 characters, used to decide what fields to expect
|
|
3756
|
+
* in the event detail.</p>
|
|
3573
3757
|
* <note>
|
|
3574
3758
|
* <p>
|
|
3575
3759
|
* <code>Detail</code>, <code>DetailType</code>, and <code>Source</code> are required for EventBridge to successfully send an event to an event bus.
|
|
@@ -3598,17 +3782,19 @@ export interface PutEventsRequestEntry {
|
|
|
3598
3782
|
* with this event bus are used to match the event. If you omit this, the default event bus is
|
|
3599
3783
|
* used.</p>
|
|
3600
3784
|
* <note>
|
|
3601
|
-
* <p>If you're using a global endpoint with a custom bus, you can enter either the name or
|
|
3602
|
-
*
|
|
3603
|
-
*
|
|
3785
|
+
* <p>If you're using a global endpoint with a custom bus, you can enter either the name or
|
|
3786
|
+
* Amazon Resource Name (ARN) of the event bus in either the primary or secondary Region here. EventBridge then
|
|
3787
|
+
* determines the corresponding event bus in the other Region based on the endpoint referenced
|
|
3788
|
+
* by the <code>EndpointId</code>. Specifying the event bus ARN is preferred.</p>
|
|
3604
3789
|
* </note>
|
|
3605
3790
|
* @public
|
|
3606
3791
|
*/
|
|
3607
3792
|
EventBusName?: string;
|
|
3608
3793
|
/**
|
|
3609
|
-
* <p>An X-Ray trace header, which is an http header (X-Amzn-Trace-Id) that
|
|
3610
|
-
* trace-id associated with the event.</p>
|
|
3611
|
-
* <p>To learn more about X-Ray trace headers, see <a href="https://docs.aws.amazon.com/xray/latest/devguide/xray-concepts.html#xray-concepts-tracingheader">Tracing
|
|
3794
|
+
* <p>An X-Ray trace header, which is an http header (X-Amzn-Trace-Id) that
|
|
3795
|
+
* contains the trace-id associated with the event.</p>
|
|
3796
|
+
* <p>To learn more about X-Ray trace headers, see <a href="https://docs.aws.amazon.com/xray/latest/devguide/xray-concepts.html#xray-concepts-tracingheader">Tracing
|
|
3797
|
+
* header</a> in the X-Ray Developer Guide.</p>
|
|
3612
3798
|
* @public
|
|
3613
3799
|
*/
|
|
3614
3800
|
TraceHeader?: string;
|
|
@@ -3625,7 +3811,9 @@ export interface PutEventsRequest {
|
|
|
3625
3811
|
*/
|
|
3626
3812
|
Entries: PutEventsRequestEntry[] | undefined;
|
|
3627
3813
|
/**
|
|
3628
|
-
* <p>The URL subdomain of the endpoint. For example, if the URL for Endpoint is
|
|
3814
|
+
* <p>The URL subdomain of the endpoint. For example, if the URL for Endpoint is
|
|
3815
|
+
* https://abcde.veo.endpoints.event.amazonaws.com, then the EndpointId is
|
|
3816
|
+
* <code>abcde.veo</code>.</p>
|
|
3629
3817
|
* <important>
|
|
3630
3818
|
* <p>When using Java, you must include <code>auth-crt</code> on the class path.</p>
|
|
3631
3819
|
* </important>
|
|
@@ -3635,10 +3823,10 @@ export interface PutEventsRequest {
|
|
|
3635
3823
|
}
|
|
3636
3824
|
/**
|
|
3637
3825
|
* <p>Represents the results of an event submitted to an event bus.</p>
|
|
3638
|
-
* <p>If the submission was successful, the entry has the event ID in it.
|
|
3639
|
-
*
|
|
3640
|
-
* <p>For information about the errors that are common to all actions, see
|
|
3641
|
-
*
|
|
3826
|
+
* <p>If the submission was successful, the entry has the event ID in it. Otherwise, you can use
|
|
3827
|
+
* the error code and error message to identify the problem with the entry.</p>
|
|
3828
|
+
* <p>For information about the errors that are common to all actions, see <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/CommonErrors.html">Common
|
|
3829
|
+
* Errors</a>.</p>
|
|
3642
3830
|
* @public
|
|
3643
3831
|
*/
|
|
3644
3832
|
export interface PutEventsResultEntry {
|
|
@@ -3657,7 +3845,8 @@ export interface PutEventsResultEntry {
|
|
|
3657
3845
|
* <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/CommonErrors.html">InternalFailure</a>
|
|
3658
3846
|
* </code>
|
|
3659
3847
|
* </p>
|
|
3660
|
-
* <p>The request processing has failed because of an unknown error, exception or
|
|
3848
|
+
* <p>The request processing has failed because of an unknown error, exception or
|
|
3849
|
+
* failure.</p>
|
|
3661
3850
|
* </li>
|
|
3662
3851
|
* <li>
|
|
3663
3852
|
* <p>
|
|
@@ -3706,13 +3895,15 @@ export interface PutEventsResultEntry {
|
|
|
3706
3895
|
* <p>
|
|
3707
3896
|
* <code>NotAuthorizedForSourceException</code>
|
|
3708
3897
|
* </p>
|
|
3709
|
-
* <p>You do not have permissions to publish events with this source onto this event
|
|
3898
|
+
* <p>You do not have permissions to publish events with this source onto this event
|
|
3899
|
+
* bus.</p>
|
|
3710
3900
|
* </li>
|
|
3711
3901
|
* <li>
|
|
3712
3902
|
* <p>
|
|
3713
3903
|
* <code>NotAuthorizedForDetailTypeException</code>
|
|
3714
3904
|
* </p>
|
|
3715
|
-
* <p>You do not have permissions to publish events with this detail type onto this event
|
|
3905
|
+
* <p>You do not have permissions to publish events with this detail type onto this event
|
|
3906
|
+
* bus.</p>
|
|
3716
3907
|
* </li>
|
|
3717
3908
|
* </ul>
|
|
3718
3909
|
* @public
|
|
@@ -3737,7 +3928,8 @@ export interface PutEventsResponse {
|
|
|
3737
3928
|
* <p>The successfully and unsuccessfully ingested events results. If the ingestion was
|
|
3738
3929
|
* successful, the entry has the event ID in it. Otherwise, you can use the error code and error
|
|
3739
3930
|
* message to identify the problem with the entry.</p>
|
|
3740
|
-
* <p>For each record, the index of the response element is the same as the index in the request
|
|
3931
|
+
* <p>For each record, the index of the response element is the same as the index in the request
|
|
3932
|
+
* array.</p>
|
|
3741
3933
|
* @public
|
|
3742
3934
|
*/
|
|
3743
3935
|
Entries?: PutEventsResultEntry[];
|
|
@@ -3765,13 +3957,14 @@ export interface PutPartnerEventsRequestEntry {
|
|
|
3765
3957
|
*/
|
|
3766
3958
|
Source?: string;
|
|
3767
3959
|
/**
|
|
3768
|
-
* <p>Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily
|
|
3769
|
-
*
|
|
3960
|
+
* <p>Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily concerns.
|
|
3961
|
+
* Any number, including zero, may be present.</p>
|
|
3770
3962
|
* @public
|
|
3771
3963
|
*/
|
|
3772
3964
|
Resources?: string[];
|
|
3773
3965
|
/**
|
|
3774
|
-
* <p>A free-form string, with a maximum of 128 characters, used to decide what fields to expect
|
|
3966
|
+
* <p>A free-form string, with a maximum of 128 characters, used to decide what fields to expect
|
|
3967
|
+
* in the event detail.</p>
|
|
3775
3968
|
* <note>
|
|
3776
3969
|
* <p>
|
|
3777
3970
|
* <code>Detail</code>, <code>DetailType</code>, and <code>Source</code> are required for EventBridge to successfully send an event to an event bus.
|
|
@@ -3807,9 +4000,9 @@ export interface PutPartnerEventsRequest {
|
|
|
3807
4000
|
Entries: PutPartnerEventsRequestEntry[] | undefined;
|
|
3808
4001
|
}
|
|
3809
4002
|
/**
|
|
3810
|
-
* <p>The result of an event entry the partner submitted in this request.
|
|
3811
|
-
*
|
|
3812
|
-
*
|
|
4003
|
+
* <p>The result of an event entry the partner submitted in this request. If the event was
|
|
4004
|
+
* successfully submitted, the entry has the event ID in it. Otherwise, you can use the error
|
|
4005
|
+
* code and error message to identify the problem with the entry.</p>
|
|
3813
4006
|
* @public
|
|
3814
4007
|
*/
|
|
3815
4008
|
export interface PutPartnerEventsResultEntry {
|
|
@@ -3840,10 +4033,11 @@ export interface PutPartnerEventsResponse {
|
|
|
3840
4033
|
*/
|
|
3841
4034
|
FailedEntryCount?: number;
|
|
3842
4035
|
/**
|
|
3843
|
-
* <p>The results for each event entry the partner submitted in this request.
|
|
3844
|
-
*
|
|
3845
|
-
*
|
|
3846
|
-
* <p>For each record, the index of the response element is the same as the index in the request
|
|
4036
|
+
* <p>The results for each event entry the partner submitted in this request. If the event was
|
|
4037
|
+
* successfully submitted, the entry has the event ID in it. Otherwise, you can use the error
|
|
4038
|
+
* code and error message to identify the problem with the entry.</p>
|
|
4039
|
+
* <p>For each record, the index of the response element is the same as the index in the request
|
|
4040
|
+
* array.</p>
|
|
3847
4041
|
* @public
|
|
3848
4042
|
*/
|
|
3849
4043
|
Entries?: PutPartnerEventsResultEntry[];
|
|
@@ -3863,9 +4057,10 @@ export declare class PolicyLengthExceededException extends __BaseException {
|
|
|
3863
4057
|
/**
|
|
3864
4058
|
* <p>A JSON string which you can use to limit the event bus permissions you are granting to
|
|
3865
4059
|
* only accounts that fulfill the condition. Currently, the only supported condition is
|
|
3866
|
-
* membership in a certain Amazon Web Services organization. The string must contain
|
|
3867
|
-
* <code>Key</code>, and <code>Value</code> fields. The <code>Value</code>
|
|
3868
|
-
* ID of the Amazon Web Services organization. Following is an example value
|
|
4060
|
+
* membership in a certain Amazon Web Services organization. The string must contain
|
|
4061
|
+
* <code>Type</code>, <code>Key</code>, and <code>Value</code> fields. The <code>Value</code>
|
|
4062
|
+
* field specifies the ID of the Amazon Web Services organization. Following is an example value
|
|
4063
|
+
* for <code>Condition</code>:</p>
|
|
3869
4064
|
* <p>
|
|
3870
4065
|
* <code>'\{"Type" : "StringEquals", "Key": "aws:PrincipalOrgID", "Value":
|
|
3871
4066
|
* "o-1234567890"\}'</code>
|
|
@@ -3908,8 +4103,9 @@ export interface PutPermissionRequest {
|
|
|
3908
4103
|
*/
|
|
3909
4104
|
Action?: string;
|
|
3910
4105
|
/**
|
|
3911
|
-
* <p>The 12-digit Amazon Web Services account ID that you are permitting to put events to your
|
|
3912
|
-
* bus. Specify "*" to permit any account to put events to your default event
|
|
4106
|
+
* <p>The 12-digit Amazon Web Services account ID that you are permitting to put events to your
|
|
4107
|
+
* default event bus. Specify "*" to permit any account to put events to your default event
|
|
4108
|
+
* bus.</p>
|
|
3913
4109
|
* <p>If you specify "*" without specifying <code>Condition</code>, avoid creating rules that
|
|
3914
4110
|
* may match undesirable events. To create more secure rules, make sure that the event pattern
|
|
3915
4111
|
* for each rule contains an <code>account</code> field with a specific account ID from which to
|
|
@@ -3921,7 +4117,7 @@ export interface PutPermissionRequest {
|
|
|
3921
4117
|
/**
|
|
3922
4118
|
* <p>An identifier string for the external account that you are granting permissions to. If you
|
|
3923
4119
|
* later want to revoke the permission for this external account, specify this
|
|
3924
|
-
*
|
|
4120
|
+
* <code>StatementId</code> when you run <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_RemovePermission.html">RemovePermission</a>.</p>
|
|
3925
4121
|
* <note>
|
|
3926
4122
|
* <p>Each <code>StatementId</code> must be unique.</p>
|
|
3927
4123
|
* </note>
|
|
@@ -3930,12 +4126,13 @@ export interface PutPermissionRequest {
|
|
|
3930
4126
|
StatementId?: string;
|
|
3931
4127
|
/**
|
|
3932
4128
|
* <p>This parameter enables you to limit the permission to accounts that fulfill a certain
|
|
3933
|
-
* condition, such as being a member of a certain Amazon Web Services organization. For more
|
|
3934
|
-
* Amazon Web Services Organizations, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_introduction.html">What Is Amazon Web Services
|
|
3935
|
-
* Organizations</a> in the <i>Amazon Web Services Organizations User
|
|
3936
|
-
*
|
|
3937
|
-
*
|
|
3938
|
-
*
|
|
4129
|
+
* condition, such as being a member of a certain Amazon Web Services organization. For more
|
|
4130
|
+
* information about Amazon Web Services Organizations, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_introduction.html">What Is Amazon Web Services
|
|
4131
|
+
* Organizations</a> in the <i>Amazon Web Services Organizations User
|
|
4132
|
+
* Guide</i>.</p>
|
|
4133
|
+
* <p>If you specify <code>Condition</code> with an Amazon Web Services organization ID, and
|
|
4134
|
+
* specify "*" as the value for <code>Principal</code>, you grant permission to all the accounts
|
|
4135
|
+
* in the named organization.</p>
|
|
3939
4136
|
* <p>The <code>Condition</code> is a JSON string which must contain <code>Type</code>,
|
|
3940
4137
|
* <code>Key</code>, and <code>Value</code> fields.</p>
|
|
3941
4138
|
* @public
|
|
@@ -3965,12 +4162,41 @@ export interface PutRuleRequest {
|
|
|
3965
4162
|
ScheduleExpression?: string;
|
|
3966
4163
|
/**
|
|
3967
4164
|
* <p>The event pattern. For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html">Amazon EventBridge event
|
|
3968
|
-
*
|
|
4165
|
+
* patterns</a> in the <i>
|
|
4166
|
+
* <i>Amazon EventBridge User Guide</i>
|
|
4167
|
+
* </i>.</p>
|
|
3969
4168
|
* @public
|
|
3970
4169
|
*/
|
|
3971
4170
|
EventPattern?: string;
|
|
3972
4171
|
/**
|
|
3973
|
-
* <p>
|
|
4172
|
+
* <p>The state of the rule.</p>
|
|
4173
|
+
* <p>Valid values include:</p>
|
|
4174
|
+
* <ul>
|
|
4175
|
+
* <li>
|
|
4176
|
+
* <p>
|
|
4177
|
+
* <code>DISABLED</code>: The rule is disabled. EventBridge does not match any events against the rule.</p>
|
|
4178
|
+
* </li>
|
|
4179
|
+
* <li>
|
|
4180
|
+
* <p>
|
|
4181
|
+
* <code>ENABLED</code>: The rule is enabled.
|
|
4182
|
+
* EventBridge matches events against the rule, <i>except</i> for Amazon Web Services management events delivered through CloudTrail.</p>
|
|
4183
|
+
* </li>
|
|
4184
|
+
* <li>
|
|
4185
|
+
* <p>
|
|
4186
|
+
* <code>ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS</code>: The rule is enabled for all
|
|
4187
|
+
* events, including Amazon Web Services management events delivered through CloudTrail.</p>
|
|
4188
|
+
* <p>Management events provide visibility into management operations that are performed on
|
|
4189
|
+
* resources in your Amazon Web Services account. These are also known as control plane
|
|
4190
|
+
* operations. For more information, see <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-events-with-cloudtrail.html#logging-management-events">Logging management events</a> in the <i>CloudTrail User
|
|
4191
|
+
* Guide</i>, and <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-service-event.html#eb-service-event-cloudtrail">Filtering management events from Amazon Web Services services</a> in the
|
|
4192
|
+
* <i>
|
|
4193
|
+
* <i>Amazon EventBridge User Guide</i>
|
|
4194
|
+
* </i>.</p>
|
|
4195
|
+
* <p>This value is only valid for rules on the <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-what-is-how-it-works-concepts.html#eb-bus-concepts-buses">default</a> event bus
|
|
4196
|
+
* or <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-create-event-bus.html">custom event buses</a>.
|
|
4197
|
+
* It does not apply to <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-saas.html">partner event buses</a>.</p>
|
|
4198
|
+
* </li>
|
|
4199
|
+
* </ul>
|
|
3974
4200
|
* @public
|
|
3975
4201
|
*/
|
|
3976
4202
|
State?: RuleState;
|
|
@@ -4112,11 +4338,11 @@ export interface RemoveTargetsRequest {
|
|
|
4112
4338
|
*/
|
|
4113
4339
|
Ids: string[] | undefined;
|
|
4114
4340
|
/**
|
|
4115
|
-
* <p>If this is a managed rule, created by an Amazon Web Services service on your behalf, you
|
|
4116
|
-
*
|
|
4117
|
-
* rules that are not managed rules. You can check whether a rule is a managed rule
|
|
4118
|
-
*
|
|
4119
|
-
*
|
|
4341
|
+
* <p>If this is a managed rule, created by an Amazon Web Services service on your behalf, you
|
|
4342
|
+
* must specify <code>Force</code> as <code>True</code> to remove targets. This parameter is
|
|
4343
|
+
* ignored for rules that are not managed rules. You can check whether a rule is a managed rule
|
|
4344
|
+
* by using <code>DescribeRule</code> or <code>ListRules</code> and checking the
|
|
4345
|
+
* <code>ManagedBy</code> field of the response.</p>
|
|
4120
4346
|
* @public
|
|
4121
4347
|
*/
|
|
4122
4348
|
Force?: boolean;
|
|
@@ -4248,14 +4474,16 @@ export interface TagResourceResponse {
|
|
|
4248
4474
|
export interface TestEventPatternRequest {
|
|
4249
4475
|
/**
|
|
4250
4476
|
* <p>The event pattern. For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html">Events and Event
|
|
4251
|
-
*
|
|
4477
|
+
* Patterns</a> in the <i>
|
|
4478
|
+
* <i>Amazon EventBridge User Guide</i>
|
|
4479
|
+
* </i>.</p>
|
|
4252
4480
|
* @public
|
|
4253
4481
|
*/
|
|
4254
4482
|
EventPattern: string | undefined;
|
|
4255
4483
|
/**
|
|
4256
4484
|
* <p>The event, in JSON format, to test against the event pattern. The JSON must follow the
|
|
4257
|
-
* format specified in <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/aws-events.html">Amazon Web Services Events</a>, and
|
|
4258
|
-
* fields are mandatory:</p>
|
|
4485
|
+
* format specified in <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/aws-events.html">Amazon Web Services Events</a>, and
|
|
4486
|
+
* the following fields are mandatory:</p>
|
|
4259
4487
|
* <ul>
|
|
4260
4488
|
* <li>
|
|
4261
4489
|
* <p>
|
|
@@ -4654,7 +4882,8 @@ export interface UpdateEndpointResponse {
|
|
|
4654
4882
|
*/
|
|
4655
4883
|
RoutingConfig?: RoutingConfig;
|
|
4656
4884
|
/**
|
|
4657
|
-
* <p>Whether event replication was enabled or disabled for the endpoint you updated in this
|
|
4885
|
+
* <p>Whether event replication was enabled or disabled for the endpoint you updated in this
|
|
4886
|
+
* request.</p>
|
|
4658
4887
|
* @public
|
|
4659
4888
|
*/
|
|
4660
4889
|
ReplicationConfig?: ReplicationConfig;
|
|
@@ -4664,7 +4893,8 @@ export interface UpdateEndpointResponse {
|
|
|
4664
4893
|
*/
|
|
4665
4894
|
EventBuses?: EndpointEventBus[];
|
|
4666
4895
|
/**
|
|
4667
|
-
* <p>The ARN of the role used by event replication for the endpoint you updated in this
|
|
4896
|
+
* <p>The ARN of the role used by event replication for the endpoint you updated in this
|
|
4897
|
+
* request.</p>
|
|
4668
4898
|
* @public
|
|
4669
4899
|
*/
|
|
4670
4900
|
RoleArn?: string;
|
|
@@ -4684,6 +4914,100 @@ export interface UpdateEndpointResponse {
|
|
|
4684
4914
|
*/
|
|
4685
4915
|
State?: EndpointState;
|
|
4686
4916
|
}
|
|
4917
|
+
/**
|
|
4918
|
+
* @public
|
|
4919
|
+
*/
|
|
4920
|
+
export interface UpdateEventBusRequest {
|
|
4921
|
+
/**
|
|
4922
|
+
* <p>The name of the event bus.</p>
|
|
4923
|
+
* @public
|
|
4924
|
+
*/
|
|
4925
|
+
Name?: string;
|
|
4926
|
+
/**
|
|
4927
|
+
* <p>The identifier of the KMS
|
|
4928
|
+
* customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt events on this event bus. The identifier can be the key
|
|
4929
|
+
* Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.</p>
|
|
4930
|
+
* <p>If you do not specify a customer managed key identifier, EventBridge uses an
|
|
4931
|
+
* Amazon Web Services owned key to encrypt events on the event bus.</p>
|
|
4932
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/getting-started.html">Managing keys</a> in the <i>Key Management Service
|
|
4933
|
+
* Developer Guide</i>. </p>
|
|
4934
|
+
* <note>
|
|
4935
|
+
* <p>Archives and schema discovery are not supported for event buses encrypted using a
|
|
4936
|
+
* customer managed key. EventBridge returns an error if:</p>
|
|
4937
|
+
* <ul>
|
|
4938
|
+
* <li>
|
|
4939
|
+
* <p>You call <code>
|
|
4940
|
+
* <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_CreateArchive.html">CreateArchive</a>
|
|
4941
|
+
* </code> on an event bus set to use a customer managed key for encryption.</p>
|
|
4942
|
+
* </li>
|
|
4943
|
+
* <li>
|
|
4944
|
+
* <p>You call <code>
|
|
4945
|
+
* <a href="https://docs.aws.amazon.com/eventbridge/latest/schema-reference/v1-discoverers.html#CreateDiscoverer">CreateDiscoverer</a>
|
|
4946
|
+
* </code> on an event bus set to use a customer managed key for encryption.</p>
|
|
4947
|
+
* </li>
|
|
4948
|
+
* <li>
|
|
4949
|
+
* <p>You call <code>
|
|
4950
|
+
* <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_UpdatedEventBus.html">UpdatedEventBus</a>
|
|
4951
|
+
* </code> to set a customer managed key on an event bus with an archives or schema discovery enabled.</p>
|
|
4952
|
+
* </li>
|
|
4953
|
+
* </ul>
|
|
4954
|
+
* <p>To enable archives or schema discovery on an event bus, choose to
|
|
4955
|
+
* use an Amazon Web Services owned key. For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-encryption.html">Data encryption in EventBridge</a> in the <i>Amazon EventBridge User Guide</i>.</p>
|
|
4956
|
+
* </note>
|
|
4957
|
+
* @public
|
|
4958
|
+
*/
|
|
4959
|
+
KmsKeyIdentifier?: string;
|
|
4960
|
+
/**
|
|
4961
|
+
* <p>The event bus description.</p>
|
|
4962
|
+
* @public
|
|
4963
|
+
*/
|
|
4964
|
+
Description?: string;
|
|
4965
|
+
/**
|
|
4966
|
+
* <p>Configuration details of the Amazon SQS queue for EventBridge to use as a
|
|
4967
|
+
* dead-letter queue (DLQ).</p>
|
|
4968
|
+
* <p>For more information, see <a href="eventbridge/latest/userguide/eb-rule-dlq.html">Event
|
|
4969
|
+
* retry policy and using dead-letter queues</a> in the <i>EventBridge User
|
|
4970
|
+
* Guide</i>.</p>
|
|
4971
|
+
* @public
|
|
4972
|
+
*/
|
|
4973
|
+
DeadLetterConfig?: DeadLetterConfig;
|
|
4974
|
+
}
|
|
4975
|
+
/**
|
|
4976
|
+
* @public
|
|
4977
|
+
*/
|
|
4978
|
+
export interface UpdateEventBusResponse {
|
|
4979
|
+
/**
|
|
4980
|
+
* <p>The event bus Amazon Resource Name (ARN).</p>
|
|
4981
|
+
* @public
|
|
4982
|
+
*/
|
|
4983
|
+
Arn?: string;
|
|
4984
|
+
/**
|
|
4985
|
+
* <p>The event bus name.</p>
|
|
4986
|
+
* @public
|
|
4987
|
+
*/
|
|
4988
|
+
Name?: string;
|
|
4989
|
+
/**
|
|
4990
|
+
* <p>The identifier of the KMS
|
|
4991
|
+
* customer managed key for EventBridge to use to encrypt events on this event bus, if one has been specified.</p>
|
|
4992
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-encryption.html">Data encryption in EventBridge</a> in the <i>Amazon EventBridge User Guide</i>.</p>
|
|
4993
|
+
* @public
|
|
4994
|
+
*/
|
|
4995
|
+
KmsKeyIdentifier?: string;
|
|
4996
|
+
/**
|
|
4997
|
+
* <p>The event bus description.</p>
|
|
4998
|
+
* @public
|
|
4999
|
+
*/
|
|
5000
|
+
Description?: string;
|
|
5001
|
+
/**
|
|
5002
|
+
* <p>Configuration details of the Amazon SQS queue for EventBridge to use as a
|
|
5003
|
+
* dead-letter queue (DLQ).</p>
|
|
5004
|
+
* <p>For more information, see <a href="eventbridge/latest/userguide/eb-rule-dlq.html">Event
|
|
5005
|
+
* retry policy and using dead-letter queues</a> in the <i>EventBridge User
|
|
5006
|
+
* Guide</i>.</p>
|
|
5007
|
+
* @public
|
|
5008
|
+
*/
|
|
5009
|
+
DeadLetterConfig?: DeadLetterConfig;
|
|
5010
|
+
}
|
|
4687
5011
|
/**
|
|
4688
5012
|
* @internal
|
|
4689
5013
|
*/
|