EventBridge / Client / update_endpoint

update_endpoint#

EventBridge.Client.update_endpoint(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.update_endpoint(
    Name='string',
    Description='string',
    RoutingConfig={
        'FailoverConfig': {
            'Primary': {
                'HealthCheck': 'string'
            },
            'Secondary': {
                'Route': 'string'
            }
        }
    },
    ReplicationConfig={
        'State': 'ENABLED'|'DISABLED'
    },
    EventBuses=[
        {
            'EventBusArn': 'string'
        },
    ],
    RoleArn='string'
)
Parameters:

  • Name (string) –

    [REQUIRED]

    The name of the endpoint you want to update.

  • Description (string) – A description for the endpoint.

  • RoutingConfig (dict) –

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

    • FailoverConfig (dict) – [REQUIRED]

      The failover configuration for an endpoint. This includes what triggers failover and what happens when it’s triggered.

      • Primary (dict) – [REQUIRED]

        The main Region of the endpoint.

        • HealthCheck (string) – [REQUIRED]

          The ARN of the health check used by the endpoint to determine whether failover is triggered.

      • Secondary (dict) – [REQUIRED]

        The Region that events are routed to when failover is triggered or event replication is enabled.

        • Route (string) – [REQUIRED]

          Defines the secondary Region.

  • ReplicationConfig (dict) –

    Whether event replication was enabled or disabled by this request.

    • State (string) –

      The state of event replication.

  • EventBuses (list) –

    Define event buses used for replication.

    • (dict) –

      The event buses the endpoint is associated with.

      • EventBusArn (string) – [REQUIRED]

        The ARN of the event bus the endpoint is associated with.

  • RoleArn (string) – The ARN of the role used by event replication for this request.

Return type:

dict

Returns:

Response Syntax

{
    'Name': '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'
}

Response Structure

  • (dict) –

    • Name (string) –

      The name of the endpoint you updated in this request.

    • Arn (string) –

      The ARN of the endpoint you updated in this request.

    • RoutingConfig (dict) –

      The routing configuration you updated in this request.

      • 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 the endpoint you updated in this request.

      • State (string) –

        The state of event replication.

    • EventBuses (list) –

      The event buses used for replication for the endpoint you updated in this request.

      • (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 you updated in this request.

    • EndpointId (string) –

      The ID of the endpoint you updated in this request.

    • EndpointUrl (string) –

      The URL of the endpoint you updated in this request.

    • State (string) –

      The state of the endpoint you updated in this request.

Exceptions

  • EventBridge.Client.exceptions.ResourceNotFoundException

  • EventBridge.Client.exceptions.ConcurrentModificationException

  • EventBridge.Client.exceptions.InternalException