ECS / Client / discover_poll_endpoint

discover_poll_endpoint#

ECS.Client.discover_poll_endpoint(**kwargs)#

Note

This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.

Returns an endpoint for the Amazon ECS agent to poll for updates.

See also: AWS API Documentation

Request Syntax

response = client.discover_poll_endpoint(
    containerInstance='string',
    cluster='string'
)
Parameters:

  • containerInstance (string) – The container instance ID or full ARN of the container instance. For more information about the ARN format, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.

  • cluster (string) – The short name or full Amazon Resource Name (ARN) of the cluster that the container instance belongs to.

Return type:

dict

Returns:

Response Syntax

{
    'endpoint': 'string',
    'telemetryEndpoint': 'string',
    'serviceConnectEndpoint': 'string'
}

Response Structure

  • (dict) –

    • endpoint (string) –

      The endpoint for the Amazon ECS agent to poll.

    • telemetryEndpoint (string) –

      The telemetry endpoint for the Amazon ECS agent.

    • serviceConnectEndpoint (string) –

      The endpoint for the Amazon ECS agent to poll for Service Connect configuration. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

Exceptions

  • ECS.Client.exceptions.ServerException

  • ECS.Client.exceptions.ClientException