The AWS Support API Reference is intended for programmers who need detailed\n information about the AWS Support operations and data types. You can use the API to manage\n your support cases programmatically. The AWS Support API uses HTTP methods that return\n results in JSON format.
\nYou must have a Business or Enterprise Support plan to use the AWS Support\n API.
\nIf you call the AWS Support API from an account that does not have a\n Business or Enterprise Support plan, the\n SubscriptionRequiredException error message appears. For\n information about changing your support plan, see AWS Support.
The AWS Support service also exposes a set of AWS Trusted Advisor features. You can\n retrieve a list of checks and their descriptions, get check results, specify checks to\n refresh, and get the refresh status of checks.
\nThe following list describes the AWS Support case management operations:
\nService names, issue categories, and available severity levels - The\n DescribeServices and DescribeSeverityLevels operations return AWS service names,\n service codes, service categories, and problem severity levels. You use these\n values when you call the CreateCase operation.
\nCase creation, case details, and case resolution - The CreateCase, DescribeCases, DescribeAttachment, and ResolveCase operations\n create AWS Support cases, retrieve information about cases, and resolve cases.
\nCase communication - The DescribeCommunications,\n AddCommunicationToCase, and AddAttachmentsToSet operations retrieve and add communications\n and attachments to AWS Support cases.
\nThe following list describes the operations available from the AWS Support service for\n Trusted Advisor:
\n\n DescribeTrustedAdvisorChecks returns the list of checks that\n run against your AWS resources.
\nUsing the checkId for a specific check returned by DescribeTrustedAdvisorChecks, you can call DescribeTrustedAdvisorCheckResult to obtain the results for the\n check that you specified.
\n DescribeTrustedAdvisorCheckSummaries returns summarized\n results for one or more Trusted Advisor checks.
\n\n RefreshTrustedAdvisorCheck requests that Trusted Advisor rerun a\n specified check.
\n\n DescribeTrustedAdvisorCheckRefreshStatuses reports the refresh\n status of one or more checks.
\nFor authentication of requests, AWS Support uses Signature Version 4 Signing\n Process.
\nSee About the\n AWS Support API in the AWS Support User Guide for\n information about how to use this service to create and manage your support cases, and\n how to call Trusted Advisor for results of checks on your resources.
", "smithy.api#title": "AWS Support", "smithy.api#xmlNamespace": { "uri": "http://support.amazonaws.com/doc/2013-04-15/" } } }, "com.amazonaws.support#AddAttachmentsToSet": { "type": "operation", "input": { "target": "com.amazonaws.support#AddAttachmentsToSetRequest" }, "output": { "target": "com.amazonaws.support#AddAttachmentsToSetResponse" }, "errors": [ { "target": "com.amazonaws.support#AttachmentLimitExceeded" }, { "target": "com.amazonaws.support#AttachmentSetExpired" }, { "target": "com.amazonaws.support#AttachmentSetIdNotFound" }, { "target": "com.amazonaws.support#AttachmentSetSizeLimitExceeded" }, { "target": "com.amazonaws.support#InternalServerError" } ], "traits": { "smithy.api#documentation": "Adds one or more attachments to an attachment set.
\nAn attachment set is a temporary container for attachments that you add to a case or\n case communication. The set is available for 1 hour after it's created. The\n expiryTime returned in the response is when the set expires.
You must have a Business or Enterprise Support plan to use the AWS Support\n API.
\nIf you call the AWS Support API from an account that does not have a\n Business or Enterprise Support plan, the\n SubscriptionRequiredException error message appears. For\n information about changing your support plan, see AWS Support.
The ID of the attachment set. If an attachmentSetId is not specified, a\n new attachment set is created, and the ID of the set is returned in the response. If an\n attachmentSetId is specified, the attachments are added to the\n specified set, if it exists.
One or more attachments to add to the set. You can add up to three attachments per\n set. The size limit is 5 MB per attachment.
\nIn the Attachment object, use the data parameter to specify\n the contents of the attachment file. In the previous request syntax, the value for\n data appear as blob, which is represented as a\n base64-encoded string. The value for fileName is the name of the\n attachment, such as troubleshoot-screenshot.png.
The ID of the attachment set. If an attachmentSetId was not specified, a\n new attachment set is created, and the ID of the set is returned in the response. If an\n attachmentSetId was specified, the attachments are added to the\n specified set, if it exists.
The time and date when the attachment set expires.
" } } }, "traits": { "smithy.api#documentation": "The ID and expiry time of the attachment set returned by the AddAttachmentsToSet operation.
" } }, "com.amazonaws.support#AddCommunicationToCase": { "type": "operation", "input": { "target": "com.amazonaws.support#AddCommunicationToCaseRequest" }, "output": { "target": "com.amazonaws.support#AddCommunicationToCaseResponse" }, "errors": [ { "target": "com.amazonaws.support#AttachmentSetExpired" }, { "target": "com.amazonaws.support#AttachmentSetIdNotFound" }, { "target": "com.amazonaws.support#CaseIdNotFound" }, { "target": "com.amazonaws.support#InternalServerError" } ], "traits": { "smithy.api#documentation": "Adds additional customer communication to an AWS Support case. Use the caseId\n parameter to identify the case to which to add communication. You can list a set of\n email addresses to copy on the communication by using the ccEmailAddresses\n parameter. The communicationBody value contains the text of the\n communication.
You must have a Business or Enterprise Support plan to use the AWS Support\n API.
\nIf you call the AWS Support API from an account that does not have a\n Business or Enterprise Support plan, the\n SubscriptionRequiredException error message appears. For\n information about changing your support plan, see AWS Support.
The support case ID requested or returned in the call. The case ID is an\n alphanumeric string formatted as shown in this example:\n case-12345678910-2013-c4c1d2bf33c5cf47\n
" } }, "communicationBody": { "target": "com.amazonaws.support#CommunicationBody", "traits": { "smithy.api#documentation": "The body of an email communication to add to the support case.
", "smithy.api#required": {} } }, "ccEmailAddresses": { "target": "com.amazonaws.support#CcEmailAddressList", "traits": { "smithy.api#documentation": "The email addresses in the CC line of an email to be added to the support case.
" } }, "attachmentSetId": { "target": "com.amazonaws.support#AttachmentSetId", "traits": { "smithy.api#documentation": "The ID of a set of one or more attachments for the communication to add to the case.\n Create the set by calling AddAttachmentsToSet\n
" } } } }, "com.amazonaws.support#AddCommunicationToCaseResponse": { "type": "structure", "members": { "result": { "target": "com.amazonaws.support#Result", "traits": { "smithy.api#documentation": "True if AddCommunicationToCase succeeds. Otherwise, returns an\n error.
" } } }, "traits": { "smithy.api#documentation": "The result of the AddCommunicationToCase operation.
" } }, "com.amazonaws.support#AfterTime": { "type": "string" }, "com.amazonaws.support#Attachment": { "type": "structure", "members": { "fileName": { "target": "com.amazonaws.support#FileName", "traits": { "smithy.api#documentation": "The name of the attachment file.
" } }, "data": { "target": "com.amazonaws.support#Data", "traits": { "smithy.api#documentation": "The content of the attachment file.
" } } }, "traits": { "smithy.api#documentation": "An attachment to a case communication. The attachment consists of the file name and\n the content of the file.
" } }, "com.amazonaws.support#AttachmentDetails": { "type": "structure", "members": { "attachmentId": { "target": "com.amazonaws.support#AttachmentId", "traits": { "smithy.api#documentation": "The ID of the attachment.
" } }, "fileName": { "target": "com.amazonaws.support#FileName", "traits": { "smithy.api#documentation": "The file name of the attachment.
" } } }, "traits": { "smithy.api#documentation": "The file name and ID of an attachment to a case communication. You can use the ID to\n retrieve the attachment with the DescribeAttachment operation.
" } }, "com.amazonaws.support#AttachmentId": { "type": "string" }, "com.amazonaws.support#AttachmentIdNotFound": { "type": "structure", "members": { "message": { "target": "com.amazonaws.support#ErrorMessage", "traits": { "smithy.api#documentation": "An attachment with the specified ID could not be found.
" } } }, "traits": { "smithy.api#documentation": "An attachment with the specified ID could not be found.
", "smithy.api#error": "client" } }, "com.amazonaws.support#AttachmentLimitExceeded": { "type": "structure", "members": { "message": { "target": "com.amazonaws.support#ErrorMessage", "traits": { "smithy.api#documentation": "The limit for the number of attachment sets created in a short period of time has been\n exceeded.
" } } }, "traits": { "smithy.api#documentation": "The limit for the number of attachment sets created in a short period of time has been\n exceeded.
", "smithy.api#error": "client" } }, "com.amazonaws.support#AttachmentSet": { "type": "list", "member": { "target": "com.amazonaws.support#AttachmentDetails" } }, "com.amazonaws.support#AttachmentSetExpired": { "type": "structure", "members": { "message": { "target": "com.amazonaws.support#ErrorMessage", "traits": { "smithy.api#documentation": "The expiration time of the attachment set has passed. The set expires one hour after\n it is created.
" } } }, "traits": { "smithy.api#documentation": "The expiration time of the attachment set has passed. The set expires 1 hour after it\n is created.
", "smithy.api#error": "client" } }, "com.amazonaws.support#AttachmentSetId": { "type": "string" }, "com.amazonaws.support#AttachmentSetIdNotFound": { "type": "structure", "members": { "message": { "target": "com.amazonaws.support#ErrorMessage", "traits": { "smithy.api#documentation": "An attachment set with the specified ID could not be found.
" } } }, "traits": { "smithy.api#documentation": "An attachment set with the specified ID could not be found.
", "smithy.api#error": "client" } }, "com.amazonaws.support#AttachmentSetSizeLimitExceeded": { "type": "structure", "members": { "message": { "target": "com.amazonaws.support#ErrorMessage", "traits": { "smithy.api#documentation": "A limit for the size of an attachment set has been exceeded. The limits are three\n attachments and 5 MB per attachment.
" } } }, "traits": { "smithy.api#documentation": "A limit for the size of an attachment set has been exceeded. The limits are three\n attachments and 5 MB per attachment.
", "smithy.api#error": "client" } }, "com.amazonaws.support#Attachments": { "type": "list", "member": { "target": "com.amazonaws.support#Attachment" } }, "com.amazonaws.support#BeforeTime": { "type": "string" }, "com.amazonaws.support#Boolean": { "type": "boolean" }, "com.amazonaws.support#CaseCreationLimitExceeded": { "type": "structure", "members": { "message": { "target": "com.amazonaws.support#ErrorMessage", "traits": { "smithy.api#documentation": "An error message that indicates that you have exceeded the number of cases you can\n have open.
" } } }, "traits": { "smithy.api#documentation": "The case creation limit for the account has been exceeded.
", "smithy.api#error": "client" } }, "com.amazonaws.support#CaseDetails": { "type": "structure", "members": { "caseId": { "target": "com.amazonaws.support#CaseId", "traits": { "smithy.api#documentation": "The support case ID requested or returned in the call. The case ID is an\n alphanumeric string formatted as shown in this example:\n case-12345678910-2013-c4c1d2bf33c5cf47\n
" } }, "displayId": { "target": "com.amazonaws.support#DisplayId", "traits": { "smithy.api#documentation": "The ID displayed for the case in the AWS Support Center. This is a numeric\n string.
" } }, "subject": { "target": "com.amazonaws.support#Subject", "traits": { "smithy.api#documentation": "The subject line for the case in the AWS Support Center.
" } }, "status": { "target": "com.amazonaws.support#Status", "traits": { "smithy.api#documentation": "The status of the case.
\nValid values:
\n\n opened\n
\n pending-customer-action\n
\n reopened\n
\n resolved\n
\n unassigned\n
\n work-in-progress\n
The code for the AWS service. You can get a list of codes and the corresponding\n service names by calling DescribeServices.
" } }, "categoryCode": { "target": "com.amazonaws.support#CategoryCode", "traits": { "smithy.api#documentation": "The category of problem for the support case.
" } }, "severityCode": { "target": "com.amazonaws.support#SeverityCode", "traits": { "smithy.api#documentation": "The code for the severity level returned by the call to DescribeSeverityLevels.
" } }, "submittedBy": { "target": "com.amazonaws.support#SubmittedBy", "traits": { "smithy.api#documentation": "The email address of the account that submitted the case.
" } }, "timeCreated": { "target": "com.amazonaws.support#TimeCreated", "traits": { "smithy.api#documentation": "The time that the case was created in the AWS Support Center.
" } }, "recentCommunications": { "target": "com.amazonaws.support#RecentCaseCommunications", "traits": { "smithy.api#documentation": "The five most recent communications between you and AWS Support Center, including the\n IDs of any attachments to the communications. Also includes a nextToken\n that you can use to retrieve earlier communications.
The email addresses that receive copies of communication about the case.
" } }, "language": { "target": "com.amazonaws.support#Language", "traits": { "smithy.api#documentation": "The ISO 639-1 code for the language in which AWS provides support. AWS Support\n currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be\n passed explicitly for operations that take them.
" } } }, "traits": { "smithy.api#documentation": "A JSON-formatted object that contains the metadata for a support case. It is contained\n in the response from a DescribeCases request. CaseDetails contains the following fields:
\n\n caseId - The support case ID requested or\n returned in the call. The case ID is an alphanumeric string formatted as shown\n in this example:\n case-12345678910-2013-c4c1d2bf33c5cf47.
\n\n categoryCode - The category of problem for the\n support case. Corresponds to the CategoryCode values returned by a call to\n DescribeServices.
\n displayId - The identifier for the case on pages\n in the AWS Support Center.
\n\n language - The ISO 639-1 code for the language\n in which AWS provides support. AWS Support currently supports English (\"en\") and\n Japanese (\"ja\"). Language parameters must be passed explicitly for operations\n that take them.
\n\n nextToken - A resumption point for\n pagination.
\n\n recentCommunications - One or more Communication objects. Fields of these objects are\n attachments, body, caseId,\n submittedBy, and timeCreated.
\n serviceCode - The identifier for the AWS service\n that corresponds to the service code defined in the call to DescribeServices.
\n\n severityCode - The severity code assigned to the\n case. Contains one of the values returned by the call to DescribeSeverityLevels. The possible values are:\n low, normal, high,\n urgent, and critical.
\n status - The status of the case in the AWS Support Center. Valid values:
\n\n opened\n
\n pending-customer-action\n
\n reopened\n
\n resolved\n
\n unassigned\n
\n work-in-progress\n
\n subject - The subject line of the case.
\n\n submittedBy - The email address of the account\n that submitted the case.
\n\n timeCreated - The time the case was created, in\n ISO-8601 format.
\nThe requested CaseId could not be located.
The requested caseId couldn't be located.
The category code for the support case.
" } }, "name": { "target": "com.amazonaws.support#CategoryName", "traits": { "smithy.api#documentation": "The category name for the support case.
" } } }, "traits": { "smithy.api#documentation": "A JSON-formatted name/value pair that represents the category name and category code\n of the problem, selected from the DescribeServices response for each\n AWS service.
" } }, "com.amazonaws.support#CategoryCode": { "type": "string" }, "com.amazonaws.support#CategoryList": { "type": "list", "member": { "target": "com.amazonaws.support#Category" } }, "com.amazonaws.support#CategoryName": { "type": "string" }, "com.amazonaws.support#CcEmailAddress": { "type": "string" }, "com.amazonaws.support#CcEmailAddressList": { "type": "list", "member": { "target": "com.amazonaws.support#CcEmailAddress" } }, "com.amazonaws.support#Communication": { "type": "structure", "members": { "caseId": { "target": "com.amazonaws.support#CaseId", "traits": { "smithy.api#documentation": "The support case ID requested or returned in the call. The case ID is an\n alphanumeric string formatted as shown in this example:\n case-12345678910-2013-c4c1d2bf33c5cf47\n
" } }, "body": { "target": "com.amazonaws.support#CommunicationBody", "traits": { "smithy.api#documentation": "The text of the communication between the customer and AWS Support.
" } }, "submittedBy": { "target": "com.amazonaws.support#SubmittedBy", "traits": { "smithy.api#documentation": "The identity of the account that submitted, or responded to, the support case.\n Customer entries include the role or IAM user as well as the email address. For example,\n \"AdminRole (Role)
The time the communication was created.
" } }, "attachmentSet": { "target": "com.amazonaws.support#AttachmentSet", "traits": { "smithy.api#documentation": "Information about the attachments to the case communication.
" } } }, "traits": { "smithy.api#documentation": "A communication associated with a support case. The communication consists of the\n case ID, the message body, attachment information, the submitter of the communication,\n and the date and time of the communication.
" } }, "com.amazonaws.support#CommunicationBody": { "type": "string" }, "com.amazonaws.support#CommunicationList": { "type": "list", "member": { "target": "com.amazonaws.support#Communication" } }, "com.amazonaws.support#CreateCase": { "type": "operation", "input": { "target": "com.amazonaws.support#CreateCaseRequest" }, "output": { "target": "com.amazonaws.support#CreateCaseResponse" }, "errors": [ { "target": "com.amazonaws.support#AttachmentSetExpired" }, { "target": "com.amazonaws.support#AttachmentSetIdNotFound" }, { "target": "com.amazonaws.support#CaseCreationLimitExceeded" }, { "target": "com.amazonaws.support#InternalServerError" } ], "traits": { "smithy.api#documentation": "Creates a case in the AWS Support Center. This operation is similar to how you create a case\n in the AWS Support Center Create\n Case page.
\nThe AWS Support API doesn't support requesting service limit increases. You can submit a\n service limit increase in the following ways:
\nSubmit a request from the AWS Support Center Create Case page.
\nUse the Service Quotas RequestServiceQuotaIncrease operation.
\nA successful CreateCase request returns an AWS Support case number. You can use\n the DescribeCases operation and specify the case number to get\n existing AWS Support cases. After you create a case, use the AddCommunicationToCase operation to add additional communication or\n attachments to an existing case.
The caseId is separate from the displayId that appears in\n the AWS Support Center. Use the DescribeCases operation to get the displayId.
You must have a Business or Enterprise Support plan to use the AWS Support\n API.
\nIf you call the AWS Support API from an account that does not have a\n Business or Enterprise Support plan, the\n SubscriptionRequiredException error message appears. For\n information about changing your support plan, see AWS Support.
The title of the support case. The title appears in the Subject field on the AWS Support Center Create Case page.
", "smithy.api#required": {} } }, "serviceCode": { "target": "com.amazonaws.support#ServiceCode", "traits": { "smithy.api#documentation": "The code for the AWS service. You can use the DescribeServices\n operation to get the possible serviceCode values.
A value that indicates the urgency of the case. This value determines the response\n time according to your service level agreement with AWS Support. You can use the DescribeSeverityLevels operation to get the possible values for\n severityCode.
For more information, see SeverityLevel and Choosing a\n Severity in the AWS Support User Guide.
\nThe availability of severity levels depends on the support plan for the AWS\n account.
\nThe category of problem for the support case. You also use the DescribeServices operation to get the category code for a service. Each\n AWS service defines its own set of category codes.
" } }, "communicationBody": { "target": "com.amazonaws.support#CommunicationBody", "traits": { "smithy.api#documentation": "The communication body text that describes the issue. This text appears in the\n Description field on the AWS Support Center Create Case page.
", "smithy.api#required": {} } }, "ccEmailAddresses": { "target": "com.amazonaws.support#CcEmailAddressList", "traits": { "smithy.api#documentation": "A list of email addresses that AWS Support copies on case correspondence. AWS Support\n identifies the account that creates the case when you specify your AWS credentials in an\n HTTP POST method or use the AWS SDKs.\n
" } }, "language": { "target": "com.amazonaws.support#Language", "traits": { "smithy.api#documentation": "The language in which AWS Support handles the case. You must specify the ISO 639-1\n code for the language parameter if you want support in that language.\n Currently, English (\"en\") and Japanese (\"ja\") are supported.
The type of issue for the case. You can specify customer-service or\n technical. If you don't specify a value, the default is\n technical.
The ID of a set of one or more attachments for the case. Create the set by using the\n AddAttachmentsToSet operation.
" } } } }, "com.amazonaws.support#CreateCaseResponse": { "type": "structure", "members": { "caseId": { "target": "com.amazonaws.support#CaseId", "traits": { "smithy.api#documentation": "The support case ID requested or returned in the call. The case ID is an\n alphanumeric string in the following format:\n case-12345678910-2013-c4c1d2bf33c5cf47\n
" } } }, "traits": { "smithy.api#documentation": "The support case ID returned by a successful completion of the CreateCase operation.
" } }, "com.amazonaws.support#Data": { "type": "blob" }, "com.amazonaws.support#DescribeAttachment": { "type": "operation", "input": { "target": "com.amazonaws.support#DescribeAttachmentRequest" }, "output": { "target": "com.amazonaws.support#DescribeAttachmentResponse" }, "errors": [ { "target": "com.amazonaws.support#AttachmentIdNotFound" }, { "target": "com.amazonaws.support#DescribeAttachmentLimitExceeded" }, { "target": "com.amazonaws.support#InternalServerError" } ], "traits": { "smithy.api#documentation": "Returns the attachment that has the specified ID. Attachments can include screenshots,\n error logs, or other files that describe your issue. Attachment IDs are generated by the\n case management system when you add an attachment to a case or case communication.\n Attachment IDs are returned in the AttachmentDetails objects that are\n returned by the DescribeCommunications operation.
\nYou must have a Business or Enterprise Support plan to use the AWS Support\n API.
\nIf you call the AWS Support API from an account that does not have a\n Business or Enterprise Support plan, the\n SubscriptionRequiredException error message appears. For\n information about changing your support plan, see AWS Support.
The limit for the number of DescribeAttachment requests in a short\n period of time has been exceeded.
" } } }, "traits": { "smithy.api#documentation": "The limit for the number of DescribeAttachment requests in a short\n period of time has been exceeded.
", "smithy.api#error": "client" } }, "com.amazonaws.support#DescribeAttachmentRequest": { "type": "structure", "members": { "attachmentId": { "target": "com.amazonaws.support#AttachmentId", "traits": { "smithy.api#documentation": "The ID of the attachment to return. Attachment IDs are returned by the DescribeCommunications operation.
", "smithy.api#required": {} } } } }, "com.amazonaws.support#DescribeAttachmentResponse": { "type": "structure", "members": { "attachment": { "target": "com.amazonaws.support#Attachment", "traits": { "smithy.api#documentation": "This object includes the attachment content and file name.
\nIn the previous response syntax, the value for the data parameter appears\n as blob, which is represented as a base64-encoded string. The value for\n fileName is the name of the attachment, such as\n troubleshoot-screenshot.png.
The content and file name of the attachment returned by the DescribeAttachment operation.
" } }, "com.amazonaws.support#DescribeCases": { "type": "operation", "input": { "target": "com.amazonaws.support#DescribeCasesRequest" }, "output": { "target": "com.amazonaws.support#DescribeCasesResponse" }, "errors": [ { "target": "com.amazonaws.support#CaseIdNotFound" }, { "target": "com.amazonaws.support#InternalServerError" } ], "traits": { "smithy.api#documentation": "Returns a list of cases that you specify by passing one or more case IDs. You can use\n the afterTime and beforeTime parameters to filter the cases by\n date. You can set values for the includeResolvedCases and\n includeCommunications parameters to specify how much information to\n return.
The response returns the following in JSON format:
\nOne or more CaseDetails data types.
\nOne or more nextToken values, which specify where to paginate the\n returned records represented by the CaseDetails objects.
Case data is available for 12 months after creation. If a case was created more than\n 12 months ago, a request might return an error.
\nYou must have a Business or Enterprise Support plan to use the AWS Support\n API.
\nIf you call the AWS Support API from an account that does not have a\n Business or Enterprise Support plan, the\n SubscriptionRequiredException error message appears. For\n information about changing your support plan, see AWS Support.
A list of ID numbers of the support cases you want returned. The maximum number of\n cases is 100.
" } }, "displayId": { "target": "com.amazonaws.support#DisplayId", "traits": { "smithy.api#documentation": "The ID displayed for a case in the AWS Support Center user interface.
" } }, "afterTime": { "target": "com.amazonaws.support#AfterTime", "traits": { "smithy.api#documentation": "The start date for a filtered date search on support case communications. Case\n communications are available for 12 months after creation.
" } }, "beforeTime": { "target": "com.amazonaws.support#BeforeTime", "traits": { "smithy.api#documentation": "The end date for a filtered date search on support case communications. Case\n communications are available for 12 months after creation.
" } }, "includeResolvedCases": { "target": "com.amazonaws.support#IncludeResolvedCases", "traits": { "smithy.api#documentation": "Specifies whether to include resolved support cases in the DescribeCases\n response. By default, resolved cases aren't included.
A resumption point for pagination.
" } }, "maxResults": { "target": "com.amazonaws.support#MaxResults", "traits": { "smithy.api#documentation": "The maximum number of results to return before paginating.
" } }, "language": { "target": "com.amazonaws.support#Language", "traits": { "smithy.api#documentation": "The ISO 639-1 code for the language in which AWS provides support. AWS Support\n currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be\n passed explicitly for operations that take them.
" } }, "includeCommunications": { "target": "com.amazonaws.support#IncludeCommunications", "traits": { "smithy.api#documentation": "Specifies whether to include communications in the DescribeCases\n response. By default, communications are included.
The details for the cases that match the request.
" } }, "nextToken": { "target": "com.amazonaws.support#NextToken", "traits": { "smithy.api#documentation": "A resumption point for pagination.
" } } }, "traits": { "smithy.api#documentation": "Returns an array of CaseDetails\n objects and a nextToken that defines a point for pagination in the result\n set.
Returns communications and attachments for one or more support cases. Use the\n afterTime and beforeTime parameters to filter by date. You\n can use the caseId parameter to restrict the results to a specific\n case.
Case data is available for 12 months after creation. If a case was created more than\n 12 months ago, a request for data might cause an error.
\nYou can use the maxResults and nextToken parameters to\n control the pagination of the results. Set maxResults to the number of\n cases that you want to display on each page, and use nextToken to specify\n the resumption of pagination.
You must have a Business or Enterprise Support plan to use the AWS Support\n API.
\nIf you call the AWS Support API from an account that does not have a\n Business or Enterprise Support plan, the\n SubscriptionRequiredException error message appears. For\n information about changing your support plan, see AWS Support.
The support case ID requested or returned in the call. The case ID is an\n alphanumeric string formatted as shown in this example:\n case-12345678910-2013-c4c1d2bf33c5cf47\n
", "smithy.api#required": {} } }, "beforeTime": { "target": "com.amazonaws.support#BeforeTime", "traits": { "smithy.api#documentation": "The end date for a filtered date search on support case communications. Case\n communications are available for 12 months after creation.
" } }, "afterTime": { "target": "com.amazonaws.support#AfterTime", "traits": { "smithy.api#documentation": "The start date for a filtered date search on support case communications. Case\n communications are available for 12 months after creation.
" } }, "nextToken": { "target": "com.amazonaws.support#NextToken", "traits": { "smithy.api#documentation": "A resumption point for pagination.
" } }, "maxResults": { "target": "com.amazonaws.support#MaxResults", "traits": { "smithy.api#documentation": "The maximum number of results to return before paginating.
" } } } }, "com.amazonaws.support#DescribeCommunicationsResponse": { "type": "structure", "members": { "communications": { "target": "com.amazonaws.support#CommunicationList", "traits": { "smithy.api#documentation": "The communications for the case.
" } }, "nextToken": { "target": "com.amazonaws.support#NextToken", "traits": { "smithy.api#documentation": "A resumption point for pagination.
" } } }, "traits": { "smithy.api#documentation": "The communications returned by the DescribeCommunications\n operation.
" } }, "com.amazonaws.support#DescribeServices": { "type": "operation", "input": { "target": "com.amazonaws.support#DescribeServicesRequest" }, "output": { "target": "com.amazonaws.support#DescribeServicesResponse" }, "errors": [ { "target": "com.amazonaws.support#InternalServerError" } ], "traits": { "smithy.api#documentation": "Returns the current list of AWS services and a list of service categories for each\n service. You then use service names and categories in your CreateCase\n requests. Each AWS service has its own set of categories.
\nThe service codes and category codes correspond to the values that appear in the\n Service and Category lists on the AWS Support Center Create Case page. The values in those fields\n don't necessarily match the service codes and categories returned by the\n DescribeServices operation. Always use the service codes and categories\n that the DescribeServices operation returns, so that you have the most\n recent set of service and category codes.
You must have a Business or Enterprise Support plan to use the AWS Support\n API.
\nIf you call the AWS Support API from an account that does not have a\n Business or Enterprise Support plan, the\n SubscriptionRequiredException error message appears. For\n information about changing your support plan, see AWS Support.
A JSON-formatted list of service codes available for AWS services.
" } }, "language": { "target": "com.amazonaws.support#Language", "traits": { "smithy.api#documentation": "The ISO 639-1 code for the language in which AWS provides support. AWS Support\n currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be\n passed explicitly for operations that take them.
" } } } }, "com.amazonaws.support#DescribeServicesResponse": { "type": "structure", "members": { "services": { "target": "com.amazonaws.support#ServiceList", "traits": { "smithy.api#documentation": "A JSON-formatted list of AWS services.
" } } }, "traits": { "smithy.api#documentation": "The list of AWS services returned by the DescribeServices\n operation.
" } }, "com.amazonaws.support#DescribeSeverityLevels": { "type": "operation", "input": { "target": "com.amazonaws.support#DescribeSeverityLevelsRequest" }, "output": { "target": "com.amazonaws.support#DescribeSeverityLevelsResponse" }, "errors": [ { "target": "com.amazonaws.support#InternalServerError" } ], "traits": { "smithy.api#documentation": "Returns the list of severity levels that you can assign to a support case. The severity\n level for a case is also a field in the CaseDetails data type that you\n include for a CreateCase request.
\nYou must have a Business or Enterprise Support plan to use the AWS Support\n API.
\nIf you call the AWS Support API from an account that does not have a\n Business or Enterprise Support plan, the\n SubscriptionRequiredException error message appears. For\n information about changing your support plan, see AWS Support.
The ISO 639-1 code for the language in which AWS provides support. AWS Support\n currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be\n passed explicitly for operations that take them.
" } } } }, "com.amazonaws.support#DescribeSeverityLevelsResponse": { "type": "structure", "members": { "severityLevels": { "target": "com.amazonaws.support#SeverityLevelsList", "traits": { "smithy.api#documentation": "The available severity levels for the support case. Available severity levels are\n defined by your service level agreement with AWS.
" } } }, "traits": { "smithy.api#documentation": "The list of severity levels returned by the DescribeSeverityLevels\n operation.
" } }, "com.amazonaws.support#DescribeTrustedAdvisorCheckRefreshStatuses": { "type": "operation", "input": { "target": "com.amazonaws.support#DescribeTrustedAdvisorCheckRefreshStatusesRequest" }, "output": { "target": "com.amazonaws.support#DescribeTrustedAdvisorCheckRefreshStatusesResponse" }, "errors": [ { "target": "com.amazonaws.support#InternalServerError" } ], "traits": { "smithy.api#documentation": "Returns the refresh status of the AWS Trusted Advisor checks that have the specified check\n IDs. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation.
\nSome checks are refreshed automatically, and you can't return their refresh statuses\n by using the DescribeTrustedAdvisorCheckRefreshStatuses operation. If you\n call this operation for these checks, you might see an\n InvalidParameterValue error.
You must have a Business or Enterprise Support plan to use the AWS Support\n API.
\nIf you call the AWS Support API from an account that does not have a\n Business or Enterprise Support plan, the\n SubscriptionRequiredException error message appears. For\n information about changing your support plan, see AWS Support.
The IDs of the Trusted Advisor checks to get the status.
\nIf you specify the check ID of a check that is automatically refreshed, you might\n see an InvalidParameterValue error.
The refresh status of the specified Trusted Advisor checks.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The statuses of the Trusted Advisor checks returned by the DescribeTrustedAdvisorCheckRefreshStatuses operation.
" } }, "com.amazonaws.support#DescribeTrustedAdvisorCheckResult": { "type": "operation", "input": { "target": "com.amazonaws.support#DescribeTrustedAdvisorCheckResultRequest" }, "output": { "target": "com.amazonaws.support#DescribeTrustedAdvisorCheckResultResponse" }, "errors": [ { "target": "com.amazonaws.support#InternalServerError" } ], "traits": { "smithy.api#documentation": "Returns the results of the AWS Trusted Advisor check that has the specified check ID. You\n can get the check IDs by calling the DescribeTrustedAdvisorChecks\n operation.
\nThe response contains a TrustedAdvisorCheckResult object, which\n contains these three objects:
\nIn addition, the response contains these fields:
\n\n status - The alert status of the check\n can be ok (green), warning (yellow),\n error (red), or not_available.
\n timestamp - The time of the last refresh\n of the check.
\n\n checkId - The unique identifier for the\n check.
\nYou must have a Business or Enterprise Support plan to use the AWS Support\n API.
\nIf you call the AWS Support API from an account that does not have a\n Business or Enterprise Support plan, the\n SubscriptionRequiredException error message appears. For\n information about changing your support plan, see AWS Support.
The unique identifier for the Trusted Advisor check.
", "smithy.api#required": {} } }, "language": { "target": "com.amazonaws.support#String", "traits": { "smithy.api#documentation": "The ISO 639-1 code for the language in which AWS provides support. AWS Support\n currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be\n passed explicitly for operations that take them.
" } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.support#DescribeTrustedAdvisorCheckResultResponse": { "type": "structure", "members": { "result": { "target": "com.amazonaws.support#TrustedAdvisorCheckResult", "traits": { "smithy.api#documentation": "The detailed results of the Trusted Advisor check.
" } } }, "traits": { "smithy.api#documentation": "The result of the Trusted Advisor check returned by the DescribeTrustedAdvisorCheckResult operation.
" } }, "com.amazonaws.support#DescribeTrustedAdvisorCheckSummaries": { "type": "operation", "input": { "target": "com.amazonaws.support#DescribeTrustedAdvisorCheckSummariesRequest" }, "output": { "target": "com.amazonaws.support#DescribeTrustedAdvisorCheckSummariesResponse" }, "errors": [ { "target": "com.amazonaws.support#InternalServerError" } ], "traits": { "smithy.api#documentation": "Returns the results for the AWS Trusted Advisor check summaries for the check IDs that you\n specified. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation.
\nThe response contains an array of TrustedAdvisorCheckSummary\n objects.
\nYou must have a Business or Enterprise Support plan to use the AWS Support\n API.
\nIf you call the AWS Support API from an account that does not have a\n Business or Enterprise Support plan, the\n SubscriptionRequiredException error message appears. For\n information about changing your support plan, see AWS Support.
The IDs of the Trusted Advisor checks.
", "smithy.api#required": {} } } } }, "com.amazonaws.support#DescribeTrustedAdvisorCheckSummariesResponse": { "type": "structure", "members": { "summaries": { "target": "com.amazonaws.support#TrustedAdvisorCheckSummaryList", "traits": { "smithy.api#documentation": "The summary information for the requested Trusted Advisor checks.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The summaries of the Trusted Advisor checks returned by the DescribeTrustedAdvisorCheckSummaries operation.
" } }, "com.amazonaws.support#DescribeTrustedAdvisorChecks": { "type": "operation", "input": { "target": "com.amazonaws.support#DescribeTrustedAdvisorChecksRequest" }, "output": { "target": "com.amazonaws.support#DescribeTrustedAdvisorChecksResponse" }, "errors": [ { "target": "com.amazonaws.support#InternalServerError" } ], "traits": { "smithy.api#documentation": "Returns information about all available AWS Trusted Advisor checks, including the name, ID,\n category, description, and metadata. You must specify a language code. The AWS Support API\n currently supports English (\"en\") and Japanese (\"ja\"). The response contains a TrustedAdvisorCheckDescription object for each check. You must set the\n AWS Region to us-east-1.
\n \n \nYou must have a Business or Enterprise Support plan to use the AWS Support\n API.
\nIf you call the AWS Support API from an account that does not have a\n Business or Enterprise Support plan, the\n SubscriptionRequiredException error message appears. For\n information about changing your support plan, see AWS Support.
The names and descriptions for Trusted Advisor checks are subject to change. We recommend\n that you specify the check ID in your code to uniquely identify a check.
\nThe ISO 639-1 code for the language in which AWS provides support. AWS Support\n currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be\n passed explicitly for operations that take them.
", "smithy.api#required": {} } } } }, "com.amazonaws.support#DescribeTrustedAdvisorChecksResponse": { "type": "structure", "members": { "checks": { "target": "com.amazonaws.support#TrustedAdvisorCheckList", "traits": { "smithy.api#documentation": "Information about all available Trusted Advisor checks.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Information about the Trusted Advisor checks returned by the DescribeTrustedAdvisorChecks operation.
" } }, "com.amazonaws.support#DisplayId": { "type": "string" }, "com.amazonaws.support#Double": { "type": "double" }, "com.amazonaws.support#ErrorMessage": { "type": "string" }, "com.amazonaws.support#ExpiryTime": { "type": "string" }, "com.amazonaws.support#FileName": { "type": "string" }, "com.amazonaws.support#IncludeCommunications": { "type": "boolean", "traits": { "smithy.api#box": {} } }, "com.amazonaws.support#IncludeResolvedCases": { "type": "boolean" }, "com.amazonaws.support#InternalServerError": { "type": "structure", "members": { "message": { "target": "com.amazonaws.support#ErrorMessage", "traits": { "smithy.api#documentation": "An internal server error occurred.
" } } }, "traits": { "smithy.api#documentation": "An internal server error occurred.
", "smithy.api#error": "server" } }, "com.amazonaws.support#IssueType": { "type": "string" }, "com.amazonaws.support#Language": { "type": "string" }, "com.amazonaws.support#Long": { "type": "long" }, "com.amazonaws.support#MaxResults": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 10, "max": 100 } } }, "com.amazonaws.support#NextToken": { "type": "string" }, "com.amazonaws.support#RecentCaseCommunications": { "type": "structure", "members": { "communications": { "target": "com.amazonaws.support#CommunicationList", "traits": { "smithy.api#documentation": "The five most recent communications associated with the case.
" } }, "nextToken": { "target": "com.amazonaws.support#NextToken", "traits": { "smithy.api#documentation": "A resumption point for pagination.
" } } }, "traits": { "smithy.api#documentation": "The five most recent communications associated with the case.
" } }, "com.amazonaws.support#RefreshTrustedAdvisorCheck": { "type": "operation", "input": { "target": "com.amazonaws.support#RefreshTrustedAdvisorCheckRequest" }, "output": { "target": "com.amazonaws.support#RefreshTrustedAdvisorCheckResponse" }, "errors": [ { "target": "com.amazonaws.support#InternalServerError" } ], "traits": { "smithy.api#documentation": "Refreshes the AWS Trusted Advisor check that you specify using the check ID. You can get the\n check IDs by calling the DescribeTrustedAdvisorChecks\n operation.
\nSome checks are refreshed automatically. If you call the\n RefreshTrustedAdvisorCheck operation to refresh them, you might see\n the InvalidParameterValue error.
The response contains a TrustedAdvisorCheckRefreshStatus\n object.
\nYou must have a Business or Enterprise Support plan to use the AWS Support\n API.
\nIf you call the AWS Support API from an account that does not have a\n Business or Enterprise Support plan, the\n SubscriptionRequiredException error message appears. For\n information about changing your support plan, see AWS Support.
The unique identifier for the Trusted Advisor check to refresh.
\nSpecifying the check ID of a check that is automatically refreshed\n causes an InvalidParameterValue error.
The current refresh status for a check, including the amount of time until the check\n is eligible for refresh.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The current refresh status of a Trusted Advisor check.
" } }, "com.amazonaws.support#ResolveCase": { "type": "operation", "input": { "target": "com.amazonaws.support#ResolveCaseRequest" }, "output": { "target": "com.amazonaws.support#ResolveCaseResponse" }, "errors": [ { "target": "com.amazonaws.support#CaseIdNotFound" }, { "target": "com.amazonaws.support#InternalServerError" } ], "traits": { "smithy.api#documentation": "Resolves a support case. This operation takes a caseId and returns the\n initial and final state of the case.
You must have a Business or Enterprise Support plan to use the AWS Support\n API.
\nIf you call the AWS Support API from an account that does not have a\n Business or Enterprise Support plan, the\n SubscriptionRequiredException error message appears. For\n information about changing your support plan, see AWS Support.
The support case ID requested or returned in the call. The case ID is an\n alphanumeric string formatted as shown in this example:\n case-12345678910-2013-c4c1d2bf33c5cf47\n
" } } } }, "com.amazonaws.support#ResolveCaseResponse": { "type": "structure", "members": { "initialCaseStatus": { "target": "com.amazonaws.support#CaseStatus", "traits": { "smithy.api#documentation": "The status of the case when the ResolveCase request was sent.
" } }, "finalCaseStatus": { "target": "com.amazonaws.support#CaseStatus", "traits": { "smithy.api#documentation": "The status of the case after the ResolveCase request was\n processed.
" } } }, "traits": { "smithy.api#documentation": "The status of the case returned by the ResolveCase operation.
" } }, "com.amazonaws.support#Result": { "type": "boolean" }, "com.amazonaws.support#Service": { "type": "structure", "members": { "code": { "target": "com.amazonaws.support#ServiceCode", "traits": { "smithy.api#documentation": "The code for an AWS service returned by the DescribeServices\n response. The name element contains the corresponding friendly name.
The friendly name for an AWS service. The code element contains the\n corresponding code.
A list of categories that describe the type of support issue a case describes.\n Categories consist of a category name and a category code. Category names and codes are\n passed to AWS Support when you call CreateCase.
" } } }, "traits": { "smithy.api#documentation": "Information about an AWS service returned by the DescribeServices\n operation.
" } }, "com.amazonaws.support#ServiceCode": { "type": "string", "traits": { "smithy.api#pattern": "[0-9a-z\\-_]+" } }, "com.amazonaws.support#ServiceCodeList": { "type": "list", "member": { "target": "com.amazonaws.support#ServiceCode" }, "traits": { "smithy.api#length": { "min": 0, "max": 100 } } }, "com.amazonaws.support#ServiceList": { "type": "list", "member": { "target": "com.amazonaws.support#Service" } }, "com.amazonaws.support#ServiceName": { "type": "string" }, "com.amazonaws.support#SeverityCode": { "type": "string" }, "com.amazonaws.support#SeverityLevel": { "type": "structure", "members": { "code": { "target": "com.amazonaws.support#SeverityLevelCode", "traits": { "smithy.api#documentation": "The code for case severity level.
\nValid values: low | normal | high |\n urgent | critical\n
The name of the severity level that corresponds to the severity level code.
\nThe values returned by the API are different from the values that appear in the\n AWS Support Center. For example, the API uses the code low, but the name\n appears as General guidance in Support Center.
The following are the API code names and how they appear in the console:
\n\n low - General guidance
\n normal - System impaired
\n high - Production system impaired
\n urgent - Production system down
\n critical - Business-critical system down
For more information, see Choosing a\n severity in the AWS Support User Guide.
" } } }, "traits": { "smithy.api#documentation": "A code and name pair that represents the severity level of a support case. The\n available values depend on the support plan for the account. For more information, see\n Choosing a\n severity in the AWS Support User Guide.
" } }, "com.amazonaws.support#SeverityLevelCode": { "type": "string" }, "com.amazonaws.support#SeverityLevelName": { "type": "string" }, "com.amazonaws.support#SeverityLevelsList": { "type": "list", "member": { "target": "com.amazonaws.support#SeverityLevel" } }, "com.amazonaws.support#Status": { "type": "string" }, "com.amazonaws.support#String": { "type": "string" }, "com.amazonaws.support#StringList": { "type": "list", "member": { "target": "com.amazonaws.support#String" } }, "com.amazonaws.support#Subject": { "type": "string" }, "com.amazonaws.support#SubmittedBy": { "type": "string" }, "com.amazonaws.support#TimeCreated": { "type": "string" }, "com.amazonaws.support#TrustedAdvisorCategorySpecificSummary": { "type": "structure", "members": { "costOptimizing": { "target": "com.amazonaws.support#TrustedAdvisorCostOptimizingSummary", "traits": { "smithy.api#documentation": "The summary information about cost savings for a Trusted Advisor check that is in the\n Cost Optimizing category.
" } } }, "traits": { "smithy.api#documentation": "The container for summary information that relates to the category of the Trusted Advisor check.
" } }, "com.amazonaws.support#TrustedAdvisorCheckDescription": { "type": "structure", "members": { "id": { "target": "com.amazonaws.support#String", "traits": { "smithy.api#documentation": "The unique identifier for the Trusted Advisor check.
", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.support#String", "traits": { "smithy.api#documentation": "The display name for the Trusted Advisor check.
", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.support#String", "traits": { "smithy.api#documentation": "The description of the Trusted Advisor check, which includes the alert criteria and\n recommended operations (contains HTML markup).
", "smithy.api#required": {} } }, "category": { "target": "com.amazonaws.support#String", "traits": { "smithy.api#documentation": "The category of the Trusted Advisor check.
", "smithy.api#required": {} } }, "metadata": { "target": "com.amazonaws.support#StringList", "traits": { "smithy.api#documentation": "The column headings for the data returned by the Trusted Advisor check. The order of\n the headings corresponds to the order of the data in the Metadata element of the TrustedAdvisorResourceDetail\n for the check. Metadata contains all the data that is\n shown in the Excel download, even in those cases where the UI shows just summary data.\n
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The description and metadata for a Trusted Advisor check.
" } }, "com.amazonaws.support#TrustedAdvisorCheckList": { "type": "list", "member": { "target": "com.amazonaws.support#TrustedAdvisorCheckDescription" } }, "com.amazonaws.support#TrustedAdvisorCheckRefreshStatus": { "type": "structure", "members": { "checkId": { "target": "com.amazonaws.support#String", "traits": { "smithy.api#documentation": "The unique identifier for the Trusted Advisor check.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.support#String", "traits": { "smithy.api#documentation": "The status of the Trusted Advisor check for which a refresh has been requested:\n
\n\n none - The check is not refreshed or the non-success status\n exceeds the timeout
\n enqueued - The check refresh requests has entered the refresh\n queue
\n processing - The check refresh request is picked up by the rule\n processing engine
\n success - The check is successfully refreshed
\n abandoned - The check refresh has failed
The amount of time, in milliseconds, until the Trusted Advisor check is eligible for\n refresh.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The refresh status of a Trusted Advisor check.
" } }, "com.amazonaws.support#TrustedAdvisorCheckRefreshStatusList": { "type": "list", "member": { "target": "com.amazonaws.support#TrustedAdvisorCheckRefreshStatus" } }, "com.amazonaws.support#TrustedAdvisorCheckResult": { "type": "structure", "members": { "checkId": { "target": "com.amazonaws.support#String", "traits": { "smithy.api#documentation": "The unique identifier for the Trusted Advisor check.
", "smithy.api#required": {} } }, "timestamp": { "target": "com.amazonaws.support#String", "traits": { "smithy.api#documentation": "The time of the last refresh of the check.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.support#String", "traits": { "smithy.api#documentation": "The alert status of the check: \"ok\" (green), \"warning\" (yellow), \"error\" (red), or\n \"not_available\".
", "smithy.api#required": {} } }, "resourcesSummary": { "target": "com.amazonaws.support#TrustedAdvisorResourcesSummary", "traits": { "smithy.api#required": {} } }, "categorySpecificSummary": { "target": "com.amazonaws.support#TrustedAdvisorCategorySpecificSummary", "traits": { "smithy.api#documentation": "Summary information that relates to the category of the check. Cost Optimizing is the\n only category that is currently supported.
", "smithy.api#required": {} } }, "flaggedResources": { "target": "com.amazonaws.support#TrustedAdvisorResourceDetailList", "traits": { "smithy.api#documentation": "The details about each resource listed in the check result.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The results of a Trusted Advisor check returned by DescribeTrustedAdvisorCheckResult.
" } }, "com.amazonaws.support#TrustedAdvisorCheckSummary": { "type": "structure", "members": { "checkId": { "target": "com.amazonaws.support#String", "traits": { "smithy.api#documentation": "The unique identifier for the Trusted Advisor check.
", "smithy.api#required": {} } }, "timestamp": { "target": "com.amazonaws.support#String", "traits": { "smithy.api#documentation": "The time of the last refresh of the check.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.support#String", "traits": { "smithy.api#documentation": "The alert status of the check: \"ok\" (green), \"warning\" (yellow), \"error\" (red), or\n \"not_available\".
", "smithy.api#required": {} } }, "hasFlaggedResources": { "target": "com.amazonaws.support#Boolean", "traits": { "smithy.api#documentation": "Specifies whether the Trusted Advisor check has flagged resources.
" } }, "resourcesSummary": { "target": "com.amazonaws.support#TrustedAdvisorResourcesSummary", "traits": { "smithy.api#required": {} } }, "categorySpecificSummary": { "target": "com.amazonaws.support#TrustedAdvisorCategorySpecificSummary", "traits": { "smithy.api#documentation": "Summary information that relates to the category of the check. Cost Optimizing is the\n only category that is currently supported.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A summary of a Trusted Advisor check result, including the alert status, last refresh,\n and number of resources examined.
" } }, "com.amazonaws.support#TrustedAdvisorCheckSummaryList": { "type": "list", "member": { "target": "com.amazonaws.support#TrustedAdvisorCheckSummary" } }, "com.amazonaws.support#TrustedAdvisorCostOptimizingSummary": { "type": "structure", "members": { "estimatedMonthlySavings": { "target": "com.amazonaws.support#Double", "traits": { "smithy.api#documentation": "The estimated monthly savings that might be realized if the recommended operations are\n taken.
", "smithy.api#required": {} } }, "estimatedPercentMonthlySavings": { "target": "com.amazonaws.support#Double", "traits": { "smithy.api#documentation": "The estimated percentage of savings that might be realized if the recommended\n operations are taken.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The estimated cost savings that might be realized if the recommended operations are\n taken.
" } }, "com.amazonaws.support#TrustedAdvisorResourceDetail": { "type": "structure", "members": { "status": { "target": "com.amazonaws.support#String", "traits": { "smithy.api#documentation": "The status code for the resource identified in the Trusted Advisor check.
", "smithy.api#required": {} } }, "region": { "target": "com.amazonaws.support#String", "traits": { "smithy.api#documentation": "The AWS Region in which the identified resource is located.
" } }, "resourceId": { "target": "com.amazonaws.support#String", "traits": { "smithy.api#documentation": "The unique identifier for the identified resource.
", "smithy.api#required": {} } }, "isSuppressed": { "target": "com.amazonaws.support#Boolean", "traits": { "smithy.api#documentation": "Specifies whether the AWS resource was ignored by Trusted Advisor because it was\n marked as suppressed by the user.
" } }, "metadata": { "target": "com.amazonaws.support#StringList", "traits": { "smithy.api#documentation": "Additional information about the identified resource. The exact metadata and its order\n can be obtained by inspecting the TrustedAdvisorCheckDescription\n object returned by the call to DescribeTrustedAdvisorChecks. Metadata contains all the data that is shown in the Excel\n download, even in those cases where the UI shows just summary data.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains information about a resource identified by a Trusted Advisor check.
" } }, "com.amazonaws.support#TrustedAdvisorResourceDetailList": { "type": "list", "member": { "target": "com.amazonaws.support#TrustedAdvisorResourceDetail" } }, "com.amazonaws.support#TrustedAdvisorResourcesSummary": { "type": "structure", "members": { "resourcesProcessed": { "target": "com.amazonaws.support#Long", "traits": { "smithy.api#documentation": "The number of AWS resources that were analyzed by the Trusted Advisor check.
", "smithy.api#required": {} } }, "resourcesFlagged": { "target": "com.amazonaws.support#Long", "traits": { "smithy.api#documentation": "The number of AWS resources that were flagged (listed) by the Trusted Advisor\n check.
", "smithy.api#required": {} } }, "resourcesIgnored": { "target": "com.amazonaws.support#Long", "traits": { "smithy.api#documentation": "The number of AWS resources ignored by Trusted Advisor because information was\n unavailable.
", "smithy.api#required": {} } }, "resourcesSuppressed": { "target": "com.amazonaws.support#Long", "traits": { "smithy.api#documentation": "The number of AWS resources ignored by Trusted Advisor because they were marked as\n suppressed by the user.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Details about AWS resources that were analyzed in a call to Trusted Advisor DescribeTrustedAdvisorCheckSummaries.
" } } } }