ListEndpoints
List the global endpoints associated with this account. 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
{
"HomeRegion": "string",
"MaxResults": number,
"NamePrefix": "string",
"NextToken": "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.
- HomeRegion
-
The primary Region of the endpoints associated with this account. For example
"HomeRegion": "us-east-1".Type: String
Length Constraints: Minimum length of 9. Maximum length of 20.
Pattern:
^[\-a-z0-9]+$Required: No
- MaxResults
-
The maximum number of results returned by the call.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- NamePrefix
-
A value that will return a subset of the endpoints associated with this account. For example,
"NamePrefix": "ABC"will return all endpoints with "ABC" in the name.Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[\.\-_A-Za-z0-9]+Required: No
- NextToken
-
The token returned by a previous call, which you can use to retrieve the next set of results.
The value of
nextTokenis a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.Using an expired pagination token results in an
HTTP 400 InvalidTokenerror.Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: No
Response Syntax
{
"Endpoints": [
{
"Arn": "string",
"CreationTime": number,
"Description": "string",
"EndpointId": "string",
"EndpointUrl": "string",
"EventBuses": [
{
"EventBusArn": "string"
}
],
"LastModifiedTime": number,
"Name": "string",
"ReplicationConfig": {
"State": "string"
},
"RoleArn": "string",
"RoutingConfig": {
"FailoverConfig": {
"Primary": {
"HealthCheck": "string"
},
"Secondary": {
"Route": "string"
}
}
},
"State": "string",
"StateReason": "string"
}
],
"NextToken": "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.
- Endpoints
-
The endpoints returned by the call.
Type: Array of Endpoint objects
- NextToken
-
A token indicating there are more results available. If there are no more results, no token is included in the response.
The value of
nextTokenis a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.Using an expired pagination token results in an
HTTP 400 InvalidTokenerror.Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalException
-
This exception occurs due to unexpected causes.
HTTP Status Code: 500
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
