1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::describe_cases::_describe_cases_output::DescribeCasesOutputBuilder;
pub use crate::operation::describe_cases::_describe_cases_input::DescribeCasesInputBuilder;
/// Fluent builder constructing a request to `DescribeCases`.
///
/// <p>Returns a list of cases that you specify by passing one or more case IDs. You can use the <code>afterTime</code> and <code>beforeTime</code> parameters to filter the cases by date. You can set values for the <code>includeResolvedCases</code> and <code>includeCommunications</code> parameters to specify how much information to return.</p>
/// <p>The response returns the following in JSON format:</p>
/// <ul>
/// <li> <p>One or more <a href="https://docs.aws.amazon.com/awssupport/latest/APIReference/API_CaseDetails.html">CaseDetails</a> data types.</p> </li>
/// <li> <p>One or more <code>nextToken</code> values, which specify where to paginate the returned records represented by the <code>CaseDetails</code> objects.</p> </li>
/// </ul>
/// <p>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.</p> <note>
/// <ul>
/// <li> <p>You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API. </p> </li>
/// <li> <p>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 <code>SubscriptionRequiredException</code> error message appears. For information about changing your support plan, see <a href="http://aws.amazon.com/premiumsupport/">Amazon Web Services Support</a>.</p> </li>
/// </ul>
/// </note>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct DescribeCasesFluentBuilder {
handle: std::sync::Arc<crate::client::Handle>,
inner: crate::operation::describe_cases::builders::DescribeCasesInputBuilder,
}
impl DescribeCasesFluentBuilder {
/// Creates a new `DescribeCases`.
pub(crate) fn new(handle: std::sync::Arc<crate::client::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::client::customize::CustomizableOperation<
crate::operation::describe_cases::DescribeCases,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::operation::describe_cases::DescribeCasesError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::client::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::operation::describe_cases::DescribeCasesOutput,
aws_smithy_http::result::SdkError<crate::operation::describe_cases::DescribeCasesError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// Create a paginator for this request
///
/// Paginators are used by calling [`send().await`](crate::operation::describe_cases::paginator::DescribeCasesPaginator::send) which returns a `Stream`.
pub fn into_paginator(
self,
) -> crate::operation::describe_cases::paginator::DescribeCasesPaginator {
crate::operation::describe_cases::paginator::DescribeCasesPaginator::new(
self.handle,
self.inner,
)
}
/// Appends an item to `caseIdList`.
///
/// To override the contents of this collection use [`set_case_id_list`](Self::set_case_id_list).
///
/// <p>A list of ID numbers of the support cases you want returned. The maximum number of cases is 100.</p>
pub fn case_id_list(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.case_id_list(input.into());
self
}
/// <p>A list of ID numbers of the support cases you want returned. The maximum number of cases is 100.</p>
pub fn set_case_id_list(
mut self,
input: std::option::Option<std::vec::Vec<std::string::String>>,
) -> Self {
self.inner = self.inner.set_case_id_list(input);
self
}
/// <p>The ID displayed for a case in the Amazon Web Services Support Center user interface.</p>
pub fn display_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.display_id(input.into());
self
}
/// <p>The ID displayed for a case in the Amazon Web Services Support Center user interface.</p>
pub fn set_display_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_display_id(input);
self
}
/// <p>The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation.</p>
pub fn after_time(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.after_time(input.into());
self
}
/// <p>The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation.</p>
pub fn set_after_time(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_after_time(input);
self
}
/// <p>The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation.</p>
pub fn before_time(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.before_time(input.into());
self
}
/// <p>The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation.</p>
pub fn set_before_time(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_before_time(input);
self
}
/// <p>Specifies whether to include resolved support cases in the <code>DescribeCases</code> response. By default, resolved cases aren't included.</p>
pub fn include_resolved_cases(mut self, input: bool) -> Self {
self.inner = self.inner.include_resolved_cases(input);
self
}
/// <p>Specifies whether to include resolved support cases in the <code>DescribeCases</code> response. By default, resolved cases aren't included.</p>
pub fn set_include_resolved_cases(mut self, input: std::option::Option<bool>) -> Self {
self.inner = self.inner.set_include_resolved_cases(input);
self
}
/// <p>A resumption point for pagination.</p>
pub fn next_token(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.next_token(input.into());
self
}
/// <p>A resumption point for pagination.</p>
pub fn set_next_token(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_next_token(input);
self
}
/// <p>The maximum number of results to return before paginating.</p>
pub fn max_results(mut self, input: i32) -> Self {
self.inner = self.inner.max_results(input);
self
}
/// <p>The maximum number of results to return before paginating.</p>
pub fn set_max_results(mut self, input: std::option::Option<i32>) -> Self {
self.inner = self.inner.set_max_results(input);
self
}
/// <p>The language in which Amazon Web Services Support handles the case. Amazon Web Services Support currently supports English ("en") and Japanese ("ja"). You must specify the ISO 639-1 code for the <code>language</code> parameter if you want support in that language.</p>
pub fn language(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.language(input.into());
self
}
/// <p>The language in which Amazon Web Services Support handles the case. Amazon Web Services Support currently supports English ("en") and Japanese ("ja"). You must specify the ISO 639-1 code for the <code>language</code> parameter if you want support in that language.</p>
pub fn set_language(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_language(input);
self
}
/// <p>Specifies whether to include communications in the <code>DescribeCases</code> response. By default, communications are included.</p>
pub fn include_communications(mut self, input: bool) -> Self {
self.inner = self.inner.include_communications(input);
self
}
/// <p>Specifies whether to include communications in the <code>DescribeCases</code> response. By default, communications are included.</p>
pub fn set_include_communications(mut self, input: std::option::Option<bool>) -> Self {
self.inner = self.inner.set_include_communications(input);
self
}
}