@aws-sdk/client-marketplace-agreement 3.463.0

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

@@ -0,0 +1,213 @@
+import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
+import { Command as $Command } from "@smithy/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
+import { MarketplaceAgreementClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../MarketplaceAgreementClient";
+import { SearchAgreementsInput, SearchAgreementsOutput } from "../models/models_0";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link SearchAgreementsCommand}.
+ */
+export interface SearchAgreementsCommandInput extends SearchAgreementsInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link SearchAgreementsCommand}.
+ */
+export interface SearchAgreementsCommandOutput extends SearchAgreementsOutput, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Searches across all agreements that a proposer or an acceptor has in AWS Marketplace. The search returns a list of agreements with basic agreement information.</p>
+ *          <p>The following filter combinations are supported:</p>
+ *          <ul>
+ *             <li>
+ *                <p>
+ *                   <code>PartyType</code> as <code>Proposer</code> + <code>AgreementType</code> +
+ *                   <code>ResourceIdentifier</code>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <code>PartyType</code> as <code>Proposer</code> + <code>AgreementType</code> +
+ *                   <code>OfferId</code>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <code>PartyType</code> as <code>Proposer</code> + <code>AgreementType</code> +
+ *                   <code>AcceptorAccountId</code>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <code>PartyType</code> as <code>Proposer</code> + <code>AgreementType</code> +
+ *                   <code>Status</code>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <code>PartyType</code> as <code>Proposer</code> + <code>AgreementType</code> +
+ *                   <code>ResourceIdentifier</code> + <code>Status</code>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <code>PartyType</code> as <code>Proposer</code> + <code>AgreementType</code> +
+ *                   <code>OfferId</code> + <code>Status</code>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <code>PartyType</code> as <code>Proposer</code> + <code>AgreementType</code> +
+ *                   <code>AcceptorAccountId</code> + <code>Status</code>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <code>PartyType</code> as <code>Proposer</code> + <code>AgreementType</code> +
+ *                   <code>ResourceType</code> + <code>Status</code>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <code>PartyType</code> as <code>Proposer</code> + <code>AgreementType</code> +
+ *                   <code>AcceptorAccountId</code> + <code>ResourceType</code> +
+ *                <code>Status</code>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <code>PartyType</code> as <code>Proposer</code> + <code>AgreementType</code> +
+ *                   <code>AcceptorAccountId</code> + <code>OfferId</code>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <code>PartyType</code> as <code>Proposer</code> + <code>AgreementType</code> +
+ *                   <code>AcceptorAccountId</code> + <code>OfferId</code> + <code>Status</code>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <code>PartyType</code> as <code>Proposer</code> + <code>AgreementType</code> +
+ *                   <code>AcceptorAccountId</code> + <code>ResourceIdentifier</code>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <code>PartyType</code> as <code>Proposer</code> + <code>AgreementType</code> +
+ *                   <code>AcceptorAccountId</code> + <code>ResourceIdentifier</code> +
+ *                   <code>Status</code>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <code>PartyType</code> as <code>Proposer</code> + <code>AgreementType</code> +
+ *                   <code>AcceptorAccountId</code> + <code>ResourceType</code>
+ *                </p>
+ *             </li>
+ *          </ul>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { MarketplaceAgreementClient, SearchAgreementsCommand } from "@aws-sdk/client-marketplace-agreement"; // ES Modules import
+ * // const { MarketplaceAgreementClient, SearchAgreementsCommand } = require("@aws-sdk/client-marketplace-agreement"); // CommonJS import
+ * const client = new MarketplaceAgreementClient(config);
+ * const input = { // SearchAgreementsInput
+ *   catalog: "STRING_VALUE",
+ *   filters: [ // FilterList
+ *     { // Filter
+ *       name: "STRING_VALUE",
+ *       values: [ // FilterValueList
+ *         "STRING_VALUE",
+ *       ],
+ *     },
+ *   ],
+ *   sort: { // Sort
+ *     sortBy: "STRING_VALUE",
+ *     sortOrder: "ASCENDING" || "DESCENDING",
+ *   },
+ *   maxResults: Number("int"),
+ *   nextToken: "STRING_VALUE",
+ * };
+ * const command = new SearchAgreementsCommand(input);
+ * const response = await client.send(command);
+ * // { // SearchAgreementsOutput
+ * //   agreementViewSummaries: [ // AgreementViewSummaryList
+ * //     { // AgreementViewSummary
+ * //       agreementId: "STRING_VALUE",
+ * //       acceptanceTime: new Date("TIMESTAMP"),
+ * //       startTime: new Date("TIMESTAMP"),
+ * //       endTime: new Date("TIMESTAMP"),
+ * //       agreementType: "STRING_VALUE",
+ * //       acceptor: { // Acceptor
+ * //         accountId: "STRING_VALUE",
+ * //       },
+ * //       proposer: { // Proposer
+ * //         accountId: "STRING_VALUE",
+ * //       },
+ * //       proposalSummary: { // ProposalSummary
+ * //         resources: [ // Resources
+ * //           { // Resource
+ * //             id: "STRING_VALUE",
+ * //             type: "STRING_VALUE",
+ * //           },
+ * //         ],
+ * //         offerId: "STRING_VALUE",
+ * //       },
+ * //       status: "ACTIVE" || "ARCHIVED" || "CANCELLED" || "EXPIRED" || "RENEWED" || "REPLACED" || "ROLLED_BACK" || "SUPERSEDED" || "TERMINATED",
+ * //     },
+ * //   ],
+ * //   nextToken: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param SearchAgreementsCommandInput - {@link SearchAgreementsCommandInput}
+ * @returns {@link SearchAgreementsCommandOutput}
+ * @see {@link SearchAgreementsCommandInput} for command's `input` shape.
+ * @see {@link SearchAgreementsCommandOutput} for command's `response` shape.
+ * @see {@link MarketplaceAgreementClientResolvedConfig | config} for MarketplaceAgreementClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>User does not have sufficient access to perform this action.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>Unexpected error during processing of request.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>Request was denied due to request throttling.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The input fails to satisfy the constraints specified by the service.</p>
+ *
+ * @throws {@link MarketplaceAgreementServiceException}
+ * <p>Base exception class for all service exceptions from MarketplaceAgreement service.</p>
+ *
+ */
+export declare class SearchAgreementsCommand extends $Command<SearchAgreementsCommandInput, SearchAgreementsCommandOutput, MarketplaceAgreementClientResolvedConfig> {
+    readonly input: SearchAgreementsCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: SearchAgreementsCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: MarketplaceAgreementClientResolvedConfig, options?: __HttpHandlerOptions): Handler<SearchAgreementsCommandInput, SearchAgreementsCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -0,0 +1,3 @@
+export * from "./DescribeAgreementCommand";
+export * from "./GetAgreementTermsCommand";
+export * from "./SearchAgreementsCommand";

package/dist-types/endpoint/EndpointParameters.d.ts

@@ -0,0 +1,22 @@
+import { Endpoint, EndpointParameters as __EndpointParameters, EndpointV2, Provider } from "@smithy/types";
+/**
+ * @public
+ */
+export interface ClientInputEndpointParameters {
+    region?: string | Provider<string>;
+    useDualstackEndpoint?: boolean | Provider<boolean>;
+    useFipsEndpoint?: boolean | Provider<boolean>;
+    endpoint?: string | Provider<string> | Endpoint | Provider<Endpoint> | EndpointV2 | Provider<EndpointV2>;
+}
+export type ClientResolvedEndpointParameters = ClientInputEndpointParameters & {
+    defaultSigningName: string;
+};
+export declare const resolveClientEndpointParameters: <T>(options: T & ClientInputEndpointParameters) => T & ClientInputEndpointParameters & {
+    defaultSigningName: string;
+};
+export interface EndpointParameters extends __EndpointParameters {
+    Region?: string;
+    UseDualStack?: boolean;
+    UseFIPS?: boolean;
+    Endpoint?: string;
+}

package/dist-types/endpoint/endpointResolver.d.ts

@@ -0,0 +1,5 @@
+import { EndpointV2, Logger } from "@smithy/types";
+import { EndpointParameters } from "./EndpointParameters";
+export declare const defaultEndpointResolver: (endpointParams: EndpointParameters, context?: {
+    logger?: Logger;
+}) => EndpointV2;

package/dist-types/endpoint/ruleset.d.ts

@@ -0,0 +1,2 @@
+import { RuleSetObject } from "@smithy/types";
+export declare const ruleSet: RuleSetObject;

package/dist-types/extensionConfiguration.d.ts

@@ -0,0 +1,8 @@
+import { AwsRegionExtensionConfiguration } from "@aws-sdk/types";
+import { HttpHandlerExtensionConfiguration } from "@smithy/protocol-http";
+import { DefaultExtensionConfiguration } from "@smithy/types";
+/**
+ * @internal
+ */
+export interface MarketplaceAgreementExtensionConfiguration extends HttpHandlerExtensionConfiguration, DefaultExtensionConfiguration, AwsRegionExtensionConfiguration {
+}

package/dist-types/index.d.ts

@@ -0,0 +1,35 @@
+/**
+ * <p>AWS Marketplace is a curated digital catalog that customers can use to find, buy, deploy, and manage third-party software, data, and services to build solutions and run their businesses. The AWS Marketplace Agreement Service provides an API interface that helps AWS Marketplace sellers manage their product-related agreements, including listing, searching, and filtering agreements.</p>
+ *          <p>To manage agreements in AWS Marketplace, you must ensure that your AWS Identity and
+ *          Access Management (IAM) policies and roles are set up. The user must have the required
+ *          policies/permissions that allow them to carry out the actions in AWS:</p>
+ *          <ul>
+ *             <li>
+ *                <p>
+ *                   <code>DescribeAgreement</code> – Grants permission to users to obtain detailed
+ *                meta data about any of their agreements.</p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <code>GetAgreementTerms</code> – Grants permission to users to obtain details
+ *                about the terms of an agreement.</p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <code>SearchAgreements</code> – Grants permission to users to search through all
+ *                their agreements.</p>
+ *             </li>
+ *          </ul>
+ *
+ * @packageDocumentation
+ */
+export * from "./MarketplaceAgreementClient";
+export * from "./MarketplaceAgreement";
+export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
+export { RuntimeExtension } from "./runtimeExtensions";
+export { MarketplaceAgreementExtensionConfiguration } from "./extensionConfiguration";
+export * from "./commands";
+export * from "./pagination";
+export * from "./models";
+import "@aws-sdk/util-endpoints";
+export { MarketplaceAgreementServiceException } from "./models/MarketplaceAgreementServiceException";

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

@@ -0,0 +1,13 @@
+import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@smithy/smithy-client";
+export { __ServiceException, __ServiceExceptionOptions };
+/**
+ * @public
+ *
+ * Base exception class for all service exceptions from MarketplaceAgreement service.
+ */
+export declare class MarketplaceAgreementServiceException extends __ServiceException {
+    /**
+     * @internal
+     */
+    constructor(options: __ServiceExceptionOptions);
+}

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

@@ -0,0 +1 @@
+export * from "./models_0";