libZSservicesZSamazonka-ecsZSamazonka-ecs
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.ECS.UpdateContainerAgent

Description

Updates the Amazon ECS container agent on a specified container instance. Updating the Amazon ECS container agent does not 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 which will update the agent. For more information, see Updating the Amazon ECS container agent in the Amazon Elastic Container Service Developer Guide.

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

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 on which you would like to update the Amazon ECS container agent.

Instances

Instances details
Eq UpdateContainerAgent Source # 
Instance details

Defined in Amazonka.ECS.UpdateContainerAgent

Methods

(==) :: UpdateContainerAgent -> UpdateContainerAgent -> Bool #

(/=) :: UpdateContainerAgent -> UpdateContainerAgent -> Bool #

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 #

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 #

NFData UpdateContainerAgent Source # 
Instance details

Defined in Amazonka.ECS.UpdateContainerAgent

Methods

rnf :: UpdateContainerAgent -> () #

Hashable UpdateContainerAgent Source # 
Instance details

Defined in Amazonka.ECS.UpdateContainerAgent

Methods

hashWithSalt :: Int -> UpdateContainerAgent -> Int #

hash :: UpdateContainerAgent -> Int #

ToJSON UpdateContainerAgent Source # 
Instance details

Defined in Amazonka.ECS.UpdateContainerAgent

Methods

toJSON :: UpdateContainerAgent -> Value #

toEncoding :: UpdateContainerAgent -> Encoding #

toJSONList :: [UpdateContainerAgent] -> Value #

toEncodingList :: [UpdateContainerAgent] -> Encoding #

AWSRequest UpdateContainerAgent Source # 
Instance details

Defined in Amazonka.ECS.UpdateContainerAgent

Associated Types

type AWSResponse UpdateContainerAgent #

Methods

request :: UpdateContainerAgent -> Request UpdateContainerAgent #

response :: MonadResource m => Logger -> Service -> Proxy UpdateContainerAgent -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateContainerAgent))) #

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 #

type Rep UpdateContainerAgent Source # 
Instance details

Defined in Amazonka.ECS.UpdateContainerAgent

type Rep UpdateContainerAgent = D1 ('MetaData "UpdateContainerAgent" "Amazonka.ECS.UpdateContainerAgent" "libZSservicesZSamazonka-ecsZSamazonka-ecs" '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)))
type AWSResponse UpdateContainerAgent Source # 
Instance details

Defined in Amazonka.ECS.UpdateContainerAgent

type AWSResponse UpdateContainerAgent = UpdateContainerAgentResponse

newUpdateContainerAgent Source #

Arguments

:: Text

$sel:containerInstance: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.

$sel:containerInstance:UpdateContainerAgent', updateContainerAgent_containerInstance - The container instance ID or full ARN entries for the container instance on which 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 on which you would like to update the Amazon ECS container agent.

Destructuring the Response

data UpdateContainerAgentResponse Source #

See: newUpdateContainerAgentResponse smart constructor.

Constructors

UpdateContainerAgentResponse' 

Fields

Instances

Instances details
Eq UpdateContainerAgentResponse Source # 
Instance details

Defined in Amazonka.ECS.UpdateContainerAgent

Methods

(==) :: UpdateContainerAgentResponse -> UpdateContainerAgentResponse -> Bool #

(/=) :: UpdateContainerAgentResponse -> UpdateContainerAgentResponse -> Bool #

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 #

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 #

NFData UpdateContainerAgentResponse Source # 
Instance details

Defined in Amazonka.ECS.UpdateContainerAgent

Methods

rnf :: UpdateContainerAgentResponse -> () #

type Rep UpdateContainerAgentResponse Source # 
Instance details

Defined in Amazonka.ECS.UpdateContainerAgent

type Rep UpdateContainerAgentResponse = D1 ('MetaData "UpdateContainerAgentResponse" "Amazonka.ECS.UpdateContainerAgent" "libZSservicesZSamazonka-ecsZSamazonka-ecs" '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:

$sel:containerInstance:UpdateContainerAgent', updateContainerAgentResponse_containerInstance - The container instance for which the container agent was updated.

$sel:httpStatus:UpdateContainerAgentResponse', updateContainerAgentResponse_httpStatus - The response's http status code.

Response Lenses

updateContainerAgentResponse_containerInstance :: Lens' UpdateContainerAgentResponse (Maybe ContainerInstance) Source #

The container instance for which the container agent was updated.

updateContainerAgentResponse_httpStatus :: Lens' UpdateContainerAgentResponse Int Source #

The response's http status code.