Struct aws_sdk_support::client::fluent_builders::DescribeCases

pub struct DescribeCases<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* private fields */ }

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 the CaseDetails 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 does not 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

impl<C, M, R> DescribeCases<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<DescribeCasesOutput, SdkError<DescribeCasesError>> where
    R::Policy: SmithyRetryPolicy<DescribeCasesInputOperationOutputAlias, DescribeCasesOutput, DescribeCasesError, DescribeCasesInputOperationRetryAlias>, 

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.

pub fn into_paginator(self) -> DescribeCasesPaginator<C, M, R>

Create a paginator for this request

Paginators are used by calling send().await which returns a Stream.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

pub fn next_token(self, input: impl Into<String>) -> Self

A resumption point for pagination.

pub fn set_next_token(self, input: Option<String>) -> Self

A resumption point for pagination.

pub fn max_results(self, input: i32) -> Self

The maximum number of results to return before paginating.

pub fn set_max_results(self, input: Option<i32>) -> Self

The maximum number of results to return before paginating.

pub fn language(self, input: impl Into<String>) -> Self

The ISO 639-1 code for the language in which Amazon Web Services provides support. Amazon Web Services Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them.

pub fn set_language(self, input: Option<String>) -> Self

The ISO 639-1 code for the language in which Amazon Web Services provides support. Amazon Web Services Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them.

pub fn include_communications(self, input: bool) -> Self

Specifies whether to include communications in the DescribeCases response. By default, communications are included.

pub fn set_include_communications(self, input: Option<bool>) -> Self

Specifies whether to include communications in the DescribeCases response. By default, communications are included.

Trait Implementations

impl<C: Clone, M: Clone, R: Clone> Clone for DescribeCases<C, M, R>

fn clone(&self) -> DescribeCases<C, M, R>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<C: Debug, M: Debug, R: Debug> Debug for DescribeCases<C, M, R>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.