aws_sdk_deadline/client/
list_sessions.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListSessions`](crate::operation::list_sessions::builders::ListSessionsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_sessions::builders::ListSessionsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`farm_id(impl Into<String>)`](crate::operation::list_sessions::builders::ListSessionsFluentBuilder::farm_id) / [`set_farm_id(Option<String>)`](crate::operation::list_sessions::builders::ListSessionsFluentBuilder::set_farm_id):<br>required: **true**<br><p>The farm ID for the list of sessions.</p><br>
    ///   - [`queue_id(impl Into<String>)`](crate::operation::list_sessions::builders::ListSessionsFluentBuilder::queue_id) / [`set_queue_id(Option<String>)`](crate::operation::list_sessions::builders::ListSessionsFluentBuilder::set_queue_id):<br>required: **true**<br><p>The queue ID for the list of sessions</p><br>
    ///   - [`job_id(impl Into<String>)`](crate::operation::list_sessions::builders::ListSessionsFluentBuilder::job_id) / [`set_job_id(Option<String>)`](crate::operation::list_sessions::builders::ListSessionsFluentBuilder::set_job_id):<br>required: **true**<br><p>The job ID for the list of sessions.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::list_sessions::builders::ListSessionsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_sessions::builders::ListSessionsFluentBuilder::set_next_token):<br>required: **false**<br><p>The token for the next set of results, or <code>null</code> to start from the beginning.</p><br>
    ///   - [`max_results(i32)`](crate::operation::list_sessions::builders::ListSessionsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_sessions::builders::ListSessionsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages.</p><br>
    /// - On success, responds with [`ListSessionsOutput`](crate::operation::list_sessions::ListSessionsOutput) with field(s):
    ///   - [`sessions(Vec::<SessionSummary>)`](crate::operation::list_sessions::ListSessionsOutput::sessions): <p>The sessions on the list.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::list_sessions::ListSessionsOutput::next_token): <p>If Deadline Cloud returns <code>nextToken</code>, then there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then <code>nextToken</code> is set to <code>null</code>. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 <code>ValidationException</code> error.</p>
    /// - On failure, responds with [`SdkError<ListSessionsError>`](crate::operation::list_sessions::ListSessionsError)
    pub fn list_sessions(&self) -> crate::operation::list_sessions::builders::ListSessionsFluentBuilder {
        crate::operation::list_sessions::builders::ListSessionsFluentBuilder::new(self.handle.clone())
    }
}