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

Inherits:

Struct

• Object
• Struct
• Aws::Support::Types::DescribeCasesRequest

Defined in:

gems/aws-sdk-support/lib/aws-sdk-support/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #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 Amazon Web Services 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 language in which Amazon Web Services Support handles the case.

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

Returns:

• (String)

# File 'gems/aws-sdk-support/lib/aws-sdk-support/types.rb', line 757

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

#before_time ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-support/lib/aws-sdk-support/types.rb', line 757

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

#case_id_list ⇒ Array<String>

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

Returns:

• (Array<String>)

# File 'gems/aws-sdk-support/lib/aws-sdk-support/types.rb', line 757

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

#display_id ⇒ String

The ID displayed for a case in the Amazon Web Services Support Center user interface.

Returns:

• (String)

# File 'gems/aws-sdk-support/lib/aws-sdk-support/types.rb', line 757

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

#include_communications ⇒ Boolean

Specifies whether to include communications in the DescribeCases response. By default, communications are included.

Returns:

• (Boolean)

# File 'gems/aws-sdk-support/lib/aws-sdk-support/types.rb', line 757

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

#include_resolved_cases ⇒ Boolean

Specifies whether to include resolved support cases in the DescribeCases response. By default, resolved cases aren't included.

Returns:

• (Boolean)

# File 'gems/aws-sdk-support/lib/aws-sdk-support/types.rb', line 757

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

#language ⇒ String

The language in which Amazon Web Services Support handles the case. Amazon Web Services Support currently supports Chinese (“zh”), English ("en"), Japanese ("ja") and Korean (“ko”). You must specify the ISO 639-1 code for the language parameter if you want support in that language.

Returns:

• (String)

# File 'gems/aws-sdk-support/lib/aws-sdk-support/types.rb', line 757

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

#max_results ⇒ Integer

The maximum number of results to return before paginating.

Returns:

• (Integer)

# File 'gems/aws-sdk-support/lib/aws-sdk-support/types.rb', line 757

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

#next_token ⇒ String

A resumption point for pagination.

Returns:

• (String)

# File 'gems/aws-sdk-support/lib/aws-sdk-support/types.rb', line 757

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