You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::Support::Types::DescribeCasesRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::Support::Types::DescribeCasesRequest
- Defined in:
- (unknown)
Overview
When passing DescribeCasesRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
case_id_list: ["CaseId"],
display_id: "DisplayId",
after_time: "AfterTime",
before_time: "BeforeTime",
include_resolved_cases: false,
next_token: "NextToken",
max_results: 1,
language: "Language",
include_communications: false,
}
Instance Attribute Summary collapse
-
#after_time ⇒ String
The start date for a filtered date search on support case communications.
-
#before_time ⇒ String
The end date for a filtered date search on support case communications.
-
#case_id_list ⇒ Array<String>
A list of ID numbers of the support cases you want returned.
-
#display_id ⇒ String
The ID displayed for a case in the AWS Support Center user interface.
-
#include_communications ⇒ Boolean
Specifies whether to include communications in the
DescribeCases
response. -
#include_resolved_cases ⇒ Boolean
Specifies whether to include resolved support cases in the
DescribeCases
response. -
#language ⇒ String
The ISO 639-1 code for the language in which AWS provides support.
-
#max_results ⇒ Integer
The maximum number of results to return before paginating.
-
#next_token ⇒ String
A resumption point for pagination.
Instance Attribute Details
#after_time ⇒ String
The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation.
#before_time ⇒ String
The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation.
#case_id_list ⇒ Array<String>
A list of ID numbers of the support cases you want returned. The maximum number of cases is 100.
#display_id ⇒ String
The ID displayed for a case in the AWS Support Center user interface.
#include_communications ⇒ Boolean
Specifies whether to include communications in the DescribeCases
response. By default, communications are incuded.
#include_resolved_cases ⇒ Boolean
Specifies whether to include resolved support cases in the
DescribeCases
response. By default, resolved cases aren\'t included.
#language ⇒ String
The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be passed explicitly for operations that take them.
#max_results ⇒ Integer
The maximum number of results to return before paginating.
#next_token ⇒ String
A resumption point for pagination.