Skip to content

DescribeCasesRequest

Source code in docs_src/capo_support/types/describe_cases_request.py
class DescribeCasesRequest(TypedDict, closed=True):
    case_id_list: NotRequired["capo_support.types.case_id_list.CaseIdList"]
    """<p>A list of ID numbers of the support cases you want returned. The maximum number of cases is 100.</p>"""
    display_id: NotRequired["capo_support.types.display_id.DisplayId"]
    """<p>The ID displayed for a case in the Amazon Web Services Support Center user interface.</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>"""
    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>"""
    include_resolved_cases: (
        "capo_support.types.include_resolved_cases.IncludeResolvedCases"
    )
    """<p>Specifies whether to include resolved support cases in the <code>DescribeCases</code> response. By default, resolved cases aren't included.</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>"""
    language: NotRequired["capo_support.types.language.Language"]
    """<p>The language in which Amazon Web Services Support handles the case. Amazon Web Services Support currently supports Chinese (“zh”), English ("en"), Japanese ("ja") , Chinese ("zh"), Spanish ("es"), Portuguese ("pt"), French ("fr"), Korean (“ko”), and Turkish ("tr"). You must specify the ISO 639-1 code for the <code>language</code> parameter if you want support in that language.</p>"""
    include_communications: NotRequired[
        "capo_support.types.include_communications.IncludeCommunications"
    ]
    """<p>Specifies whether to include communications in the <code>DescribeCases</code> response. By default, communications are included.</p>"""
    dry_run: NotRequired["capo_support.types.nullable_boolean_type.NullableBooleanType"]
    """<p>Specifies whether to validate the request without actually returning case data. When set to <code>true</code>, the request is validated but no cases 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_list instance-attribute

case_id_list: NotRequired[CaseIdList]

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

display_id instance-attribute

display_id: NotRequired[DisplayId]

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

dry_run instance-attribute

dry_run: NotRequired[NullableBooleanType]

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

include_communications instance-attribute

include_communications: NotRequired[IncludeCommunications]

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

include_resolved_cases instance-attribute

include_resolved_cases: IncludeResolvedCases

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

language instance-attribute

language: NotRequired[Language]

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

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.