Skip to content

DescribeCommunicationsRequest

Source code in docs_src/capo_support/types/describe_communications_request.py
class DescribeCommunicationsRequest(TypedDict, closed=True):
    case_id: "capo_support.types.case_id.CaseId"
    """<p>The support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-<i>12345678910-exen-2025-c4c1d2bf33c5cf47</i> </p>"""
    before_time: NotRequired["capo_support.types.before_time.BeforeTime"]
    """<p>The end date for a filtered date search on support case communications. Case communications are available for 24 months after creation.</p>"""
    after_time: NotRequired["capo_support.types.after_time.AfterTime"]
    """<p>The start date for a filtered date search on support case communications. Case communications are available for 24 months after creation.</p>"""
    next_token: NotRequired["capo_support.types.next_token.NextToken"]
    """<p>A resumption point for pagination.</p>"""
    max_results: NotRequired["capo_support.types.max_results.MaxResults"]
    """<p>The maximum number of results to return before paginating.</p>"""
    dry_run: NotRequired["capo_support.types.nullable_boolean_type.NullableBooleanType"]
    """<p>Specifies whether to validate the request without actually returning communications. When set to <code>true</code>, the request is validated but no communications are returned, and the operation returns a <code>DryRunOperationException</code>. When omitted or set to <code>false</code>, the request runs normally.</p>"""

after_time instance-attribute

after_time: NotRequired[AfterTime]

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

before_time instance-attribute

before_time: NotRequired[BeforeTime]

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

case_id instance-attribute

case_id: CaseId

The support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-exen-2025-c4c1d2bf33c5cf47

dry_run instance-attribute

dry_run: NotRequired[NullableBooleanType]

Specifies whether to validate the request without actually returning communications. When set to true, the request is validated but no communications are returned, and the operation returns a DryRunOperationException. When omitted or set to false, the request runs normally.

max_results instance-attribute

max_results: NotRequired[MaxResults]

The maximum number of results to return before paginating.

next_token instance-attribute

next_token: NotRequired[NextToken]

A resumption point for pagination.