Table of Contents
A low-level client representing AWS Support
The Amazon Web Services Support API Reference is intended for programmers who need detailed information about the Amazon Web Services Support operations and data types. You can use the API to manage your support cases programmatically. The Amazon Web Services Support API uses HTTP methods that return results in JSON format.
Note
The Amazon Web Services Support service also exposes a set of Trusted Advisor features. You can retrieve a list of checks and their descriptions, get check results, specify checks to refresh, and get the refresh status of checks.
The following list describes the Amazon Web Services Support case management operations:
The following list describes the operations available from the Amazon Web Services Support service for Trusted Advisor:
For authentication of requests, Amazon Web Services Support uses Signature Version 4 Signing Process .
See About the Amazon Web Services Support API in the Amazon Web Services Support User Guide for information about how to use this service to create and manage your support cases, and how to call Trusted Advisor for results of checks on your resources.
import boto3
client = boto3.client('support')
These are the available methods:
Adds one or more attachments to an attachment set.
An attachment set is a temporary container for attachments that you add to a case or case communication. The set is available for 1 hour after it's created. The expiryTime returned in the response is when the set expires.
Note
See also: AWS API Documentation
Request Syntax
response = client.add_attachments_to_set(
attachmentSetId='string',
attachments=[
{
'fileName': 'string',
'data': b'bytes'
},
]
)
[REQUIRED]
One or more attachments to add to the set. You can add up to three attachments per set. The size limit is 5 MB per attachment.
In the Attachment object, use the data parameter to specify the contents of the attachment file. In the previous request syntax, the value for data appear as blob , which is represented as a base64-encoded string. The value for fileName is the name of the attachment, such as troubleshoot-screenshot.png .
An attachment to a case communication. The attachment consists of the file name and the content of the file.
The name of the attachment file.
The content of the attachment file.
dict
Response Syntax
{
'attachmentSetId': 'string',
'expiryTime': 'string'
}
Response Structure
(dict) --
The ID and expiry time of the attachment set returned by the AddAttachmentsToSet operation.
attachmentSetId (string) --
The ID of the attachment set. If an attachmentSetId was not specified, a new attachment set is created, and the ID of the set is returned in the response. If an attachmentSetId was specified, the attachments are added to the specified set, if it exists.
expiryTime (string) --
The time and date when the attachment set expires.
Exceptions
Adds additional customer communication to an Amazon Web Services Support case. Use the caseId parameter to identify the case to which to add communication. You can list a set of email addresses to copy on the communication by using the ccEmailAddresses parameter. The communicationBody value contains the text of the communication.
Note
See also: AWS API Documentation
Request Syntax
response = client.add_communication_to_case(
caseId='string',
communicationBody='string',
ccEmailAddresses=[
'string',
],
attachmentSetId='string'
)
[REQUIRED]
The body of an email communication to add to the support case.
The email addresses in the CC line of an email to be added to the support case.
dict
Response Syntax
{
'result': True|False
}
Response Structure
(dict) --
The result of the AddCommunicationToCase operation.
result (boolean) --
True if AddCommunicationToCase succeeds. Otherwise, returns an error.
Exceptions
Check if an operation can be paginated.
Creates a case in the Amazon Web Services Support Center. This operation is similar to how you create a case in the Amazon Web Services Support Center Create Case page.
The Amazon Web Services Support API doesn't support requesting service limit increases. You can submit a service limit increase in the following ways:
A successful CreateCase request returns an Amazon Web Services Support case number. You can use the DescribeCases operation and specify the case number to get existing Amazon Web Services Support cases. After you create a case, use the AddCommunicationToCase operation to add additional communication or attachments to an existing case.
The caseId is separate from the displayId that appears in the Amazon Web Services Support Center . Use the DescribeCases operation to get the displayId .
Note
See also: AWS API Documentation
Request Syntax
response = client.create_case(
subject='string',
serviceCode='string',
severityCode='string',
categoryCode='string',
communicationBody='string',
ccEmailAddresses=[
'string',
],
language='string',
issueType='string',
attachmentSetId='string'
)
[REQUIRED]
The title of the support case. The title appears in the Subject field on the Amazon Web Services Support Center Create Case page.
A value that indicates the urgency of the case. This value determines the response time according to your service level agreement with Amazon Web Services Support. You can use the DescribeSeverityLevels operation to get the possible values for severityCode .
For more information, see SeverityLevel and Choosing a Severity in the Amazon Web Services Support User Guide .
Note
The availability of severity levels depends on the support plan for the Amazon Web Services account.
[REQUIRED]
The communication body text that describes the issue. This text appears in the Description field on the Amazon Web Services Support Center Create Case page.
A list of email addresses that Amazon Web Services Support copies on case correspondence. Amazon Web Services Support identifies the account that creates the case when you specify your Amazon Web Services credentials in an HTTP POST method or use the Amazon Web Services SDKs .
dict
Response Syntax
{
'caseId': 'string'
}
Response Structure
(dict) --
The support case ID returned by a successful completion of the CreateCase operation.
caseId (string) --
The support case ID requested or returned in the call. The case ID is an alphanumeric string in the following format: case-12345678910-2013-c4c1d2bf33c5cf47
Exceptions
Returns the attachment that has the specified ID. Attachments can include screenshots, error logs, or other files that describe your issue. Attachment IDs are generated by the case management system when you add an attachment to a case or case communication. Attachment IDs are returned in the AttachmentDetails objects that are returned by the DescribeCommunications operation.
Note
See also: AWS API Documentation
Request Syntax
response = client.describe_attachment(
attachmentId='string'
)
[REQUIRED]
The ID of the attachment to return. Attachment IDs are returned by the DescribeCommunications operation.
{
'attachment': {
'fileName': 'string',
'data': b'bytes'
}
}
Response Structure
The content and file name of the attachment returned by the DescribeAttachment operation.
This object includes the attachment content and file name.
In the previous response syntax, the value for the data parameter appears as blob , which is represented as a base64-encoded string. The value for fileName is the name of the attachment, such as troubleshoot-screenshot.png .
The name of the attachment file.
The content of the attachment file.
Exceptions
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:
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.
Note
See also: AWS API Documentation
Request Syntax
response = client.describe_cases(
caseIdList=[
'string',
],
displayId='string',
afterTime='string',
beforeTime='string',
includeResolvedCases=True|False,
nextToken='string',
maxResults=123,
language='string',
includeCommunications=True|False
)
A list of ID numbers of the support cases you want returned. The maximum number of cases is 100.
dict
Response Syntax
{
'cases': [
{
'caseId': 'string',
'displayId': 'string',
'subject': 'string',
'status': 'string',
'serviceCode': 'string',
'categoryCode': 'string',
'severityCode': 'string',
'submittedBy': 'string',
'timeCreated': 'string',
'recentCommunications': {
'communications': [
{
'caseId': 'string',
'body': 'string',
'submittedBy': 'string',
'timeCreated': 'string',
'attachmentSet': [
{
'attachmentId': 'string',
'fileName': 'string'
},
]
},
],
'nextToken': 'string'
},
'ccEmailAddresses': [
'string',
],
'language': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
Returns an array of CaseDetails objects and a nextToken that defines a point for pagination in the result set.
cases (list) --
The details for the cases that match the request.
(dict) --
A JSON-formatted object that contains the metadata for a support case. It is contained in the response from a DescribeCases request. CaseDetails contains the following fields:
caseId (string) --
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
displayId (string) --
The ID displayed for the case in the Amazon Web Services Support Center. This is a numeric string.
subject (string) --
The subject line for the case in the Amazon Web Services Support Center.
status (string) --
The status of the case.
Valid values:
serviceCode (string) --
The code for the Amazon Web Services service. You can get a list of codes and the corresponding service names by calling DescribeServices .
categoryCode (string) --
The category of problem for the support case.
severityCode (string) --
The code for the severity level returned by the call to DescribeSeverityLevels .
submittedBy (string) --
The email address of the account that submitted the case.
timeCreated (string) --
The time that the case was created in the Amazon Web Services Support Center.
recentCommunications (dict) --
The five most recent communications between you and Amazon Web Services Support Center, including the IDs of any attachments to the communications. Also includes a nextToken that you can use to retrieve earlier communications.
communications (list) --
The five most recent communications associated with the case.
(dict) --
A communication associated with a support case. The communication consists of the case ID, the message body, attachment information, the submitter of the communication, and the date and time of the communication.
caseId (string) --
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
body (string) --
The text of the communication between the customer and Amazon Web Services Support.
submittedBy (string) --
The identity of the account that submitted, or responded to, the support case. Customer entries include the role or IAM user as well as the email address. For example, "AdminRole (Role) <janedoe@example.com>. Entries from the Amazon Web Services Support team display "Amazon Web Services," and don't show an email address.
timeCreated (string) --
The time the communication was created.
attachmentSet (list) --
Information about the attachments to the case communication.
(dict) --
The file name and ID of an attachment to a case communication. You can use the ID to retrieve the attachment with the DescribeAttachment operation.
attachmentId (string) --
The ID of the attachment.
fileName (string) --
The file name of the attachment.
nextToken (string) --
A resumption point for pagination.
ccEmailAddresses (list) --
The email addresses that receive copies of communication about the case.
language (string) --
The ISO 639-1 code for the language in which Amazon Web Services provides support. Amazon Web Services Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them.
nextToken (string) --
A resumption point for pagination.
Exceptions
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.
Note
See also: AWS API Documentation
Request Syntax
response = client.describe_communications(
caseId='string',
beforeTime='string',
afterTime='string',
nextToken='string',
maxResults=123
)
[REQUIRED]
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
dict
Response Syntax
{
'communications': [
{
'caseId': 'string',
'body': 'string',
'submittedBy': 'string',
'timeCreated': 'string',
'attachmentSet': [
{
'attachmentId': 'string',
'fileName': 'string'
},
]
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
The communications returned by the DescribeCommunications operation.
communications (list) --
The communications for the case.
(dict) --
A communication associated with a support case. The communication consists of the case ID, the message body, attachment information, the submitter of the communication, and the date and time of the communication.
caseId (string) --
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
body (string) --
The text of the communication between the customer and Amazon Web Services Support.
submittedBy (string) --
The identity of the account that submitted, or responded to, the support case. Customer entries include the role or IAM user as well as the email address. For example, "AdminRole (Role) <janedoe@example.com>. Entries from the Amazon Web Services Support team display "Amazon Web Services," and don't show an email address.
timeCreated (string) --
The time the communication was created.
attachmentSet (list) --
Information about the attachments to the case communication.
(dict) --
The file name and ID of an attachment to a case communication. You can use the ID to retrieve the attachment with the DescribeAttachment operation.
attachmentId (string) --
The ID of the attachment.
fileName (string) --
The file name of the attachment.
nextToken (string) --
A resumption point for pagination.
Exceptions
Returns the current list of Amazon Web Services services and a list of service categories for each service. You then use service names and categories in your CreateCase requests. Each Amazon Web Services service has its own set of categories.
The service codes and category codes correspond to the values that appear in the Service and Category lists on the Amazon Web Services Support Center Create Case page. The values in those fields don't necessarily match the service codes and categories returned by the DescribeServices operation. Always use the service codes and categories that the DescribeServices operation returns, so that you have the most recent set of service and category codes.
Note
See also: AWS API Documentation
Request Syntax
response = client.describe_services(
serviceCodeList=[
'string',
],
language='string'
)
A JSON-formatted list of service codes available for Amazon Web Services services.
dict
Response Syntax
{
'services': [
{
'code': 'string',
'name': 'string',
'categories': [
{
'code': 'string',
'name': 'string'
},
]
},
]
}
Response Structure
(dict) --
The list of Amazon Web Services services returned by the DescribeServices operation.
services (list) --
A JSON-formatted list of Amazon Web Services services.
(dict) --
Information about an Amazon Web Services service returned by the DescribeServices operation.
code (string) --
The code for an Amazon Web Services service returned by the DescribeServices response. The name element contains the corresponding friendly name.
name (string) --
The friendly name for an Amazon Web Services service. The code element contains the corresponding code.
categories (list) --
A list of categories that describe the type of support issue a case describes. Categories consist of a category name and a category code. Category names and codes are passed to Amazon Web Services Support when you call CreateCase .
(dict) --
A JSON-formatted name/value pair that represents the category name and category code of the problem, selected from the DescribeServices response for each Amazon Web Services service.
code (string) --
The category code for the support case.
name (string) --
The category name for the support case.
Exceptions
Returns the list of severity levels that you can assign to a support case. The severity level for a case is also a field in the CaseDetails data type that you include for a CreateCase request.
Note
See also: AWS API Documentation
Request Syntax
response = client.describe_severity_levels(
language='string'
)
{
'severityLevels': [
{
'code': 'string',
'name': 'string'
},
]
}
Response Structure
The list of severity levels returned by the DescribeSeverityLevels operation.
The available severity levels for the support case. Available severity levels are defined by your service level agreement with Amazon Web Services.
A code and name pair that represents the severity level of a support case. The available values depend on the support plan for the account. For more information, see Choosing a severity in the Amazon Web Services Support User Guide .
The code for case severity level.
Valid values: low | normal | high | urgent | critical
The name of the severity level that corresponds to the severity level code.
Note
The values returned by the API are different from the values that appear in the Amazon Web Services Support Center. For example, the API uses the code low , but the name appears as General guidance in Support Center.
The following are the API code names and how they appear in the console:
For more information, see Choosing a severity in the Amazon Web Services Support User Guide .
Exceptions
Returns the refresh status of the Trusted Advisor checks that have the specified check IDs. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation.
Some checks are refreshed automatically, and you can't return their refresh statuses by using the DescribeTrustedAdvisorCheckRefreshStatuses operation. If you call this operation for these checks, you might see an InvalidParameterValue error.
Note
See also: AWS API Documentation
Request Syntax
response = client.describe_trusted_advisor_check_refresh_statuses(
checkIds=[
'string',
]
)
[REQUIRED]
The IDs of the Trusted Advisor checks to get the status.
Note
If you specify the check ID of a check that is automatically refreshed, you might see an InvalidParameterValue error.
{
'statuses': [
{
'checkId': 'string',
'status': 'string',
'millisUntilNextRefreshable': 123
},
]
}
Response Structure
The statuses of the Trusted Advisor checks returned by the DescribeTrustedAdvisorCheckRefreshStatuses operation.
The refresh status of the specified Trusted Advisor checks.
The refresh status of a Trusted Advisor check.
The unique identifier for the Trusted Advisor check.
The status of the Trusted Advisor check for which a refresh has been requested:
The amount of time, in milliseconds, until the Trusted Advisor check is eligible for refresh.
Exceptions
Returns the results of the Trusted Advisor check that has the specified check ID. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation.
The response contains a TrustedAdvisorCheckResult object, which contains these three objects:
In addition, the response contains these fields:
Note
See also: AWS API Documentation
Request Syntax
response = client.describe_trusted_advisor_check_result(
checkId='string',
language='string'
)
[REQUIRED]
The unique identifier for the Trusted Advisor check.
dict
Response Syntax
{
'result': {
'checkId': 'string',
'timestamp': 'string',
'status': 'string',
'resourcesSummary': {
'resourcesProcessed': 123,
'resourcesFlagged': 123,
'resourcesIgnored': 123,
'resourcesSuppressed': 123
},
'categorySpecificSummary': {
'costOptimizing': {
'estimatedMonthlySavings': 123.0,
'estimatedPercentMonthlySavings': 123.0
}
},
'flaggedResources': [
{
'status': 'string',
'region': 'string',
'resourceId': 'string',
'isSuppressed': True|False,
'metadata': [
'string',
]
},
]
}
}
Response Structure
(dict) --
The result of the Trusted Advisor check returned by the DescribeTrustedAdvisorCheckResult operation.
result (dict) --
The detailed results of the Trusted Advisor check.
checkId (string) --
The unique identifier for the Trusted Advisor check.
timestamp (string) --
The time of the last refresh of the check.
status (string) --
The alert status of the check: "ok" (green), "warning" (yellow), "error" (red), or "not_available".
resourcesSummary (dict) --
Details about Amazon Web Services resources that were analyzed in a call to Trusted Advisor DescribeTrustedAdvisorCheckSummaries .
resourcesProcessed (integer) --
The number of Amazon Web Services resources that were analyzed by the Trusted Advisor check.
resourcesFlagged (integer) --
The number of Amazon Web Services resources that were flagged (listed) by the Trusted Advisor check.
resourcesIgnored (integer) --
The number of Amazon Web Services resources ignored by Trusted Advisor because information was unavailable.
resourcesSuppressed (integer) --
The number of Amazon Web Services resources ignored by Trusted Advisor because they were marked as suppressed by the user.
categorySpecificSummary (dict) --
Summary information that relates to the category of the check. Cost Optimizing is the only category that is currently supported.
costOptimizing (dict) --
The summary information about cost savings for a Trusted Advisor check that is in the Cost Optimizing category.
estimatedMonthlySavings (float) --
The estimated monthly savings that might be realized if the recommended operations are taken.
estimatedPercentMonthlySavings (float) --
The estimated percentage of savings that might be realized if the recommended operations are taken.
flaggedResources (list) --
The details about each resource listed in the check result.
(dict) --
Contains information about a resource identified by a Trusted Advisor check.
status (string) --
The status code for the resource identified in the Trusted Advisor check.
region (string) --
The Amazon Web Services Region in which the identified resource is located.
resourceId (string) --
The unique identifier for the identified resource.
isSuppressed (boolean) --
Specifies whether the Amazon Web Services resource was ignored by Trusted Advisor because it was marked as suppressed by the user.
metadata (list) --
Additional information about the identified resource. The exact metadata and its order can be obtained by inspecting the TrustedAdvisorCheckDescription object returned by the call to DescribeTrustedAdvisorChecks . Metadata contains all the data that is shown in the Excel download, even in those cases where the UI shows just summary data.
Exceptions
Returns the results for the Trusted Advisor check summaries for the check IDs that you specified. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation.
The response contains an array of TrustedAdvisorCheckSummary objects.
Note
See also: AWS API Documentation
Request Syntax
response = client.describe_trusted_advisor_check_summaries(
checkIds=[
'string',
]
)
[REQUIRED]
The IDs of the Trusted Advisor checks.
{
'summaries': [
{
'checkId': 'string',
'timestamp': 'string',
'status': 'string',
'hasFlaggedResources': True|False,
'resourcesSummary': {
'resourcesProcessed': 123,
'resourcesFlagged': 123,
'resourcesIgnored': 123,
'resourcesSuppressed': 123
},
'categorySpecificSummary': {
'costOptimizing': {
'estimatedMonthlySavings': 123.0,
'estimatedPercentMonthlySavings': 123.0
}
}
},
]
}
Response Structure
The summaries of the Trusted Advisor checks returned by the DescribeTrustedAdvisorCheckSummaries operation.
The summary information for the requested Trusted Advisor checks.
A summary of a Trusted Advisor check result, including the alert status, last refresh, and number of resources examined.
The unique identifier for the Trusted Advisor check.
The time of the last refresh of the check.
The alert status of the check: "ok" (green), "warning" (yellow), "error" (red), or "not_available".
Specifies whether the Trusted Advisor check has flagged resources.
Details about Amazon Web Services resources that were analyzed in a call to Trusted Advisor DescribeTrustedAdvisorCheckSummaries .
The number of Amazon Web Services resources that were analyzed by the Trusted Advisor check.
The number of Amazon Web Services resources that were flagged (listed) by the Trusted Advisor check.
The number of Amazon Web Services resources ignored by Trusted Advisor because information was unavailable.
The number of Amazon Web Services resources ignored by Trusted Advisor because they were marked as suppressed by the user.
Summary information that relates to the category of the check. Cost Optimizing is the only category that is currently supported.
The summary information about cost savings for a Trusted Advisor check that is in the Cost Optimizing category.
The estimated monthly savings that might be realized if the recommended operations are taken.
The estimated percentage of savings that might be realized if the recommended operations are taken.
Exceptions
Returns information about all available Trusted Advisor checks, including the name, ID, category, description, and metadata. You must specify a language code. The Amazon Web Services Support API currently supports English ("en") and Japanese ("ja"). The response contains a TrustedAdvisorCheckDescription object for each check. You must set the Amazon Web Services Region to us-east-1.
Note
See also: AWS API Documentation
Request Syntax
response = client.describe_trusted_advisor_checks(
language='string'
)
[REQUIRED]
The ISO 639-1 code for the language in which Amazon Web Services provides support. Amazon Web Services Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them.
{
'checks': [
{
'id': 'string',
'name': 'string',
'description': 'string',
'category': 'string',
'metadata': [
'string',
]
},
]
}
Response Structure
Information about the Trusted Advisor checks returned by the DescribeTrustedAdvisorChecks operation.
Information about all available Trusted Advisor checks.
The description and metadata for a Trusted Advisor check.
The unique identifier for the Trusted Advisor check.
The display name for the Trusted Advisor check.
The description of the Trusted Advisor check, which includes the alert criteria and recommended operations (contains HTML markup).
The category of the Trusted Advisor check.
The column headings for the data returned by the Trusted Advisor check. The order of the headings corresponds to the order of the data in the Metadata element of the TrustedAdvisorResourceDetail for the check. Metadata contains all the data that is shown in the Excel download, even in those cases where the UI shows just summary data.
Exceptions
Create a paginator for an operation.
Returns an object that can wait for some condition.
Refreshes the Trusted Advisor check that you specify using the check ID. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation.
Note
Some checks are refreshed automatically. If you call the RefreshTrustedAdvisorCheck operation to refresh them, you might see the InvalidParameterValue error.
The response contains a TrustedAdvisorCheckRefreshStatus object.
Note
See also: AWS API Documentation
Request Syntax
response = client.refresh_trusted_advisor_check(
checkId='string'
)
[REQUIRED]
The unique identifier for the Trusted Advisor check to refresh.
Note
Specifying the check ID of a check that is automatically refreshed causes an InvalidParameterValue error.
{
'status': {
'checkId': 'string',
'status': 'string',
'millisUntilNextRefreshable': 123
}
}
Response Structure
The current refresh status of a Trusted Advisor check.
The current refresh status for a check, including the amount of time until the check is eligible for refresh.
The unique identifier for the Trusted Advisor check.
The status of the Trusted Advisor check for which a refresh has been requested:
The amount of time, in milliseconds, until the Trusted Advisor check is eligible for refresh.
Exceptions
Resolves a support case. This operation takes a caseId and returns the initial and final state of the case.
Note
See also: AWS API Documentation
Request Syntax
response = client.resolve_case(
caseId='string'
)
{
'initialCaseStatus': 'string',
'finalCaseStatus': 'string'
}
Response Structure
The status of the case returned by the ResolveCase operation.
The status of the case when the ResolveCase request was sent.
The status of the case after the ResolveCase request was processed.
Exceptions
The available paginators are:
paginator = client.get_paginator('describe_cases')
Creates an iterator that will paginate through responses from Support.Client.describe_cases().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
caseIdList=[
'string',
],
displayId='string',
afterTime='string',
beforeTime='string',
includeResolvedCases=True|False,
language='string',
includeCommunications=True|False,
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A list of ID numbers of the support cases you want returned. The maximum number of cases is 100.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'cases': [
{
'caseId': 'string',
'displayId': 'string',
'subject': 'string',
'status': 'string',
'serviceCode': 'string',
'categoryCode': 'string',
'severityCode': 'string',
'submittedBy': 'string',
'timeCreated': 'string',
'recentCommunications': {
'communications': [
{
'caseId': 'string',
'body': 'string',
'submittedBy': 'string',
'timeCreated': 'string',
'attachmentSet': [
{
'attachmentId': 'string',
'fileName': 'string'
},
]
},
],
'nextToken': 'string'
},
'ccEmailAddresses': [
'string',
],
'language': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Returns an array of CaseDetails objects and a nextToken that defines a point for pagination in the result set.
cases (list) --
The details for the cases that match the request.
(dict) --
A JSON-formatted object that contains the metadata for a support case. It is contained in the response from a DescribeCases request. CaseDetails contains the following fields:
caseId (string) --
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
displayId (string) --
The ID displayed for the case in the Amazon Web Services Support Center. This is a numeric string.
subject (string) --
The subject line for the case in the Amazon Web Services Support Center.
status (string) --
The status of the case.
Valid values:
serviceCode (string) --
The code for the Amazon Web Services service. You can get a list of codes and the corresponding service names by calling DescribeServices .
categoryCode (string) --
The category of problem for the support case.
severityCode (string) --
The code for the severity level returned by the call to DescribeSeverityLevels .
submittedBy (string) --
The email address of the account that submitted the case.
timeCreated (string) --
The time that the case was created in the Amazon Web Services Support Center.
recentCommunications (dict) --
The five most recent communications between you and Amazon Web Services Support Center, including the IDs of any attachments to the communications. Also includes a nextToken that you can use to retrieve earlier communications.
communications (list) --
The five most recent communications associated with the case.
(dict) --
A communication associated with a support case. The communication consists of the case ID, the message body, attachment information, the submitter of the communication, and the date and time of the communication.
caseId (string) --
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
body (string) --
The text of the communication between the customer and Amazon Web Services Support.
submittedBy (string) --
The identity of the account that submitted, or responded to, the support case. Customer entries include the role or IAM user as well as the email address. For example, "AdminRole (Role) <janedoe@example.com>. Entries from the Amazon Web Services Support team display "Amazon Web Services," and don't show an email address.
timeCreated (string) --
The time the communication was created.
attachmentSet (list) --
Information about the attachments to the case communication.
(dict) --
The file name and ID of an attachment to a case communication. You can use the ID to retrieve the attachment with the DescribeAttachment operation.
attachmentId (string) --
The ID of the attachment.
fileName (string) --
The file name of the attachment.
nextToken (string) --
A resumption point for pagination.
ccEmailAddresses (list) --
The email addresses that receive copies of communication about the case.
language (string) --
The ISO 639-1 code for the language in which Amazon Web Services provides support. Amazon Web Services Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('describe_communications')
Creates an iterator that will paginate through responses from Support.Client.describe_communications().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
caseId='string',
beforeTime='string',
afterTime='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
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
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'communications': [
{
'caseId': 'string',
'body': 'string',
'submittedBy': 'string',
'timeCreated': 'string',
'attachmentSet': [
{
'attachmentId': 'string',
'fileName': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
The communications returned by the DescribeCommunications operation.
communications (list) --
The communications for the case.
(dict) --
A communication associated with a support case. The communication consists of the case ID, the message body, attachment information, the submitter of the communication, and the date and time of the communication.
caseId (string) --
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
body (string) --
The text of the communication between the customer and Amazon Web Services Support.
submittedBy (string) --
The identity of the account that submitted, or responded to, the support case. Customer entries include the role or IAM user as well as the email address. For example, "AdminRole (Role) <janedoe@example.com>. Entries from the Amazon Web Services Support team display "Amazon Web Services," and don't show an email address.
timeCreated (string) --
The time the communication was created.
attachmentSet (list) --
Information about the attachments to the case communication.
(dict) --
The file name and ID of an attachment to a case communication. You can use the ID to retrieve the attachment with the DescribeAttachment operation.
attachmentId (string) --
The ID of the attachment.
fileName (string) --
The file name of the attachment.
NextToken (string) --
A token to resume pagination.