aws-sdk-robomaker 1.81.0

AWS SDK for AWS RoboMaker
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListWorldExportJobs`](crate::operation::list_world_export_jobs::builders::ListWorldExportJobsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_world_export_jobs::builders::ListWorldExportJobsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`next_token(impl Into<String>)`](crate::operation::list_world_export_jobs::builders::ListWorldExportJobsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_world_export_jobs::builders::ListWorldExportJobsFluentBuilder::set_next_token):<br>required: **false**<br><p>If the previous paginated request did not return all of the remaining results, the response object's <code>nextToken</code> parameter value is set to a token. To retrieve the next set of results, call <code>ListWorldExportJobs</code> again and assign that token to the request object's <code>nextToken</code> parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.</p><br>
    ///   - [`max_results(i32)`](crate::operation::list_world_export_jobs::builders::ListWorldExportJobsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_world_export_jobs::builders::ListWorldExportJobsFluentBuilder::set_max_results):<br>required: **false**<br><p>When this parameter is used, <code>ListWorldExportJobs</code> only returns <code>maxResults</code> results in a single page along with a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>ListWorldExportJobs</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If this parameter is not used, then <code>ListWorldExportJobs</code> returns up to 100 results and a <code>nextToken</code> value if applicable.</p><br>
    ///   - [`filters(Filter)`](crate::operation::list_world_export_jobs::builders::ListWorldExportJobsFluentBuilder::filters) / [`set_filters(Option<Vec::<Filter>>)`](crate::operation::list_world_export_jobs::builders::ListWorldExportJobsFluentBuilder::set_filters):<br>required: **false**<br><p>Optional filters to limit results. You can use <code>generationJobId</code> and <code>templateId</code>.</p><br>
    /// - On success, responds with [`ListWorldExportJobsOutput`](crate::operation::list_world_export_jobs::ListWorldExportJobsOutput) with field(s):
    ///   - [`world_export_job_summaries(Vec::<WorldExportJobSummary>)`](crate::operation::list_world_export_jobs::ListWorldExportJobsOutput::world_export_job_summaries): <p>Summary information for world export jobs.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::list_world_export_jobs::ListWorldExportJobsOutput::next_token): <p>If the previous paginated request did not return all of the remaining results, the response object's <code>nextToken</code> parameter value is set to a token. To retrieve the next set of results, call <code>ListWorldExportJobsRequest</code> again and assign that token to the request object's <code>nextToken</code> parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.</p>
    /// - On failure, responds with [`SdkError<ListWorldExportJobsError>`](crate::operation::list_world_export_jobs::ListWorldExportJobsError)
    pub fn list_world_export_jobs(&self) -> crate::operation::list_world_export_jobs::builders::ListWorldExportJobsFluentBuilder {
        crate::operation::list_world_export_jobs::builders::ListWorldExportJobsFluentBuilder::new(self.handle.clone())
    }
}