Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.ECS.ExecuteCommand

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Runs a command remotely on a container within a task.

Synopsis

data ExecuteCommand = ExecuteCommand' {
- cluster :: Maybe Text
- container :: Maybe Text
- command :: Text
- interactive :: Bool
- task :: Text
}
newExecuteCommand :: Text -> Bool -> Text -> ExecuteCommand
executeCommand_cluster :: Lens' ExecuteCommand (Maybe Text)
executeCommand_container :: Lens' ExecuteCommand (Maybe Text)
executeCommand_command :: Lens' ExecuteCommand Text
executeCommand_interactive :: Lens' ExecuteCommand Bool
executeCommand_task :: Lens' ExecuteCommand Text
data ExecuteCommandResponse = ExecuteCommandResponse' {
- clusterArn :: Maybe Text
- containerArn :: Maybe Text
- taskArn :: Maybe Text
- containerName :: Maybe Text
- interactive :: Maybe Bool
- session :: Maybe Session
- httpStatus :: Int
}
newExecuteCommandResponse :: Int -> ExecuteCommandResponse
executeCommandResponse_clusterArn :: Lens' ExecuteCommandResponse (Maybe Text)
executeCommandResponse_containerArn :: Lens' ExecuteCommandResponse (Maybe Text)
executeCommandResponse_taskArn :: Lens' ExecuteCommandResponse (Maybe Text)
executeCommandResponse_containerName :: Lens' ExecuteCommandResponse (Maybe Text)
executeCommandResponse_interactive :: Lens' ExecuteCommandResponse (Maybe Bool)
executeCommandResponse_session :: Lens' ExecuteCommandResponse (Maybe Session)
executeCommandResponse_httpStatus :: Lens' ExecuteCommandResponse Int

Creating a Request

data ExecuteCommand Source #

See: newExecuteCommand smart constructor.

Constructors

ExecuteCommand'

Fields

cluster :: Maybe Text
The Amazon Resource Name (ARN) or short name of the cluster the task is running in. If you do not specify a cluster, the default cluster is assumed.
container :: Maybe Text
The name of the container to execute the command on. A container name only needs to be specified for tasks containing multiple containers.
command :: Text
The command to run on the container.
interactive :: Bool
Use this flag to run your command in interactive mode.
task :: Text
The Amazon Resource Name (ARN) or ID of the task the container is part of.

Instances

Instances details

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

newExecuteCommand Source #

Arguments

:: Text	`$sel:command:ExecuteCommand'`
-> Bool	`$sel:interactive:ExecuteCommand'`
-> Text	`$sel:task:ExecuteCommand'`
-> ExecuteCommand

Create a value of ExecuteCommand 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:ExecuteCommand', executeCommand_cluster - The Amazon Resource Name (ARN) or short name of the cluster the task is running in. If you do not specify a cluster, the default cluster is assumed.

$sel:container:ExecuteCommand', executeCommand_container - The name of the container to execute the command on. A container name only needs to be specified for tasks containing multiple containers.

$sel:command:ExecuteCommand', executeCommand_command - The command to run on the container.

$sel:interactive:ExecuteCommand', executeCommand_interactive - Use this flag to run your command in interactive mode.

$sel:task:ExecuteCommand', executeCommand_task - The Amazon Resource Name (ARN) or ID of the task the container is part of.

Request Lenses

executeCommand_cluster :: Lens' ExecuteCommand (Maybe Text) Source #

The Amazon Resource Name (ARN) or short name of the cluster the task is running in. If you do not specify a cluster, the default cluster is assumed.

executeCommand_container :: Lens' ExecuteCommand (Maybe Text) Source #

The name of the container to execute the command on. A container name only needs to be specified for tasks containing multiple containers.

executeCommand_command :: Lens' ExecuteCommand Text Source #

The command to run on the container.

executeCommand_interactive :: Lens' ExecuteCommand Bool Source #

Use this flag to run your command in interactive mode.

executeCommand_task :: Lens' ExecuteCommand Text Source #

The Amazon Resource Name (ARN) or ID of the task the container is part of.

Destructuring the Response

data ExecuteCommandResponse Source #

See: newExecuteCommandResponse smart constructor.

Constructors

ExecuteCommandResponse'

Fields

clusterArn :: Maybe Text
The Amazon Resource Name (ARN) of the cluster.
containerArn :: Maybe Text
The Amazon Resource Name (ARN) of the container.
taskArn :: Maybe Text
The Amazon Resource Name (ARN) of the task.
containerName :: Maybe Text
The name of the container.
interactive :: Maybe Bool
Whether or not the execute command session is running in interactive mode. Amazon ECS only supports initiating interactive sessions, so you must specify true for this value.
session :: Maybe Session
The details of the SSM session that was created for this instance of execute-command.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq ExecuteCommandResponse Source #
Instance details Defined in Amazonka.ECS.ExecuteCommand Methods (==) :: ExecuteCommandResponse -> ExecuteCommandResponse -> Bool # (/=) :: ExecuteCommandResponse -> ExecuteCommandResponse -> Bool #
Show ExecuteCommandResponse Source #
Instance details Defined in Amazonka.ECS.ExecuteCommand Methods showsPrec :: Int -> ExecuteCommandResponse -> ShowS # show :: ExecuteCommandResponse -> String # showList :: [ExecuteCommandResponse] -> ShowS #
Generic ExecuteCommandResponse Source #
Instance details Defined in Amazonka.ECS.ExecuteCommand Associated Types type Rep ExecuteCommandResponse :: Type -> Type # Methods from :: ExecuteCommandResponse -> Rep ExecuteCommandResponse x # to :: Rep ExecuteCommandResponse x -> ExecuteCommandResponse #
NFData ExecuteCommandResponse Source #
Instance details Defined in Amazonka.ECS.ExecuteCommand Methods rnf :: ExecuteCommandResponse -> () #
type Rep ExecuteCommandResponse Source #
Instance details Defined in Amazonka.ECS.ExecuteCommand type Rep ExecuteCommandResponse = D1 ('MetaData "ExecuteCommandResponse" "Amazonka.ECS.ExecuteCommand" "libZSservicesZSamazonka-ecsZSamazonka-ecs" 'False) (C1 ('MetaCons "ExecuteCommandResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clusterArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "containerArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "taskArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "containerName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "interactive") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "session") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Session)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newExecuteCommandResponse Source #

Arguments

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

Create a value of ExecuteCommandResponse 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:clusterArn:ExecuteCommandResponse', executeCommandResponse_clusterArn - The Amazon Resource Name (ARN) of the cluster.

$sel:containerArn:ExecuteCommandResponse', executeCommandResponse_containerArn - The Amazon Resource Name (ARN) of the container.

$sel:taskArn:ExecuteCommandResponse', executeCommandResponse_taskArn - The Amazon Resource Name (ARN) of the task.

$sel:containerName:ExecuteCommandResponse', executeCommandResponse_containerName - The name of the container.

$sel:interactive:ExecuteCommand', executeCommandResponse_interactive - Whether or not the execute command session is running in interactive mode. Amazon ECS only supports initiating interactive sessions, so you must specify true for this value.

$sel:session:ExecuteCommandResponse', executeCommandResponse_session - The details of the SSM session that was created for this instance of execute-command.

$sel:httpStatus:ExecuteCommandResponse', executeCommandResponse_httpStatus - The response's http status code.

Response Lenses

executeCommandResponse_clusterArn :: Lens' ExecuteCommandResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the cluster.

executeCommandResponse_containerArn :: Lens' ExecuteCommandResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the container.

executeCommandResponse_taskArn :: Lens' ExecuteCommandResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the task.

executeCommandResponse_containerName :: Lens' ExecuteCommandResponse (Maybe Text) Source #

The name of the container.

executeCommandResponse_interactive :: Lens' ExecuteCommandResponse (Maybe Bool) Source #

Whether or not the execute command session is running in interactive mode. Amazon ECS only supports initiating interactive sessions, so you must specify true for this value.

executeCommandResponse_session :: Lens' ExecuteCommandResponse (Maybe Session) Source #

The details of the SSM session that was created for this instance of execute-command.

executeCommandResponse_httpStatus :: Lens' ExecuteCommandResponse Int Source #

The response's http status code.