EventBridge / Client / list_endpoints

list_endpoints#

EventBridge.Client.list_endpoints(**kwargs)#

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

response = client.list_endpoints(
    NamePrefix='string',
    HomeRegion='string',
    NextToken='string',
    MaxResults=123
)

Parameters:

NamePrefix (string) – 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.
HomeRegion (string) – The primary Region of the endpoints associated with this account. For example "HomeRegion": "us-east-1".
NextToken (string) –
The token returned by a previous call, which you can use to retrieve the next set of results.

The value of nextToken is 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 InvalidToken error.
MaxResults (integer) – The maximum number of results returned by the call.

Return type:

dict

Returns:

Response Syntax

{
    'Endpoints': [
        {
            'Name': 'string',
            'Description': 'string',
            'Arn': 'string',
            'RoutingConfig': {
                'FailoverConfig': {
                    'Primary': {
                        'HealthCheck': 'string'
                    },
                    'Secondary': {
                        'Route': 'string'
                    }
                }
            },
            'ReplicationConfig': {
                'State': 'ENABLED'|'DISABLED'
            },
            'EventBuses': [
                {
                    'EventBusArn': 'string'
                },
            ],
            'RoleArn': 'string',
            'EndpointId': 'string',
            'EndpointUrl': 'string',
            'State': 'ACTIVE'|'CREATING'|'UPDATING'|'DELETING'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETE_FAILED',
            'StateReason': 'string',
            'CreationTime': datetime(2015, 1, 1),
            'LastModifiedTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- Endpoints (list) –
  
  The endpoints returned by the call.
  - (dict) –
    
    A global endpoint used to improve your application’s availability by making it regional-fault tolerant. For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide .
    - Name (string) –
      
      The name of the endpoint.
    - Description (string) –
      
      A description for the endpoint.
    - Arn (string) –
      
      The ARN of the endpoint.
    - RoutingConfig (dict) –
      
      The routing configuration of the endpoint.
      - FailoverConfig (dict) –
        
        The failover configuration for an endpoint. This includes what triggers failover and what happens when it’s triggered.
        
        Primary (dict) –
        
        The main Region of the endpoint.
        
        HealthCheck (string) –
        
        The ARN of the health check used by the endpoint to determine whether failover is triggered.
        
        Secondary (dict) –
        
        The Region that events are routed to when failover is triggered or event replication is enabled.
        
        Route (string) –
        
        Defines the secondary Region.
    - ReplicationConfig (dict) –
      
      Whether event replication was enabled or disabled for this endpoint. The default state is ENABLED which means you must supply a RoleArn. If you don’t have a RoleArn or you don’t want event replication enabled, set the state to DISABLED.
      - State (string) –
        
        The state of event replication.
    - EventBuses (list) –
      
      The event buses being used by the endpoint.
      - (dict) –
        
        The event buses the endpoint is associated with.
        
        EventBusArn (string) –
        
        The ARN of the event bus the endpoint is associated with.
    - RoleArn (string) –
      
      The ARN of the role used by event replication for the endpoint.
    - EndpointId (string) –
      
      The URL subdomain of the endpoint. For example, if the URL for Endpoint is https://abcde.veo.endpoints.event.amazonaws.com, then the EndpointId is abcde.veo.
    - EndpointUrl (string) –
      
      The URL of the endpoint.
    - State (string) –
      
      The current state of the endpoint.
    - StateReason (string) –
      
      The reason the endpoint is in its current state.
    - CreationTime (datetime) –
      
      The time the endpoint was created.
    - LastModifiedTime (datetime) –
      
      The last time the endpoint was modified.
- NextToken (string) –
  
  A token indicating there are more results available. If there are no more results, no token is included in the response.
  
  The value of nextToken is 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 InvalidToken error.

Exceptions

EventBridge.Client.exceptions.InternalException