Skip to content

Commit 224d5a7

Browse files
author
awstools
committed
feat(client-eventbridge): Call private APIs by configuring Connections with VPC connectivity through PrivateLink and VPC Lattice
1 parent e2236af commit 224d5a7

13 files changed

+642
-161
lines changed

‎clients/client-eventbridge/src/commands/CreateConnectionCommand.ts

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ export interface CreateConnectionCommandOutput extends CreateConnectionResponse,
3434
/**
3535
* <p>Creates a connection. A connection defines the authorization type and credentials to use
3636
* for authorization with an API destination HTTP endpoint.</p>
37+
* <p>For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-target-connection.html">Connections for endpoint targets</a> in the <i>Amazon EventBridge User Guide</i>.</p>
3738
* @example
3839
* Use a bare-bones client and the command you need to make an API call.
3940
* ```javascript
@@ -107,13 +108,23 @@ export interface CreateConnectionCommandOutput extends CreateConnectionResponse,
107108
* },
108109
* ],
109110
* },
111+
* ConnectivityParameters: { // ConnectivityResourceParameters
112+
* ResourceParameters: { // ConnectivityResourceConfigurationArn
113+
* ResourceConfigurationArn: "STRING_VALUE", // required
114+
* },
115+
* },
116+
* },
117+
* InvocationConnectivityParameters: {
118+
* ResourceParameters: {
119+
* ResourceConfigurationArn: "STRING_VALUE", // required
120+
* },
110121
* },
111122
* };
112123
* const command = new CreateConnectionCommand(input);
113124
* const response = await client.send(command);
114125
* // { // CreateConnectionResponse
115126
* // ConnectionArn: "STRING_VALUE",
116-
* // ConnectionState: "CREATING" || "UPDATING" || "DELETING" || "AUTHORIZED" || "DEAUTHORIZED" || "AUTHORIZING" || "DEAUTHORIZING",
127+
* // ConnectionState: "CREATING" || "UPDATING" || "DELETING" || "AUTHORIZED" || "DEAUTHORIZED" || "AUTHORIZING" || "DEAUTHORIZING" || "ACTIVE" || "FAILED_CONNECTIVITY",
117128
* // CreationTime: new Date("TIMESTAMP"),
118129
* // LastModifiedTime: new Date("TIMESTAMP"),
119130
* // };
@@ -126,6 +137,9 @@ export interface CreateConnectionCommandOutput extends CreateConnectionResponse,
126137
* @see {@link CreateConnectionCommandOutput} for command's `response` shape.
127138
* @see {@link EventBridgeClientResolvedConfig | config} for EventBridgeClient's `config` shape.
128139
*
140+
* @throws {@link AccessDeniedException} (client fault)
141+
* <p>You do not have the necessary permissons for this action.</p>
142+
*
129143
* @throws {@link InternalException} (server fault)
130144
* <p>This exception occurs due to unexpected causes.</p>
131145
*
@@ -136,6 +150,12 @@ export interface CreateConnectionCommandOutput extends CreateConnectionResponse,
136150
* @throws {@link ResourceAlreadyExistsException} (client fault)
137151
* <p>The resource you are trying to create already exists.</p>
138152
*
153+
* @throws {@link ResourceNotFoundException} (client fault)
154+
* <p>An entity that you specified does not exist.</p>
155+
*
156+
* @throws {@link ThrottlingException} (client fault)
157+
* <p>This request cannot be completed due to throttling issues.</p>
158+
*
139159
* @throws {@link EventBridgeServiceException}
140160
* <p>Base exception class for all service exceptions from EventBridge service.</p>
141161
*

‎clients/client-eventbridge/src/commands/DeauthorizeConnectionCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ export interface DeauthorizeConnectionCommandOutput extends DeauthorizeConnectio
4343
* const response = await client.send(command);
4444
* // { // DeauthorizeConnectionResponse
4545
* // ConnectionArn: "STRING_VALUE",
46-
* // ConnectionState: "CREATING" || "UPDATING" || "DELETING" || "AUTHORIZED" || "DEAUTHORIZED" || "AUTHORIZING" || "DEAUTHORIZING",
46+
* // ConnectionState: "CREATING" || "UPDATING" || "DELETING" || "AUTHORIZED" || "DEAUTHORIZED" || "AUTHORIZING" || "DEAUTHORIZING" || "ACTIVE" || "FAILED_CONNECTIVITY",
4747
* // CreationTime: new Date("TIMESTAMP"),
4848
* // LastModifiedTime: new Date("TIMESTAMP"),
4949
* // LastAuthorizedTime: new Date("TIMESTAMP"),

‎clients/client-eventbridge/src/commands/DeleteConnectionCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ export interface DeleteConnectionCommandOutput extends DeleteConnectionResponse,
4242
* const response = await client.send(command);
4343
* // { // DeleteConnectionResponse
4444
* // ConnectionArn: "STRING_VALUE",
45-
* // ConnectionState: "CREATING" || "UPDATING" || "DELETING" || "AUTHORIZED" || "DEAUTHORIZED" || "AUTHORIZING" || "DEAUTHORIZING",
45+
* // ConnectionState: "CREATING" || "UPDATING" || "DELETING" || "AUTHORIZED" || "DEAUTHORIZED" || "AUTHORIZING" || "DEAUTHORIZING" || "ACTIVE" || "FAILED_CONNECTIVITY",
4646
* // CreationTime: new Date("TIMESTAMP"),
4747
* // LastModifiedTime: new Date("TIMESTAMP"),
4848
* // LastAuthorizedTime: new Date("TIMESTAMP"),

‎clients/client-eventbridge/src/commands/DescribeConnectionCommand.ts

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,13 @@ export interface DescribeConnectionCommandOutput extends DescribeConnectionRespo
4848
* // ConnectionArn: "STRING_VALUE",
4949
* // Name: "STRING_VALUE",
5050
* // Description: "STRING_VALUE",
51-
* // ConnectionState: "CREATING" || "UPDATING" || "DELETING" || "AUTHORIZED" || "DEAUTHORIZED" || "AUTHORIZING" || "DEAUTHORIZING",
51+
* // InvocationConnectivityParameters: { // DescribeConnectionConnectivityParameters
52+
* // ResourceParameters: { // DescribeConnectionResourceParameters
53+
* // ResourceConfigurationArn: "STRING_VALUE", // required
54+
* // ResourceAssociationArn: "STRING_VALUE", // required
55+
* // },
56+
* // },
57+
* // ConnectionState: "CREATING" || "UPDATING" || "DELETING" || "AUTHORIZED" || "DEAUTHORIZED" || "AUTHORIZING" || "DEAUTHORIZING" || "ACTIVE" || "FAILED_CONNECTIVITY",
5258
* // StateReason: "STRING_VALUE",
5359
* // AuthorizationType: "BASIC" || "OAUTH_CLIENT_CREDENTIALS" || "API_KEY",
5460
* // SecretArn: "STRING_VALUE",
@@ -112,6 +118,12 @@ export interface DescribeConnectionCommandOutput extends DescribeConnectionRespo
112118
* // },
113119
* // ],
114120
* // },
121+
* // ConnectivityParameters: {
122+
* // ResourceParameters: {
123+
* // ResourceConfigurationArn: "STRING_VALUE", // required
124+
* // ResourceAssociationArn: "STRING_VALUE", // required
125+
* // },
126+
* // },
115127
* // },
116128
* // CreationTime: new Date("TIMESTAMP"),
117129
* // LastModifiedTime: new Date("TIMESTAMP"),

‎clients/client-eventbridge/src/commands/ListConnectionsCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ export interface ListConnectionsCommandOutput extends ListConnectionsResponse, _
3737
* const client = new EventBridgeClient(config);
3838
* const input = { // ListConnectionsRequest
3939
* NamePrefix: "STRING_VALUE",
40-
* ConnectionState: "CREATING" || "UPDATING" || "DELETING" || "AUTHORIZED" || "DEAUTHORIZED" || "AUTHORIZING" || "DEAUTHORIZING",
40+
* ConnectionState: "CREATING" || "UPDATING" || "DELETING" || "AUTHORIZED" || "DEAUTHORIZED" || "AUTHORIZING" || "DEAUTHORIZING" || "ACTIVE" || "FAILED_CONNECTIVITY",
4141
* NextToken: "STRING_VALUE",
4242
* Limit: Number("int"),
4343
* };
@@ -48,7 +48,7 @@ export interface ListConnectionsCommandOutput extends ListConnectionsResponse, _
4848
* // { // Connection
4949
* // ConnectionArn: "STRING_VALUE",
5050
* // Name: "STRING_VALUE",
51-
* // ConnectionState: "CREATING" || "UPDATING" || "DELETING" || "AUTHORIZED" || "DEAUTHORIZED" || "AUTHORIZING" || "DEAUTHORIZING",
51+
* // ConnectionState: "CREATING" || "UPDATING" || "DELETING" || "AUTHORIZED" || "DEAUTHORIZED" || "AUTHORIZING" || "DEAUTHORIZING" || "ACTIVE" || "FAILED_CONNECTIVITY",
5252
* // StateReason: "STRING_VALUE",
5353
* // AuthorizationType: "BASIC" || "OAUTH_CLIENT_CREDENTIALS" || "API_KEY",
5454
* // CreationTime: new Date("TIMESTAMP"),

‎clients/client-eventbridge/src/commands/PutEventsCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ export interface PutEventsCommandOutput extends PutEventsResponse, __MetadataBea
4040
* constraints are: a minimum value of -9,223,372,036,854,775,808 and a maximum value of
4141
* 9,223,372,036,854,775,807.</p>
4242
* <note>
43-
* <p>PutEvents will only process nested JSON up to 1100 levels deep.</p>
43+
* <p>PutEvents will only process nested JSON up to 1000 levels deep.</p>
4444
* </note>
4545
* @example
4646
* Use a bare-bones client and the command you need to make an API call.

‎clients/client-eventbridge/src/commands/PutPermissionCommand.ts

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,9 @@ export interface PutPermissionCommandInput extends PutPermissionRequest {}
2828
export interface PutPermissionCommandOutput extends __MetadataBearer {}
2929

3030
/**
31-
* <p>Running <code>PutPermission</code> permits the specified Amazon Web Services account or
32-
* Amazon Web Services organization to put events to the specified <i>event
33-
* bus</i>. Amazon EventBridge (CloudWatch Events) rules in your account are
34-
* triggered by these events arriving to an event bus in your account. </p>
31+
* <p>Running <code>PutPermission</code> permits the specified Amazon Web Services account or Amazon Web Services organization
32+
* to put events to the specified <i>event bus</i>. Amazon EventBridge rules in your account are triggered by these events arriving to an event bus in your
33+
* account. </p>
3534
* <p>For another account to send events to your account, that external account must have an
3635
* EventBridge rule with your account's event bus as a target.</p>
3736
* <p>To enable multiple Amazon Web Services accounts to put events to your event bus, run

‎clients/client-eventbridge/src/commands/PutRuleCommand.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,9 @@ export interface PutRuleCommandOutput extends PutRuleResponse, __MetadataBearer
6767
* budgeting, which alerts you when charges exceed your specified limit. For more information,
6868
* see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/budgets-managing-costs.html">Managing Your Costs with
6969
* Budgets</a>.</p>
70+
* <p>To create a rule that filters for management events from Amazon Web Services services, see
71+
* <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-service-event-cloudtrail.html#eb-service-event-cloudtrail-management">Receiving read-only management events from Amazon Web Services services</a> in the
72+
* <i>EventBridge User Guide</i>.</p>
7073
* @example
7174
* Use a bare-bones client and the command you need to make an API call.
7275
* ```javascript

‎clients/client-eventbridge/src/commands/UntagResourceCommand.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,7 @@ export interface UntagResourceCommandInput extends UntagResourceRequest {}
2828
export interface UntagResourceCommandOutput extends UntagResourceResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Removes one or more tags from the specified EventBridge resource. In Amazon EventBridge
32-
* (CloudWatch Events), rules and event buses can be tagged.</p>
31+
* <p>Removes one or more tags from the specified EventBridge resource. In Amazon EventBridge, rules and event buses can be tagged.</p>
3332
* @example
3433
* Use a bare-bones client and the command you need to make an API call.
3534
* ```javascript

‎clients/client-eventbridge/src/commands/UpdateConnectionCommand.ts

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,13 +106,23 @@ export interface UpdateConnectionCommandOutput extends UpdateConnectionResponse,
106106
* },
107107
* ],
108108
* },
109+
* ConnectivityParameters: { // ConnectivityResourceParameters
110+
* ResourceParameters: { // ConnectivityResourceConfigurationArn
111+
* ResourceConfigurationArn: "STRING_VALUE", // required
112+
* },
113+
* },
114+
* },
115+
* InvocationConnectivityParameters: {
116+
* ResourceParameters: {
117+
* ResourceConfigurationArn: "STRING_VALUE", // required
118+
* },
109119
* },
110120
* };
111121
* const command = new UpdateConnectionCommand(input);
112122
* const response = await client.send(command);
113123
* // { // UpdateConnectionResponse
114124
* // ConnectionArn: "STRING_VALUE",
115-
* // ConnectionState: "CREATING" || "UPDATING" || "DELETING" || "AUTHORIZED" || "DEAUTHORIZED" || "AUTHORIZING" || "DEAUTHORIZING",
125+
* // ConnectionState: "CREATING" || "UPDATING" || "DELETING" || "AUTHORIZED" || "DEAUTHORIZED" || "AUTHORIZING" || "DEAUTHORIZING" || "ACTIVE" || "FAILED_CONNECTIVITY",
116126
* // CreationTime: new Date("TIMESTAMP"),
117127
* // LastModifiedTime: new Date("TIMESTAMP"),
118128
* // LastAuthorizedTime: new Date("TIMESTAMP"),
@@ -126,6 +136,9 @@ export interface UpdateConnectionCommandOutput extends UpdateConnectionResponse,
126136
* @see {@link UpdateConnectionCommandOutput} for command's `response` shape.
127137
* @see {@link EventBridgeClientResolvedConfig | config} for EventBridgeClient's `config` shape.
128138
*
139+
* @throws {@link AccessDeniedException} (client fault)
140+
* <p>You do not have the necessary permissons for this action.</p>
141+
*
129142
* @throws {@link ConcurrentModificationException} (client fault)
130143
* <p>There is concurrent modification on a rule, target, archive, or replay.</p>
131144
*
@@ -139,6 +152,9 @@ export interface UpdateConnectionCommandOutput extends UpdateConnectionResponse,
139152
* @throws {@link ResourceNotFoundException} (client fault)
140153
* <p>An entity that you specified does not exist.</p>
141154
*
155+
* @throws {@link ThrottlingException} (client fault)
156+
* <p>This request cannot be completed due to throttling issues.</p>
157+
*
142158
* @throws {@link EventBridgeServiceException}
143159
* <p>Base exception class for all service exceptions from EventBridge service.</p>
144160
*

0 commit comments

Comments
 (0)