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
show all
Defined in:
(unknown)

Overview

Note:

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

Instance Attribute Details

#after_timeString

The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation.

Returns:

  • (String)

    The start date for a filtered date search on support case communications.

#before_timeString

The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation.

Returns:

  • (String)

    The end date for a filtered date search on support case communications.

#case_id_listArray<String>

A list of ID numbers of the support cases you want returned. The maximum number of cases is 100.

Returns:

  • (Array<String>)

    A list of ID numbers of the support cases you want returned.

#display_idString

The ID displayed for a case in the AWS Support Center user interface.

Returns:

  • (String)

    The ID displayed for a case in the AWS Support Center user interface.

#include_communicationsBoolean

Specifies whether communications should be included in the DescribeCases results. The default is true.

Returns:

  • (Boolean)

    Specifies whether communications should be included in the DescribeCases results.

#include_resolved_casesBoolean

Specifies whether resolved support cases should be included in the DescribeCases results. The default is false.

Returns:

  • (Boolean)

    Specifies whether resolved support cases should be included in the DescribeCases results.

#languageString

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.

Returns:

  • (String)

    The ISO 639-1 code for the language in which AWS provides support.

#max_resultsInteger

The maximum number of results to return before paginating.

Returns:

  • (Integer)

    The maximum number of results to return before paginating.

#next_tokenString

A resumption point for pagination.

Returns:

  • (String)

    A resumption point for pagination.