AmazonECSClient.ExecuteCommand Method (ExecuteCommandRequest)

Runs a command remotely on a container within a task.

If you use a condition key in your IAM policy to refine the conditions for the policy statement, for example limit the actions to a specific cluster, you receive an AccessDeniedException when there is a mismatch between the condition key value and the corresponding parameter value.

For information about required permissions and considerations, see Using Amazon ECS Exec for debugging in the Amazon ECS Developer Guide.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to ExecuteCommandAsync.

Namespace: Amazon.ECS
Assembly: AWSSDK.ECS.dll
Version: 3.x.y.z

Syntax

public virtual ExecuteCommandResponse ExecuteCommand(
         ExecuteCommandRequest request
)

Parameters

request: Type: Amazon.ECS.Model.ExecuteCommandRequest

Container for the necessary parameters to execute the ExecuteCommand service method.

Return Value

Type: ExecuteCommandResponse

The response from the ExecuteCommand service method, as returned by ECS.

Exceptions

Exception	Condition
AccessDeniedException	You don't have authorization to perform the requested action.
ClientException	These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.
ClusterNotFoundException	The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
InvalidParameterException	The specified parameter isn't valid. Review the available parameters for the API request. For more information about service event errors, see Amazon ECS service event messages.
ServerException	These errors are usually caused by a server issue.
TargetNotConnectedException	The execute command cannot run. This error can be caused by any of the following configuration issues: Incorrect IAM permissions The SSM agent is not installed or is not running There is an interface Amazon VPC endpoint for Amazon ECS, but there is not one for Systems Manager Session Manager For information about how to troubleshoot the issues, see Troubleshooting issues with ECS Exec in the Amazon Elastic Container Service Developer Guide.

Examples

This example runs an interactive /bin/sh command on a container MyContainer.

To run a command remotely on a container in a task


var client = new AmazonECSClient();
var response = client.ExecuteCommand(new ExecuteCommandRequest 
{
    Cluster = "MyCluster",
    Command = "/bin/sh",
    Container = "MyContainer",
    Interactive = true,
    Task = "arn:aws:ecs:us-east-1:123456789012:task/MyCluster/d789e94343414c25b9f6bd59eEXAMPLE"
});

string clusterArn = response.ClusterArn;
string containerArn = response.ContainerArn;
string containerName = response.ContainerName;
bool interactive = response.Interactive;
Session session = response.Session;
string taskArn = response.TaskArn;

Version Information

.NET Framework:
Supported in: 4.5 and newer, 3.5

AmazonECSClient.ExecuteCommand (ExecuteCommandRequest)

Method