@aws-sdk/client-eventbridge 3.58.0 → 3.66.0

package/dist-types/commands/UpdateEndpointCommand.d.ts

@@ -0,0 +1,35 @@
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
+import { EventBridgeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EventBridgeClient";
+import { UpdateEndpointRequest, UpdateEndpointResponse } from "../models/models_0";
+export interface UpdateEndpointCommandInput extends UpdateEndpointRequest {
+}
+export interface UpdateEndpointCommandOutput extends UpdateEndpointResponse, __MetadataBearer {
+}
+/**
+ * <p>Update an existing endpoint. For more information about global endpoints, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-global-endpoints.html">Making applications Regional-fault tolerant with global endpoints and event replication</a> in the Amazon EventBridge User Guide..</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { EventBridgeClient, UpdateEndpointCommand } from "@aws-sdk/client-eventbridge"; // ES Modules import
+ * // const { EventBridgeClient, UpdateEndpointCommand } = require("@aws-sdk/client-eventbridge"); // CommonJS import
+ * const client = new EventBridgeClient(config);
+ * const command = new UpdateEndpointCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @see {@link UpdateEndpointCommandInput} for command's `input` shape.
+ * @see {@link UpdateEndpointCommandOutput} for command's `response` shape.
+ * @see {@link EventBridgeClientResolvedConfig | config} for EventBridgeClient's `config` shape.
+ *
+ */
+export declare class UpdateEndpointCommand extends $Command<UpdateEndpointCommandInput, UpdateEndpointCommandOutput, EventBridgeClientResolvedConfig> {
+    readonly input: UpdateEndpointCommandInput;
+    constructor(input: UpdateEndpointCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: EventBridgeClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateEndpointCommandInput, UpdateEndpointCommandOutput>;
+    private serialize;
+    private deserialize;
+}

package/dist-types/commands/index.d.ts

@@ -3,6 +3,7 @@ export * from "./CancelReplayCommand";
 export * from "./CreateApiDestinationCommand";
 export * from "./CreateArchiveCommand";
 export * from "./CreateConnectionCommand";
+export * from "./CreateEndpointCommand";
 export * from "./CreateEventBusCommand";
 export * from "./CreatePartnerEventSourceCommand";
 export * from "./DeactivateEventSourceCommand";
@@ -10,12 +11,14 @@ export * from "./DeauthorizeConnectionCommand";
 export * from "./DeleteApiDestinationCommand";
 export * from "./DeleteArchiveCommand";
 export * from "./DeleteConnectionCommand";
+export * from "./DeleteEndpointCommand";
 export * from "./DeleteEventBusCommand";
 export * from "./DeletePartnerEventSourceCommand";
 export * from "./DeleteRuleCommand";
 export * from "./DescribeApiDestinationCommand";
 export * from "./DescribeArchiveCommand";
 export * from "./DescribeConnectionCommand";
+export * from "./DescribeEndpointCommand";
 export * from "./DescribeEventBusCommand";
 export * from "./DescribeEventSourceCommand";
 export * from "./DescribePartnerEventSourceCommand";
@@ -26,6 +29,7 @@ export * from "./EnableRuleCommand";
 export * from "./ListApiDestinationsCommand";
 export * from "./ListArchivesCommand";
 export * from "./ListConnectionsCommand";
+export * from "./ListEndpointsCommand";
 export * from "./ListEventBusesCommand";
 export * from "./ListEventSourcesCommand";
 export * from "./ListPartnerEventSourceAccountsCommand";
@@ -49,3 +53,4 @@ export * from "./UntagResourceCommand";
 export * from "./UpdateApiDestinationCommand";
 export * from "./UpdateArchiveCommand";
 export * from "./UpdateConnectionCommand";
+export * from "./UpdateEndpointCommand";

package/dist-types/models/models_0.d.ts

@@ -664,6 +664,184 @@ export declare namespace CreateConnectionResponse {
      */
     const filterSensitiveLog: (obj: CreateConnectionResponse) => any;
 }
+/**
+ * <p>The event buses the endpoint is associated with.</p>
+ */
+export interface EndpointEventBus {
+    /**
+     * <p>The ARN of the event bus the endpoint is associated with.</p>
+     */
+    EventBusArn: string | undefined;
+}
+export declare namespace EndpointEventBus {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: EndpointEventBus) => any;
+}
+export declare enum ReplicationState {
+    DISABLED = "DISABLED",
+    ENABLED = "ENABLED"
+}
+/**
+ * <p>Endpoints can replicate all events to the secondary Region.</p>
+ */
+export interface ReplicationConfig {
+    /**
+     * <p>The state of event replication.</p>
+     */
+    State?: ReplicationState | string;
+}
+export declare namespace ReplicationConfig {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: ReplicationConfig) => any;
+}
+/**
+ * <p>The primary Region of the endpoint.</p>
+ */
+export interface Primary {
+    /**
+     * <p>The ARN of the health check used by the endpoint to determine whether failover is triggered.</p>
+     */
+    HealthCheck: string | undefined;
+}
+export declare namespace Primary {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: Primary) => any;
+}
+/**
+ * <p>The secondary Region that processes events when failover is triggered or replication is enabled.</p>
+ */
+export interface Secondary {
+    /**
+     * <p>Defines the secondary Region.</p>
+     */
+    Route: string | undefined;
+}
+export declare namespace Secondary {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: Secondary) => any;
+}
+/**
+ * <p>The failover configuration for an endpoint. This includes what triggers failover and what happens when it's triggered.</p>
+ */
+export interface FailoverConfig {
+    /**
+     * <p>The main Region of the endpoint.</p>
+     */
+    Primary: Primary | undefined;
+    /**
+     * <p>The Region that events are routed to when failover is triggered or event replication is enabled.</p>
+     */
+    Secondary: Secondary | undefined;
+}
+export declare namespace FailoverConfig {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: FailoverConfig) => any;
+}
+/**
+ * <p>The routing configuration of the endpoint.</p>
+ */
+export interface RoutingConfig {
+    /**
+     * <p>The failover configuration for an endpoint. This includes what triggers failover and what happens when it's triggered.</p>
+     */
+    FailoverConfig: FailoverConfig | undefined;
+}
+export declare namespace RoutingConfig {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: RoutingConfig) => any;
+}
+export interface CreateEndpointRequest {
+    /**
+     * <p>The name of the global endpoint. For example, <code>"Name":"us-east-2-custom_bus_A-endpoint"</code>.</p>
+     */
+    Name: string | undefined;
+    /**
+     * <p>A description of the global endpoint.</p>
+     */
+    Description?: string;
+    /**
+     * <p>Configure the routing policy, including the health check and secondary Region..</p>
+     */
+    RoutingConfig: RoutingConfig | undefined;
+    /**
+     * <p>Enable or disable event replication.</p>
+     */
+    ReplicationConfig?: ReplicationConfig;
+    /**
+     * <p>Define the event buses used. </p>
+     *          <important>
+     *             <p>The names of the event buses must be identical in each Region.</p>
+     *          </important>
+     */
+    EventBuses: EndpointEventBus[] | undefined;
+    /**
+     * <p>The ARN of the role used for replication.</p>
+     */
+    RoleArn?: string;
+}
+export declare namespace CreateEndpointRequest {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: CreateEndpointRequest) => any;
+}
+export declare enum EndpointState {
+    ACTIVE = "ACTIVE",
+    CREATE_FAILED = "CREATE_FAILED",
+    CREATING = "CREATING",
+    DELETE_FAILED = "DELETE_FAILED",
+    DELETING = "DELETING",
+    UPDATE_FAILED = "UPDATE_FAILED",
+    UPDATING = "UPDATING"
+}
+export interface CreateEndpointResponse {
+    /**
+     * <p>The name of the endpoint that was created by this request.</p>
+     */
+    Name?: string;
+    /**
+     * <p>The ARN of the endpoint that was created by this request.</p>
+     */
+    Arn?: string;
+    /**
+     * <p>The routing configuration defined by this request.</p>
+     */
+    RoutingConfig?: RoutingConfig;
+    /**
+     * <p>Whether event replication was enabled or disabled by this request.</p>
+     */
+    ReplicationConfig?: ReplicationConfig;
+    /**
+     * <p>The event buses used by this request.</p>
+     */
+    EventBuses?: EndpointEventBus[];
+    /**
+     * <p>The ARN of the role used by event replication for this request.</p>
+     */
+    RoleArn?: string;
+    /**
+     * <p>The state of the endpoint that was created by this request.</p>
+     */
+    State?: EndpointState | string;
+}
+export declare namespace CreateEndpointResponse {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: CreateEndpointResponse) => any;
+}
 /**
  * <p>A key-value pair associated with an Amazon Web Services resource. In EventBridge, rules and event buses
  *       support tagging.</p>
@@ -891,6 +1069,26 @@ export declare namespace DeleteConnectionResponse {
      */
     const filterSensitiveLog: (obj: DeleteConnectionResponse) => any;
 }
+export interface DeleteEndpointRequest {
+    /**
+     * <p>The name of the endpoint you want to delete. For example, <code>"Name":"us-east-2-custom_bus_A-endpoint"</code>..</p>
+     */
+    Name: string | undefined;
+}
+export declare namespace DeleteEndpointRequest {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: DeleteEndpointRequest) => any;
+}
+export interface DeleteEndpointResponse {
+}
+export declare namespace DeleteEndpointResponse {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: DeleteEndpointResponse) => any;
+}
 export interface DeleteEventBusRequest {
     /**
      * <p>The name of the event bus to delete.</p>
@@ -1259,6 +1457,82 @@ export declare namespace DescribeConnectionResponse {
      */
     const filterSensitiveLog: (obj: DescribeConnectionResponse) => any;
 }
+export interface DescribeEndpointRequest {
+    /**
+     * <p>The name of the endpoint you want to get information about. For example, <code>"Name":"us-east-2-custom_bus_A-endpoint"</code>.</p>
+     */
+    Name: string | undefined;
+    /**
+     * <p>The primary Region of the endpoint you want to get information about. For example <code>"HomeRegion": "us-east-1"</code>.</p>
+     */
+    HomeRegion?: string;
+}
+export declare namespace DescribeEndpointRequest {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: DescribeEndpointRequest) => any;
+}
+export interface DescribeEndpointResponse {
+    /**
+     * <p>The name of the endpoint you asked for information about.</p>
+     */
+    Name?: string;
+    /**
+     * <p>The description of the endpoint you asked for information about.</p>
+     */
+    Description?: string;
+    /**
+     * <p>The ARN of the endpoint you asked for information about.</p>
+     */
+    Arn?: string;
+    /**
+     * <p>The routing configuration of the endpoint you asked for information about.</p>
+     */
+    RoutingConfig?: RoutingConfig;
+    /**
+     * <p>Whether replication is enabled or disabled for the endpoint you asked for information about.</p>
+     */
+    ReplicationConfig?: ReplicationConfig;
+    /**
+     * <p>The event buses being used by the endpoint you asked for information about.</p>
+     */
+    EventBuses?: EndpointEventBus[];
+    /**
+     * <p>The ARN of the role used by the endpoint you asked for information about.</p>
+     */
+    RoleArn?: string;
+    /**
+     * <p>The ID of the endpoint you asked for information about.</p>
+     */
+    EndpointId?: string;
+    /**
+     * <p>The URL of the endpoint you asked for information about.</p>
+     */
+    EndpointUrl?: string;
+    /**
+     * <p>The current state of the endpoint you asked for information about.</p>
+     */
+    State?: EndpointState | string;
+    /**
+     * <p>The reason the endpoint you asked for information about is in its current state.</p>
+     */
+    StateReason?: string;
+    /**
+     * <p>The time the endpoint you asked for information about was created.</p>
+     */
+    CreationTime?: Date;
+    /**
+     * <p>The last time the endpoint you asked for information about was modified.</p>
+     */
+    LastModifiedTime?: Date;
+}
+export declare namespace DescribeEndpointResponse {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: DescribeEndpointResponse) => any;
+}
 export interface DescribeEventBusRequest {
     /**
      * <p>The name or ARN of the event bus to show details for. If you omit this, the default event
@@ -1742,6 +2016,113 @@ export declare namespace ListConnectionsResponse {
      */
     const filterSensitiveLog: (obj: ListConnectionsResponse) => any;
 }
+export interface ListEndpointsRequest {
+    /**
+     * <p>A value that will return a subset of the endpoints associated with this account. For example, <code>"NamePrefix": "ABC"</code> will return all endpoints with "ABC" in the name.</p>
+     */
+    NamePrefix?: string;
+    /**
+     * <p>The primary Region of the endpoints associated with this account. For example <code>"HomeRegion": "us-east-1"</code>.</p>
+     */
+    HomeRegion?: string;
+    /**
+     * <p>If <code>nextToken</code> is returned, there are more results available. The value of nextToken is a unique pagination token for each page.
+     *        Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination
+     *        token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.</p>
+     */
+    NextToken?: string;
+    /**
+     * <p>The maximum number of results returned by the call.</p>
+     */
+    MaxResults?: number;
+}
+export declare namespace ListEndpointsRequest {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: ListEndpointsRequest) => any;
+}
+/**
+ * <p>An global endpoint used to improve your application's availability by making it 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 applications Regional-fault tolerant with global endpoints and event replication</a> in the Amazon EventBridge User Guide..</p>
+ */
+export interface Endpoint {
+    /**
+     * <p>The name of the endpoint.</p>
+     */
+    Name?: string;
+    /**
+     * <p>A description for the endpoint.</p>
+     */
+    Description?: string;
+    /**
+     * <p>The ARN of the endpoint.</p>
+     */
+    Arn?: string;
+    /**
+     * <p>The routing configuration of the endpoint.</p>
+     */
+    RoutingConfig?: RoutingConfig;
+    /**
+     * <p>Whether event replication was enabled or disabled for this endpoint.</p>
+     */
+    ReplicationConfig?: ReplicationConfig;
+    /**
+     * <p>The event buses being used by the endpoint.</p>
+     */
+    EventBuses?: EndpointEventBus[];
+    /**
+     * <p>The ARN of the role used by event replication for the endpoint.</p>
+     */
+    RoleArn?: string;
+    /**
+     * <p>The URL subdomain of the endpoint. For example, if the URL for Endpoint is abcde.veo.endpoints.event.amazonaws.com, then the EndpointId is <code>abcde.veo</code>.</p>
+     */
+    EndpointId?: string;
+    /**
+     * <p>The URL of the endpoint.</p>
+     */
+    EndpointUrl?: string;
+    /**
+     * <p>The current state of the endpoint.</p>
+     */
+    State?: EndpointState | string;
+    /**
+     * <p>The reason the endpoint is in its current state.</p>
+     */
+    StateReason?: string;
+    /**
+     * <p>The time the endpoint was created.</p>
+     */
+    CreationTime?: Date;
+    /**
+     * <p>The last time the endpoint was modified.</p>
+     */
+    LastModifiedTime?: Date;
+}
+export declare namespace Endpoint {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: Endpoint) => any;
+}
+export interface ListEndpointsResponse {
+    /**
+     * <p>The endpoints returned by the call.</p>
+     */
+    Endpoints?: Endpoint[];
+    /**
+     * <p>If <code>nextToken</code> is returned, there are more results available. The value of nextToken is a unique pagination token for each page.
+     *        Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination
+     *        token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.</p>
+     */
+    NextToken?: string;
+}
+export declare namespace ListEndpointsResponse {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: ListEndpointsResponse) => any;
+}
 export interface ListEventBusesRequest {
     /**
      * <p>Specifying this limits the results to only those event buses with names that start with
@@ -3082,7 +3463,7 @@ export interface PutEventsRequestEntry {
      */
     DetailType?: string;
     /**
-     * <p>A valid JSON string. There is no other schema imposed. The JSON string may contain fields
+     * <p>A valid JSON object. There is no other schema imposed. The JSON object may contain fields
      *       and nested subobjects.</p>
      */
     Detail?: string;
@@ -3090,6 +3471,11 @@ export interface PutEventsRequestEntry {
      * <p>The name or ARN of the event bus to receive the event. Only the rules that are associated
      *       with this event bus are used to match the event. If you omit this, the default event bus is
      *       used.</p>
+     *          <note>
+     *             <p>If you're using a global endpoint with a custom bus, you must enter the name, not the ARN, of the event bus in either
+     *       the primary or secondary Region here and the corresponding event bus in the
+     *       other Region will be determined based on the endpoint referenced by the <code>EndpointId</code>.</p>
+     *          </note>
      */
     EventBusName?: string;
     /**
@@ -3112,6 +3498,13 @@ export interface PutEventsRequest {
      *       on.</p>
      */
     Entries: PutEventsRequestEntry[] | undefined;
+    /**
+     * <p>The URL subdomain of the endpoint. For example, if the URL for Endpoint is abcde.veo.endpoints.event.amazonaws.com, then the EndpointId is <code>abcde.veo</code>.</p>
+     *          <important>
+     *             <p>When using Java, you must include <code>auth-crt</code> on the class path.</p>
+     *          </important>
+     */
+    EndpointId?: string;
 }
 export declare namespace PutEventsRequest {
     /**
@@ -3358,8 +3751,8 @@ export interface PutRuleRequest {
      */
     ScheduleExpression?: string;
     /**
-     * <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
-     *         Patterns</a> in the <i>Amazon EventBridge User Guide</i>.</p>
+     * <p>The event pattern. For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html.html">EventBridge event
+     *         patterns</a> in the <i>Amazon EventBridge User Guide</i>.</p>
      */
     EventPattern?: string;
     /**
@@ -4009,3 +4402,79 @@ export declare namespace UpdateConnectionResponse {
      */
     const filterSensitiveLog: (obj: UpdateConnectionResponse) => any;
 }
+export interface UpdateEndpointRequest {
+    /**
+     * <p>The name of the endpoint you want to update.</p>
+     */
+    Name: string | undefined;
+    /**
+     * <p>A description for the endpoint.</p>
+     */
+    Description?: string;
+    /**
+     * <p>Configure the routing policy, including the health check and secondary Region..</p>
+     */
+    RoutingConfig?: RoutingConfig;
+    /**
+     * <p>Whether event replication was enabled or disabled by this request.</p>
+     */
+    ReplicationConfig?: ReplicationConfig;
+    /**
+     * <p>Define event buses used for replication.</p>
+     */
+    EventBuses?: EndpointEventBus[];
+    /**
+     * <p>The ARN of the role used by event replication for this request.</p>
+     */
+    RoleArn?: string;
+}
+export declare namespace UpdateEndpointRequest {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: UpdateEndpointRequest) => any;
+}
+export interface UpdateEndpointResponse {
+    /**
+     * <p>The name of the endpoint you updated in this request.</p>
+     */
+    Name?: string;
+    /**
+     * <p>The ARN of the endpoint you updated in this request.</p>
+     */
+    Arn?: string;
+    /**
+     * <p>The routing configuration you updated in this request.</p>
+     */
+    RoutingConfig?: RoutingConfig;
+    /**
+     * <p>Whether event replication was enabled or disabled for the endpoint you updated in this request.</p>
+     */
+    ReplicationConfig?: ReplicationConfig;
+    /**
+     * <p>The event buses used for replication for the endpoint you updated in this request.</p>
+     */
+    EventBuses?: EndpointEventBus[];
+    /**
+     * <p>The ARN of the role used by event replication for the endpoint you updated in this request.</p>
+     */
+    RoleArn?: string;
+    /**
+     * <p>The ID of the endpoint you updated in this request.</p>
+     */
+    EndpointId?: string;
+    /**
+     * <p>The URL of the endpoint you updated in this request.</p>
+     */
+    EndpointUrl?: string;
+    /**
+     * <p>The state of the endpoint you updated in this request.</p>
+     */
+    State?: EndpointState | string;
+}
+export declare namespace UpdateEndpointResponse {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: UpdateEndpointResponse) => any;
+}