support.d.ts (45855B)
1 import {Request} from '../lib/request'; 2 import {Response} from '../lib/response'; 3 import {AWSError} from '../lib/error'; 4 import {Service} from '../lib/service'; 5 import {ServiceConfigurationOptions} from '../lib/service'; 6 import {ConfigBase as Config} from '../lib/config'; 7 interface Blob {} 8 declare class Support extends Service { 9 /** 10 * Constructs a service object. This object has one method for each API operation. 11 */ 12 constructor(options?: Support.Types.ClientConfiguration) 13 config: Config & Support.Types.ClientConfiguration; 14 /** 15 * Adds one or more attachments to an attachment set. If an attachmentSetId is not specified, a new attachment set is created, and the ID of the set is returned in the response. If an attachmentSetId is specified, the attachments are added to the specified set, if it exists. An attachment set is a temporary container for attachments that are to be added to a case or case communication. The set is available for one hour after it is created; the expiryTime returned in the response indicates when the set expires. The maximum number of attachments in a set is 3, and the maximum size of any attachment in the set is 5 MB. 16 */ 17 addAttachmentsToSet(params: Support.Types.AddAttachmentsToSetRequest, callback?: (err: AWSError, data: Support.Types.AddAttachmentsToSetResponse) => void): Request<Support.Types.AddAttachmentsToSetResponse, AWSError>; 18 /** 19 * Adds one or more attachments to an attachment set. If an attachmentSetId is not specified, a new attachment set is created, and the ID of the set is returned in the response. If an attachmentSetId is specified, the attachments are added to the specified set, if it exists. An attachment set is a temporary container for attachments that are to be added to a case or case communication. The set is available for one hour after it is created; the expiryTime returned in the response indicates when the set expires. The maximum number of attachments in a set is 3, and the maximum size of any attachment in the set is 5 MB. 20 */ 21 addAttachmentsToSet(callback?: (err: AWSError, data: Support.Types.AddAttachmentsToSetResponse) => void): Request<Support.Types.AddAttachmentsToSetResponse, AWSError>; 22 /** 23 * Adds additional customer communication to an AWS Support case. You use the caseId value to identify the case to add communication to. You can list a set of email addresses to copy on the communication using the ccEmailAddresses value. The communicationBody value contains the text of the communication. The response indicates the success or failure of the request. This operation implements a subset of the features of the AWS Support Center. 24 */ 25 addCommunicationToCase(params: Support.Types.AddCommunicationToCaseRequest, callback?: (err: AWSError, data: Support.Types.AddCommunicationToCaseResponse) => void): Request<Support.Types.AddCommunicationToCaseResponse, AWSError>; 26 /** 27 * Adds additional customer communication to an AWS Support case. You use the caseId value to identify the case to add communication to. You can list a set of email addresses to copy on the communication using the ccEmailAddresses value. The communicationBody value contains the text of the communication. The response indicates the success or failure of the request. This operation implements a subset of the features of the AWS Support Center. 28 */ 29 addCommunicationToCase(callback?: (err: AWSError, data: Support.Types.AddCommunicationToCaseResponse) => void): Request<Support.Types.AddCommunicationToCaseResponse, AWSError>; 30 /** 31 * Creates a new case in the AWS Support Center. This operation is modeled on the behavior of the AWS Support Center Create Case page. Its parameters require you to specify the following information: issueType. The type of issue for the case. You can specify either "customer-service" or "technical." If you do not indicate a value, the default is "technical." serviceCode. The code for an AWS service. You obtain the serviceCode by calling DescribeServices. categoryCode. The category for the service defined for the serviceCode value. You also obtain the category code for a service by calling DescribeServices. Each AWS service defines its own set of category codes. severityCode. A value that indicates the urgency of the case, which in turn determines the response time according to your service level agreement with AWS Support. You obtain the SeverityCode by calling DescribeSeverityLevels. subject. The Subject field on the AWS Support Center Create Case page. communicationBody. The Description field on the AWS Support Center Create Case page. attachmentSetId. The ID of a set of attachments that has been created by using AddAttachmentsToSet. language. The human language in which AWS Support handles the case. English and Japanese are currently supported. ccEmailAddresses. The AWS Support Center CC field on the Create Case page. You can list email addresses to be copied on any correspondence about the case. The account that opens the case is already identified by passing the AWS Credentials in the HTTP POST method or in a method or function call from one of the programming languages supported by an AWS SDK. To add additional communication or attachments to an existing case, use AddCommunicationToCase. A successful CreateCase request returns an AWS Support case number. Case numbers are used by the DescribeCases operation to retrieve existing AWS Support cases. 32 */ 33 createCase(params: Support.Types.CreateCaseRequest, callback?: (err: AWSError, data: Support.Types.CreateCaseResponse) => void): Request<Support.Types.CreateCaseResponse, AWSError>; 34 /** 35 * Creates a new case in the AWS Support Center. This operation is modeled on the behavior of the AWS Support Center Create Case page. Its parameters require you to specify the following information: issueType. The type of issue for the case. You can specify either "customer-service" or "technical." If you do not indicate a value, the default is "technical." serviceCode. The code for an AWS service. You obtain the serviceCode by calling DescribeServices. categoryCode. The category for the service defined for the serviceCode value. You also obtain the category code for a service by calling DescribeServices. Each AWS service defines its own set of category codes. severityCode. A value that indicates the urgency of the case, which in turn determines the response time according to your service level agreement with AWS Support. You obtain the SeverityCode by calling DescribeSeverityLevels. subject. The Subject field on the AWS Support Center Create Case page. communicationBody. The Description field on the AWS Support Center Create Case page. attachmentSetId. The ID of a set of attachments that has been created by using AddAttachmentsToSet. language. The human language in which AWS Support handles the case. English and Japanese are currently supported. ccEmailAddresses. The AWS Support Center CC field on the Create Case page. You can list email addresses to be copied on any correspondence about the case. The account that opens the case is already identified by passing the AWS Credentials in the HTTP POST method or in a method or function call from one of the programming languages supported by an AWS SDK. To add additional communication or attachments to an existing case, use AddCommunicationToCase. A successful CreateCase request returns an AWS Support case number. Case numbers are used by the DescribeCases operation to retrieve existing AWS Support cases. 36 */ 37 createCase(callback?: (err: AWSError, data: Support.Types.CreateCaseResponse) => void): Request<Support.Types.CreateCaseResponse, AWSError>; 38 /** 39 * Returns the attachment that has the specified ID. 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. 40 */ 41 describeAttachment(params: Support.Types.DescribeAttachmentRequest, callback?: (err: AWSError, data: Support.Types.DescribeAttachmentResponse) => void): Request<Support.Types.DescribeAttachmentResponse, AWSError>; 42 /** 43 * Returns the attachment that has the specified ID. 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. 44 */ 45 describeAttachment(callback?: (err: AWSError, data: Support.Types.DescribeAttachmentResponse) => void): Request<Support.Types.DescribeAttachmentResponse, AWSError>; 46 /** 47 * Returns a list of cases that you specify by passing one or more case IDs. In addition, you can filter the cases by date by setting values for the afterTime and beforeTime request parameters. You can set values for the includeResolvedCases and includeCommunications request parameters to control how much information is returned. 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. The response returns the following in JSON format: One or more CaseDetails data types. One or more nextToken values, which specify where to paginate the returned records represented by the CaseDetails objects. 48 */ 49 describeCases(params: Support.Types.DescribeCasesRequest, callback?: (err: AWSError, data: Support.Types.DescribeCasesResponse) => void): Request<Support.Types.DescribeCasesResponse, AWSError>; 50 /** 51 * Returns a list of cases that you specify by passing one or more case IDs. In addition, you can filter the cases by date by setting values for the afterTime and beforeTime request parameters. You can set values for the includeResolvedCases and includeCommunications request parameters to control how much information is returned. 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. The response returns the following in JSON format: One or more CaseDetails data types. One or more nextToken values, which specify where to paginate the returned records represented by the CaseDetails objects. 52 */ 53 describeCases(callback?: (err: AWSError, data: Support.Types.DescribeCasesResponse) => void): Request<Support.Types.DescribeCasesResponse, AWSError>; 54 /** 55 * Returns communications (and attachments) for one or more support cases. You can use the afterTime and beforeTime parameters to filter by date. You can use the caseId parameter to restrict the results to a particular 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 result set. Set maxResults to the number of cases you want displayed on each page, and use nextToken to specify the resumption of pagination. 56 */ 57 describeCommunications(params: Support.Types.DescribeCommunicationsRequest, callback?: (err: AWSError, data: Support.Types.DescribeCommunicationsResponse) => void): Request<Support.Types.DescribeCommunicationsResponse, AWSError>; 58 /** 59 * Returns communications (and attachments) for one or more support cases. You can use the afterTime and beforeTime parameters to filter by date. You can use the caseId parameter to restrict the results to a particular 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 result set. Set maxResults to the number of cases you want displayed on each page, and use nextToken to specify the resumption of pagination. 60 */ 61 describeCommunications(callback?: (err: AWSError, data: Support.Types.DescribeCommunicationsResponse) => void): Request<Support.Types.DescribeCommunicationsResponse, AWSError>; 62 /** 63 * Returns the current list of AWS services and a list of service categories that applies to each one. You then use service names and categories in your CreateCase requests. Each AWS service has its own set of categories. The service codes and category codes correspond to the values that are displayed in the Service and Category drop-down lists on the AWS Support Center Create Case page. The values in those fields, however, do not necessarily match the service codes and categories returned by the DescribeServices request. Always use the service codes and categories obtained programmatically. This practice ensures that you always have the most recent set of service and category codes. 64 */ 65 describeServices(params: Support.Types.DescribeServicesRequest, callback?: (err: AWSError, data: Support.Types.DescribeServicesResponse) => void): Request<Support.Types.DescribeServicesResponse, AWSError>; 66 /** 67 * Returns the current list of AWS services and a list of service categories that applies to each one. You then use service names and categories in your CreateCase requests. Each AWS service has its own set of categories. The service codes and category codes correspond to the values that are displayed in the Service and Category drop-down lists on the AWS Support Center Create Case page. The values in those fields, however, do not necessarily match the service codes and categories returned by the DescribeServices request. Always use the service codes and categories obtained programmatically. This practice ensures that you always have the most recent set of service and category codes. 68 */ 69 describeServices(callback?: (err: AWSError, data: Support.Types.DescribeServicesResponse) => void): Request<Support.Types.DescribeServicesResponse, AWSError>; 70 /** 71 * Returns the list of severity levels that you can assign to an AWS Support case. The severity level for a case is also a field in the CaseDetails data type included in any CreateCase request. 72 */ 73 describeSeverityLevels(params: Support.Types.DescribeSeverityLevelsRequest, callback?: (err: AWSError, data: Support.Types.DescribeSeverityLevelsResponse) => void): Request<Support.Types.DescribeSeverityLevelsResponse, AWSError>; 74 /** 75 * Returns the list of severity levels that you can assign to an AWS Support case. The severity level for a case is also a field in the CaseDetails data type included in any CreateCase request. 76 */ 77 describeSeverityLevels(callback?: (err: AWSError, data: Support.Types.DescribeSeverityLevelsResponse) => void): Request<Support.Types.DescribeSeverityLevelsResponse, AWSError>; 78 /** 79 * Returns the refresh status of the Trusted Advisor checks that have the specified check IDs. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks. Some checks are refreshed automatically, and their refresh statuses cannot be retrieved by using this operation. Use of the DescribeTrustedAdvisorCheckRefreshStatuses operation for these checks causes an InvalidParameterValue error. 80 */ 81 describeTrustedAdvisorCheckRefreshStatuses(params: Support.Types.DescribeTrustedAdvisorCheckRefreshStatusesRequest, callback?: (err: AWSError, data: Support.Types.DescribeTrustedAdvisorCheckRefreshStatusesResponse) => void): Request<Support.Types.DescribeTrustedAdvisorCheckRefreshStatusesResponse, AWSError>; 82 /** 83 * Returns the refresh status of the Trusted Advisor checks that have the specified check IDs. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks. Some checks are refreshed automatically, and their refresh statuses cannot be retrieved by using this operation. Use of the DescribeTrustedAdvisorCheckRefreshStatuses operation for these checks causes an InvalidParameterValue error. 84 */ 85 describeTrustedAdvisorCheckRefreshStatuses(callback?: (err: AWSError, data: Support.Types.DescribeTrustedAdvisorCheckRefreshStatusesResponse) => void): Request<Support.Types.DescribeTrustedAdvisorCheckRefreshStatusesResponse, AWSError>; 86 /** 87 * Returns the results of the Trusted Advisor check that has the specified check ID. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks. The response contains a TrustedAdvisorCheckResult object, which contains these three objects: TrustedAdvisorCategorySpecificSummary TrustedAdvisorResourceDetail TrustedAdvisorResourcesSummary In addition, the response contains these fields: status. The alert status of the check: "ok" (green), "warning" (yellow), "error" (red), or "not_available". timestamp. The time of the last refresh of the check. checkId. The unique identifier for the check. 88 */ 89 describeTrustedAdvisorCheckResult(params: Support.Types.DescribeTrustedAdvisorCheckResultRequest, callback?: (err: AWSError, data: Support.Types.DescribeTrustedAdvisorCheckResultResponse) => void): Request<Support.Types.DescribeTrustedAdvisorCheckResultResponse, AWSError>; 90 /** 91 * Returns the results of the Trusted Advisor check that has the specified check ID. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks. The response contains a TrustedAdvisorCheckResult object, which contains these three objects: TrustedAdvisorCategorySpecificSummary TrustedAdvisorResourceDetail TrustedAdvisorResourcesSummary In addition, the response contains these fields: status. The alert status of the check: "ok" (green), "warning" (yellow), "error" (red), or "not_available". timestamp. The time of the last refresh of the check. checkId. The unique identifier for the check. 92 */ 93 describeTrustedAdvisorCheckResult(callback?: (err: AWSError, data: Support.Types.DescribeTrustedAdvisorCheckResultResponse) => void): Request<Support.Types.DescribeTrustedAdvisorCheckResultResponse, AWSError>; 94 /** 95 * Returns the summaries of the results of the Trusted Advisor checks that have the specified check IDs. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks. The response contains an array of TrustedAdvisorCheckSummary objects. 96 */ 97 describeTrustedAdvisorCheckSummaries(params: Support.Types.DescribeTrustedAdvisorCheckSummariesRequest, callback?: (err: AWSError, data: Support.Types.DescribeTrustedAdvisorCheckSummariesResponse) => void): Request<Support.Types.DescribeTrustedAdvisorCheckSummariesResponse, AWSError>; 98 /** 99 * Returns the summaries of the results of the Trusted Advisor checks that have the specified check IDs. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks. The response contains an array of TrustedAdvisorCheckSummary objects. 100 */ 101 describeTrustedAdvisorCheckSummaries(callback?: (err: AWSError, data: Support.Types.DescribeTrustedAdvisorCheckSummariesResponse) => void): Request<Support.Types.DescribeTrustedAdvisorCheckSummariesResponse, AWSError>; 102 /** 103 * Returns information about all available Trusted Advisor checks, including name, ID, category, description, and metadata. You must specify a language code; English ("en") and Japanese ("ja") are currently supported. The response contains a TrustedAdvisorCheckDescription for each check. 104 */ 105 describeTrustedAdvisorChecks(params: Support.Types.DescribeTrustedAdvisorChecksRequest, callback?: (err: AWSError, data: Support.Types.DescribeTrustedAdvisorChecksResponse) => void): Request<Support.Types.DescribeTrustedAdvisorChecksResponse, AWSError>; 106 /** 107 * Returns information about all available Trusted Advisor checks, including name, ID, category, description, and metadata. You must specify a language code; English ("en") and Japanese ("ja") are currently supported. The response contains a TrustedAdvisorCheckDescription for each check. 108 */ 109 describeTrustedAdvisorChecks(callback?: (err: AWSError, data: Support.Types.DescribeTrustedAdvisorChecksResponse) => void): Request<Support.Types.DescribeTrustedAdvisorChecksResponse, AWSError>; 110 /** 111 * Requests a refresh of the Trusted Advisor check that has the specified check ID. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks. Some checks are refreshed automatically, and they cannot be refreshed by using this operation. Use of the RefreshTrustedAdvisorCheck operation for these checks causes an InvalidParameterValue error. The response contains a TrustedAdvisorCheckRefreshStatus object, which contains these fields: status. The refresh status of the check: "none", "enqueued", "processing", "success", or "abandoned". millisUntilNextRefreshable. The amount of time, in milliseconds, until the check is eligible for refresh. checkId. The unique identifier for the check. 112 */ 113 refreshTrustedAdvisorCheck(params: Support.Types.RefreshTrustedAdvisorCheckRequest, callback?: (err: AWSError, data: Support.Types.RefreshTrustedAdvisorCheckResponse) => void): Request<Support.Types.RefreshTrustedAdvisorCheckResponse, AWSError>; 114 /** 115 * Requests a refresh of the Trusted Advisor check that has the specified check ID. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks. Some checks are refreshed automatically, and they cannot be refreshed by using this operation. Use of the RefreshTrustedAdvisorCheck operation for these checks causes an InvalidParameterValue error. The response contains a TrustedAdvisorCheckRefreshStatus object, which contains these fields: status. The refresh status of the check: "none", "enqueued", "processing", "success", or "abandoned". millisUntilNextRefreshable. The amount of time, in milliseconds, until the check is eligible for refresh. checkId. The unique identifier for the check. 116 */ 117 refreshTrustedAdvisorCheck(callback?: (err: AWSError, data: Support.Types.RefreshTrustedAdvisorCheckResponse) => void): Request<Support.Types.RefreshTrustedAdvisorCheckResponse, AWSError>; 118 /** 119 * Takes a caseId and returns the initial state of the case along with the state of the case after the call to ResolveCase completed. 120 */ 121 resolveCase(params: Support.Types.ResolveCaseRequest, callback?: (err: AWSError, data: Support.Types.ResolveCaseResponse) => void): Request<Support.Types.ResolveCaseResponse, AWSError>; 122 /** 123 * Takes a caseId and returns the initial state of the case along with the state of the case after the call to ResolveCase completed. 124 */ 125 resolveCase(callback?: (err: AWSError, data: Support.Types.ResolveCaseResponse) => void): Request<Support.Types.ResolveCaseResponse, AWSError>; 126 } 127 declare namespace Support.Types { 128 export interface AddAttachmentsToSetRequest { 129 /** 130 * The ID of the attachment set. If an attachmentSetId is not specified, a new attachment set is created, and the ID of the set is returned in the response. If an attachmentSetId is specified, the attachments are added to the specified set, if it exists. 131 */ 132 attachmentSetId?: AttachmentSetId; 133 /** 134 * One or more attachments to add to the set. The limit is 3 attachments per set, and the size limit is 5 MB per attachment. 135 */ 136 attachments: Attachments; 137 } 138 export interface AddAttachmentsToSetResponse { 139 /** 140 * 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. 141 */ 142 attachmentSetId?: AttachmentSetId; 143 /** 144 * The time and date when the attachment set expires. 145 */ 146 expiryTime?: ExpiryTime; 147 } 148 export interface AddCommunicationToCaseRequest { 149 /** 150 * The AWS 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 151 */ 152 caseId?: CaseId; 153 /** 154 * The body of an email communication to add to the support case. 155 */ 156 communicationBody: CommunicationBody; 157 /** 158 * The email addresses in the CC line of an email to be added to the support case. 159 */ 160 ccEmailAddresses?: CcEmailAddressList; 161 /** 162 * The ID of a set of one or more attachments for the communication to add to the case. Create the set by calling AddAttachmentsToSet 163 */ 164 attachmentSetId?: AttachmentSetId; 165 } 166 export interface AddCommunicationToCaseResponse { 167 /** 168 * True if AddCommunicationToCase succeeds. Otherwise, returns an error. 169 */ 170 result?: Result; 171 } 172 export type AfterTime = string; 173 export interface Attachment { 174 /** 175 * The name of the attachment file. 176 */ 177 fileName?: FileName; 178 /** 179 * The content of the attachment file. 180 */ 181 data?: Data; 182 } 183 export interface AttachmentDetails { 184 /** 185 * The ID of the attachment. 186 */ 187 attachmentId?: AttachmentId; 188 /** 189 * The file name of the attachment. 190 */ 191 fileName?: FileName; 192 } 193 export type AttachmentId = string; 194 export type AttachmentSet = AttachmentDetails[]; 195 export type AttachmentSetId = string; 196 export type Attachments = Attachment[]; 197 export type BeforeTime = string; 198 export type Boolean = boolean; 199 export interface CaseDetails { 200 /** 201 * The AWS 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 202 */ 203 caseId?: CaseId; 204 /** 205 * The ID displayed for the case in the AWS Support Center. This is a numeric string. 206 */ 207 displayId?: DisplayId; 208 /** 209 * The subject line for the case in the AWS Support Center. 210 */ 211 subject?: Subject; 212 /** 213 * The status of the case. 214 */ 215 status?: Status; 216 /** 217 * The code for the AWS service returned by the call to DescribeServices. 218 */ 219 serviceCode?: ServiceCode; 220 /** 221 * The category of problem for the AWS Support case. 222 */ 223 categoryCode?: CategoryCode; 224 /** 225 * The code for the severity level returned by the call to DescribeSeverityLevels. 226 */ 227 severityCode?: SeverityCode; 228 /** 229 * The email address of the account that submitted the case. 230 */ 231 submittedBy?: SubmittedBy; 232 /** 233 * The time that the case was case created in the AWS Support Center. 234 */ 235 timeCreated?: TimeCreated; 236 /** 237 * The five most recent communications between you and AWS Support Center, including the IDs of any attachments to the communications. Also includes a nextToken that you can use to retrieve earlier communications. 238 */ 239 recentCommunications?: RecentCaseCommunications; 240 /** 241 * The email addresses that receive copies of communication about the case. 242 */ 243 ccEmailAddresses?: CcEmailAddressList; 244 /** 245 * The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them. 246 */ 247 language?: Language; 248 } 249 export type CaseId = string; 250 export type CaseIdList = CaseId[]; 251 export type CaseList = CaseDetails[]; 252 export type CaseStatus = string; 253 export interface Category { 254 /** 255 * The category code for the support case. 256 */ 257 code?: CategoryCode; 258 /** 259 * The category name for the support case. 260 */ 261 name?: CategoryName; 262 } 263 export type CategoryCode = string; 264 export type CategoryList = Category[]; 265 export type CategoryName = string; 266 export type CcEmailAddress = string; 267 export type CcEmailAddressList = CcEmailAddress[]; 268 export interface Communication { 269 /** 270 * The AWS 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 271 */ 272 caseId?: CaseId; 273 /** 274 * The text of the communication between the customer and AWS Support. 275 */ 276 body?: CommunicationBody; 277 /** 278 * The email address of the account that submitted the AWS Support case. 279 */ 280 submittedBy?: SubmittedBy; 281 /** 282 * The time the communication was created. 283 */ 284 timeCreated?: TimeCreated; 285 /** 286 * Information about the attachments to the case communication. 287 */ 288 attachmentSet?: AttachmentSet; 289 } 290 export type CommunicationBody = string; 291 export type CommunicationList = Communication[]; 292 export interface CreateCaseRequest { 293 /** 294 * The title of the AWS Support case. 295 */ 296 subject: Subject; 297 /** 298 * The code for the AWS service returned by the call to DescribeServices. 299 */ 300 serviceCode?: ServiceCode; 301 /** 302 * The code for the severity level returned by the call to DescribeSeverityLevels. The availability of severity levels depends on each customer's support subscription. In other words, your subscription may not necessarily require the urgent level of response time. 303 */ 304 severityCode?: SeverityCode; 305 /** 306 * The category of problem for the AWS Support case. 307 */ 308 categoryCode?: CategoryCode; 309 /** 310 * The communication body text when you create an AWS Support case by calling CreateCase. 311 */ 312 communicationBody: CommunicationBody; 313 /** 314 * A list of email addresses that AWS Support copies on case correspondence. 315 */ 316 ccEmailAddresses?: CcEmailAddressList; 317 /** 318 * The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them. 319 */ 320 language?: Language; 321 /** 322 * The type of issue for the case. You can specify either "customer-service" or "technical." If you do not indicate a value, the default is "technical." 323 */ 324 issueType?: IssueType; 325 /** 326 * The ID of a set of one or more attachments for the case. Create the set by using AddAttachmentsToSet. 327 */ 328 attachmentSetId?: AttachmentSetId; 329 } 330 export interface CreateCaseResponse { 331 /** 332 * The AWS 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 333 */ 334 caseId?: CaseId; 335 } 336 export type Data = Buffer|Uint8Array|Blob|string; 337 export interface DescribeAttachmentRequest { 338 /** 339 * The ID of the attachment to return. Attachment IDs are returned by the DescribeCommunications operation. 340 */ 341 attachmentId: AttachmentId; 342 } 343 export interface DescribeAttachmentResponse { 344 /** 345 * The attachment content and file name. 346 */ 347 attachment?: Attachment; 348 } 349 export interface DescribeCasesRequest { 350 /** 351 * A list of ID numbers of the support cases you want returned. The maximum number of cases is 100. 352 */ 353 caseIdList?: CaseIdList; 354 /** 355 * The ID displayed for a case in the AWS Support Center user interface. 356 */ 357 displayId?: DisplayId; 358 /** 359 * The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation. 360 */ 361 afterTime?: AfterTime; 362 /** 363 * The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation. 364 */ 365 beforeTime?: BeforeTime; 366 /** 367 * Specifies whether resolved support cases should be included in the DescribeCases results. The default is false. 368 */ 369 includeResolvedCases?: IncludeResolvedCases; 370 /** 371 * A resumption point for pagination. 372 */ 373 nextToken?: NextToken; 374 /** 375 * The maximum number of results to return before paginating. 376 */ 377 maxResults?: MaxResults; 378 /** 379 * The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them. 380 */ 381 language?: Language; 382 /** 383 * Specifies whether communications should be included in the DescribeCases results. The default is true. 384 */ 385 includeCommunications?: IncludeCommunications; 386 } 387 export interface DescribeCasesResponse { 388 /** 389 * The details for the cases that match the request. 390 */ 391 cases?: CaseList; 392 /** 393 * A resumption point for pagination. 394 */ 395 nextToken?: NextToken; 396 } 397 export interface DescribeCommunicationsRequest { 398 /** 399 * The AWS 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 400 */ 401 caseId: CaseId; 402 /** 403 * The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation. 404 */ 405 beforeTime?: BeforeTime; 406 /** 407 * The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation. 408 */ 409 afterTime?: AfterTime; 410 /** 411 * A resumption point for pagination. 412 */ 413 nextToken?: NextToken; 414 /** 415 * The maximum number of results to return before paginating. 416 */ 417 maxResults?: MaxResults; 418 } 419 export interface DescribeCommunicationsResponse { 420 /** 421 * The communications for the case. 422 */ 423 communications?: CommunicationList; 424 /** 425 * A resumption point for pagination. 426 */ 427 nextToken?: NextToken; 428 } 429 export interface DescribeServicesRequest { 430 /** 431 * A JSON-formatted list of service codes available for AWS services. 432 */ 433 serviceCodeList?: ServiceCodeList; 434 /** 435 * The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them. 436 */ 437 language?: Language; 438 } 439 export interface DescribeServicesResponse { 440 /** 441 * A JSON-formatted list of AWS services. 442 */ 443 services?: ServiceList; 444 } 445 export interface DescribeSeverityLevelsRequest { 446 /** 447 * The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them. 448 */ 449 language?: Language; 450 } 451 export interface DescribeSeverityLevelsResponse { 452 /** 453 * The available severity levels for the support case. Available severity levels are defined by your service level agreement with AWS. 454 */ 455 severityLevels?: SeverityLevelsList; 456 } 457 export interface DescribeTrustedAdvisorCheckRefreshStatusesRequest { 458 /** 459 * The IDs of the Trusted Advisor checks to get the status of. Note: Specifying the check ID of a check that is automatically refreshed causes an InvalidParameterValue error. 460 */ 461 checkIds: StringList; 462 } 463 export interface DescribeTrustedAdvisorCheckRefreshStatusesResponse { 464 /** 465 * The refresh status of the specified Trusted Advisor checks. 466 */ 467 statuses: TrustedAdvisorCheckRefreshStatusList; 468 } 469 export interface DescribeTrustedAdvisorCheckResultRequest { 470 /** 471 * The unique identifier for the Trusted Advisor check. 472 */ 473 checkId: String; 474 /** 475 * The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them. 476 */ 477 language?: String; 478 } 479 export interface DescribeTrustedAdvisorCheckResultResponse { 480 /** 481 * The detailed results of the Trusted Advisor check. 482 */ 483 result?: TrustedAdvisorCheckResult; 484 } 485 export interface DescribeTrustedAdvisorCheckSummariesRequest { 486 /** 487 * The IDs of the Trusted Advisor checks. 488 */ 489 checkIds: StringList; 490 } 491 export interface DescribeTrustedAdvisorCheckSummariesResponse { 492 /** 493 * The summary information for the requested Trusted Advisor checks. 494 */ 495 summaries: TrustedAdvisorCheckSummaryList; 496 } 497 export interface DescribeTrustedAdvisorChecksRequest { 498 /** 499 * The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them. 500 */ 501 language: String; 502 } 503 export interface DescribeTrustedAdvisorChecksResponse { 504 /** 505 * Information about all available Trusted Advisor checks. 506 */ 507 checks: TrustedAdvisorCheckList; 508 } 509 export type DisplayId = string; 510 export type Double = number; 511 export type ErrorMessage = string; 512 export type ExpiryTime = string; 513 export type FileName = string; 514 export type IncludeCommunications = boolean; 515 export type IncludeResolvedCases = boolean; 516 export type IssueType = string; 517 export type Language = string; 518 export type Long = number; 519 export type MaxResults = number; 520 export type NextToken = string; 521 export interface RecentCaseCommunications { 522 /** 523 * The five most recent communications associated with the case. 524 */ 525 communications?: CommunicationList; 526 /** 527 * A resumption point for pagination. 528 */ 529 nextToken?: NextToken; 530 } 531 export interface RefreshTrustedAdvisorCheckRequest { 532 /** 533 * 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. 534 */ 535 checkId: String; 536 } 537 export interface RefreshTrustedAdvisorCheckResponse { 538 /** 539 * The current refresh status for a check, including the amount of time until the check is eligible for refresh. 540 */ 541 status: TrustedAdvisorCheckRefreshStatus; 542 } 543 export interface ResolveCaseRequest { 544 /** 545 * The AWS 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 546 */ 547 caseId?: CaseId; 548 } 549 export interface ResolveCaseResponse { 550 /** 551 * The status of the case when the ResolveCase request was sent. 552 */ 553 initialCaseStatus?: CaseStatus; 554 /** 555 * The status of the case after the ResolveCase request was processed. 556 */ 557 finalCaseStatus?: CaseStatus; 558 } 559 export type Result = boolean; 560 export interface Service { 561 /** 562 * The code for an AWS service returned by the DescribeServices response. The name element contains the corresponding friendly name. 563 */ 564 code?: ServiceCode; 565 /** 566 * The friendly name for an AWS service. The code element contains the corresponding code. 567 */ 568 name?: ServiceName; 569 /** 570 * 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 AWS Support when you call CreateCase. 571 */ 572 categories?: CategoryList; 573 } 574 export type ServiceCode = string; 575 export type ServiceCodeList = ServiceCode[]; 576 export type ServiceList = Service[]; 577 export type ServiceName = string; 578 export type SeverityCode = string; 579 export interface SeverityLevel { 580 /** 581 * One of four values: "low," "medium," "high," and "urgent". These values correspond to response times returned to the caller in severityLevel.name. 582 */ 583 code?: SeverityLevelCode; 584 /** 585 * The name of the severity level that corresponds to the severity level code. 586 */ 587 name?: SeverityLevelName; 588 } 589 export type SeverityLevelCode = string; 590 export type SeverityLevelName = string; 591 export type SeverityLevelsList = SeverityLevel[]; 592 export type Status = string; 593 export type String = string; 594 export type StringList = String[]; 595 export type Subject = string; 596 export type SubmittedBy = string; 597 export type TimeCreated = string; 598 export interface TrustedAdvisorCategorySpecificSummary { 599 /** 600 * The summary information about cost savings for a Trusted Advisor check that is in the Cost Optimizing category. 601 */ 602 costOptimizing?: TrustedAdvisorCostOptimizingSummary; 603 } 604 export interface TrustedAdvisorCheckDescription { 605 /** 606 * The unique identifier for the Trusted Advisor check. 607 */ 608 id: String; 609 /** 610 * The display name for the Trusted Advisor check. 611 */ 612 name: String; 613 /** 614 * The description of the Trusted Advisor check, which includes the alert criteria and recommended actions (contains HTML markup). 615 */ 616 description: String; 617 /** 618 * The category of the Trusted Advisor check. 619 */ 620 category: String; 621 /** 622 * 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. 623 */ 624 metadata: StringList; 625 } 626 export type TrustedAdvisorCheckList = TrustedAdvisorCheckDescription[]; 627 export interface TrustedAdvisorCheckRefreshStatus { 628 /** 629 * The unique identifier for the Trusted Advisor check. 630 */ 631 checkId: String; 632 /** 633 * The status of the Trusted Advisor check for which a refresh has been requested: "none", "enqueued", "processing", "success", or "abandoned". 634 */ 635 status: String; 636 /** 637 * The amount of time, in milliseconds, until the Trusted Advisor check is eligible for refresh. 638 */ 639 millisUntilNextRefreshable: Long; 640 } 641 export type TrustedAdvisorCheckRefreshStatusList = TrustedAdvisorCheckRefreshStatus[]; 642 export interface TrustedAdvisorCheckResult { 643 /** 644 * The unique identifier for the Trusted Advisor check. 645 */ 646 checkId: String; 647 /** 648 * The time of the last refresh of the check. 649 */ 650 timestamp: String; 651 /** 652 * The alert status of the check: "ok" (green), "warning" (yellow), "error" (red), or "not_available". 653 */ 654 status: String; 655 resourcesSummary: TrustedAdvisorResourcesSummary; 656 /** 657 * Summary information that relates to the category of the check. Cost Optimizing is the only category that is currently supported. 658 */ 659 categorySpecificSummary: TrustedAdvisorCategorySpecificSummary; 660 /** 661 * The details about each resource listed in the check result. 662 */ 663 flaggedResources: TrustedAdvisorResourceDetailList; 664 } 665 export interface TrustedAdvisorCheckSummary { 666 /** 667 * The unique identifier for the Trusted Advisor check. 668 */ 669 checkId: String; 670 /** 671 * The time of the last refresh of the check. 672 */ 673 timestamp: String; 674 /** 675 * The alert status of the check: "ok" (green), "warning" (yellow), "error" (red), or "not_available". 676 */ 677 status: String; 678 /** 679 * Specifies whether the Trusted Advisor check has flagged resources. 680 */ 681 hasFlaggedResources?: Boolean; 682 resourcesSummary: TrustedAdvisorResourcesSummary; 683 /** 684 * Summary information that relates to the category of the check. Cost Optimizing is the only category that is currently supported. 685 */ 686 categorySpecificSummary: TrustedAdvisorCategorySpecificSummary; 687 } 688 export type TrustedAdvisorCheckSummaryList = TrustedAdvisorCheckSummary[]; 689 export interface TrustedAdvisorCostOptimizingSummary { 690 /** 691 * The estimated monthly savings that might be realized if the recommended actions are taken. 692 */ 693 estimatedMonthlySavings: Double; 694 /** 695 * The estimated percentage of savings that might be realized if the recommended actions are taken. 696 */ 697 estimatedPercentMonthlySavings: Double; 698 } 699 export interface TrustedAdvisorResourceDetail { 700 /** 701 * The status code for the resource identified in the Trusted Advisor check. 702 */ 703 status: String; 704 /** 705 * The AWS region in which the identified resource is located. 706 */ 707 region?: String; 708 /** 709 * The unique identifier for the identified resource. 710 */ 711 resourceId: String; 712 /** 713 * Specifies whether the AWS resource was ignored by Trusted Advisor because it was marked as suppressed by the user. 714 */ 715 isSuppressed?: Boolean; 716 /** 717 * 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. 718 */ 719 metadata: StringList; 720 } 721 export type TrustedAdvisorResourceDetailList = TrustedAdvisorResourceDetail[]; 722 export interface TrustedAdvisorResourcesSummary { 723 /** 724 * The number of AWS resources that were analyzed by the Trusted Advisor check. 725 */ 726 resourcesProcessed: Long; 727 /** 728 * The number of AWS resources that were flagged (listed) by the Trusted Advisor check. 729 */ 730 resourcesFlagged: Long; 731 /** 732 * The number of AWS resources ignored by Trusted Advisor because information was unavailable. 733 */ 734 resourcesIgnored: Long; 735 /** 736 * The number of AWS resources ignored by Trusted Advisor because they were marked as suppressed by the user. 737 */ 738 resourcesSuppressed: Long; 739 } 740 /** 741 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. 742 */ 743 export type apiVersion = "2013-04-15"|"latest"|string; 744 export interface ClientApiVersions { 745 /** 746 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. 747 */ 748 apiVersion?: apiVersion; 749 } 750 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; 751 } 752 export = Support;