Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Updates the Amazon ECS container agent on a specified container instance. Updating the Amazon ECS container agent doesn't interrupt running tasks or services on the container instance. The process for updating the agent differs depending on whether your container instance was launched with the Amazon ECS-optimized AMI or another operating system.
The UpdateContainerAgent
API isn't supported for container instances
using the Amazon ECS-optimized Amazon Linux 2 (arm64) AMI. To update the
container agent, you can update the ecs-init
package. This updates the
agent. For more information, see
Updating the Amazon ECS container agent
in the Amazon Elastic Container Service Developer Guide.
Agent updates with the UpdateContainerAgent
API operation do not apply
to Windows container instances. We recommend that you launch new
container instances to update the agent version in your Windows
clusters.
The UpdateContainerAgent
API requires an Amazon ECS-optimized AMI or
Amazon Linux AMI with the ecs-init
service installed and running. For
help updating the Amazon ECS container agent on other operating systems,
see
Manually updating the Amazon ECS container agent
in the Amazon Elastic Container Service Developer Guide.
Synopsis
- data UpdateContainerAgent = UpdateContainerAgent' {}
- newUpdateContainerAgent :: Text -> UpdateContainerAgent
- updateContainerAgent_cluster :: Lens' UpdateContainerAgent (Maybe Text)
- updateContainerAgent_containerInstance :: Lens' UpdateContainerAgent Text
- data UpdateContainerAgentResponse = UpdateContainerAgentResponse' {}
- newUpdateContainerAgentResponse :: Int -> UpdateContainerAgentResponse
- updateContainerAgentResponse_containerInstance :: Lens' UpdateContainerAgentResponse (Maybe ContainerInstance)
- updateContainerAgentResponse_httpStatus :: Lens' UpdateContainerAgentResponse Int
Creating a Request
data UpdateContainerAgent Source #
See: newUpdateContainerAgent
smart constructor.
UpdateContainerAgent' | |
|
Instances
newUpdateContainerAgent Source #
Create a value of UpdateContainerAgent
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:cluster:UpdateContainerAgent'
, updateContainerAgent_cluster
- The short name or full Amazon Resource Name (ARN) of the cluster that
your container instance is running on. If you do not specify a cluster,
the default cluster is assumed.
UpdateContainerAgent
, updateContainerAgent_containerInstance
- The container instance ID or full ARN entries for the container instance
where you would like to update the Amazon ECS container agent.
Request Lenses
updateContainerAgent_cluster :: Lens' UpdateContainerAgent (Maybe Text) Source #
The short name or full Amazon Resource Name (ARN) of the cluster that your container instance is running on. If you do not specify a cluster, the default cluster is assumed.
updateContainerAgent_containerInstance :: Lens' UpdateContainerAgent Text Source #
The container instance ID or full ARN entries for the container instance where you would like to update the Amazon ECS container agent.
Destructuring the Response
data UpdateContainerAgentResponse Source #
See: newUpdateContainerAgentResponse
smart constructor.
UpdateContainerAgentResponse' | |
|
Instances
newUpdateContainerAgentResponse Source #
Create a value of UpdateContainerAgentResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateContainerAgent
, updateContainerAgentResponse_containerInstance
- The container instance that the container agent was updated for.
$sel:httpStatus:UpdateContainerAgentResponse'
, updateContainerAgentResponse_httpStatus
- The response's http status code.
Response Lenses
updateContainerAgentResponse_containerInstance :: Lens' UpdateContainerAgentResponse (Maybe ContainerInstance) Source #
The container instance that the container agent was updated for.
updateContainerAgentResponse_httpStatus :: Lens' UpdateContainerAgentResponse Int Source #
The response's http status code.