EventBridge / Client / describe_endpoint

describe_endpoint#

EventBridge.Client.describe_endpoint(**kwargs)#

Get the information about an existing global 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

response = client.describe_endpoint(
    Name='string',
    HomeRegion='string'
)

Parameters:

Name (string) –
[REQUIRED]

The name of the endpoint you want to get information about. For example, "Name":"us-east-2-custom_bus_A-endpoint".
HomeRegion (string) – The primary Region of the endpoint you want to get information about. For example "HomeRegion": "us-east-1".

Return type:

dict

Returns:

Response Syntax

{
    '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)
}

Response Structure

(dict) –
- Name (string) –
  
  The name of the endpoint you asked for information about.
- Description (string) –
  
  The description of the endpoint you asked for information about.
- Arn (string) –
  
  The ARN of the endpoint you asked for information about.
- RoutingConfig (dict) –
  
  The routing configuration of the endpoint you asked for information about.
  - 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 replication is enabled or disabled for the endpoint you asked for information about.
  - State (string) –
    
    The state of event replication.
- EventBuses (list) –
  
  The event buses being used by the endpoint you asked for information about.
  - (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 the endpoint you asked for information about.
- EndpointId (string) –
  
  The ID of the endpoint you asked for information about.
- EndpointUrl (string) –
  
  The URL of the endpoint you asked for information about.
- State (string) –
  
  The current state of the endpoint you asked for information about.
- StateReason (string) –
  
  The reason the endpoint you asked for information about is in its current state.
- CreationTime (datetime) –
  
  The time the endpoint you asked for information about was created.
- LastModifiedTime (datetime) –
  
  The last time the endpoint you asked for information about was modified.

Exceptions

EventBridge.Client.exceptions.ResourceNotFoundException
EventBridge.Client.exceptions.InternalException