Struct aws_sdk_ecs::input::ListTasksInput

#[non_exhaustive]
pub struct ListTasksInput {
    pub cluster: Option<String>,
    pub container_instance: Option<String>,
    pub family: Option<String>,
    pub next_token: Option<String>,
    pub max_results: Option<i32>,
    pub started_by: Option<String>,
    pub service_name: Option<String>,
    pub desired_status: Option<DesiredStatus>,
    pub launch_type: Option<LaunchType>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

cluster: Option<String>

The short name or full Amazon Resource Name (ARN) of the cluster to use when filtering the ListTasks results. If you do not specify a cluster, the default cluster is assumed.

container_instance: Option<String>

The container instance ID or full ARN of the container instance to use when filtering the ListTasks results. Specifying a containerInstance limits the results to tasks that belong to that container instance.

family: Option<String>

The name of the task definition family to use when filtering the ListTasks results. Specifying a family limits the results to tasks that belong to that family.

next_token: Option<String>

The nextToken value returned from a ListTasks request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it is possible the number of results to be fewer than maxResults.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

max_results: Option<i32>

The maximum number of task results returned by ListTasks in paginated output. When this parameter is used, ListTasks only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListTasks request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListTasks returns up to 100 results and a nextToken value if applicable.

started_by: Option<String>

The startedBy value with which to filter the task results. Specifying a startedBy value limits the results to tasks that were started with that value.

service_name: Option<String>

The name of the service to use when filtering the ListTasks results. Specifying a serviceName limits the results to tasks that belong to that service.

desired_status: Option<DesiredStatus>

The task desired status to use when filtering the ListTasks results. Specifying a desiredStatus of STOPPED limits the results to tasks that Amazon ECS has set the desired status to STOPPED. This can be useful for debugging tasks that are not starting properly or have died or finished. The default status filter is RUNNING, which shows tasks that Amazon ECS has set the desired status to RUNNING.

Although you can filter results based on a desired status of PENDING, this does not return any results. Amazon ECS never sets the desired status of a task to that value (only a task's lastStatus may have a value of PENDING).

launch_type: Option<LaunchType>

The launch type to use when filtering the ListTasks results.

Implementations

impl ListTasksInput

pub async fn make_operation(
    &self,
    _config: &Config
) -> Result<Operation<ListTasks, AwsErrorRetryPolicy>, BuildError>

Consumes the builder and constructs an Operation<ListTasks>

pub fn builder() -> Builder

Creates a new builder-style object to manufacture ListTasksInput

impl ListTasksInput

pub fn cluster(&self) -> Option<&str>

The short name or full Amazon Resource Name (ARN) of the cluster to use when filtering the ListTasks results. If you do not specify a cluster, the default cluster is assumed.

pub fn container_instance(&self) -> Option<&str>

The container instance ID or full ARN of the container instance to use when filtering the ListTasks results. Specifying a containerInstance limits the results to tasks that belong to that container instance.

pub fn family(&self) -> Option<&str>

The name of the task definition family to use when filtering the ListTasks results. Specifying a family limits the results to tasks that belong to that family.

pub fn next_token(&self) -> Option<&str>

The nextToken value returned from a ListTasks request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it is possible the number of results to be fewer than maxResults.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

pub fn max_results(&self) -> Option<i32>

The maximum number of task results returned by ListTasks in paginated output. When this parameter is used, ListTasks only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListTasks request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListTasks returns up to 100 results and a nextToken value if applicable.

pub fn started_by(&self) -> Option<&str>

The startedBy value with which to filter the task results. Specifying a startedBy value limits the results to tasks that were started with that value.

pub fn service_name(&self) -> Option<&str>

The name of the service to use when filtering the ListTasks results. Specifying a serviceName limits the results to tasks that belong to that service.

pub fn desired_status(&self) -> Option<&DesiredStatus>

The task desired status to use when filtering the ListTasks results. Specifying a desiredStatus of STOPPED limits the results to tasks that Amazon ECS has set the desired status to STOPPED. This can be useful for debugging tasks that are not starting properly or have died or finished. The default status filter is RUNNING, which shows tasks that Amazon ECS has set the desired status to RUNNING.

Although you can filter results based on a desired status of PENDING, this does not return any results. Amazon ECS never sets the desired status of a task to that value (only a task's lastStatus may have a value of PENDING).

pub fn launch_type(&self) -> Option<&LaunchType>

The launch type to use when filtering the ListTasks results.

Trait Implementations

impl Clone for ListTasksInput

fn clone(&self) -> ListTasksInput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ListTasksInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<ListTasksInput> for ListTasksInput

fn eq(&self, other: &ListTasksInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &ListTasksInput) -> bool

This method tests for !=.

impl StructuralPartialEq for ListTasksInput