aws_sdk_pinpoint/client/get_segment_export_jobs.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 [`GetSegmentExportJobs`](crate::operation::get_segment_export_jobs::builders::GetSegmentExportJobsFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`application_id(impl Into<String>)`](crate::operation::get_segment_export_jobs::builders::GetSegmentExportJobsFluentBuilder::application_id) / [`set_application_id(Option<String>)`](crate::operation::get_segment_export_jobs::builders::GetSegmentExportJobsFluentBuilder::set_application_id):<br>required: **true**<br><p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p><br>
7 /// - [`page_size(impl Into<String>)`](crate::operation::get_segment_export_jobs::builders::GetSegmentExportJobsFluentBuilder::page_size) / [`set_page_size(Option<String>)`](crate::operation::get_segment_export_jobs::builders::GetSegmentExportJobsFluentBuilder::set_page_size):<br>required: **false**<br><p>The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.</p><br>
8 /// - [`segment_id(impl Into<String>)`](crate::operation::get_segment_export_jobs::builders::GetSegmentExportJobsFluentBuilder::segment_id) / [`set_segment_id(Option<String>)`](crate::operation::get_segment_export_jobs::builders::GetSegmentExportJobsFluentBuilder::set_segment_id):<br>required: **true**<br><p>The unique identifier for the segment.</p><br>
9 /// - [`token(impl Into<String>)`](crate::operation::get_segment_export_jobs::builders::GetSegmentExportJobsFluentBuilder::token) / [`set_token(Option<String>)`](crate::operation::get_segment_export_jobs::builders::GetSegmentExportJobsFluentBuilder::set_token):<br>required: **false**<br><p>The NextToken string that specifies which page of results to return in a paginated response.</p><br>
10 /// - On success, responds with [`GetSegmentExportJobsOutput`](crate::operation::get_segment_export_jobs::GetSegmentExportJobsOutput) with field(s):
11 /// - [`export_jobs_response(Option<ExportJobsResponse>)`](crate::operation::get_segment_export_jobs::GetSegmentExportJobsOutput::export_jobs_response): <p>Provides information about all the export jobs that are associated with an application or segment. An export job is a job that exports endpoint definitions to a file.</p>
12 /// - On failure, responds with [`SdkError<GetSegmentExportJobsError>`](crate::operation::get_segment_export_jobs::GetSegmentExportJobsError)
13 pub fn get_segment_export_jobs(&self) -> crate::operation::get_segment_export_jobs::builders::GetSegmentExportJobsFluentBuilder {
14 crate::operation::get_segment_export_jobs::builders::GetSegmentExportJobsFluentBuilder::new(self.handle.clone())
15 }
16}