DiscoverPollEndpoint
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.
Request Syntax
{
"cluster": "string",
"containerInstance": "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.
- cluster
-
The short name or full Amazon Resource Name (ARN) of the cluster that the container instance belongs to.
Type: String
Required: No
- containerInstance
-
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.
Type: String
Required: No
Response Syntax
{
"endpoint": "string",
"serviceConnectEndpoint": "string",
"telemetryEndpoint": "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.
- endpoint
-
The endpoint for the Amazon ECS agent to poll.
Type: String
- serviceConnectEndpoint
-
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.
Type: String
- telemetryEndpoint
-
The telemetry endpoint for the Amazon ECS agent.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- ClientException
-
These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.
The following list includes additional causes for the error:
-
The
RunTaskcould not be processed because you use managed scaling and there is a capacity error because the quota of tasks in thePROVISIONINGper cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.
HTTP Status Code: 400
-
- ServerException
-
These errors are usually caused by a server issue.
HTTP Status Code: 500
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
