aws-sdk 2.667.0 → 2.671.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -12,11 +12,11 @@ declare class Support extends Service {
12
12
  constructor(options?: Support.Types.ClientConfiguration)
13
13
  config: Config & Support.Types.ClientConfiguration;
14
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.
15
+ * Adds one or more attachments to an attachment set. An attachment set is a temporary container for attachments that you add to a case or case communication. The set is available for 1 hour after it's created. The expiryTime returned in the response is when the set expires.
16
16
  */
17
17
  addAttachmentsToSet(params: Support.Types.AddAttachmentsToSetRequest, callback?: (err: AWSError, data: Support.Types.AddAttachmentsToSetResponse) => void): Request<Support.Types.AddAttachmentsToSetResponse, AWSError>;
18
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.
19
+ * Adds one or more attachments to an attachment set. An attachment set is a temporary container for attachments that you add to a case or case communication. The set is available for 1 hour after it's created. The expiryTime returned in the response is when the set expires.
20
20
  */
21
21
  addAttachmentsToSet(callback?: (err: AWSError, data: Support.Types.AddAttachmentsToSetResponse) => void): Request<Support.Types.AddAttachmentsToSetResponse, AWSError>;
22
22
  /**
@@ -28,19 +28,19 @@ declare class Support extends Service {
28
28
  */
29
29
  addCommunicationToCase(callback?: (err: AWSError, data: Support.Types.AddCommunicationToCaseResponse) => void): Request<Support.Types.AddCommunicationToCaseResponse, AWSError>;
30
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." Service limit increases are not supported by the Support API; you must submit service limit increase requests in Support Center. The caseId is not the displayId that appears in Support Center. You can use the DescribeCases API to get the displayId. serviceCode. The code for an AWS service. You can get the possible serviceCode values by calling DescribeServices. categoryCode. The category for the service defined for the serviceCode value. You also get 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 can get the possible severityCode values by calling DescribeSeverityLevels. For more information about the meaning of the codes, see SeverityLevel and Choosing a Severity. 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.
31
+ * Creates a case in the AWS Support Center. This operation is similar to how you create a case in the AWS Support Center Create Case page. The AWS Support API doesn't support requesting service limit increases. You can submit a service limit increase in the following ways: Submit a request from the AWS Support Center Create Case page. Use the Service Quotas RequestServiceQuotaIncrease operation. A successful CreateCase request returns an AWS Support case number. You can use the DescribeCases operation and specify the case number to get existing AWS Support cases. After you create a case, you can use the AddCommunicationToCase operation to add additional communication or attachments to an existing case. The caseId is separate from the displayId that appears in the Support Center. You can use the DescribeCases operation to get the displayId.
32
32
  */
33
33
  createCase(params: Support.Types.CreateCaseRequest, callback?: (err: AWSError, data: Support.Types.CreateCaseResponse) => void): Request<Support.Types.CreateCaseResponse, AWSError>;
34
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." Service limit increases are not supported by the Support API; you must submit service limit increase requests in Support Center. The caseId is not the displayId that appears in Support Center. You can use the DescribeCases API to get the displayId. serviceCode. The code for an AWS service. You can get the possible serviceCode values by calling DescribeServices. categoryCode. The category for the service defined for the serviceCode value. You also get 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 can get the possible severityCode values by calling DescribeSeverityLevels. For more information about the meaning of the codes, see SeverityLevel and Choosing a Severity. 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.
35
+ * Creates a case in the AWS Support Center. This operation is similar to how you create a case in the AWS Support Center Create Case page. The AWS Support API doesn't support requesting service limit increases. You can submit a service limit increase in the following ways: Submit a request from the AWS Support Center Create Case page. Use the Service Quotas RequestServiceQuotaIncrease operation. A successful CreateCase request returns an AWS Support case number. You can use the DescribeCases operation and specify the case number to get existing AWS Support cases. After you create a case, you can use the AddCommunicationToCase operation to add additional communication or attachments to an existing case. The caseId is separate from the displayId that appears in the Support Center. You can use the DescribeCases operation to get the displayId.
36
36
  */
37
37
  createCase(callback?: (err: AWSError, data: Support.Types.CreateCaseResponse) => void): Request<Support.Types.CreateCaseResponse, AWSError>;
38
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.
39
+ * Returns the attachment that has the specified ID. Attachments can include screenshots, error logs, or other files that describe your issue. Attachment IDs are generated by the case management system when you add an attachment to a case or case communication. Attachment IDs are returned in the AttachmentDetails objects that are returned by the DescribeCommunications operation.
40
40
  */
41
41
  describeAttachment(params: Support.Types.DescribeAttachmentRequest, callback?: (err: AWSError, data: Support.Types.DescribeAttachmentResponse) => void): Request<Support.Types.DescribeAttachmentResponse, AWSError>;
42
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.
43
+ * Returns the attachment that has the specified ID. Attachments can include screenshots, error logs, or other files that describe your issue. Attachment IDs are generated by the case management system when you add an attachment to a case or case communication. Attachment IDs are returned in the AttachmentDetails objects that are returned by the DescribeCommunications operation.
44
44
  */
45
45
  describeAttachment(callback?: (err: AWSError, data: Support.Types.DescribeAttachmentResponse) => void): Request<Support.Types.DescribeAttachmentResponse, AWSError>;
46
46
  /**
@@ -131,7 +131,7 @@ declare namespace Support {
131
131
  */
132
132
  attachmentSetId?: AttachmentSetId;
133
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.
134
+ * One or more attachments to add to the set. You can add up to three attachments per set. The size limit is 5 MB per attachment. In the Attachment object, use the data parameter to specify the contents of the attachment file. In the previous request syntax, the value for data appear as blob, which is represented as a base64-encoded string. The value for fileName is the name of the attachment, such as troubleshoot-screenshot.png.
135
135
  */
136
136
  attachments: Attachments;
137
137
  }
@@ -210,7 +210,7 @@ declare namespace Support {
210
210
  */
211
211
  subject?: Subject;
212
212
  /**
213
- * The status of the case. Valid values: resolved | pending-customer-action | opened | unassigned | work-in-progress.
213
+ * The status of the case. Valid values: opened pending-customer-action reopened resolved unassigned work-in-progress
214
214
  */
215
215
  status?: Status;
216
216
  /**
@@ -291,45 +291,45 @@ declare namespace Support {
291
291
  export type CommunicationList = Communication[];
292
292
  export interface CreateCaseRequest {
293
293
  /**
294
- * The title of the AWS Support case.
294
+ * The title of the AWS Support case. The title appears in the Subject field on the AWS Support Center Create Case page.
295
295
  */
296
296
  subject: Subject;
297
297
  /**
298
- * The code for the AWS service returned by the call to DescribeServices.
298
+ * The code for the AWS service. You can use the DescribeServices operation to get the possible serviceCode values.
299
299
  */
300
300
  serviceCode?: ServiceCode;
301
301
  /**
302
- * The code for the severity level returned by the call to DescribeSeverityLevels. The availability of severity levels depends on the support plan for the account.
302
+ * A value that indicates the urgency of the case. This value determines the response time according to your service level agreement with AWS Support. You can use the DescribeSeverityLevels operation to get the possible values for severityCode. For more information, see SeverityLevel and Choosing a Severity in the AWS Support User Guide. The availability of severity levels depends on the support plan for the AWS account.
303
303
  */
304
304
  severityCode?: SeverityCode;
305
305
  /**
306
- * The category of problem for the AWS Support case.
306
+ * The category of problem for the AWS Support case. You also use the DescribeServices operation to get the category code for a service. Each AWS service defines its own set of category codes.
307
307
  */
308
308
  categoryCode?: CategoryCode;
309
309
  /**
310
- * The communication body text when you create an AWS Support case by calling CreateCase.
310
+ * The communication body text that describes the issue. This text appears in the Description field on the AWS Support Center Create Case page.
311
311
  */
312
312
  communicationBody: CommunicationBody;
313
313
  /**
314
- * A list of email addresses that AWS Support copies on case correspondence.
314
+ * A list of email addresses that AWS Support copies on case correspondence. AWS Support identifies the account that creates the case when you specify your AWS credentials in an HTTP POST method or use the AWS SDKs.
315
315
  */
316
316
  ccEmailAddresses?: CcEmailAddressList;
317
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.
318
+ * The language in which AWS Support handles the case. You must specify the ISO 639-1 code for the language parameter if you want support in that language. Currently, English ("en") and Japanese ("ja") are supported.
319
319
  */
320
320
  language?: Language;
321
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." Service limit increases are not supported by the Support API; you must submit service limit increase requests in Support Center.
322
+ * The type of issue for the case. You can specify customer-service or technical. If you don't specify a value, the default is technical.
323
323
  */
324
324
  issueType?: IssueType;
325
325
  /**
326
- * The ID of a set of one or more attachments for the case. Create the set by using AddAttachmentsToSet.
326
+ * The ID of a set of one or more attachments for the case. Create the set by using the AddAttachmentsToSet operation.
327
327
  */
328
328
  attachmentSetId?: AttachmentSetId;
329
329
  }
330
330
  export interface CreateCaseResponse {
331
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
332
+ * The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string in the following format: case-12345678910-2013-c4c1d2bf33c5cf47
333
333
  */
334
334
  caseId?: CaseId;
335
335
  }
@@ -342,7 +342,7 @@ declare namespace Support {
342
342
  }
343
343
  export interface DescribeAttachmentResponse {
344
344
  /**
345
- * The attachment content and file name.
345
+ * This object includes the attachment content and file name. In the previous response syntax, the value for the data parameter appears as blob, which is represented as a base64-encoded string. The value for fileName is the name of the attachment, such as troubleshoot-screenshot.png.
346
346
  */
347
347
  attachment?: Attachment;
348
348
  }
@@ -610,7 +610,7 @@ declare namespace Support {
610
610
  */
611
611
  name: String;
612
612
  /**
613
- * The description of the Trusted Advisor check, which includes the alert criteria and recommended actions (contains HTML markup).
613
+ * The description of the Trusted Advisor check, which includes the alert criteria and recommended operations (contains HTML markup).
614
614
  */
615
615
  description: String;
616
616
  /**
@@ -687,11 +687,11 @@ declare namespace Support {
687
687
  export type TrustedAdvisorCheckSummaryList = TrustedAdvisorCheckSummary[];
688
688
  export interface TrustedAdvisorCostOptimizingSummary {
689
689
  /**
690
- * The estimated monthly savings that might be realized if the recommended actions are taken.
690
+ * The estimated monthly savings that might be realized if the recommended operations are taken.
691
691
  */
692
692
  estimatedMonthlySavings: Double;
693
693
  /**
694
- * The estimated percentage of savings that might be realized if the recommended actions are taken.
694
+ * The estimated percentage of savings that might be realized if the recommended operations are taken.
695
695
  */
696
696
  estimatedPercentMonthlySavings: Double;
697
697
  }
@@ -83,7 +83,7 @@ return /******/ (function(modules) { // webpackBootstrap
83
83
  /**
84
84
  * @constant
85
85
  */
86
- VERSION: '2.667.0',
86
+ VERSION: '2.671.0',
87
87
 
88
88
  /**
89
89
  * @api private