aws_sdk_ecs/client/
execute_command.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`ExecuteCommand`](crate::operation::execute_command::builders::ExecuteCommandFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`cluster(impl Into<String>)`](crate::operation::execute_command::builders::ExecuteCommandFluentBuilder::cluster) / [`set_cluster(Option<String>)`](crate::operation::execute_command::builders::ExecuteCommandFluentBuilder::set_cluster):<br>required: **false**<br><p>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.</p><br>
7    ///   - [`container(impl Into<String>)`](crate::operation::execute_command::builders::ExecuteCommandFluentBuilder::container) / [`set_container(Option<String>)`](crate::operation::execute_command::builders::ExecuteCommandFluentBuilder::set_container):<br>required: **false**<br><p>The name of the container to execute the command on. A container name only needs to be specified for tasks containing multiple containers.</p><br>
8    ///   - [`command(impl Into<String>)`](crate::operation::execute_command::builders::ExecuteCommandFluentBuilder::command) / [`set_command(Option<String>)`](crate::operation::execute_command::builders::ExecuteCommandFluentBuilder::set_command):<br>required: **true**<br><p>The command to run on the container.</p><br>
9    ///   - [`interactive(bool)`](crate::operation::execute_command::builders::ExecuteCommandFluentBuilder::interactive) / [`set_interactive(Option<bool>)`](crate::operation::execute_command::builders::ExecuteCommandFluentBuilder::set_interactive):<br>required: **true**<br><p>Use this flag to run your command in interactive mode.</p><br>
10    ///   - [`task(impl Into<String>)`](crate::operation::execute_command::builders::ExecuteCommandFluentBuilder::task) / [`set_task(Option<String>)`](crate::operation::execute_command::builders::ExecuteCommandFluentBuilder::set_task):<br>required: **true**<br><p>The Amazon Resource Name (ARN) or ID of the task the container is part of.</p><br>
11    /// - On success, responds with [`ExecuteCommandOutput`](crate::operation::execute_command::ExecuteCommandOutput) with field(s):
12    ///   - [`cluster_arn(Option<String>)`](crate::operation::execute_command::ExecuteCommandOutput::cluster_arn): <p>The Amazon Resource Name (ARN) of the cluster.</p>
13    ///   - [`container_arn(Option<String>)`](crate::operation::execute_command::ExecuteCommandOutput::container_arn): <p>The Amazon Resource Name (ARN) of the container.</p>
14    ///   - [`container_name(Option<String>)`](crate::operation::execute_command::ExecuteCommandOutput::container_name): <p>The name of the container.</p>
15    ///   - [`interactive(bool)`](crate::operation::execute_command::ExecuteCommandOutput::interactive): <p>Determines whether the execute command session is running in interactive mode. Amazon ECS only supports initiating interactive sessions, so you must specify <code>true</code> for this value.</p>
16    ///   - [`session(Option<Session>)`](crate::operation::execute_command::ExecuteCommandOutput::session): <p>The details of the SSM session that was created for this instance of execute-command.</p>
17    ///   - [`task_arn(Option<String>)`](crate::operation::execute_command::ExecuteCommandOutput::task_arn): <p>The Amazon Resource Name (ARN) of the task.</p>
18    /// - On failure, responds with [`SdkError<ExecuteCommandError>`](crate::operation::execute_command::ExecuteCommandError)
19    pub fn execute_command(&self) -> crate::operation::execute_command::builders::ExecuteCommandFluentBuilder {
20        crate::operation::execute_command::builders::ExecuteCommandFluentBuilder::new(self.handle.clone())
21    }
22}
aws_sdk_ecs/client/execute_command.rs

aws_sdk_ecs/client/
execute_command.rs
