@aws-sdk/client-partnercentral-selling 3.699.0 → 3.709.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.
- package/README.md +206 -45
- package/dist-cjs/PartnerCentralSelling.js +42 -0
- package/dist-cjs/commands/AcceptEngagementInvitationCommand.js +26 -0
- package/dist-cjs/commands/CreateEngagementCommand.js +27 -0
- package/dist-cjs/commands/CreateEngagementInvitationCommand.js +27 -0
- package/dist-cjs/commands/CreateResourceSnapshotCommand.js +26 -0
- package/dist-cjs/commands/CreateResourceSnapshotJobCommand.js +26 -0
- package/dist-cjs/commands/DeleteResourceSnapshotJobCommand.js +26 -0
- package/dist-cjs/commands/GetEngagementCommand.js +27 -0
- package/dist-cjs/commands/GetResourceSnapshotCommand.js +27 -0
- package/dist-cjs/commands/GetResourceSnapshotJobCommand.js +26 -0
- package/dist-cjs/commands/GetSellingSystemSettingsCommand.js +26 -0
- package/dist-cjs/commands/ListEngagementByAcceptingInvitationTasksCommand.js +26 -0
- package/dist-cjs/commands/ListEngagementFromOpportunityTasksCommand.js +26 -0
- package/dist-cjs/commands/ListEngagementInvitationsCommand.js +1 -1
- package/dist-cjs/commands/ListEngagementMembersCommand.js +27 -0
- package/dist-cjs/commands/ListEngagementResourceAssociationsCommand.js +27 -0
- package/dist-cjs/commands/ListEngagementsCommand.js +27 -0
- package/dist-cjs/commands/ListResourceSnapshotJobsCommand.js +26 -0
- package/dist-cjs/commands/ListResourceSnapshotsCommand.js +27 -0
- package/dist-cjs/commands/PutSellingSystemSettingsCommand.js +26 -0
- package/dist-cjs/commands/StartResourceSnapshotJobCommand.js +26 -0
- package/dist-cjs/commands/StopResourceSnapshotJobCommand.js +26 -0
- package/dist-cjs/commands/SubmitOpportunityCommand.js +26 -0
- package/dist-cjs/commands/index.js +21 -0
- package/dist-cjs/models/models_0.js +281 -87
- package/dist-cjs/pagination/ListEngagementByAcceptingInvitationTasksPaginator.js +7 -0
- package/dist-cjs/pagination/ListEngagementFromOpportunityTasksPaginator.js +7 -0
- package/dist-cjs/pagination/ListEngagementMembersPaginator.js +7 -0
- package/dist-cjs/pagination/ListEngagementResourceAssociationsPaginator.js +7 -0
- package/dist-cjs/pagination/ListEngagementsPaginator.js +7 -0
- package/dist-cjs/pagination/ListResourceSnapshotJobsPaginator.js +7 -0
- package/dist-cjs/pagination/ListResourceSnapshotsPaginator.js +7 -0
- package/dist-cjs/pagination/index.js +7 -0
- package/dist-cjs/protocols/Aws_json1_0.js +599 -1
- package/dist-es/PartnerCentralSelling.js +42 -0
- package/dist-es/commands/AcceptEngagementInvitationCommand.js +22 -0
- package/dist-es/commands/CreateEngagementCommand.js +23 -0
- package/dist-es/commands/CreateEngagementInvitationCommand.js +23 -0
- package/dist-es/commands/CreateResourceSnapshotCommand.js +22 -0
- package/dist-es/commands/CreateResourceSnapshotJobCommand.js +22 -0
- package/dist-es/commands/DeleteResourceSnapshotJobCommand.js +22 -0
- package/dist-es/commands/GetEngagementCommand.js +23 -0
- package/dist-es/commands/GetResourceSnapshotCommand.js +23 -0
- package/dist-es/commands/GetResourceSnapshotJobCommand.js +22 -0
- package/dist-es/commands/GetSellingSystemSettingsCommand.js +22 -0
- package/dist-es/commands/ListEngagementByAcceptingInvitationTasksCommand.js +22 -0
- package/dist-es/commands/ListEngagementFromOpportunityTasksCommand.js +22 -0
- package/dist-es/commands/ListEngagementInvitationsCommand.js +2 -2
- package/dist-es/commands/ListEngagementMembersCommand.js +23 -0
- package/dist-es/commands/ListEngagementResourceAssociationsCommand.js +23 -0
- package/dist-es/commands/ListEngagementsCommand.js +23 -0
- package/dist-es/commands/ListResourceSnapshotJobsCommand.js +22 -0
- package/dist-es/commands/ListResourceSnapshotsCommand.js +23 -0
- package/dist-es/commands/PutSellingSystemSettingsCommand.js +22 -0
- package/dist-es/commands/StartResourceSnapshotJobCommand.js +22 -0
- package/dist-es/commands/StopResourceSnapshotJobCommand.js +22 -0
- package/dist-es/commands/SubmitOpportunityCommand.js +22 -0
- package/dist-es/commands/index.js +21 -0
- package/dist-es/models/models_0.js +249 -81
- package/dist-es/pagination/ListEngagementByAcceptingInvitationTasksPaginator.js +4 -0
- package/dist-es/pagination/ListEngagementFromOpportunityTasksPaginator.js +4 -0
- package/dist-es/pagination/ListEngagementMembersPaginator.js +4 -0
- package/dist-es/pagination/ListEngagementResourceAssociationsPaginator.js +4 -0
- package/dist-es/pagination/ListEngagementsPaginator.js +4 -0
- package/dist-es/pagination/ListResourceSnapshotJobsPaginator.js +4 -0
- package/dist-es/pagination/ListResourceSnapshotsPaginator.js +4 -0
- package/dist-es/pagination/index.js +7 -0
- package/dist-es/protocols/Aws_json1_0.js +556 -1
- package/dist-types/PartnerCentralSelling.d.ts +182 -42
- package/dist-types/PartnerCentralSellingClient.d.ts +58 -44
- package/dist-types/commands/AcceptEngagementInvitationCommand.d.ts +103 -0
- package/dist-types/commands/AssignOpportunityCommand.d.ts +27 -32
- package/dist-types/commands/AssociateOpportunityCommand.d.ts +40 -46
- package/dist-types/commands/CreateEngagementCommand.d.ts +136 -0
- package/dist-types/commands/CreateEngagementInvitationCommand.d.ts +158 -0
- package/dist-types/commands/CreateOpportunityCommand.d.ts +40 -46
- package/dist-types/commands/CreateResourceSnapshotCommand.d.ts +117 -0
- package/dist-types/commands/CreateResourceSnapshotJobCommand.d.ts +119 -0
- package/dist-types/commands/DeleteResourceSnapshotJobCommand.d.ts +96 -0
- package/dist-types/commands/DisassociateOpportunityCommand.d.ts +29 -34
- package/dist-types/commands/GetAwsOpportunitySummaryCommand.d.ts +24 -28
- package/dist-types/commands/GetEngagementCommand.d.ts +124 -0
- package/dist-types/commands/GetEngagementInvitationCommand.d.ts +34 -24
- package/dist-types/commands/GetOpportunityCommand.d.ts +24 -29
- package/dist-types/commands/GetResourceSnapshotCommand.d.ts +186 -0
- package/dist-types/commands/GetResourceSnapshotJobCommand.d.ts +109 -0
- package/dist-types/commands/GetSellingSystemSettingsCommand.d.ts +95 -0
- package/dist-types/commands/ListEngagementByAcceptingInvitationTasksCommand.d.ts +128 -0
- package/dist-types/commands/ListEngagementFromOpportunityTasksCommand.d.ts +129 -0
- package/dist-types/commands/ListEngagementInvitationsCommand.d.ts +34 -25
- package/dist-types/commands/ListEngagementMembersCommand.d.ts +109 -0
- package/dist-types/commands/ListEngagementResourceAssociationsCommand.d.ts +112 -0
- package/dist-types/commands/ListEngagementsCommand.d.ts +123 -0
- package/dist-types/commands/ListOpportunitiesCommand.d.ts +35 -39
- package/dist-types/commands/ListResourceSnapshotJobsCommand.d.ts +108 -0
- package/dist-types/commands/ListResourceSnapshotsCommand.d.ts +113 -0
- package/dist-types/commands/ListSolutionsCommand.d.ts +20 -20
- package/dist-types/commands/PutSellingSystemSettingsCommand.d.ts +96 -0
- package/dist-types/commands/RejectEngagementInvitationCommand.d.ts +22 -27
- package/dist-types/commands/StartEngagementByAcceptingInvitationTaskCommand.d.ts +37 -35
- package/dist-types/commands/StartEngagementFromOpportunityTaskCommand.d.ts +37 -35
- package/dist-types/commands/StartResourceSnapshotJobCommand.d.ts +95 -0
- package/dist-types/commands/StopResourceSnapshotJobCommand.d.ts +95 -0
- package/dist-types/commands/SubmitOpportunityCommand.d.ts +106 -0
- package/dist-types/commands/UpdateOpportunityCommand.d.ts +33 -35
- package/dist-types/commands/index.d.ts +21 -0
- package/dist-types/index.d.ts +35 -42
- package/dist-types/models/models_0.d.ts +4764 -2209
- package/dist-types/pagination/ListEngagementByAcceptingInvitationTasksPaginator.d.ts +7 -0
- package/dist-types/pagination/ListEngagementFromOpportunityTasksPaginator.d.ts +7 -0
- package/dist-types/pagination/ListEngagementMembersPaginator.d.ts +7 -0
- package/dist-types/pagination/ListEngagementResourceAssociationsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListEngagementsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListResourceSnapshotJobsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListResourceSnapshotsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +7 -0
- package/dist-types/protocols/Aws_json1_0.d.ts +189 -0
- package/dist-types/ts3.4/PartnerCentralSelling.d.ts +375 -0
- package/dist-types/ts3.4/PartnerCentralSellingClient.d.ts +126 -0
- package/dist-types/ts3.4/commands/AcceptEngagementInvitationCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/CreateEngagementCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/CreateEngagementInvitationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/CreateResourceSnapshotCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/CreateResourceSnapshotJobCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeleteResourceSnapshotJobCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/GetEngagementCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/GetResourceSnapshotCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetResourceSnapshotJobCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetSellingSystemSettingsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListEngagementByAcceptingInvitationTasksCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListEngagementFromOpportunityTasksCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListEngagementMembersCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListEngagementResourceAssociationsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListEngagementsCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/ListResourceSnapshotJobsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListResourceSnapshotsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/PutSellingSystemSettingsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/StartResourceSnapshotJobCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/StopResourceSnapshotJobCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/SubmitOpportunityCommand.d.ts +46 -0
- package/dist-types/ts3.4/commands/index.d.ts +21 -0
- package/dist-types/ts3.4/models/models_0.d.ts +587 -86
- package/dist-types/ts3.4/pagination/ListEngagementByAcceptingInvitationTasksPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListEngagementFromOpportunityTasksPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListEngagementMembersPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListEngagementResourceAssociationsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListEngagementsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListResourceSnapshotJobsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListResourceSnapshotsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +7 -0
- package/dist-types/ts3.4/protocols/Aws_json1_0.d.ts +252 -0
- package/package.json +35 -35
|
@@ -0,0 +1,109 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { ListEngagementMembersRequest, ListEngagementMembersResponse } from "../models/models_0";
|
|
4
|
+
import { PartnerCentralSellingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PartnerCentralSellingClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ListEngagementMembersCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListEngagementMembersCommandInput extends ListEngagementMembersRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListEngagementMembersCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListEngagementMembersCommandOutput extends ListEngagementMembersResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const ListEngagementMembersCommand_base: {
|
|
25
|
+
new (input: ListEngagementMembersCommandInput): import("@smithy/smithy-client").CommandImpl<ListEngagementMembersCommandInput, ListEngagementMembersCommandOutput, PartnerCentralSellingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: ListEngagementMembersCommandInput): import("@smithy/smithy-client").CommandImpl<ListEngagementMembersCommandInput, ListEngagementMembersCommandOutput, PartnerCentralSellingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>
|
|
31
|
+
* Retrieves the details of member partners in an engagement. This operation can only be
|
|
32
|
+
* invoked by members of the engagement. The <code>ListEngagementMembers</code> operation allows you to
|
|
33
|
+
* fetch information about the members of a specific engagement. This action is restricted
|
|
34
|
+
* to members of the engagement being queried.
|
|
35
|
+
* </p>
|
|
36
|
+
* @example
|
|
37
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
38
|
+
* ```javascript
|
|
39
|
+
* import { PartnerCentralSellingClient, ListEngagementMembersCommand } from "@aws-sdk/client-partnercentral-selling"; // ES Modules import
|
|
40
|
+
* // const { PartnerCentralSellingClient, ListEngagementMembersCommand } = require("@aws-sdk/client-partnercentral-selling"); // CommonJS import
|
|
41
|
+
* const client = new PartnerCentralSellingClient(config);
|
|
42
|
+
* const input = { // ListEngagementMembersRequest
|
|
43
|
+
* Catalog: "STRING_VALUE", // required
|
|
44
|
+
* Identifier: "STRING_VALUE", // required
|
|
45
|
+
* MaxResults: Number("int"),
|
|
46
|
+
* NextToken: "STRING_VALUE",
|
|
47
|
+
* };
|
|
48
|
+
* const command = new ListEngagementMembersCommand(input);
|
|
49
|
+
* const response = await client.send(command);
|
|
50
|
+
* // { // ListEngagementMembersResponse
|
|
51
|
+
* // EngagementMemberList: [ // EngagementMembers // required
|
|
52
|
+
* // { // EngagementMember
|
|
53
|
+
* // CompanyName: "STRING_VALUE",
|
|
54
|
+
* // WebsiteUrl: "STRING_VALUE",
|
|
55
|
+
* // AccountId: "STRING_VALUE",
|
|
56
|
+
* // },
|
|
57
|
+
* // ],
|
|
58
|
+
* // NextToken: "STRING_VALUE",
|
|
59
|
+
* // };
|
|
60
|
+
*
|
|
61
|
+
* ```
|
|
62
|
+
*
|
|
63
|
+
* @param ListEngagementMembersCommandInput - {@link ListEngagementMembersCommandInput}
|
|
64
|
+
* @returns {@link ListEngagementMembersCommandOutput}
|
|
65
|
+
* @see {@link ListEngagementMembersCommandInput} for command's `input` shape.
|
|
66
|
+
* @see {@link ListEngagementMembersCommandOutput} for command's `response` shape.
|
|
67
|
+
* @see {@link PartnerCentralSellingClientResolvedConfig | config} for PartnerCentralSellingClient's `config` shape.
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
70
|
+
* <p>This error occurs when you don't have permission to perform the requested
|
|
71
|
+
* action.</p>
|
|
72
|
+
* <p>You don’t have access to this action or resource. Review IAM policies or contact your
|
|
73
|
+
* AWS administrator for assistance.</p>
|
|
74
|
+
*
|
|
75
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
76
|
+
* <p>This error occurs when the specified resource can't be found. The resource might not
|
|
77
|
+
* exist, or isn't visible with the current credentials.</p>
|
|
78
|
+
* <p>Suggested action: Verify that the resource ID is correct and the resource is in the
|
|
79
|
+
* expected AWS region. Check IAM permissions for accessing the resource.</p>
|
|
80
|
+
*
|
|
81
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
82
|
+
* <p>This error occurs when there are too many requests sent. Review the provided quotas
|
|
83
|
+
* and adapt your usage to avoid throttling.</p>
|
|
84
|
+
* <p>This error occurs when there are too many requests sent. Review the provided <a href="https://docs.aws.amazon.com/partner-central/latest/selling-api/quotas.html">Quotas</a> and retry after the provided delay.</p>
|
|
85
|
+
*
|
|
86
|
+
* @throws {@link ValidationException} (client fault)
|
|
87
|
+
* <p>The input fails to satisfy the constraints specified by the service or business
|
|
88
|
+
* validation rules.</p>
|
|
89
|
+
* <p>Suggested action: Review the error message, including the failed fields and reasons,
|
|
90
|
+
* to correct the request payload.</p>
|
|
91
|
+
*
|
|
92
|
+
* @throws {@link PartnerCentralSellingServiceException}
|
|
93
|
+
* <p>Base exception class for all service exceptions from PartnerCentralSelling service.</p>
|
|
94
|
+
*
|
|
95
|
+
* @public
|
|
96
|
+
*/
|
|
97
|
+
export declare class ListEngagementMembersCommand extends ListEngagementMembersCommand_base {
|
|
98
|
+
/** @internal type navigation helper, not in runtime. */
|
|
99
|
+
protected static __types: {
|
|
100
|
+
api: {
|
|
101
|
+
input: ListEngagementMembersRequest;
|
|
102
|
+
output: ListEngagementMembersResponse;
|
|
103
|
+
};
|
|
104
|
+
sdk: {
|
|
105
|
+
input: ListEngagementMembersCommandInput;
|
|
106
|
+
output: ListEngagementMembersCommandOutput;
|
|
107
|
+
};
|
|
108
|
+
};
|
|
109
|
+
}
|
|
@@ -0,0 +1,112 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { ListEngagementResourceAssociationsRequest, ListEngagementResourceAssociationsResponse } from "../models/models_0";
|
|
4
|
+
import { PartnerCentralSellingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PartnerCentralSellingClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ListEngagementResourceAssociationsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListEngagementResourceAssociationsCommandInput extends ListEngagementResourceAssociationsRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListEngagementResourceAssociationsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListEngagementResourceAssociationsCommandOutput extends ListEngagementResourceAssociationsResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const ListEngagementResourceAssociationsCommand_base: {
|
|
25
|
+
new (input: ListEngagementResourceAssociationsCommandInput): import("@smithy/smithy-client").CommandImpl<ListEngagementResourceAssociationsCommandInput, ListEngagementResourceAssociationsCommandOutput, PartnerCentralSellingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: ListEngagementResourceAssociationsCommandInput): import("@smithy/smithy-client").CommandImpl<ListEngagementResourceAssociationsCommandInput, ListEngagementResourceAssociationsCommandOutput, PartnerCentralSellingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>
|
|
31
|
+
* Lists the associations between resources and engagements where the caller is a member
|
|
32
|
+
* and has at least one snapshot in the engagement.
|
|
33
|
+
* </p>
|
|
34
|
+
* @example
|
|
35
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
36
|
+
* ```javascript
|
|
37
|
+
* import { PartnerCentralSellingClient, ListEngagementResourceAssociationsCommand } from "@aws-sdk/client-partnercentral-selling"; // ES Modules import
|
|
38
|
+
* // const { PartnerCentralSellingClient, ListEngagementResourceAssociationsCommand } = require("@aws-sdk/client-partnercentral-selling"); // CommonJS import
|
|
39
|
+
* const client = new PartnerCentralSellingClient(config);
|
|
40
|
+
* const input = { // ListEngagementResourceAssociationsRequest
|
|
41
|
+
* Catalog: "STRING_VALUE", // required
|
|
42
|
+
* MaxResults: Number("int"),
|
|
43
|
+
* NextToken: "STRING_VALUE",
|
|
44
|
+
* EngagementIdentifier: "STRING_VALUE",
|
|
45
|
+
* ResourceType: "Opportunity",
|
|
46
|
+
* ResourceIdentifier: "STRING_VALUE",
|
|
47
|
+
* CreatedBy: "STRING_VALUE",
|
|
48
|
+
* };
|
|
49
|
+
* const command = new ListEngagementResourceAssociationsCommand(input);
|
|
50
|
+
* const response = await client.send(command);
|
|
51
|
+
* // { // ListEngagementResourceAssociationsResponse
|
|
52
|
+
* // EngagementResourceAssociationSummaries: [ // EngagementResourceAssociationSummaryList // required
|
|
53
|
+
* // { // EngagementResourceAssociationSummary
|
|
54
|
+
* // Catalog: "STRING_VALUE", // required
|
|
55
|
+
* // EngagementId: "STRING_VALUE",
|
|
56
|
+
* // ResourceType: "Opportunity",
|
|
57
|
+
* // ResourceId: "STRING_VALUE",
|
|
58
|
+
* // CreatedBy: "STRING_VALUE",
|
|
59
|
+
* // },
|
|
60
|
+
* // ],
|
|
61
|
+
* // NextToken: "STRING_VALUE",
|
|
62
|
+
* // };
|
|
63
|
+
*
|
|
64
|
+
* ```
|
|
65
|
+
*
|
|
66
|
+
* @param ListEngagementResourceAssociationsCommandInput - {@link ListEngagementResourceAssociationsCommandInput}
|
|
67
|
+
* @returns {@link ListEngagementResourceAssociationsCommandOutput}
|
|
68
|
+
* @see {@link ListEngagementResourceAssociationsCommandInput} for command's `input` shape.
|
|
69
|
+
* @see {@link ListEngagementResourceAssociationsCommandOutput} for command's `response` shape.
|
|
70
|
+
* @see {@link PartnerCentralSellingClientResolvedConfig | config} for PartnerCentralSellingClient's `config` shape.
|
|
71
|
+
*
|
|
72
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
73
|
+
* <p>This error occurs when you don't have permission to perform the requested
|
|
74
|
+
* action.</p>
|
|
75
|
+
* <p>You don’t have access to this action or resource. Review IAM policies or contact your
|
|
76
|
+
* AWS administrator for assistance.</p>
|
|
77
|
+
*
|
|
78
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
79
|
+
* <p>This error occurs when the specified resource can't be found. The resource might not
|
|
80
|
+
* exist, or isn't visible with the current credentials.</p>
|
|
81
|
+
* <p>Suggested action: Verify that the resource ID is correct and the resource is in the
|
|
82
|
+
* expected AWS region. Check IAM permissions for accessing the resource.</p>
|
|
83
|
+
*
|
|
84
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
85
|
+
* <p>This error occurs when there are too many requests sent. Review the provided quotas
|
|
86
|
+
* and adapt your usage to avoid throttling.</p>
|
|
87
|
+
* <p>This error occurs when there are too many requests sent. Review the provided <a href="https://docs.aws.amazon.com/partner-central/latest/selling-api/quotas.html">Quotas</a> and retry after the provided delay.</p>
|
|
88
|
+
*
|
|
89
|
+
* @throws {@link ValidationException} (client fault)
|
|
90
|
+
* <p>The input fails to satisfy the constraints specified by the service or business
|
|
91
|
+
* validation rules.</p>
|
|
92
|
+
* <p>Suggested action: Review the error message, including the failed fields and reasons,
|
|
93
|
+
* to correct the request payload.</p>
|
|
94
|
+
*
|
|
95
|
+
* @throws {@link PartnerCentralSellingServiceException}
|
|
96
|
+
* <p>Base exception class for all service exceptions from PartnerCentralSelling service.</p>
|
|
97
|
+
*
|
|
98
|
+
* @public
|
|
99
|
+
*/
|
|
100
|
+
export declare class ListEngagementResourceAssociationsCommand extends ListEngagementResourceAssociationsCommand_base {
|
|
101
|
+
/** @internal type navigation helper, not in runtime. */
|
|
102
|
+
protected static __types: {
|
|
103
|
+
api: {
|
|
104
|
+
input: ListEngagementResourceAssociationsRequest;
|
|
105
|
+
output: ListEngagementResourceAssociationsResponse;
|
|
106
|
+
};
|
|
107
|
+
sdk: {
|
|
108
|
+
input: ListEngagementResourceAssociationsCommandInput;
|
|
109
|
+
output: ListEngagementResourceAssociationsCommandOutput;
|
|
110
|
+
};
|
|
111
|
+
};
|
|
112
|
+
}
|
|
@@ -0,0 +1,123 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { ListEngagementsRequest, ListEngagementsResponse } from "../models/models_0";
|
|
4
|
+
import { PartnerCentralSellingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PartnerCentralSellingClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ListEngagementsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListEngagementsCommandInput extends ListEngagementsRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListEngagementsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListEngagementsCommandOutput extends ListEngagementsResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const ListEngagementsCommand_base: {
|
|
25
|
+
new (input: ListEngagementsCommandInput): import("@smithy/smithy-client").CommandImpl<ListEngagementsCommandInput, ListEngagementsCommandOutput, PartnerCentralSellingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: ListEngagementsCommandInput): import("@smithy/smithy-client").CommandImpl<ListEngagementsCommandInput, ListEngagementsCommandOutput, PartnerCentralSellingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>
|
|
31
|
+
* This action allows users to retrieve a list of engagement records from Partner
|
|
32
|
+
* Central. This action can be used to manage and track various engagements across
|
|
33
|
+
* different stages of the partner selling process.
|
|
34
|
+
* </p>
|
|
35
|
+
* @example
|
|
36
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
37
|
+
* ```javascript
|
|
38
|
+
* import { PartnerCentralSellingClient, ListEngagementsCommand } from "@aws-sdk/client-partnercentral-selling"; // ES Modules import
|
|
39
|
+
* // const { PartnerCentralSellingClient, ListEngagementsCommand } = require("@aws-sdk/client-partnercentral-selling"); // CommonJS import
|
|
40
|
+
* const client = new PartnerCentralSellingClient(config);
|
|
41
|
+
* const input = { // ListEngagementsRequest
|
|
42
|
+
* Catalog: "STRING_VALUE", // required
|
|
43
|
+
* CreatedBy: [ // AwsAccountList
|
|
44
|
+
* "STRING_VALUE",
|
|
45
|
+
* ],
|
|
46
|
+
* ExcludeCreatedBy: [
|
|
47
|
+
* "STRING_VALUE",
|
|
48
|
+
* ],
|
|
49
|
+
* Sort: { // EngagementSort
|
|
50
|
+
* SortOrder: "ASCENDING" || "DESCENDING", // required
|
|
51
|
+
* SortBy: "CreatedDate", // required
|
|
52
|
+
* },
|
|
53
|
+
* MaxResults: Number("int"),
|
|
54
|
+
* NextToken: "STRING_VALUE",
|
|
55
|
+
* EngagementIdentifier: [ // EngagementIdentifiers
|
|
56
|
+
* "STRING_VALUE",
|
|
57
|
+
* ],
|
|
58
|
+
* };
|
|
59
|
+
* const command = new ListEngagementsCommand(input);
|
|
60
|
+
* const response = await client.send(command);
|
|
61
|
+
* // { // ListEngagementsResponse
|
|
62
|
+
* // EngagementSummaryList: [ // EngagementSummaryList // required
|
|
63
|
+
* // { // EngagementSummary
|
|
64
|
+
* // Arn: "STRING_VALUE",
|
|
65
|
+
* // Id: "STRING_VALUE",
|
|
66
|
+
* // Title: "STRING_VALUE",
|
|
67
|
+
* // CreatedAt: new Date("TIMESTAMP"),
|
|
68
|
+
* // CreatedBy: "STRING_VALUE",
|
|
69
|
+
* // MemberCount: Number("int"),
|
|
70
|
+
* // },
|
|
71
|
+
* // ],
|
|
72
|
+
* // NextToken: "STRING_VALUE",
|
|
73
|
+
* // };
|
|
74
|
+
*
|
|
75
|
+
* ```
|
|
76
|
+
*
|
|
77
|
+
* @param ListEngagementsCommandInput - {@link ListEngagementsCommandInput}
|
|
78
|
+
* @returns {@link ListEngagementsCommandOutput}
|
|
79
|
+
* @see {@link ListEngagementsCommandInput} for command's `input` shape.
|
|
80
|
+
* @see {@link ListEngagementsCommandOutput} for command's `response` shape.
|
|
81
|
+
* @see {@link PartnerCentralSellingClientResolvedConfig | config} for PartnerCentralSellingClient's `config` shape.
|
|
82
|
+
*
|
|
83
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
84
|
+
* <p>This error occurs when you don't have permission to perform the requested
|
|
85
|
+
* action.</p>
|
|
86
|
+
* <p>You don’t have access to this action or resource. Review IAM policies or contact your
|
|
87
|
+
* AWS administrator for assistance.</p>
|
|
88
|
+
*
|
|
89
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
90
|
+
* <p>This error occurs when the specified resource can't be found. The resource might not
|
|
91
|
+
* exist, or isn't visible with the current credentials.</p>
|
|
92
|
+
* <p>Suggested action: Verify that the resource ID is correct and the resource is in the
|
|
93
|
+
* expected AWS region. Check IAM permissions for accessing the resource.</p>
|
|
94
|
+
*
|
|
95
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
96
|
+
* <p>This error occurs when there are too many requests sent. Review the provided quotas
|
|
97
|
+
* and adapt your usage to avoid throttling.</p>
|
|
98
|
+
* <p>This error occurs when there are too many requests sent. Review the provided <a href="https://docs.aws.amazon.com/partner-central/latest/selling-api/quotas.html">Quotas</a> and retry after the provided delay.</p>
|
|
99
|
+
*
|
|
100
|
+
* @throws {@link ValidationException} (client fault)
|
|
101
|
+
* <p>The input fails to satisfy the constraints specified by the service or business
|
|
102
|
+
* validation rules.</p>
|
|
103
|
+
* <p>Suggested action: Review the error message, including the failed fields and reasons,
|
|
104
|
+
* to correct the request payload.</p>
|
|
105
|
+
*
|
|
106
|
+
* @throws {@link PartnerCentralSellingServiceException}
|
|
107
|
+
* <p>Base exception class for all service exceptions from PartnerCentralSelling service.</p>
|
|
108
|
+
*
|
|
109
|
+
* @public
|
|
110
|
+
*/
|
|
111
|
+
export declare class ListEngagementsCommand extends ListEngagementsCommand_base {
|
|
112
|
+
/** @internal type navigation helper, not in runtime. */
|
|
113
|
+
protected static __types: {
|
|
114
|
+
api: {
|
|
115
|
+
input: ListEngagementsRequest;
|
|
116
|
+
output: ListEngagementsResponse;
|
|
117
|
+
};
|
|
118
|
+
sdk: {
|
|
119
|
+
input: ListEngagementsCommandInput;
|
|
120
|
+
output: ListEngagementsCommandOutput;
|
|
121
|
+
};
|
|
122
|
+
};
|
|
123
|
+
}
|
|
@@ -27,29 +27,27 @@ declare const ListOpportunitiesCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>This request accepts a list of filters that retrieve opportunity subsets as well as
|
|
31
|
-
* <a href="https://partnercentral.awspartner.com/">Partner Central</a>
|
|
32
|
-
*
|
|
33
|
-
*
|
|
34
|
-
*
|
|
35
|
-
*
|
|
36
|
-
*
|
|
37
|
-
* event bus, you can also use the <code>ListOpportunities</code> action.
|
|
38
|
-
* </p>
|
|
30
|
+
* <p>This request accepts a list of filters that retrieve opportunity subsets as well as
|
|
31
|
+
* sort options. This feature is available to partners from <a href="https://partnercentral.awspartner.com/">Partner Central</a> using the
|
|
32
|
+
* <code>ListOpportunities</code> API action.</p>
|
|
33
|
+
* <p>To synchronize your system with Amazon Web Services, only list the opportunities that
|
|
34
|
+
* were newly created or updated. We recommend you rely on events emitted by the service
|
|
35
|
+
* into your Amazon Web Services account’s Amazon EventBridge default event bus, you can
|
|
36
|
+
* also use the <code>ListOpportunities</code> action.</p>
|
|
39
37
|
* <p>We recommend the following approach:</p>
|
|
40
38
|
* <ol>
|
|
41
39
|
* <li>
|
|
42
|
-
* <p>Find the latest <code>LastModifiedDate</code> that you stored, and only use
|
|
43
|
-
* from Amazon Web Services. Don’t use values generated by your
|
|
44
|
-
*
|
|
40
|
+
* <p>Find the latest <code>LastModifiedDate</code> that you stored, and only use
|
|
41
|
+
* the values that came from Amazon Web Services. Don’t use values generated by your
|
|
42
|
+
* system.</p>
|
|
45
43
|
* </li>
|
|
46
44
|
* <li>
|
|
47
|
-
* <p>When you send a <code>ListOpportunities</code> request, submit the date in ISO
|
|
48
|
-
*
|
|
45
|
+
* <p>When you send a <code>ListOpportunities</code> request, submit the date in ISO
|
|
46
|
+
* 8601 format in the <code>AfterLastModifiedDate</code> filter.</p>
|
|
49
47
|
* </li>
|
|
50
48
|
* <li>
|
|
51
|
-
* <p>Amazon Web Services only returns opportunities created or updated on or after
|
|
52
|
-
*
|
|
49
|
+
* <p>Amazon Web Services only returns opportunities created or updated on or after
|
|
50
|
+
* that date and time. Use <code>NextToken</code> to iterate over all pages.</p>
|
|
53
51
|
* </li>
|
|
54
52
|
* </ol>
|
|
55
53
|
* @example
|
|
@@ -90,6 +88,7 @@ declare const ListOpportunitiesCommand_base: {
|
|
|
90
88
|
* // { // OpportunitySummary
|
|
91
89
|
* // Catalog: "STRING_VALUE", // required
|
|
92
90
|
* // Id: "STRING_VALUE",
|
|
91
|
+
* // Arn: "STRING_VALUE",
|
|
93
92
|
* // PartnerOpportunityIdentifier: "STRING_VALUE",
|
|
94
93
|
* // OpportunityType: "Net New Business" || "Flat Renewal" || "Expansion",
|
|
95
94
|
* // LastModifiedDate: new Date("TIMESTAMP"),
|
|
@@ -127,6 +126,7 @@ declare const ListOpportunitiesCommand_base: {
|
|
|
127
126
|
* // CurrencyCode: "USD" || "EUR" || "GBP" || "AUD" || "CAD" || "CNY" || "NZD" || "INR" || "JPY" || "CHF" || "SEK" || "AED" || "AFN" || "ALL" || "AMD" || "ANG" || "AOA" || "ARS" || "AWG" || "AZN" || "BAM" || "BBD" || "BDT" || "BGN" || "BHD" || "BIF" || "BMD" || "BND" || "BOB" || "BOV" || "BRL" || "BSD" || "BTN" || "BWP" || "BYN" || "BZD" || "CDF" || "CHE" || "CHW" || "CLF" || "CLP" || "COP" || "COU" || "CRC" || "CUC" || "CUP" || "CVE" || "CZK" || "DJF" || "DKK" || "DOP" || "DZD" || "EGP" || "ERN" || "ETB" || "FJD" || "FKP" || "GEL" || "GHS" || "GIP" || "GMD" || "GNF" || "GTQ" || "GYD" || "HKD" || "HNL" || "HRK" || "HTG" || "HUF" || "IDR" || "ILS" || "IQD" || "IRR" || "ISK" || "JMD" || "JOD" || "KES" || "KGS" || "KHR" || "KMF" || "KPW" || "KRW" || "KWD" || "KYD" || "KZT" || "LAK" || "LBP" || "LKR" || "LRD" || "LSL" || "LYD" || "MAD" || "MDL" || "MGA" || "MKD" || "MMK" || "MNT" || "MOP" || "MRU" || "MUR" || "MVR" || "MWK" || "MXN" || "MXV" || "MYR" || "MZN" || "NAD" || "NGN" || "NIO" || "NOK" || "NPR" || "OMR" || "PAB" || "PEN" || "PGK" || "PHP" || "PKR" || "PLN" || "PYG" || "QAR" || "RON" || "RSD" || "RUB" || "RWF" || "SAR" || "SBD" || "SCR" || "SDG" || "SGD" || "SHP" || "SLL" || "SOS" || "SRD" || "SSP" || "STN" || "SVC" || "SYP" || "SZL" || "THB" || "TJS" || "TMT" || "TND" || "TOP" || "TRY" || "TTD" || "TWD" || "TZS" || "UAH" || "UGX" || "USN" || "UYI" || "UYU" || "UZS" || "VEF" || "VND" || "VUV" || "WST" || "XAF" || "XCD" || "XDR" || "XOF" || "XPF" || "XSU" || "XUA" || "YER" || "ZAR" || "ZMW" || "ZWL", // required
|
|
128
127
|
* // Frequency: "Monthly", // required
|
|
129
128
|
* // TargetCompany: "STRING_VALUE", // required
|
|
129
|
+
* // EstimationUrl: "STRING_VALUE",
|
|
130
130
|
* // },
|
|
131
131
|
* // ],
|
|
132
132
|
* // },
|
|
@@ -144,37 +144,33 @@ declare const ListOpportunitiesCommand_base: {
|
|
|
144
144
|
* @see {@link PartnerCentralSellingClientResolvedConfig | config} for PartnerCentralSellingClient's `config` shape.
|
|
145
145
|
*
|
|
146
146
|
* @throws {@link AccessDeniedException} (client fault)
|
|
147
|
-
* <p>This error occurs when you don't have permission to perform the
|
|
148
|
-
*
|
|
149
|
-
*
|
|
150
|
-
*
|
|
151
|
-
* </p>
|
|
147
|
+
* <p>This error occurs when you don't have permission to perform the requested
|
|
148
|
+
* action.</p>
|
|
149
|
+
* <p>You don’t have access to this action or resource. Review IAM policies or contact your
|
|
150
|
+
* AWS administrator for assistance.</p>
|
|
152
151
|
*
|
|
153
152
|
* @throws {@link InternalServerException} (server fault)
|
|
154
|
-
* <p>This error occurs when the specified resource can’t be found or doesn't exist.
|
|
155
|
-
*
|
|
156
|
-
* <p>Suggested action: This is usually a transient error. Retry after the provided retry
|
|
157
|
-
*
|
|
153
|
+
* <p>This error occurs when the specified resource can’t be found or doesn't exist.
|
|
154
|
+
* Resource ID and type might be incorrect.</p>
|
|
155
|
+
* <p>Suggested action: This is usually a transient error. Retry after the provided retry
|
|
156
|
+
* delay or a short interval. If the problem persists, contact AWS support.</p>
|
|
158
157
|
*
|
|
159
158
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
160
|
-
* <p>This error occurs when the specified resource can't be found. The resource might not
|
|
161
|
-
*
|
|
162
|
-
* <p>Suggested action: Verify that the resource ID is correct and the resource is in the
|
|
163
|
-
*
|
|
159
|
+
* <p>This error occurs when the specified resource can't be found. The resource might not
|
|
160
|
+
* exist, or isn't visible with the current credentials.</p>
|
|
161
|
+
* <p>Suggested action: Verify that the resource ID is correct and the resource is in the
|
|
162
|
+
* expected AWS region. Check IAM permissions for accessing the resource.</p>
|
|
164
163
|
*
|
|
165
164
|
* @throws {@link ThrottlingException} (client fault)
|
|
166
|
-
* <p>This error occurs when there are too many requests sent. Review the provided quotas
|
|
167
|
-
* usage to avoid throttling
|
|
168
|
-
*
|
|
169
|
-
* <p>This error occurs when there are too many requests sent. Review the provided
|
|
170
|
-
* <a href="https://docs.aws.amazon.com/partner-central/latest/selling-api/quotas.html">Quotas</a> and retry after the provided delay.
|
|
171
|
-
* </p>
|
|
165
|
+
* <p>This error occurs when there are too many requests sent. Review the provided quotas
|
|
166
|
+
* and adapt your usage to avoid throttling.</p>
|
|
167
|
+
* <p>This error occurs when there are too many requests sent. Review the provided <a href="https://docs.aws.amazon.com/partner-central/latest/selling-api/quotas.html">Quotas</a> and retry after the provided delay.</p>
|
|
172
168
|
*
|
|
173
169
|
* @throws {@link ValidationException} (client fault)
|
|
174
|
-
* <p>The input fails to satisfy the constraints specified by the service or business
|
|
175
|
-
*
|
|
176
|
-
* <p>Suggested action: Review the error message, including the failed fields and reasons,
|
|
177
|
-
*
|
|
170
|
+
* <p>The input fails to satisfy the constraints specified by the service or business
|
|
171
|
+
* validation rules.</p>
|
|
172
|
+
* <p>Suggested action: Review the error message, including the failed fields and reasons,
|
|
173
|
+
* to correct the request payload.</p>
|
|
178
174
|
*
|
|
179
175
|
* @throws {@link PartnerCentralSellingServiceException}
|
|
180
176
|
* <p>Base exception class for all service exceptions from PartnerCentralSelling service.</p>
|
|
@@ -0,0 +1,108 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { ListResourceSnapshotJobsRequest, ListResourceSnapshotJobsResponse } from "../models/models_0";
|
|
4
|
+
import { PartnerCentralSellingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PartnerCentralSellingClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ListResourceSnapshotJobsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListResourceSnapshotJobsCommandInput extends ListResourceSnapshotJobsRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListResourceSnapshotJobsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListResourceSnapshotJobsCommandOutput extends ListResourceSnapshotJobsResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const ListResourceSnapshotJobsCommand_base: {
|
|
25
|
+
new (input: ListResourceSnapshotJobsCommandInput): import("@smithy/smithy-client").CommandImpl<ListResourceSnapshotJobsCommandInput, ListResourceSnapshotJobsCommandOutput, PartnerCentralSellingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: ListResourceSnapshotJobsCommandInput): import("@smithy/smithy-client").CommandImpl<ListResourceSnapshotJobsCommandInput, ListResourceSnapshotJobsCommandOutput, PartnerCentralSellingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>
|
|
31
|
+
* Lists resource snapshot jobs owned by the customer. This operation supports various
|
|
32
|
+
* filtering scenarios, including listing all jobs owned by the caller, jobs for a specific
|
|
33
|
+
* engagement, jobs with a specific status, or any combination of these filters.
|
|
34
|
+
* </p>
|
|
35
|
+
* @example
|
|
36
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
37
|
+
* ```javascript
|
|
38
|
+
* import { PartnerCentralSellingClient, ListResourceSnapshotJobsCommand } from "@aws-sdk/client-partnercentral-selling"; // ES Modules import
|
|
39
|
+
* // const { PartnerCentralSellingClient, ListResourceSnapshotJobsCommand } = require("@aws-sdk/client-partnercentral-selling"); // CommonJS import
|
|
40
|
+
* const client = new PartnerCentralSellingClient(config);
|
|
41
|
+
* const input = { // ListResourceSnapshotJobsRequest
|
|
42
|
+
* Catalog: "STRING_VALUE", // required
|
|
43
|
+
* MaxResults: Number("int"),
|
|
44
|
+
* NextToken: "STRING_VALUE",
|
|
45
|
+
* EngagementIdentifier: "STRING_VALUE",
|
|
46
|
+
* Status: "Running" || "Stopped",
|
|
47
|
+
* Sort: { // SortObject
|
|
48
|
+
* SortBy: "CreatedDate",
|
|
49
|
+
* SortOrder: "ASCENDING" || "DESCENDING",
|
|
50
|
+
* },
|
|
51
|
+
* };
|
|
52
|
+
* const command = new ListResourceSnapshotJobsCommand(input);
|
|
53
|
+
* const response = await client.send(command);
|
|
54
|
+
* // { // ListResourceSnapshotJobsResponse
|
|
55
|
+
* // ResourceSnapshotJobSummaries: [ // ResourceSnapshotJobSummaryList // required
|
|
56
|
+
* // { // ResourceSnapshotJobSummary
|
|
57
|
+
* // Id: "STRING_VALUE",
|
|
58
|
+
* // Arn: "STRING_VALUE",
|
|
59
|
+
* // EngagementId: "STRING_VALUE",
|
|
60
|
+
* // Status: "Running" || "Stopped",
|
|
61
|
+
* // },
|
|
62
|
+
* // ],
|
|
63
|
+
* // NextToken: "STRING_VALUE",
|
|
64
|
+
* // };
|
|
65
|
+
*
|
|
66
|
+
* ```
|
|
67
|
+
*
|
|
68
|
+
* @param ListResourceSnapshotJobsCommandInput - {@link ListResourceSnapshotJobsCommandInput}
|
|
69
|
+
* @returns {@link ListResourceSnapshotJobsCommandOutput}
|
|
70
|
+
* @see {@link ListResourceSnapshotJobsCommandInput} for command's `input` shape.
|
|
71
|
+
* @see {@link ListResourceSnapshotJobsCommandOutput} for command's `response` shape.
|
|
72
|
+
* @see {@link PartnerCentralSellingClientResolvedConfig | config} for PartnerCentralSellingClient's `config` shape.
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
75
|
+
* <p>This error occurs when you don't have permission to perform the requested
|
|
76
|
+
* action.</p>
|
|
77
|
+
* <p>You don’t have access to this action or resource. Review IAM policies or contact your
|
|
78
|
+
* AWS administrator for assistance.</p>
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
81
|
+
* <p>This error occurs when there are too many requests sent. Review the provided quotas
|
|
82
|
+
* and adapt your usage to avoid throttling.</p>
|
|
83
|
+
* <p>This error occurs when there are too many requests sent. Review the provided <a href="https://docs.aws.amazon.com/partner-central/latest/selling-api/quotas.html">Quotas</a> and retry after the provided delay.</p>
|
|
84
|
+
*
|
|
85
|
+
* @throws {@link ValidationException} (client fault)
|
|
86
|
+
* <p>The input fails to satisfy the constraints specified by the service or business
|
|
87
|
+
* validation rules.</p>
|
|
88
|
+
* <p>Suggested action: Review the error message, including the failed fields and reasons,
|
|
89
|
+
* to correct the request payload.</p>
|
|
90
|
+
*
|
|
91
|
+
* @throws {@link PartnerCentralSellingServiceException}
|
|
92
|
+
* <p>Base exception class for all service exceptions from PartnerCentralSelling service.</p>
|
|
93
|
+
*
|
|
94
|
+
* @public
|
|
95
|
+
*/
|
|
96
|
+
export declare class ListResourceSnapshotJobsCommand extends ListResourceSnapshotJobsCommand_base {
|
|
97
|
+
/** @internal type navigation helper, not in runtime. */
|
|
98
|
+
protected static __types: {
|
|
99
|
+
api: {
|
|
100
|
+
input: ListResourceSnapshotJobsRequest;
|
|
101
|
+
output: ListResourceSnapshotJobsResponse;
|
|
102
|
+
};
|
|
103
|
+
sdk: {
|
|
104
|
+
input: ListResourceSnapshotJobsCommandInput;
|
|
105
|
+
output: ListResourceSnapshotJobsCommandOutput;
|
|
106
|
+
};
|
|
107
|
+
};
|
|
108
|
+
}
|