@aws-sdk/client-support 3.296.0 → 3.297.0

package/dist-types/models/models_0.d.ts

@@ -1,6 +1,7 @@
 import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
 import { SupportServiceException as __BaseException } from "./SupportServiceException";
 /**
+ * @public
  * <p>An attachment to a case communication. The attachment consists of the file name and
  *             the content of the file.</p>
  */
@@ -14,6 +15,9 @@ export interface Attachment {
      */
     data?: Uint8Array;
 }
+/**
+ * @public
+ */
 export interface AddAttachmentsToSetRequest {
     /**
      * <p>The ID of the attachment set. If an <code>attachmentSetId</code> is not specified, a
@@ -34,6 +38,7 @@ export interface AddAttachmentsToSetRequest {
     attachments: Attachment[] | undefined;
 }
 /**
+ * @public
  * <p>The ID and expiry time of the attachment set returned by the <a>AddAttachmentsToSet</a> operation.</p>
  */
 export interface AddAttachmentsToSetResponse {
@@ -50,6 +55,7 @@ export interface AddAttachmentsToSetResponse {
     expiryTime?: string;
 }
 /**
+ * @public
  * <p>The limit for the number of attachment sets created in a short period of time has been
  *             exceeded.</p>
  */
@@ -62,6 +68,7 @@ export declare class AttachmentLimitExceeded extends __BaseException {
     constructor(opts: __ExceptionOptionType<AttachmentLimitExceeded, __BaseException>);
 }
 /**
+ * @public
  * <p>The expiration time of the attachment set has passed. The set expires 1 hour after it
  *             is created.</p>
  */
@@ -74,6 +81,7 @@ export declare class AttachmentSetExpired extends __BaseException {
     constructor(opts: __ExceptionOptionType<AttachmentSetExpired, __BaseException>);
 }
 /**
+ * @public
  * <p>An attachment set with the specified ID could not be found.</p>
  */
 export declare class AttachmentSetIdNotFound extends __BaseException {
@@ -85,6 +93,7 @@ export declare class AttachmentSetIdNotFound extends __BaseException {
     constructor(opts: __ExceptionOptionType<AttachmentSetIdNotFound, __BaseException>);
 }
 /**
+ * @public
  * <p>A limit for the size of an attachment set has been exceeded. The limits are three
  *             attachments and 5 MB per attachment.</p>
  */
@@ -97,6 +106,7 @@ export declare class AttachmentSetSizeLimitExceeded extends __BaseException {
     constructor(opts: __ExceptionOptionType<AttachmentSetSizeLimitExceeded, __BaseException>);
 }
 /**
+ * @public
  * <p>An internal server error occurred.</p>
  */
 export declare class InternalServerError extends __BaseException {
@@ -107,6 +117,9 @@ export declare class InternalServerError extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<InternalServerError, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface AddCommunicationToCaseRequest {
     /**
      * <p>The support case ID requested or returned in the call. The case ID is an alphanumeric
@@ -131,6 +144,7 @@ export interface AddCommunicationToCaseRequest {
     attachmentSetId?: string;
 }
 /**
+ * @public
  * <p>The result of the <a>AddCommunicationToCase</a> operation.</p>
  */
 export interface AddCommunicationToCaseResponse {
@@ -141,6 +155,7 @@ export interface AddCommunicationToCaseResponse {
     result?: boolean;
 }
 /**
+ * @public
  * <p>The requested <code>caseId</code> couldn't be located.</p>
  */
 export declare class CaseIdNotFound extends __BaseException {
@@ -152,6 +167,7 @@ export declare class CaseIdNotFound extends __BaseException {
     constructor(opts: __ExceptionOptionType<CaseIdNotFound, __BaseException>);
 }
 /**
+ * @public
  * <p>The file name and ID of an attachment to a case communication. You can use the ID to
  *             retrieve the attachment with the <a>DescribeAttachment</a> operation.</p>
  */
@@ -166,6 +182,7 @@ export interface AttachmentDetails {
     fileName?: string;
 }
 /**
+ * @public
  * <p>An attachment with the specified ID could not be found.</p>
  */
 export declare class AttachmentIdNotFound extends __BaseException {
@@ -177,6 +194,7 @@ export declare class AttachmentIdNotFound extends __BaseException {
     constructor(opts: __ExceptionOptionType<AttachmentIdNotFound, __BaseException>);
 }
 /**
+ * @public
  * <p>The case creation limit for the account has been exceeded.</p>
  */
 export declare class CaseCreationLimitExceeded extends __BaseException {
@@ -187,6 +205,9 @@ export declare class CaseCreationLimitExceeded extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<CaseCreationLimitExceeded, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface CreateCaseRequest {
     /**
      * <p>The title of the support case. The title appears in the <b>Subject</b> field on the Amazon Web Services Support Center <a href="https://console.aws.amazon.com/support/home#/case/create">Create Case</a> page.</p>
@@ -244,6 +265,7 @@ export interface CreateCaseRequest {
     attachmentSetId?: string;
 }
 /**
+ * @public
  * <p>The support case ID returned by a successful completion of the <a>CreateCase</a> operation.</p>
  */
 export interface CreateCaseResponse {
@@ -256,6 +278,7 @@ export interface CreateCaseResponse {
     caseId?: string;
 }
 /**
+ * @public
  * <p>The limit for the number of <a>DescribeAttachment</a> requests in a short
  *             period of time has been exceeded.</p>
  */
@@ -267,6 +290,9 @@ export declare class DescribeAttachmentLimitExceeded extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<DescribeAttachmentLimitExceeded, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface DescribeAttachmentRequest {
     /**
      * <p>The ID of the attachment to return. Attachment IDs are returned by the <a>DescribeCommunications</a> operation.</p>
@@ -274,6 +300,7 @@ export interface DescribeAttachmentRequest {
     attachmentId: string | undefined;
 }
 /**
+ * @public
  * <p>The content and file name of the attachment returned by the <a>DescribeAttachment</a> operation.</p>
  */
 export interface DescribeAttachmentResponse {
@@ -286,6 +313,9 @@ export interface DescribeAttachmentResponse {
      */
     attachment?: Attachment;
 }
+/**
+ * @public
+ */
 export interface DescribeCasesRequest {
     /**
      * <p>A list of ID numbers of the support cases you want returned. The maximum number of
@@ -331,6 +361,7 @@ export interface DescribeCasesRequest {
     includeCommunications?: boolean;
 }
 /**
+ * @public
  * <p>A communication associated with a support case. The communication consists of the case
  *             ID, the message body, attachment information, the submitter of the communication, and
  *             the date and time of the communication.</p>
@@ -365,6 +396,7 @@ export interface Communication {
     attachmentSet?: AttachmentDetails[];
 }
 /**
+ * @public
  * <p>The five most recent communications associated with the case.</p>
  */
 export interface RecentCaseCommunications {
@@ -378,6 +410,7 @@ export interface RecentCaseCommunications {
     nextToken?: string;
 }
 /**
+ * @public
  * <p>A JSON-formatted object that contains the metadata for a support case. It is contained
  *             in the response from a <a>DescribeCases</a> request. <b>CaseDetails</b> contains the following fields:</p>
  *          <ul>
@@ -573,6 +606,7 @@ export interface CaseDetails {
     language?: string;
 }
 /**
+ * @public
  * <p>Returns an array of <a href="https://docs.aws.amazon.com/awssupport/latest/APIReference/API_CaseDetails.html">CaseDetails</a>
  *             objects and a <code>nextToken</code> that defines a point for pagination in the result
  *             set.</p>
@@ -587,6 +621,9 @@ export interface DescribeCasesResponse {
      */
     nextToken?: string;
 }
+/**
+ * @public
+ */
 export interface DescribeCommunicationsRequest {
     /**
      * <p>The support case ID requested or returned in the call. The case ID is an alphanumeric
@@ -615,6 +652,7 @@ export interface DescribeCommunicationsRequest {
     maxResults?: number;
 }
 /**
+ * @public
  * <p>The communications returned by the <a>DescribeCommunications</a>
  *             operation.</p>
  */
@@ -628,6 +666,9 @@ export interface DescribeCommunicationsResponse {
      */
     nextToken?: string;
 }
+/**
+ * @public
+ */
 export interface DescribeServicesRequest {
     /**
      * <p>A JSON-formatted list of service codes available for Amazon Web Services services.</p>
@@ -640,6 +681,7 @@ export interface DescribeServicesRequest {
     language?: string;
 }
 /**
+ * @public
  * <p>A JSON-formatted name/value pair that represents the category name and category code
  *             of the problem, selected from the <a>DescribeServices</a> response for each
  *             Amazon Web Services service.</p>
@@ -655,6 +697,7 @@ export interface Category {
     name?: string;
 }
 /**
+ * @public
  * <p>Information about an Amazon Web Services service returned by the <a>DescribeServices</a>
  *             operation.</p>
  */
@@ -677,6 +720,7 @@ export interface Service {
     categories?: Category[];
 }
 /**
+ * @public
  * <p>The list of Amazon Web Services services returned by the <a>DescribeServices</a>
  *             operation.</p>
  */
@@ -686,6 +730,9 @@ export interface DescribeServicesResponse {
      */
     services?: Service[];
 }
+/**
+ * @public
+ */
 export interface DescribeSeverityLevelsRequest {
     /**
      * <p>The language in which Amazon Web Services Support handles the case. Amazon Web Services Support
@@ -694,6 +741,7 @@ export interface DescribeSeverityLevelsRequest {
     language?: string;
 }
 /**
+ * @public
  * <p>A code and name pair that represents the severity level of a support case. The
  *             available values depend on the support plan for the account. For more information, see
  *                 <a href="https://docs.aws.amazon.com/awssupport/latest/user/case-management.html#choosing-severity">Choosing a
@@ -743,6 +791,7 @@ export interface SeverityLevel {
     name?: string;
 }
 /**
+ * @public
  * <p>The list of severity levels returned by the <a>DescribeSeverityLevels</a>
  *             operation.</p>
  */
@@ -753,6 +802,9 @@ export interface DescribeSeverityLevelsResponse {
      */
     severityLevels?: SeverityLevel[];
 }
+/**
+ * @public
+ */
 export interface DescribeTrustedAdvisorCheckRefreshStatusesRequest {
     /**
      * <p>The IDs of the Trusted Advisor checks to get the status.</p>
@@ -764,6 +816,7 @@ export interface DescribeTrustedAdvisorCheckRefreshStatusesRequest {
     checkIds: string[] | undefined;
 }
 /**
+ * @public
  * <p>The refresh status of a Trusted Advisor check.</p>
  */
 export interface TrustedAdvisorCheckRefreshStatus {
@@ -808,6 +861,7 @@ export interface TrustedAdvisorCheckRefreshStatus {
     millisUntilNextRefreshable: number | undefined;
 }
 /**
+ * @public
  * <p>The statuses of the Trusted Advisor checks returned by the <a>DescribeTrustedAdvisorCheckRefreshStatuses</a> operation.</p>
  */
 export interface DescribeTrustedAdvisorCheckRefreshStatusesResponse {
@@ -817,6 +871,7 @@ export interface DescribeTrustedAdvisorCheckRefreshStatusesResponse {
     statuses: TrustedAdvisorCheckRefreshStatus[] | undefined;
 }
 /**
+ * @public
  * <p></p>
  */
 export interface DescribeTrustedAdvisorCheckResultRequest {
@@ -878,6 +933,7 @@ export interface DescribeTrustedAdvisorCheckResultRequest {
     language?: string;
 }
 /**
+ * @public
  * <p>The estimated cost savings that might be realized if the recommended operations are
  *             taken.</p>
  */
@@ -894,6 +950,7 @@ export interface TrustedAdvisorCostOptimizingSummary {
     estimatedPercentMonthlySavings: number | undefined;
 }
 /**
+ * @public
  * <p>The container for summary information that relates to the category of the Trusted Advisor
  *             check.</p>
  */
@@ -905,6 +962,7 @@ export interface TrustedAdvisorCategorySpecificSummary {
     costOptimizing?: TrustedAdvisorCostOptimizingSummary;
 }
 /**
+ * @public
  * <p>Contains information about a resource identified by a Trusted Advisor check.</p>
  */
 export interface TrustedAdvisorResourceDetail {
@@ -934,6 +992,7 @@ export interface TrustedAdvisorResourceDetail {
     metadata: string[] | undefined;
 }
 /**
+ * @public
  * <p>Details about Amazon Web Services resources that were analyzed in a call to Trusted Advisor <a>DescribeTrustedAdvisorCheckSummaries</a>.</p>
  */
 export interface TrustedAdvisorResourcesSummary {
@@ -957,6 +1016,7 @@ export interface TrustedAdvisorResourcesSummary {
     resourcesSuppressed: number | undefined;
 }
 /**
+ * @public
  * <p>The results of a Trusted Advisor check returned by <a>DescribeTrustedAdvisorCheckResult</a>.</p>
  */
 export interface TrustedAdvisorCheckResult {
@@ -988,6 +1048,7 @@ export interface TrustedAdvisorCheckResult {
     flaggedResources: TrustedAdvisorResourceDetail[] | undefined;
 }
 /**
+ * @public
  * <p>The result of the Trusted Advisor check returned by the <a>DescribeTrustedAdvisorCheckResult</a> operation.</p>
  */
 export interface DescribeTrustedAdvisorCheckResultResponse {
@@ -996,6 +1057,9 @@ export interface DescribeTrustedAdvisorCheckResultResponse {
      */
     result?: TrustedAdvisorCheckResult;
 }
+/**
+ * @public
+ */
 export interface DescribeTrustedAdvisorChecksRequest {
     /**
      * <p>The ISO 639-1 code for the language that you want your checks to appear in.</p>
@@ -1050,6 +1114,7 @@ export interface DescribeTrustedAdvisorChecksRequest {
     language: string | undefined;
 }
 /**
+ * @public
  * <p>The description and metadata for a Trusted Advisor check.</p>
  */
 export interface TrustedAdvisorCheckDescription {
@@ -1080,6 +1145,7 @@ export interface TrustedAdvisorCheckDescription {
     metadata: string[] | undefined;
 }
 /**
+ * @public
  * <p>Information about the Trusted Advisor checks returned by the <a>DescribeTrustedAdvisorChecks</a> operation.</p>
  */
 export interface DescribeTrustedAdvisorChecksResponse {
@@ -1088,6 +1154,9 @@ export interface DescribeTrustedAdvisorChecksResponse {
      */
     checks: TrustedAdvisorCheckDescription[] | undefined;
 }
+/**
+ * @public
+ */
 export interface DescribeTrustedAdvisorCheckSummariesRequest {
     /**
      * <p>The IDs of the Trusted Advisor checks.</p>
@@ -1095,6 +1164,7 @@ export interface DescribeTrustedAdvisorCheckSummariesRequest {
     checkIds: string[] | undefined;
 }
 /**
+ * @public
  * <p>A summary of a Trusted Advisor check result, including the alert status, last refresh, and
  *             number of resources examined.</p>
  */
@@ -1127,6 +1197,7 @@ export interface TrustedAdvisorCheckSummary {
     categorySpecificSummary: TrustedAdvisorCategorySpecificSummary | undefined;
 }
 /**
+ * @public
  * <p>The summaries of the Trusted Advisor checks returned by the <a>DescribeTrustedAdvisorCheckSummaries</a> operation.</p>
  */
 export interface DescribeTrustedAdvisorCheckSummariesResponse {
@@ -1136,6 +1207,7 @@ export interface DescribeTrustedAdvisorCheckSummariesResponse {
     summaries: TrustedAdvisorCheckSummary[] | undefined;
 }
 /**
+ * @public
  * <p></p>
  */
 export interface RefreshTrustedAdvisorCheckRequest {
@@ -1149,6 +1221,7 @@ export interface RefreshTrustedAdvisorCheckRequest {
     checkId: string | undefined;
 }
 /**
+ * @public
  * <p>The current refresh status of a Trusted Advisor check.</p>
  */
 export interface RefreshTrustedAdvisorCheckResponse {
@@ -1158,6 +1231,9 @@ export interface RefreshTrustedAdvisorCheckResponse {
      */
     status: TrustedAdvisorCheckRefreshStatus | undefined;
 }
+/**
+ * @public
+ */
 export interface ResolveCaseRequest {
     /**
      * <p>The support case ID requested or returned in the call. The case ID is an alphanumeric
@@ -1168,6 +1244,7 @@ export interface ResolveCaseRequest {
     caseId?: string;
 }
 /**
+ * @public
  * <p>The status of the case returned by the <a>ResolveCase</a> operation.</p>
  */
 export interface ResolveCaseResponse {

package/dist-types/pagination/DescribeCasesPaginator.d.ts

@@ -1,4 +1,7 @@
 import { Paginator } from "@aws-sdk/types";
 import { DescribeCasesCommandInput, DescribeCasesCommandOutput } from "../commands/DescribeCasesCommand";
 import { SupportPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
 export declare function paginateDescribeCases(config: SupportPaginationConfiguration, input: DescribeCasesCommandInput, ...additionalArguments: any): Paginator<DescribeCasesCommandOutput>;

package/dist-types/pagination/DescribeCommunicationsPaginator.d.ts

@@ -1,4 +1,7 @@
 import { Paginator } from "@aws-sdk/types";
 import { DescribeCommunicationsCommandInput, DescribeCommunicationsCommandOutput } from "../commands/DescribeCommunicationsCommand";
 import { SupportPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
 export declare function paginateDescribeCommunications(config: SupportPaginationConfiguration, input: DescribeCommunicationsCommandInput, ...additionalArguments: any): Paginator<DescribeCommunicationsCommandOutput>;

package/dist-types/pagination/Interfaces.d.ts

@@ -1,5 +1,8 @@
 import { PaginationConfiguration } from "@aws-sdk/types";
 import { SupportClient } from "../SupportClient";
+/**
+ * @public
+ */
 export interface SupportPaginationConfiguration extends PaginationConfiguration {
     client: SupportClient;
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-support",
   "description": "AWS SDK for JavaScript Support Client for Node.js, Browser and React Native",
-  "version": "3.296.0",
+  "version": "3.297.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -20,9 +20,9 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "3.0.0",
     "@aws-crypto/sha256-js": "3.0.0",
-    "@aws-sdk/client-sts": "3.296.0",
+    "@aws-sdk/client-sts": "3.297.0",
     "@aws-sdk/config-resolver": "3.296.0",
-    "@aws-sdk/credential-provider-node": "3.296.0",
+    "@aws-sdk/credential-provider-node": "3.297.0",
     "@aws-sdk/fetch-http-handler": "3.296.0",
     "@aws-sdk/hash-node": "3.296.0",
     "@aws-sdk/invalid-dependency": "3.296.0",