Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

UpdateEndpoint

Update an existing endpoint. For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide .

Request Syntax


{
   "Description": "string",
   "EventBuses": [ 
      { 
         "EventBusArn": "string"
      }
   ],
   "Name": "string",
   "ReplicationConfig": { 
      "State": "string"
   },
   "RoleArn": "string",
   "RoutingConfig": { 
      "FailoverConfig": { 
         "Primary": { 
            "HealthCheck": "string"
         },
         "Secondary": { 
            "Route": "string"
         }
      }
   }
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Description

A description for the endpoint.

Type: String

Length Constraints: Maximum length of 512.

Pattern: .*

Required: No

EventBuses

Define event buses used for replication.

Type: Array of EndpointEventBus objects

Array Members: Fixed number of 2 items.

Required: No

Name

The name of the endpoint you want to update.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [\.\-_A-Za-z0-9]+

Required: Yes

ReplicationConfig

Whether event replication was enabled or disabled by this request.

Type: ReplicationConfig object

Required: No

RoleArn

The ARN of the role used by event replication for this request.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: ^arn:aws[a-z-]*:iam::\d{12}:role\/[\w+=,.@/-]+$

Required: No

RoutingConfig

Configure the routing policy, including the health check and secondary Region.

Type: RoutingConfig object

Required: No

Response Syntax


{
   "Arn": "string",
   "EndpointId": "string",
   "EndpointUrl": "string",
   "EventBuses": [ 
      { 
         "EventBusArn": "string"
      }
   ],
   "Name": "string",
   "ReplicationConfig": { 
      "State": "string"
   },
   "RoleArn": "string",
   "RoutingConfig": { 
      "FailoverConfig": { 
         "Primary": { 
            "HealthCheck": "string"
         },
         "Secondary": { 
            "Route": "string"
         }
      }
   },
   "State": "string"
}