You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::Support::Types::DescribeCasesRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-support/lib/aws-sdk-support/types.rb

Overview

Note:

When making an API call, you may pass DescribeCasesRequest data as a 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)


542
543
544
545
546
547
548
549
550
551
552
553
# File 'gems/aws-sdk-support/lib/aws-sdk-support/types.rb', line 542

class DescribeCasesRequest < Struct.new(
  :case_id_list,
  :display_id,
  :after_time,
  :before_time,
  :include_resolved_cases,
  :next_token,
  :max_results,
  :language,
  :include_communications)
  include Aws::Structure
end

#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)


542
543
544
545
546
547
548
549
550
551
552
553
# File 'gems/aws-sdk-support/lib/aws-sdk-support/types.rb', line 542

class DescribeCasesRequest < Struct.new(
  :case_id_list,
  :display_id,
  :after_time,
  :before_time,
  :include_resolved_cases,
  :next_token,
  :max_results,
  :language,
  :include_communications)
  include Aws::Structure
end

#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>)


542
543
544
545
546
547
548
549
550
551
552
553
# File 'gems/aws-sdk-support/lib/aws-sdk-support/types.rb', line 542

class DescribeCasesRequest < Struct.new(
  :case_id_list,
  :display_id,
  :after_time,
  :before_time,
  :include_resolved_cases,
  :next_token,
  :max_results,
  :language,
  :include_communications)
  include Aws::Structure
end

#display_idString

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

Returns:

  • (String)


542
543
544
545
546
547
548
549
550
551
552
553
# File 'gems/aws-sdk-support/lib/aws-sdk-support/types.rb', line 542

class DescribeCasesRequest < Struct.new(
  :case_id_list,
  :display_id,
  :after_time,
  :before_time,
  :include_resolved_cases,
  :next_token,
  :max_results,
  :language,
  :include_communications)
  include Aws::Structure
end

#include_communicationsBoolean

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

Returns:

  • (Boolean)


542
543
544
545
546
547
548
549
550
551
552
553
# File 'gems/aws-sdk-support/lib/aws-sdk-support/types.rb', line 542

class DescribeCasesRequest < Struct.new(
  :case_id_list,
  :display_id,
  :after_time,
  :before_time,
  :include_resolved_cases,
  :next_token,
  :max_results,
  :language,
  :include_communications)
  include Aws::Structure
end

#include_resolved_casesBoolean

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

Returns:

  • (Boolean)


542
543
544
545
546
547
548
549
550
551
552
553
# File 'gems/aws-sdk-support/lib/aws-sdk-support/types.rb', line 542

class DescribeCasesRequest < Struct.new(
  :case_id_list,
  :display_id,
  :after_time,
  :before_time,
  :include_resolved_cases,
  :next_token,
  :max_results,
  :language,
  :include_communications)
  include Aws::Structure
end

#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)


542
543
544
545
546
547
548
549
550
551
552
553
# File 'gems/aws-sdk-support/lib/aws-sdk-support/types.rb', line 542

class DescribeCasesRequest < Struct.new(
  :case_id_list,
  :display_id,
  :after_time,
  :before_time,
  :include_resolved_cases,
  :next_token,
  :max_results,
  :language,
  :include_communications)
  include Aws::Structure
end

#max_resultsInteger

The maximum number of results to return before paginating.

Returns:

  • (Integer)


542
543
544
545
546
547
548
549
550
551
552
553
# File 'gems/aws-sdk-support/lib/aws-sdk-support/types.rb', line 542

class DescribeCasesRequest < Struct.new(
  :case_id_list,
  :display_id,
  :after_time,
  :before_time,
  :include_resolved_cases,
  :next_token,
  :max_results,
  :language,
  :include_communications)
  include Aws::Structure
end

#next_tokenString

A resumption point for pagination.

Returns:

  • (String)


542
543
544
545
546
547
548
549
550
551
552
553
# File 'gems/aws-sdk-support/lib/aws-sdk-support/types.rb', line 542

class DescribeCasesRequest < Struct.new(
  :case_id_list,
  :display_id,
  :after_time,
  :before_time,
  :include_resolved_cases,
  :next_token,
  :max_results,
  :language,
  :include_communications)
  include Aws::Structure
end