aws support describe-cases
Returns a list of cases that you specify by passing one or more case IDs. You can use the afterTime and beforeTime parameters to filter the cases by date. You can set values for the includeResolvedCases and includeCommunications parameters to specify how much information to return. The response returns the following in JSON format: One or more CaseDetails data types. One or more nextToken values, which specify where to paginate the returned records represented by the CaseDetails objects. Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request might return an error. You must have a Business or Enterprise support plan to use the AWS Support API. If you call the AWS Support API from an account that does not have a Business or Enterprise support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see AWS Support
Options
| Name | Description |
|---|---|
--case-id-list <list> | A list of ID numbers of the support cases you want returned. The maximum number of cases is 100 |
--display-id <string> | The ID displayed for a case in the AWS Support Center user interface |
--after-time <string> | The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation |
--before-time <string> | The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation |
--include-resolved-cases | Specifies whether to include resolved support cases in the DescribeCases response. By default, resolved cases aren't included |
--no-include-resolved-cases | Specifies whether to include resolved support cases in the DescribeCases response. By default, resolved cases aren't included |
--next-token <string> | A resumption point for pagination |
--max-results <integer> | The maximum number of results to return before paginating |
--language <string> | The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them |
--include-communications | Specifies whether to include communications in the DescribeCases response. By default, communications are included |
--no-include-communications | Specifies whether to include communications in the DescribeCases response. By default, communications are included |
--cli-input-json <string> | Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally |
--starting-token <string> | A token to specify where to start paginating. This is the NextToken from a previously truncated response. For usage examples, see Pagination in the AWS Command Line Interface User Guide |
--page-size <integer> | The size of each page to get in the AWS service call. This does not affect the number of items returned in the command's output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out. For usage examples, see Pagination in the AWS Command Line Interface User Guide |
--max-items <integer> | The total number of items to return in the command's output. If the total number of items available is more than the value specified, a NextToken is provided in the command's output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI. For usage examples, see Pagination in the AWS Command Line Interface User Guide |
--generate-cli-skeleton <string> | Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command |