-
Notifications
You must be signed in to change notification settings - Fork 594
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(client-artifact): Add support for listing active customer agreem…
…ents for the calling AWS Account.
- Loading branch information
awstools
committed
Dec 11, 2024
1 parent
056dae2
commit 5c0fbe3
Showing
14 changed files
with
779 additions
and
93 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
126 changes: 126 additions & 0 deletions
126
clients/client-artifact/src/commands/ListCustomerAgreementsCommand.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,126 @@ | ||
// smithy-typescript generated code | ||
import { getEndpointPlugin } from "@smithy/middleware-endpoint"; | ||
import { getSerdePlugin } from "@smithy/middleware-serde"; | ||
import { Command as $Command } from "@smithy/smithy-client"; | ||
import { MetadataBearer as __MetadataBearer } from "@smithy/types"; | ||
|
||
import { ArtifactClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ArtifactClient"; | ||
import { commonParams } from "../endpoint/EndpointParameters"; | ||
import { ListCustomerAgreementsRequest, ListCustomerAgreementsResponse } from "../models/models_0"; | ||
import { de_ListCustomerAgreementsCommand, se_ListCustomerAgreementsCommand } from "../protocols/Aws_restJson1"; | ||
|
||
/** | ||
* @public | ||
*/ | ||
export type { __MetadataBearer }; | ||
export { $Command }; | ||
/** | ||
* @public | ||
* | ||
* The input for {@link ListCustomerAgreementsCommand}. | ||
*/ | ||
export interface ListCustomerAgreementsCommandInput extends ListCustomerAgreementsRequest {} | ||
/** | ||
* @public | ||
* | ||
* The output of {@link ListCustomerAgreementsCommand}. | ||
*/ | ||
export interface ListCustomerAgreementsCommandOutput extends ListCustomerAgreementsResponse, __MetadataBearer {} | ||
|
||
/** | ||
* <p>List active customer-agreements applicable to calling identity.</p> | ||
* @example | ||
* Use a bare-bones client and the command you need to make an API call. | ||
* ```javascript | ||
* import { ArtifactClient, ListCustomerAgreementsCommand } from "@aws-sdk/client-artifact"; // ES Modules import | ||
* // const { ArtifactClient, ListCustomerAgreementsCommand } = require("@aws-sdk/client-artifact"); // CommonJS import | ||
* const client = new ArtifactClient(config); | ||
* const input = { // ListCustomerAgreementsRequest | ||
* maxResults: Number("int"), | ||
* nextToken: "STRING_VALUE", | ||
* }; | ||
* const command = new ListCustomerAgreementsCommand(input); | ||
* const response = await client.send(command); | ||
* // { // ListCustomerAgreementsResponse | ||
* // customerAgreements: [ // CustomerAgreementList // required | ||
* // { // CustomerAgreementSummary | ||
* // name: "STRING_VALUE", | ||
* // arn: "STRING_VALUE", | ||
* // id: "STRING_VALUE", | ||
* // agreementArn: "STRING_VALUE", | ||
* // awsAccountId: "STRING_VALUE", | ||
* // organizationArn: "STRING_VALUE", | ||
* // effectiveStart: new Date("TIMESTAMP"), | ||
* // effectiveEnd: new Date("TIMESTAMP"), | ||
* // state: "ACTIVE" || "CUSTOMER_TERMINATED" || "AWS_TERMINATED", | ||
* // description: "STRING_VALUE", | ||
* // acceptanceTerms: [ // AgreementTerms | ||
* // "STRING_VALUE", | ||
* // ], | ||
* // terminateTerms: [ | ||
* // "STRING_VALUE", | ||
* // ], | ||
* // type: "CUSTOM" || "DEFAULT" || "MODIFIED", | ||
* // }, | ||
* // ], | ||
* // nextToken: "STRING_VALUE", | ||
* // }; | ||
* | ||
* ``` | ||
* | ||
* @param ListCustomerAgreementsCommandInput - {@link ListCustomerAgreementsCommandInput} | ||
* @returns {@link ListCustomerAgreementsCommandOutput} | ||
* @see {@link ListCustomerAgreementsCommandInput} for command's `input` shape. | ||
* @see {@link ListCustomerAgreementsCommandOutput} for command's `response` shape. | ||
* @see {@link ArtifactClientResolvedConfig | config} for ArtifactClient'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>An unknown server exception has occurred.</p> | ||
* | ||
* @throws {@link ThrottlingException} (client fault) | ||
* <p>Request was denied due to request throttling.</p> | ||
* | ||
* @throws {@link ValidationException} (client fault) | ||
* <p>Request fails to satisfy the constraints specified by an AWS service.</p> | ||
* | ||
* @throws {@link ArtifactServiceException} | ||
* <p>Base exception class for all service exceptions from Artifact service.</p> | ||
* | ||
* @public | ||
*/ | ||
export class ListCustomerAgreementsCommand extends $Command | ||
.classBuilder< | ||
ListCustomerAgreementsCommandInput, | ||
ListCustomerAgreementsCommandOutput, | ||
ArtifactClientResolvedConfig, | ||
ServiceInputTypes, | ||
ServiceOutputTypes | ||
>() | ||
.ep(commonParams) | ||
.m(function (this: any, Command: any, cs: any, config: ArtifactClientResolvedConfig, o: any) { | ||
return [ | ||
getSerdePlugin(config, this.serialize, this.deserialize), | ||
getEndpointPlugin(config, Command.getEndpointParameterInstructions()), | ||
]; | ||
}) | ||
.s("Artifact", "ListCustomerAgreements", {}) | ||
.n("ArtifactClient", "ListCustomerAgreementsCommand") | ||
.f(void 0, void 0) | ||
.ser(se_ListCustomerAgreementsCommand) | ||
.de(de_ListCustomerAgreementsCommand) | ||
.build() { | ||
/** @internal type navigation helper, not in runtime. */ | ||
protected declare static __types: { | ||
api: { | ||
input: ListCustomerAgreementsRequest; | ||
output: ListCustomerAgreementsResponse; | ||
}; | ||
sdk: { | ||
input: ListCustomerAgreementsCommandInput; | ||
output: ListCustomerAgreementsCommandOutput; | ||
}; | ||
}; | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.