@aws-sdk/client-marketplace-catalog 3.1111.0 → 3.1113.0

package/dist-types/commands/ListAssessmentsCommand.d.ts

@@ -0,0 +1,132 @@
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { ListAssessmentsRequest, ListAssessmentsResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+/**
+ * @public
+ *
+ * The input for {@link ListAssessmentsCommand}.
+ */
+export interface ListAssessmentsCommandInput extends ListAssessmentsRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListAssessmentsCommand}.
+ */
+export interface ListAssessmentsCommandOutput extends ListAssessmentsResponse, __MetadataBearer {
+}
+declare const ListAssessmentsCommand_base: {
+    new (input: ListAssessmentsCommandInput): import("@smithy/core/client").CommandImpl<ListAssessmentsCommandInput, ListAssessmentsCommandOutput, import("..").MarketplaceCatalogClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
+    new (input: ListAssessmentsCommandInput): import("@smithy/core/client").CommandImpl<ListAssessmentsCommandInput, ListAssessmentsCommandOutput, import("..").MarketplaceCatalogClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
+};
+/**
+ * <p>Returns a paginated list of assessments associated with an entity or change set in
+ *             AWS Marketplace. An <i>assessment</i> is the result of evaluating a
+ *             product or change set against a framework, such as AMI Security or Container
+ *             Security.</p>
+ *          <p>Use the <code>AssessmentTargetFilter</code> to scope results to a specific entity or
+ *             change set, and use <code>FrameworkFilters</code> to scope results to a single
+ *             framework. To retrieve detailed control-level results for an individual assessment, use
+ *             the <code>DescribeAssessment</code> action.</p>
+ *          <p>Results are sorted by assessment creation time in descending order.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { MarketplaceCatalogClient, ListAssessmentsCommand } from "@aws-sdk/client-marketplace-catalog"; // ES Modules import
+ * // const { MarketplaceCatalogClient, ListAssessmentsCommand } = require("@aws-sdk/client-marketplace-catalog"); // CommonJS import
+ * // import type { MarketplaceCatalogClientConfig } from "@aws-sdk/client-marketplace-catalog";
+ * const config = {}; // type is MarketplaceCatalogClientConfig
+ * const client = new MarketplaceCatalogClient(config);
+ * const input = { // ListAssessmentsRequest
+ *   Catalog: "STRING_VALUE", // required
+ *   FrameworkId: "STRING_VALUE",
+ *   AssessmentTargetFilter: { // AssessmentTargetFilter
+ *     EntityId: "STRING_VALUE",
+ *     ChangeSetId: "STRING_VALUE",
+ *   },
+ *   FrameworkFilters: { // FrameworkFilters Union: only one key present
+ *     AMISecurityFilters: { // AMISecurityFilters
+ *       DeliveryOptionId: "STRING_VALUE",
+ *     },
+ *     ContainerSecurityFilters: { // ContainerSecurityFilters
+ *       DeliveryOptionId: "STRING_VALUE",
+ *     },
+ *   },
+ *   MaxResults: Number("int"),
+ *   NextToken: "STRING_VALUE",
+ * };
+ * const command = new ListAssessmentsCommand(input);
+ * const response = await client.send(command);
+ * // { // ListAssessmentsResponse
+ * //   AssessmentSummaryList: [ // AssessmentSummaryList
+ * //     { // AssessmentSummary
+ * //       AssessmentArn: "STRING_VALUE",
+ * //       AssessmentId: "STRING_VALUE",
+ * //       FrameworkId: "STRING_VALUE",
+ * //       AssessmentTargetSummary: { // AssessmentTargetSummary
+ * //         EntityId: "STRING_VALUE",
+ * //         ChangeSetId: "STRING_VALUE",
+ * //       },
+ * //       FrameworkSummary: { // FrameworkSummary Union: only one key present
+ * //         AMISecuritySummary: { // AMISecuritySummary
+ * //           DeliveryOptionId: "STRING_VALUE",
+ * //         },
+ * //         ContainerSecuritySummary: { // ContainerSecuritySummary
+ * //           DeliveryOptionId: "STRING_VALUE",
+ * //         },
+ * //       },
+ * //       AssessmentResult: "PASS" || "FAIL",
+ * //       CreatedAt: "STRING_VALUE",
+ * //       ExpiresAt: "STRING_VALUE",
+ * //     },
+ * //   ],
+ * //   NextToken: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param ListAssessmentsCommandInput - {@link ListAssessmentsCommandInput}
+ * @returns {@link ListAssessmentsCommandOutput}
+ * @see {@link ListAssessmentsCommandInput} for command's `input` shape.
+ * @see {@link ListAssessmentsCommandOutput} for command's `response` shape.
+ * @see {@link MarketplaceCatalogClientResolvedConfig | config} for MarketplaceCatalogClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>Access is denied.</p>
+ *          <p>HTTP status code: 403</p>
+ *
+ * @throws {@link InternalServiceException} (server fault)
+ *  <p>There was an internal service exception.</p>
+ *          <p>HTTP status code: 500</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>Too many requests.</p>
+ *          <p>HTTP status code: 429</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>An error occurred during validation.</p>
+ *          <p>HTTP status code: 422</p>
+ *
+ * @throws {@link MarketplaceCatalogServiceException}
+ * <p>Base exception class for all service exceptions from MarketplaceCatalog service.</p>
+ *
+ *
+ * @public
+ */
+export declare class ListAssessmentsCommand extends ListAssessmentsCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: ListAssessmentsRequest;
+            output: ListAssessmentsResponse;
+        };
+        sdk: {
+            input: ListAssessmentsCommandInput;
+            output: ListAssessmentsCommandOutput;
+        };
+    };
+}

package/dist-types/commands/index.d.ts

@@ -1,9 +1,11 @@
 export * from "./BatchDescribeEntitiesCommand";
 export * from "./CancelChangeSetCommand";
 export * from "./DeleteResourcePolicyCommand";
+export * from "./DescribeAssessmentCommand";
 export * from "./DescribeChangeSetCommand";
 export * from "./DescribeEntityCommand";
 export * from "./GetResourcePolicyCommand";
+export * from "./ListAssessmentsCommand";
 export * from "./ListChangeSetsCommand";
 export * from "./ListEntitiesCommand";
 export * from "./ListTagsForResourceCommand";

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

@@ -38,6 +38,46 @@ export declare const SortOrder: {
  * @public
  */
 export type SortOrder = (typeof SortOrder)[keyof typeof SortOrder];
+/**
+ * @public
+ * @enum
+ */
+export declare const AssessmentResult: {
+    readonly FAIL: "FAIL";
+    readonly PASS: "PASS";
+};
+/**
+ * @public
+ */
+export type AssessmentResult = (typeof AssessmentResult)[keyof typeof AssessmentResult];
+/**
+ * @public
+ * @enum
+ */
+export declare const ValidationExceptionReason: {
+    readonly CANNOT_PARSE: "CannotParse";
+    readonly FIELD_VALIDATION_FAILED: "FieldValidationFailed";
+    readonly OTHER: "Other";
+    readonly UNKNOWN_OPERATION: "UnknownOperation";
+};
+/**
+ * @public
+ */
+export type ValidationExceptionReason = (typeof ValidationExceptionReason)[keyof typeof ValidationExceptionReason];
+/**
+ * @public
+ * @enum
+ */
+export declare const ControlAssessmentResult: {
+    readonly EXEMPTION_PASS: "EXEMPTION_PASS";
+    readonly FAIL: "FAIL";
+    readonly NOT_EXECUTED: "NOT_EXECUTED";
+    readonly PASS: "PASS";
+};
+/**
+ * @public
+ */
+export type ControlAssessmentResult = (typeof ControlAssessmentResult)[keyof typeof ControlAssessmentResult];
 /**
  * @public
  * @enum

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

@@ -1,5 +1,6 @@
 import type { ExceptionOptionType as __ExceptionOptionType } from "@smithy/core/client";
 import { MarketplaceCatalogServiceException as __BaseException } from "./MarketplaceCatalogServiceException";
+import type { ValidationExceptionField } from "./models_0";
 /**
  * <p>Access is denied.</p>
  *          <p>HTTP status code: 403</p>
@@ -51,6 +52,13 @@ export declare class ValidationException extends __BaseException {
     readonly name: "ValidationException";
     readonly $fault: "client";
     Message?: string | undefined;
+    /**
+     * <p>A list of detailed entries describing the request fields that failed
+     *             validation. Present when the failure can be attributed to one or more specific
+     *             fields.</p>
+     * @public
+     */
+    ValidationExceptionFieldList?: ValidationExceptionField[] | undefined;
     /**
      * @internal
      */