discover_poll_endpoint¶
Operation¶
discover_poll_endpoint
¶
discover_poll_endpoint(request: DiscoverPollEndpointInput | DiscoverPollEndpointInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DiscoverPollEndpointInputDict]) -> DiscoverPollEndpointOutput
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.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DiscoverPollEndpointInput | DiscoverPollEndpointInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[DiscoverPollEndpointInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DiscoverPollEndpointOutput
|
An instance of |
discover_poll_endpoint
async
¶
discover_poll_endpoint(request: DiscoverPollEndpointInput | DiscoverPollEndpointInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DiscoverPollEndpointInputDict]) -> DiscoverPollEndpointOutput
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.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DiscoverPollEndpointInput | DiscoverPollEndpointInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[DiscoverPollEndpointInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DiscoverPollEndpointOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
DiscoverPollEndpointInputDict
¶
Bases: TypedDict
Dictionary form of DiscoverPollEndpointInput.
Attributes¶
cluster
instance-attribute
¶
cluster: str | None
The short name or full Amazon Resource Name (ARN) of the cluster that the container instance belongs to.
container_instance
instance-attribute
¶
container_instance: str | None
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.
DiscoverPollEndpointInput
dataclass
¶
Bases: _SerdeShape
Attributes¶
cluster
class-attribute
instance-attribute
¶
cluster: str | None = ...
The short name or full Amazon Resource Name (ARN) of the cluster that the container instance belongs to.
container_instance
class-attribute
instance-attribute
¶
container_instance: str | None = ...
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.
Output¶
DiscoverPollEndpointOutput
dataclass
¶
Bases: _SerdeShape
Attributes¶
endpoint
class-attribute
instance-attribute
¶
endpoint: str | None = ...
The endpoint for the Amazon ECS agent to poll.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.
service_connect_endpoint
class-attribute
instance-attribute
¶
service_connect_endpoint: str | None = ...
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.