Struct aws_sdk_forecast::operation::list_what_if_analyses::builders::ListWhatIfAnalysesFluentBuilder
source · pub struct ListWhatIfAnalysesFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to ListWhatIfAnalyses
.
Returns a list of what-if analyses created using the CreateWhatIfAnalysis
operation. For each what-if analysis, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the what-if analysis ARN with the DescribeWhatIfAnalysis
operation.
Implementations§
source§impl ListWhatIfAnalysesFluentBuilder
impl ListWhatIfAnalysesFluentBuilder
sourcepub fn as_input(&self) -> &ListWhatIfAnalysesInputBuilder
pub fn as_input(&self) -> &ListWhatIfAnalysesInputBuilder
Access the ListWhatIfAnalyses as a reference.
sourcepub async fn send(
self
) -> Result<ListWhatIfAnalysesOutput, SdkError<ListWhatIfAnalysesError, HttpResponse>>
pub async fn send( self ) -> Result<ListWhatIfAnalysesOutput, SdkError<ListWhatIfAnalysesError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
sourcepub fn customize(
self
) -> CustomizableOperation<ListWhatIfAnalysesOutput, ListWhatIfAnalysesError, Self>
pub fn customize( self ) -> CustomizableOperation<ListWhatIfAnalysesOutput, ListWhatIfAnalysesError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
sourcepub fn into_paginator(self) -> ListWhatIfAnalysesPaginator
pub fn into_paginator(self) -> ListWhatIfAnalysesPaginator
Create a paginator for this request
Paginators are used by calling send().await
which returns a PaginationStream
.
sourcepub fn next_token(self, input: impl Into<String>) -> Self
pub fn next_token(self, input: impl Into<String>) -> Self
If the result of the previous request was truncated, the response includes a NextToken
. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.
sourcepub fn set_next_token(self, input: Option<String>) -> Self
pub fn set_next_token(self, input: Option<String>) -> Self
If the result of the previous request was truncated, the response includes a NextToken
. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.
sourcepub fn get_next_token(&self) -> &Option<String>
pub fn get_next_token(&self) -> &Option<String>
If the result of the previous request was truncated, the response includes a NextToken
. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.
sourcepub fn max_results(self, input: i32) -> Self
pub fn max_results(self, input: i32) -> Self
The number of items to return in the response.
sourcepub fn set_max_results(self, input: Option<i32>) -> Self
pub fn set_max_results(self, input: Option<i32>) -> Self
The number of items to return in the response.
sourcepub fn get_max_results(&self) -> &Option<i32>
pub fn get_max_results(&self) -> &Option<i32>
The number of items to return in the response.
sourcepub fn filters(self, input: Filter) -> Self
pub fn filters(self, input: Filter) -> Self
Appends an item to Filters
.
To override the contents of this collection use set_filters
.
An array of filters. For each filter, you provide a condition and a match statement. The condition is either IS
or IS_NOT
, which specifies whether to include or exclude the what-if analysis jobs that match the statement from the list, respectively. The match statement consists of a key and a value.
Filter properties
-
Condition
- The condition to apply. Valid values areIS
andIS_NOT
. To include the what-if analysis jobs that match the statement, specifyIS
. To exclude matching what-if analysis jobs, specifyIS_NOT
. -
Key
- The name of the parameter to filter on. Valid values areWhatIfAnalysisArn
andStatus
. -
Value
- The value to match.
For example, to list all jobs that export a forecast named electricityWhatIf, specify the following filter:
"Filters": [ { "Condition": "IS", "Key": "WhatIfAnalysisArn", "Value": "arn:aws:forecast:us-west-2:
sourcepub fn set_filters(self, input: Option<Vec<Filter>>) -> Self
pub fn set_filters(self, input: Option<Vec<Filter>>) -> Self
An array of filters. For each filter, you provide a condition and a match statement. The condition is either IS
or IS_NOT
, which specifies whether to include or exclude the what-if analysis jobs that match the statement from the list, respectively. The match statement consists of a key and a value.
Filter properties
-
Condition
- The condition to apply. Valid values areIS
andIS_NOT
. To include the what-if analysis jobs that match the statement, specifyIS
. To exclude matching what-if analysis jobs, specifyIS_NOT
. -
Key
- The name of the parameter to filter on. Valid values areWhatIfAnalysisArn
andStatus
. -
Value
- The value to match.
For example, to list all jobs that export a forecast named electricityWhatIf, specify the following filter:
"Filters": [ { "Condition": "IS", "Key": "WhatIfAnalysisArn", "Value": "arn:aws:forecast:us-west-2:
sourcepub fn get_filters(&self) -> &Option<Vec<Filter>>
pub fn get_filters(&self) -> &Option<Vec<Filter>>
An array of filters. For each filter, you provide a condition and a match statement. The condition is either IS
or IS_NOT
, which specifies whether to include or exclude the what-if analysis jobs that match the statement from the list, respectively. The match statement consists of a key and a value.
Filter properties
-
Condition
- The condition to apply. Valid values areIS
andIS_NOT
. To include the what-if analysis jobs that match the statement, specifyIS
. To exclude matching what-if analysis jobs, specifyIS_NOT
. -
Key
- The name of the parameter to filter on. Valid values areWhatIfAnalysisArn
andStatus
. -
Value
- The value to match.
For example, to list all jobs that export a forecast named electricityWhatIf, specify the following filter:
"Filters": [ { "Condition": "IS", "Key": "WhatIfAnalysisArn", "Value": "arn:aws:forecast:us-west-2:
Trait Implementations§
source§impl Clone for ListWhatIfAnalysesFluentBuilder
impl Clone for ListWhatIfAnalysesFluentBuilder
source§fn clone(&self) -> ListWhatIfAnalysesFluentBuilder
fn clone(&self) -> ListWhatIfAnalysesFluentBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for ListWhatIfAnalysesFluentBuilder
impl !RefUnwindSafe for ListWhatIfAnalysesFluentBuilder
impl Send for ListWhatIfAnalysesFluentBuilder
impl Sync for ListWhatIfAnalysesFluentBuilder
impl Unpin for ListWhatIfAnalysesFluentBuilder
impl !UnwindSafe for ListWhatIfAnalysesFluentBuilder
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more