/AWS1/CL_SUP=>DESCRIBECOMMUNICATIONS()
¶
About DescribeCommunications¶
Returns communications and attachments for one or more support cases. Use the
afterTime
and beforeTime
parameters to filter by date. You
can use the caseId
parameter to restrict the results to a specific
case.
Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request for data might cause an error.
You can use the maxResults
and nextToken
parameters to
control the pagination of the results. Set maxResults
to the number of
cases that you want to display on each page, and use nextToken
to specify
the resumption of pagination.
-
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
-
If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the
SubscriptionRequiredException
error message appears. For information about changing your support plan, see Amazon Web Services Support.
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_CASEID
TYPE /AWS1/SUPCASEID
/AWS1/SUPCASEID
¶
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-2013-c4c1d2bf33c5cf47
Optional arguments:¶
IV_BEFORETIME
TYPE /AWS1/SUPBEFORETIME
/AWS1/SUPBEFORETIME
¶
The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation.
IV_AFTERTIME
TYPE /AWS1/SUPAFTERTIME
/AWS1/SUPAFTERTIME
¶
The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation.
IV_NEXTTOKEN
TYPE /AWS1/SUPNEXTTOKEN
/AWS1/SUPNEXTTOKEN
¶
A resumption point for pagination.
IV_MAXRESULTS
TYPE /AWS1/SUPMAXRESULTS
/AWS1/SUPMAXRESULTS
¶
The maximum number of results to return before paginating.