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

Amazonka.ECS.UpdateContainerAgent

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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.

Creating a Request

data UpdateContainerAgent Source #

See: newUpdateContainerAgent smart constructor.

Constructors

UpdateContainerAgent'
Fields cluster :: Maybe Text 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. containerInstance :: Text The container instance ID or full ARN entries for the container instance where you would like to update the Amazon ECS container agent.

Instances

Instances details

ToJSON UpdateContainerAgent Source #
Instance details Defined in Amazonka.ECS.UpdateContainerAgent Methods toJSON :: UpdateContainerAgent -> Value # toEncoding :: UpdateContainerAgent -> Encoding # toJSONList :: [UpdateContainerAgent] -> Value # toEncodingList :: [UpdateContainerAgent] -> Encoding #
ToHeaders UpdateContainerAgent Source #
Instance details Defined in Amazonka.ECS.UpdateContainerAgent Methods toHeaders :: UpdateContainerAgent -> [Header] #
ToPath UpdateContainerAgent Source #
Instance details Defined in Amazonka.ECS.UpdateContainerAgent Methods toPath :: UpdateContainerAgent -> ByteString #
ToQuery UpdateContainerAgent Source #
Instance details Defined in Amazonka.ECS.UpdateContainerAgent Methods toQuery :: UpdateContainerAgent -> QueryString #
AWSRequest UpdateContainerAgent Source #
Instance details Defined in Amazonka.ECS.UpdateContainerAgent Associated Types type AWSResponse UpdateContainerAgent # Methods request :: (Service -> Service) -> UpdateContainerAgent -> Request UpdateContainerAgent # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateContainerAgent -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateContainerAgent))) #
Generic UpdateContainerAgent Source #
Instance details Defined in Amazonka.ECS.UpdateContainerAgent Associated Types type Rep UpdateContainerAgent :: Type -> Type # Methods from :: UpdateContainerAgent -> Rep UpdateContainerAgent x # to :: Rep UpdateContainerAgent x -> UpdateContainerAgent #
Read UpdateContainerAgent Source #
Instance details Defined in Amazonka.ECS.UpdateContainerAgent Methods readsPrec :: Int -> ReadS UpdateContainerAgent # readList :: ReadS [UpdateContainerAgent] # readPrec :: ReadPrec UpdateContainerAgent # readListPrec :: ReadPrec [UpdateContainerAgent] #
Show UpdateContainerAgent Source #
Instance details Defined in Amazonka.ECS.UpdateContainerAgent Methods showsPrec :: Int -> UpdateContainerAgent -> ShowS # show :: UpdateContainerAgent -> String # showList :: [UpdateContainerAgent] -> ShowS #
NFData UpdateContainerAgent Source #
Instance details Defined in Amazonka.ECS.UpdateContainerAgent Methods rnf :: UpdateContainerAgent -> () #
Eq UpdateContainerAgent Source #
Instance details Defined in Amazonka.ECS.UpdateContainerAgent Methods (==) :: UpdateContainerAgent -> UpdateContainerAgent -> Bool # (/=) :: UpdateContainerAgent -> UpdateContainerAgent -> Bool #
Hashable UpdateContainerAgent Source #
Instance details Defined in Amazonka.ECS.UpdateContainerAgent Methods hashWithSalt :: Int -> UpdateContainerAgent -> Int # hash :: UpdateContainerAgent -> Int #
type AWSResponse UpdateContainerAgent Source #
Instance details Defined in Amazonka.ECS.UpdateContainerAgent type AWSResponse UpdateContainerAgent = UpdateContainerAgentResponse
type Rep UpdateContainerAgent Source #
Instance details Defined in Amazonka.ECS.UpdateContainerAgent type Rep UpdateContainerAgent = D1 ('MetaData "UpdateContainerAgent" "Amazonka.ECS.UpdateContainerAgent" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "UpdateContainerAgent'" 'PrefixI 'True) (S1 ('MetaSel ('Just "cluster") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "containerInstance") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newUpdateContainerAgent Source #

Arguments

:: Text	`UpdateContainerAgent`
-> UpdateContainerAgent

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.

Constructors

UpdateContainerAgentResponse'
Fields containerInstance :: Maybe ContainerInstance The container instance that the container agent was updated for. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic UpdateContainerAgentResponse Source #
Instance details Defined in Amazonka.ECS.UpdateContainerAgent Associated Types type Rep UpdateContainerAgentResponse :: Type -> Type # Methods from :: UpdateContainerAgentResponse -> Rep UpdateContainerAgentResponse x # to :: Rep UpdateContainerAgentResponse x -> UpdateContainerAgentResponse #
Read UpdateContainerAgentResponse Source #
Instance details Defined in Amazonka.ECS.UpdateContainerAgent Methods readsPrec :: Int -> ReadS UpdateContainerAgentResponse # readList :: ReadS [UpdateContainerAgentResponse] # readPrec :: ReadPrec UpdateContainerAgentResponse # readListPrec :: ReadPrec [UpdateContainerAgentResponse] #
Show UpdateContainerAgentResponse Source #
Instance details Defined in Amazonka.ECS.UpdateContainerAgent Methods showsPrec :: Int -> UpdateContainerAgentResponse -> ShowS # show :: UpdateContainerAgentResponse -> String # showList :: [UpdateContainerAgentResponse] -> ShowS #
NFData UpdateContainerAgentResponse Source #
Instance details Defined in Amazonka.ECS.UpdateContainerAgent Methods rnf :: UpdateContainerAgentResponse -> () #
Eq UpdateContainerAgentResponse Source #
Instance details Defined in Amazonka.ECS.UpdateContainerAgent Methods (==) :: UpdateContainerAgentResponse -> UpdateContainerAgentResponse -> Bool # (/=) :: UpdateContainerAgentResponse -> UpdateContainerAgentResponse -> Bool #
type Rep UpdateContainerAgentResponse Source #
Instance details Defined in Amazonka.ECS.UpdateContainerAgent type Rep UpdateContainerAgentResponse = D1 ('MetaData "UpdateContainerAgentResponse" "Amazonka.ECS.UpdateContainerAgent" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "UpdateContainerAgentResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "containerInstance") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ContainerInstance)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateContainerAgentResponse Source #

Arguments

:: Int	`$sel:httpStatus:UpdateContainerAgentResponse'`
-> UpdateContainerAgentResponse

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.