pub struct DescribeCasesFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to DescribeCases
.
Returns a list of cases that you specify by passing one or more case IDs. You can use the afterTime
and beforeTime
parameters to filter the cases by date. You can set values for the includeResolvedCases
and includeCommunications
parameters to specify how much information to return.
The response returns the following in JSON format:
-
One or more CaseDetails data types.
-
One or more
nextToken
values, which specify where to paginate the returned records represented by theCaseDetails
objects.
Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request might return an error.
-
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
-
If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the
SubscriptionRequiredException
error message appears. For information about changing your support plan, see Amazon Web Services Support.
Implementations§
source§impl DescribeCasesFluentBuilder
impl DescribeCasesFluentBuilder
sourcepub fn as_input(&self) -> &DescribeCasesInputBuilder
pub fn as_input(&self) -> &DescribeCasesInputBuilder
Access the DescribeCases as a reference.
sourcepub async fn send(
self
) -> Result<DescribeCasesOutput, SdkError<DescribeCasesError, HttpResponse>>
pub async fn send( self ) -> Result<DescribeCasesOutput, SdkError<DescribeCasesError, 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<DescribeCasesOutput, DescribeCasesError, Self>
pub fn customize( self ) -> CustomizableOperation<DescribeCasesOutput, DescribeCasesError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
sourcepub fn into_paginator(self) -> DescribeCasesPaginator
pub fn into_paginator(self) -> DescribeCasesPaginator
Create a paginator for this request
Paginators are used by calling send().await
which returns a PaginationStream
.
sourcepub fn case_id_list(self, input: impl Into<String>) -> Self
pub fn case_id_list(self, input: impl Into<String>) -> Self
Appends an item to caseIdList
.
To override the contents of this collection use set_case_id_list
.
A list of ID numbers of the support cases you want returned. The maximum number of cases is 100.
sourcepub fn set_case_id_list(self, input: Option<Vec<String>>) -> Self
pub fn set_case_id_list(self, input: Option<Vec<String>>) -> Self
A list of ID numbers of the support cases you want returned. The maximum number of cases is 100.
sourcepub fn get_case_id_list(&self) -> &Option<Vec<String>>
pub fn get_case_id_list(&self) -> &Option<Vec<String>>
A list of ID numbers of the support cases you want returned. The maximum number of cases is 100.
sourcepub fn display_id(self, input: impl Into<String>) -> Self
pub fn display_id(self, input: impl Into<String>) -> Self
The ID displayed for a case in the Amazon Web Services Support Center user interface.
sourcepub fn set_display_id(self, input: Option<String>) -> Self
pub fn set_display_id(self, input: Option<String>) -> Self
The ID displayed for a case in the Amazon Web Services Support Center user interface.
sourcepub fn get_display_id(&self) -> &Option<String>
pub fn get_display_id(&self) -> &Option<String>
The ID displayed for a case in the Amazon Web Services Support Center user interface.
sourcepub fn after_time(self, input: impl Into<String>) -> Self
pub fn after_time(self, input: impl Into<String>) -> Self
The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation.
sourcepub fn set_after_time(self, input: Option<String>) -> Self
pub fn set_after_time(self, input: Option<String>) -> Self
The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation.
sourcepub fn get_after_time(&self) -> &Option<String>
pub fn get_after_time(&self) -> &Option<String>
The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation.
sourcepub fn before_time(self, input: impl Into<String>) -> Self
pub fn before_time(self, input: impl Into<String>) -> Self
The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation.
sourcepub fn set_before_time(self, input: Option<String>) -> Self
pub fn set_before_time(self, input: Option<String>) -> Self
The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation.
sourcepub fn get_before_time(&self) -> &Option<String>
pub fn get_before_time(&self) -> &Option<String>
The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation.
sourcepub fn include_resolved_cases(self, input: bool) -> Self
pub fn include_resolved_cases(self, input: bool) -> Self
Specifies whether to include resolved support cases in the DescribeCases
response. By default, resolved cases aren't included.
sourcepub fn set_include_resolved_cases(self, input: Option<bool>) -> Self
pub fn set_include_resolved_cases(self, input: Option<bool>) -> Self
Specifies whether to include resolved support cases in the DescribeCases
response. By default, resolved cases aren't included.
sourcepub fn get_include_resolved_cases(&self) -> &Option<bool>
pub fn get_include_resolved_cases(&self) -> &Option<bool>
Specifies whether to include resolved support cases in the DescribeCases
response. By default, resolved cases aren't included.
sourcepub fn next_token(self, input: impl Into<String>) -> Self
pub fn next_token(self, input: impl Into<String>) -> Self
A resumption point for pagination.
sourcepub fn set_next_token(self, input: Option<String>) -> Self
pub fn set_next_token(self, input: Option<String>) -> Self
A resumption point for pagination.
sourcepub fn get_next_token(&self) -> &Option<String>
pub fn get_next_token(&self) -> &Option<String>
A resumption point for pagination.
sourcepub fn max_results(self, input: i32) -> Self
pub fn max_results(self, input: i32) -> Self
The maximum number of results to return before paginating.
sourcepub fn set_max_results(self, input: Option<i32>) -> Self
pub fn set_max_results(self, input: Option<i32>) -> Self
The maximum number of results to return before paginating.
sourcepub fn get_max_results(&self) -> &Option<i32>
pub fn get_max_results(&self) -> &Option<i32>
The maximum number of results to return before paginating.
sourcepub fn language(self, input: impl Into<String>) -> Self
pub fn language(self, input: impl Into<String>) -> Self
The language in which Amazon Web Services Support handles the case. Amazon Web Services Support currently supports Chinese (“zh”), English ("en"), Japanese ("ja") and Korean (“ko”). You must specify the ISO 639-1 code for the language
parameter if you want support in that language.
sourcepub fn set_language(self, input: Option<String>) -> Self
pub fn set_language(self, input: Option<String>) -> Self
The language in which Amazon Web Services Support handles the case. Amazon Web Services Support currently supports Chinese (“zh”), English ("en"), Japanese ("ja") and Korean (“ko”). You must specify the ISO 639-1 code for the language
parameter if you want support in that language.
sourcepub fn get_language(&self) -> &Option<String>
pub fn get_language(&self) -> &Option<String>
The language in which Amazon Web Services Support handles the case. Amazon Web Services Support currently supports Chinese (“zh”), English ("en"), Japanese ("ja") and Korean (“ko”). You must specify the ISO 639-1 code for the language
parameter if you want support in that language.
sourcepub fn include_communications(self, input: bool) -> Self
pub fn include_communications(self, input: bool) -> Self
Specifies whether to include communications in the DescribeCases
response. By default, communications are included.
sourcepub fn set_include_communications(self, input: Option<bool>) -> Self
pub fn set_include_communications(self, input: Option<bool>) -> Self
Specifies whether to include communications in the DescribeCases
response. By default, communications are included.
sourcepub fn get_include_communications(&self) -> &Option<bool>
pub fn get_include_communications(&self) -> &Option<bool>
Specifies whether to include communications in the DescribeCases
response. By default, communications are included.
Trait Implementations§
source§impl Clone for DescribeCasesFluentBuilder
impl Clone for DescribeCasesFluentBuilder
source§fn clone(&self) -> DescribeCasesFluentBuilder
fn clone(&self) -> DescribeCasesFluentBuilder
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 DescribeCasesFluentBuilder
impl !RefUnwindSafe for DescribeCasesFluentBuilder
impl Send for DescribeCasesFluentBuilder
impl Sync for DescribeCasesFluentBuilder
impl Unpin for DescribeCasesFluentBuilder
impl !UnwindSafe for DescribeCasesFluentBuilder
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