feat(client-eventbridge): Call private APIs by configuring Connection…

…s with VPC connectivity through PrivateLink and VPC Lattice
aws · Dec 2, 2024 · 224d5a7 · 224d5a7
1 parent e2236af
commit 224d5a7
Show file tree

Hide file tree

Showing 13 changed files with 642 additions and 161 deletions.
diff --git a/clients/client-eventbridge/src/commands/CreateConnectionCommand.ts b/clients/client-eventbridge/src/commands/CreateConnectionCommand.ts
@@ -34,6 +34,7 @@ export interface CreateConnectionCommandOutput extends CreateConnectionResponse,
 /**
  * <p>Creates a connection. A connection defines the authorization type and credentials to use
  *       for authorization with an API destination HTTP endpoint.</p>
+ *          <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>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -107,13 +108,23 @@ export interface CreateConnectionCommandOutput extends CreateConnectionResponse,
  *         },
  *       ],
  *     },
+ *     ConnectivityParameters: { // ConnectivityResourceParameters
+ *       ResourceParameters: { // ConnectivityResourceConfigurationArn
+ *         ResourceConfigurationArn: "STRING_VALUE", // required
+ *       },
+ *     },
+ *   },
+ *   InvocationConnectivityParameters: {
+ *     ResourceParameters: {
+ *       ResourceConfigurationArn: "STRING_VALUE", // required
+ *     },
  *   },
  * };
  * const command = new CreateConnectionCommand(input);
  * const response = await client.send(command);
  * // { // CreateConnectionResponse
  * //   ConnectionArn: "STRING_VALUE",
- * //   ConnectionState: "CREATING" || "UPDATING" || "DELETING" || "AUTHORIZED" || "DEAUTHORIZED" || "AUTHORIZING" || "DEAUTHORIZING",
+ * //   ConnectionState: "CREATING" || "UPDATING" || "DELETING" || "AUTHORIZED" || "DEAUTHORIZED" || "AUTHORIZING" || "DEAUTHORIZING" || "ACTIVE" || "FAILED_CONNECTIVITY",
  * //   CreationTime: new Date("TIMESTAMP"),
  * //   LastModifiedTime: new Date("TIMESTAMP"),
  * // };
@@ -126,6 +137,9 @@ export interface CreateConnectionCommandOutput extends CreateConnectionResponse,
  * @see {@link CreateConnectionCommandOutput} for command's `response` shape.
  * @see {@link EventBridgeClientResolvedConfig | config} for EventBridgeClient's `config` shape.
  *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You do not have the necessary permissons for this action.</p>
+ *
  * @throws {@link InternalException} (server fault)
  *  <p>This exception occurs due to unexpected causes.</p>
  *
@@ -136,6 +150,12 @@ export interface CreateConnectionCommandOutput extends CreateConnectionResponse,
  * @throws {@link ResourceAlreadyExistsException} (client fault)
  *  <p>The resource you are trying to create already exists.</p>
  *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>An entity that you specified does not exist.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>This request cannot be completed due to throttling issues.</p>
+ *
  * @throws {@link EventBridgeServiceException}
  * <p>Base exception class for all service exceptions from EventBridge service.</p>
  *

diff --git a/clients/client-eventbridge/src/commands/DeauthorizeConnectionCommand.ts b/clients/client-eventbridge/src/commands/DeauthorizeConnectionCommand.ts
@@ -43,7 +43,7 @@ export interface DeauthorizeConnectionCommandOutput extends DeauthorizeConnectio
  * const response = await client.send(command);
  * // { // DeauthorizeConnectionResponse
  * //   ConnectionArn: "STRING_VALUE",
- * //   ConnectionState: "CREATING" || "UPDATING" || "DELETING" || "AUTHORIZED" || "DEAUTHORIZED" || "AUTHORIZING" || "DEAUTHORIZING",
+ * //   ConnectionState: "CREATING" || "UPDATING" || "DELETING" || "AUTHORIZED" || "DEAUTHORIZED" || "AUTHORIZING" || "DEAUTHORIZING" || "ACTIVE" || "FAILED_CONNECTIVITY",
  * //   CreationTime: new Date("TIMESTAMP"),
  * //   LastModifiedTime: new Date("TIMESTAMP"),
  * //   LastAuthorizedTime: new Date("TIMESTAMP"),

diff --git a/clients/client-eventbridge/src/commands/DeleteConnectionCommand.ts b/clients/client-eventbridge/src/commands/DeleteConnectionCommand.ts
@@ -42,7 +42,7 @@ export interface DeleteConnectionCommandOutput extends DeleteConnectionResponse,
  * const response = await client.send(command);
  * // { // DeleteConnectionResponse
  * //   ConnectionArn: "STRING_VALUE",
- * //   ConnectionState: "CREATING" || "UPDATING" || "DELETING" || "AUTHORIZED" || "DEAUTHORIZED" || "AUTHORIZING" || "DEAUTHORIZING",
+ * //   ConnectionState: "CREATING" || "UPDATING" || "DELETING" || "AUTHORIZED" || "DEAUTHORIZED" || "AUTHORIZING" || "DEAUTHORIZING" || "ACTIVE" || "FAILED_CONNECTIVITY",
  * //   CreationTime: new Date("TIMESTAMP"),
  * //   LastModifiedTime: new Date("TIMESTAMP"),
  * //   LastAuthorizedTime: new Date("TIMESTAMP"),

diff --git a/clients/client-eventbridge/src/commands/DescribeConnectionCommand.ts b/clients/client-eventbridge/src/commands/DescribeConnectionCommand.ts
@@ -48,7 +48,13 @@ export interface DescribeConnectionCommandOutput extends DescribeConnectionRespo
  * //   ConnectionArn: "STRING_VALUE",
  * //   Name: "STRING_VALUE",
  * //   Description: "STRING_VALUE",
- * //   ConnectionState: "CREATING" || "UPDATING" || "DELETING" || "AUTHORIZED" || "DEAUTHORIZED" || "AUTHORIZING" || "DEAUTHORIZING",
+ * //   InvocationConnectivityParameters: { // DescribeConnectionConnectivityParameters
+ * //     ResourceParameters: { // DescribeConnectionResourceParameters
+ * //       ResourceConfigurationArn: "STRING_VALUE", // required
+ * //       ResourceAssociationArn: "STRING_VALUE", // required
+ * //     },
+ * //   },
+ * //   ConnectionState: "CREATING" || "UPDATING" || "DELETING" || "AUTHORIZED" || "DEAUTHORIZED" || "AUTHORIZING" || "DEAUTHORIZING" || "ACTIVE" || "FAILED_CONNECTIVITY",
  * //   StateReason: "STRING_VALUE",
  * //   AuthorizationType: "BASIC" || "OAUTH_CLIENT_CREDENTIALS" || "API_KEY",
  * //   SecretArn: "STRING_VALUE",
@@ -112,6 +118,12 @@ export interface DescribeConnectionCommandOutput extends DescribeConnectionRespo
  * //         },
  * //       ],
  * //     },
+ * //     ConnectivityParameters: {
+ * //       ResourceParameters: {
+ * //         ResourceConfigurationArn: "STRING_VALUE", // required
+ * //         ResourceAssociationArn: "STRING_VALUE", // required
+ * //       },
+ * //     },
  * //   },
  * //   CreationTime: new Date("TIMESTAMP"),
  * //   LastModifiedTime: new Date("TIMESTAMP"),

diff --git a/clients/client-eventbridge/src/commands/ListConnectionsCommand.ts b/clients/client-eventbridge/src/commands/ListConnectionsCommand.ts
@@ -37,7 +37,7 @@ export interface ListConnectionsCommandOutput extends ListConnectionsResponse, _
  * const client = new EventBridgeClient(config);
  * const input = { // ListConnectionsRequest
  *   NamePrefix: "STRING_VALUE",
- *   ConnectionState: "CREATING" || "UPDATING" || "DELETING" || "AUTHORIZED" || "DEAUTHORIZED" || "AUTHORIZING" || "DEAUTHORIZING",
+ *   ConnectionState: "CREATING" || "UPDATING" || "DELETING" || "AUTHORIZED" || "DEAUTHORIZED" || "AUTHORIZING" || "DEAUTHORIZING" || "ACTIVE" || "FAILED_CONNECTIVITY",
  *   NextToken: "STRING_VALUE",
  *   Limit: Number("int"),
  * };
@@ -48,7 +48,7 @@ export interface ListConnectionsCommandOutput extends ListConnectionsResponse, _
  * //     { // Connection
  * //       ConnectionArn: "STRING_VALUE",
  * //       Name: "STRING_VALUE",
- * //       ConnectionState: "CREATING" || "UPDATING" || "DELETING" || "AUTHORIZED" || "DEAUTHORIZED" || "AUTHORIZING" || "DEAUTHORIZING",
+ * //       ConnectionState: "CREATING" || "UPDATING" || "DELETING" || "AUTHORIZED" || "DEAUTHORIZED" || "AUTHORIZING" || "DEAUTHORIZING" || "ACTIVE" || "FAILED_CONNECTIVITY",
  * //       StateReason: "STRING_VALUE",
  * //       AuthorizationType: "BASIC" || "OAUTH_CLIENT_CREDENTIALS" || "API_KEY",
  * //       CreationTime: new Date("TIMESTAMP"),

diff --git a/clients/client-eventbridge/src/commands/PutEventsCommand.ts b/clients/client-eventbridge/src/commands/PutEventsCommand.ts
@@ -40,7 +40,7 @@ export interface PutEventsCommandOutput extends PutEventsResponse, __MetadataBea
  *       constraints are: a minimum value of -9,223,372,036,854,775,808 and a maximum value of
  *       9,223,372,036,854,775,807.</p>
  *          <note>
- *             <p>PutEvents will only process nested JSON up to 1100 levels deep.</p>
+ *             <p>PutEvents will only process nested JSON up to 1000 levels deep.</p>
  *          </note>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

diff --git a/clients/client-eventbridge/src/commands/PutPermissionCommand.ts b/clients/client-eventbridge/src/commands/PutPermissionCommand.ts
@@ -28,10 +28,9 @@ export interface PutPermissionCommandInput extends PutPermissionRequest {}
 export interface PutPermissionCommandOutput extends __MetadataBearer {}
 
 /**
- * <p>Running <code>PutPermission</code> permits the specified Amazon Web Services account or
- *         Amazon Web Services organization to put events to the specified <i>event
- *         bus</i>. Amazon EventBridge (CloudWatch Events) rules in your account are
- *       triggered by these events arriving to an event bus in your account. </p>
+ * <p>Running <code>PutPermission</code> permits the specified Amazon Web Services account or Amazon Web Services organization
+ *       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
+ *       account. </p>
  *          <p>For another account to send events to your account, that external account must have an
  *       EventBridge rule with your account's event bus as a target.</p>
  *          <p>To enable multiple Amazon Web Services accounts to put events to your event bus, run

diff --git a/clients/client-eventbridge/src/commands/PutRuleCommand.ts b/clients/client-eventbridge/src/commands/PutRuleCommand.ts
@@ -67,6 +67,9 @@ export interface PutRuleCommandOutput extends PutRuleResponse, __MetadataBearer
  *       budgeting, which alerts you when charges exceed your specified limit. For more information,
  *       see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/budgets-managing-costs.html">Managing Your Costs with
  *         Budgets</a>.</p>
+ *          <p>To create a rule that filters for management events from Amazon Web Services services, see
+ *       <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
+ *       <i>EventBridge User Guide</i>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-eventbridge/src/commands/UntagResourceCommand.ts b/clients/client-eventbridge/src/commands/UntagResourceCommand.ts
@@ -28,8 +28,7 @@ export interface UntagResourceCommandInput extends UntagResourceRequest {}
 export interface UntagResourceCommandOutput extends UntagResourceResponse, __MetadataBearer {}
 
 /**
- * <p>Removes one or more tags from the specified EventBridge resource. In Amazon EventBridge
- *       (CloudWatch Events), rules and event buses can be tagged.</p>
+ * <p>Removes one or more tags from the specified EventBridge resource. In Amazon EventBridge, rules and event buses can be tagged.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-eventbridge/src/commands/UpdateConnectionCommand.ts b/clients/client-eventbridge/src/commands/UpdateConnectionCommand.ts
@@ -106,13 +106,23 @@ export interface UpdateConnectionCommandOutput extends UpdateConnectionResponse,
  *         },
  *       ],
  *     },
+ *     ConnectivityParameters: { // ConnectivityResourceParameters
+ *       ResourceParameters: { // ConnectivityResourceConfigurationArn
+ *         ResourceConfigurationArn: "STRING_VALUE", // required
+ *       },
+ *     },
+ *   },
+ *   InvocationConnectivityParameters: {
+ *     ResourceParameters: {
+ *       ResourceConfigurationArn: "STRING_VALUE", // required
+ *     },
  *   },
  * };
  * const command = new UpdateConnectionCommand(input);
  * const response = await client.send(command);
  * // { // UpdateConnectionResponse
  * //   ConnectionArn: "STRING_VALUE",
- * //   ConnectionState: "CREATING" || "UPDATING" || "DELETING" || "AUTHORIZED" || "DEAUTHORIZED" || "AUTHORIZING" || "DEAUTHORIZING",
+ * //   ConnectionState: "CREATING" || "UPDATING" || "DELETING" || "AUTHORIZED" || "DEAUTHORIZED" || "AUTHORIZING" || "DEAUTHORIZING" || "ACTIVE" || "FAILED_CONNECTIVITY",
  * //   CreationTime: new Date("TIMESTAMP"),
  * //   LastModifiedTime: new Date("TIMESTAMP"),
  * //   LastAuthorizedTime: new Date("TIMESTAMP"),
@@ -126,6 +136,9 @@ export interface UpdateConnectionCommandOutput extends UpdateConnectionResponse,
  * @see {@link UpdateConnectionCommandOutput} for command's `response` shape.
  * @see {@link EventBridgeClientResolvedConfig | config} for EventBridgeClient's `config` shape.
  *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You do not have the necessary permissons for this action.</p>
+ *
  * @throws {@link ConcurrentModificationException} (client fault)
  *  <p>There is concurrent modification on a rule, target, archive, or replay.</p>
  *
@@ -139,6 +152,9 @@ export interface UpdateConnectionCommandOutput extends UpdateConnectionResponse,
  * @throws {@link ResourceNotFoundException} (client fault)
  *  <p>An entity that you specified does not exist.</p>
  *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>This request cannot be completed due to throttling issues.</p>
+ *
  * @throws {@link EventBridgeServiceException}
  * <p>Base exception class for all service exceptions from EventBridge service.</p>
  *