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"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- Arn
-
The ARN of the endpoint you updated in this request.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Pattern:
^arn:aws([a-z]|\-)*:events:([a-z]|\d|\-)*:([0-9]{12})?:endpoint\/[/\.\-_A-Za-z0-9]+$ - EndpointId
-
The ID of the endpoint you updated in this request.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 50.
Pattern:
^[A-Za-z0-9\-]+[\.][A-Za-z0-9\-]+$ - EndpointUrl
-
The URL of the endpoint you updated in this request.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
^(https://)?[\.\-a-z0-9]+$ - EventBuses
-
The event buses used for replication for the endpoint you updated in this request.
Type: Array of EndpointEventBus objects
Array Members: Fixed number of 2 items.
- Name
-
The name of the endpoint you updated in this request.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[\.\-_A-Za-z0-9]+ - ReplicationConfig
-
Whether event replication was enabled or disabled for the endpoint you updated in this request.
Type: ReplicationConfig object
- RoleArn
-
The ARN of the role used by event replication for the endpoint you updated in this request.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
^arn:aws[a-z-]*:iam::\d{12}:role\/[\w+=,.@/-]+$ - RoutingConfig
-
The routing configuration you updated in this request.
Type: RoutingConfig object
- State
-
The state of the endpoint you updated in this request.
Type: String
Valid Values:
ACTIVE | CREATING | UPDATING | DELETING | CREATE_FAILED | UPDATE_FAILED | DELETE_FAILED
Errors
For information about the errors that are common to all actions, see Common Errors.
- ConcurrentModificationException
-
There is concurrent modification on a rule, target, archive, or replay.
HTTP Status Code: 400
- InternalException
-
This exception occurs due to unexpected causes.
HTTP Status Code: 500
- ResourceNotFoundException
-
An entity that you specified does not exist.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: