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

Class: Aws::Support::Types::DescribeCommunicationsRequest

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 DescribeCommunicationsRequest data as a hash:

{
  case_id: "CaseId", # required
  before_time: "BeforeTime",
  after_time: "AfterTime",
  next_token: "NextToken",
  max_results: 1,
}

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)


613
614
615
616
617
618
619
620
# File 'gems/aws-sdk-support/lib/aws-sdk-support/types.rb', line 613

class DescribeCommunicationsRequest < Struct.new(
  :case_id,
  :before_time,
  :after_time,
  :next_token,
  :max_results)
  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)


613
614
615
616
617
618
619
620
# File 'gems/aws-sdk-support/lib/aws-sdk-support/types.rb', line 613

class DescribeCommunicationsRequest < Struct.new(
  :case_id,
  :before_time,
  :after_time,
  :next_token,
  :max_results)
  include Aws::Structure
end

#case_idString

The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47

Returns:

  • (String)


613
614
615
616
617
618
619
620
# File 'gems/aws-sdk-support/lib/aws-sdk-support/types.rb', line 613

class DescribeCommunicationsRequest < Struct.new(
  :case_id,
  :before_time,
  :after_time,
  :next_token,
  :max_results)
  include Aws::Structure
end

#max_resultsInteger

The maximum number of results to return before paginating.

Returns:

  • (Integer)


613
614
615
616
617
618
619
620
# File 'gems/aws-sdk-support/lib/aws-sdk-support/types.rb', line 613

class DescribeCommunicationsRequest < Struct.new(
  :case_id,
  :before_time,
  :after_time,
  :next_token,
  :max_results)
  include Aws::Structure
end

#next_tokenString

A resumption point for pagination.

Returns:

  • (String)


613
614
615
616
617
618
619
620
# File 'gems/aws-sdk-support/lib/aws-sdk-support/types.rb', line 613

class DescribeCommunicationsRequest < Struct.new(
  :case_id,
  :before_time,
  :after_time,
  :next_token,
  :max_results)
  include Aws::Structure
end