aws_sdk_elementalinference/client/search_fixtures.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 [`SearchFixtures`](crate::operation::search_fixtures::builders::SearchFixturesFluentBuilder) operation.
4 /// This operation supports pagination; See [`into_paginator()`](crate::operation::search_fixtures::builders::SearchFixturesFluentBuilder::into_paginator).
5 ///
6 /// - The fluent builder is configurable:
7 /// - [`sport(DataSourceSport)`](crate::operation::search_fixtures::builders::SearchFixturesFluentBuilder::sport) / [`set_sport(Option<DataSourceSport>)`](crate::operation::search_fixtures::builders::SearchFixturesFluentBuilder::set_sport):<br>required: **true**<br><p>The sport to search for fixtures. Valid values: basketball (search for basketball fixtures), american-football (search for american-football fixtures).</p><br>
8 /// - [`start_date(impl Into<String>)`](crate::operation::search_fixtures::builders::SearchFixturesFluentBuilder::start_date) / [`set_start_date(Option<String>)`](crate::operation::search_fixtures::builders::SearchFixturesFluentBuilder::set_start_date):<br>required: **true**<br><p>The first day of the search window, in UTC. The search includes fixtures that are scheduled on this day.</p> <p>Specify the date in ISO 8601 format, as <code>YYYY-MM-DD</code>. For example, 2026-03-14.</p><br>
9 /// - [`end_date(impl Into<String>)`](crate::operation::search_fixtures::builders::SearchFixturesFluentBuilder::end_date) / [`set_end_date(Option<String>)`](crate::operation::search_fixtures::builders::SearchFixturesFluentBuilder::set_end_date):<br>required: **false**<br><p>The last day of the search window, in UTC. The search includes fixtures that are scheduled on this day. Specify the date in ISO 8601 format, as <code>YYYY-MM-DD</code>.</p> <p>If you omit this parameter, Elemental Inference searches only the day that you specified in startDate. The window from startDate through endDate must not exceed seven days.</p><br>
10 /// - [`filters(SearchFilter)`](crate::operation::search_fixtures::builders::SearchFixturesFluentBuilder::filters) / [`set_filters(Option<Vec::<SearchFilter>>)`](crate::operation::search_fixtures::builders::SearchFixturesFluentBuilder::set_filters):<br>required: **false**<br><p>An array of filters that narrow the results. Each filter applies to one dimension of a fixture, such as the competitor. You can specify up to 10 filters.</p> <p>A fixture must satisfy every filter in the array in order to appear in the results. Within one filter, a fixture must match at least one of the values.</p><br>
11 /// - [`max_results(i32)`](crate::operation::search_fixtures::builders::SearchFixturesFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::search_fixtures::builders::SearchFixturesFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of fixtures to return for each API request.</p> <p>The service might return fewer fixtures than the maxResults value. When more fixtures match the search, the response also includes a nextToken value that you can use to fetch the next batch of results.</p><br>
12 /// - [`next_token(impl Into<String>)`](crate::operation::search_fixtures::builders::SearchFixturesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::search_fixtures::builders::SearchFixturesFluentBuilder::set_next_token):<br>required: **false**<br><p>The token that identifies the batch of results that you want to see.</p> <p>For example, you submit a SearchFixtures request with maxResults set at 5. The service returns the first batch of results (up to 5) and a nextToken value. To see the next batch of results, you submit the SearchFixtures request a second time, with the same search criteria, and specify the nextToken value.</p><br>
13 /// - On success, responds with [`SearchFixturesOutput`](crate::operation::search_fixtures::SearchFixturesOutput) with field(s):
14 /// - [`fixtures(Vec::<FixtureSummary>)`](crate::operation::search_fixtures::SearchFixturesOutput::fixtures): <p>An array of FixtureSummary objects, one for each fixture that matches the search. The array is empty if no fixtures match.</p>
15 /// - [`next_token(Option<String>)`](crate::operation::search_fixtures::SearchFixturesOutput::next_token): <p>The token that identifies the next batch of results. To see the next batch, submit the SearchFixtures request again, with the same search criteria, and specify this value in nextToken.</p> <p>This parameter is absent when there are no more results to return.</p>
16 /// - On failure, responds with [`SdkError<SearchFixturesError>`](crate::operation::search_fixtures::SearchFixturesError)
17 pub fn search_fixtures(&self) -> crate::operation::search_fixtures::builders::SearchFixturesFluentBuilder {
18 crate::operation::search_fixtures::builders::SearchFixturesFluentBuilder::new(self.handle.clone())
19 }
20}