Struct aws_sdk_support::client::fluent_builders::DescribeCommunications

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

Fluent builder constructing a request to DescribeCommunications.

Returns communications and attachments for one or more support cases. Use the afterTime and beforeTime parameters to filter by date. You can use the caseId parameter to restrict the results to a specific case.

Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request for data might cause an error.

You can use the maxResults and nextToken parameters to control the pagination of the results. Set maxResults to the number of cases that you want to display on each page, and use nextToken to specify the resumption of pagination.

• 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> DescribeCommunications<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<DescribeCommunicationsOutput, SdkError<DescribeCommunicationsError>> where
    R::Policy: SmithyRetryPolicy<DescribeCommunicationsInputOperationOutputAlias, DescribeCommunicationsOutput, DescribeCommunicationsError, DescribeCommunicationsInputOperationRetryAlias>, 

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) -> DescribeCommunicationsPaginator<C, M, R>

Create a paginator for this request

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

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

The support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47

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

The support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47

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 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 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.

Trait Implementations

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

fn clone(&self) -> DescribeCommunications<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 DescribeCommunications<C, M, R>

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

Formats the value using the given formatter.