@aws-sdk/client-apigatewayv2 3.934.0 → 3.935.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.
Files changed (107) hide show
  1. package/README.md +215 -7
  2. package/dist-cjs/index.js +4158 -1317
  3. package/dist-es/ApiGatewayV2.js +52 -0
  4. package/dist-es/commands/CreatePortalCommand.js +16 -0
  5. package/dist-es/commands/CreatePortalProductCommand.js +16 -0
  6. package/dist-es/commands/CreateProductPageCommand.js +16 -0
  7. package/dist-es/commands/CreateProductRestEndpointPageCommand.js +16 -0
  8. package/dist-es/commands/DeletePortalCommand.js +16 -0
  9. package/dist-es/commands/DeletePortalProductCommand.js +16 -0
  10. package/dist-es/commands/DeletePortalProductSharingPolicyCommand.js +16 -0
  11. package/dist-es/commands/DeleteProductPageCommand.js +16 -0
  12. package/dist-es/commands/DeleteProductRestEndpointPageCommand.js +16 -0
  13. package/dist-es/commands/DisablePortalCommand.js +16 -0
  14. package/dist-es/commands/GetPortalCommand.js +16 -0
  15. package/dist-es/commands/GetPortalProductCommand.js +16 -0
  16. package/dist-es/commands/GetPortalProductSharingPolicyCommand.js +16 -0
  17. package/dist-es/commands/GetProductPageCommand.js +16 -0
  18. package/dist-es/commands/GetProductRestEndpointPageCommand.js +16 -0
  19. package/dist-es/commands/ListPortalProductsCommand.js +16 -0
  20. package/dist-es/commands/ListPortalsCommand.js +16 -0
  21. package/dist-es/commands/ListProductPagesCommand.js +16 -0
  22. package/dist-es/commands/ListProductRestEndpointPagesCommand.js +16 -0
  23. package/dist-es/commands/PreviewPortalCommand.js +16 -0
  24. package/dist-es/commands/PublishPortalCommand.js +16 -0
  25. package/dist-es/commands/PutPortalProductSharingPolicyCommand.js +16 -0
  26. package/dist-es/commands/UpdatePortalCommand.js +16 -0
  27. package/dist-es/commands/UpdatePortalProductCommand.js +16 -0
  28. package/dist-es/commands/UpdateProductPageCommand.js +16 -0
  29. package/dist-es/commands/UpdateProductRestEndpointPageCommand.js +16 -0
  30. package/dist-es/commands/index.js +26 -0
  31. package/dist-es/index.js +2 -1
  32. package/dist-es/models/enums.js +97 -0
  33. package/dist-es/models/errors.js +75 -0
  34. package/dist-es/models/models_0.js +1 -152
  35. package/dist-es/schemas/schemas_0.js +4211 -1758
  36. package/dist-types/ApiGatewayV2.d.ts +184 -0
  37. package/dist-types/ApiGatewayV2Client.d.ts +28 -2
  38. package/dist-types/commands/CreatePortalCommand.d.ts +164 -0
  39. package/dist-types/commands/CreatePortalProductCommand.d.ts +107 -0
  40. package/dist-types/commands/CreateProductPageCommand.d.ts +95 -0
  41. package/dist-types/commands/CreateProductRestEndpointPageCommand.d.ts +123 -0
  42. package/dist-types/commands/DeletePortalCommand.d.ts +80 -0
  43. package/dist-types/commands/DeletePortalProductCommand.d.ts +83 -0
  44. package/dist-types/commands/DeletePortalProductSharingPolicyCommand.d.ts +83 -0
  45. package/dist-types/commands/DeleteProductPageCommand.d.ts +84 -0
  46. package/dist-types/commands/DeleteProductRestEndpointPageCommand.d.ts +84 -0
  47. package/dist-types/commands/DisablePortalCommand.d.ts +86 -0
  48. package/dist-types/commands/GetPortalCommand.d.ts +138 -0
  49. package/dist-types/commands/GetPortalProductCommand.d.ts +107 -0
  50. package/dist-types/commands/GetPortalProductSharingPolicyCommand.d.ts +86 -0
  51. package/dist-types/commands/GetProductPageCommand.d.ts +93 -0
  52. package/dist-types/commands/GetProductRestEndpointPageCommand.d.ts +110 -0
  53. package/dist-types/commands/ListPortalProductsCommand.d.ts +96 -0
  54. package/dist-types/commands/ListPortalsCommand.d.ts +141 -0
  55. package/dist-types/commands/ListProductPagesCommand.d.ts +96 -0
  56. package/dist-types/commands/ListProductRestEndpointPagesCommand.d.ts +111 -0
  57. package/dist-types/commands/PreviewPortalCommand.d.ts +86 -0
  58. package/dist-types/commands/PublishPortalCommand.d.ts +87 -0
  59. package/dist-types/commands/PutPortalProductSharingPolicyCommand.d.ts +84 -0
  60. package/dist-types/commands/UpdatePortalCommand.d.ts +176 -0
  61. package/dist-types/commands/UpdatePortalProductCommand.d.ts +122 -0
  62. package/dist-types/commands/UpdateProductPageCommand.d.ts +96 -0
  63. package/dist-types/commands/UpdateProductRestEndpointPageCommand.d.ts +116 -0
  64. package/dist-types/commands/index.d.ts +26 -0
  65. package/dist-types/index.d.ts +3 -1
  66. package/dist-types/models/enums.d.ts +257 -0
  67. package/dist-types/models/errors.d.ts +92 -0
  68. package/dist-types/models/models_0.d.ts +2564 -1172
  69. package/dist-types/schemas/schemas_0.d.ts +101 -0
  70. package/dist-types/ts3.4/ApiGatewayV2.d.ts +444 -0
  71. package/dist-types/ts3.4/ApiGatewayV2Client.d.ts +156 -0
  72. package/dist-types/ts3.4/commands/CreatePortalCommand.d.ts +47 -0
  73. package/dist-types/ts3.4/commands/CreatePortalProductCommand.d.ts +51 -0
  74. package/dist-types/ts3.4/commands/CreateProductPageCommand.d.ts +51 -0
  75. package/dist-types/ts3.4/commands/CreateProductRestEndpointPageCommand.d.ts +51 -0
  76. package/dist-types/ts3.4/commands/DeletePortalCommand.d.ts +45 -0
  77. package/dist-types/ts3.4/commands/DeletePortalProductCommand.d.ts +46 -0
  78. package/dist-types/ts3.4/commands/DeletePortalProductSharingPolicyCommand.d.ts +47 -0
  79. package/dist-types/ts3.4/commands/DeleteProductPageCommand.d.ts +46 -0
  80. package/dist-types/ts3.4/commands/DeleteProductRestEndpointPageCommand.d.ts +47 -0
  81. package/dist-types/ts3.4/commands/DisablePortalCommand.d.ts +45 -0
  82. package/dist-types/ts3.4/commands/GetPortalCommand.d.ts +47 -0
  83. package/dist-types/ts3.4/commands/GetPortalProductCommand.d.ts +50 -0
  84. package/dist-types/ts3.4/commands/GetPortalProductSharingPolicyCommand.d.ts +51 -0
  85. package/dist-types/ts3.4/commands/GetProductPageCommand.d.ts +50 -0
  86. package/dist-types/ts3.4/commands/GetProductRestEndpointPageCommand.d.ts +51 -0
  87. package/dist-types/ts3.4/commands/ListPortalProductsCommand.d.ts +51 -0
  88. package/dist-types/ts3.4/commands/ListPortalsCommand.d.ts +47 -0
  89. package/dist-types/ts3.4/commands/ListProductPagesCommand.d.ts +50 -0
  90. package/dist-types/ts3.4/commands/ListProductRestEndpointPagesCommand.d.ts +51 -0
  91. package/dist-types/ts3.4/commands/PreviewPortalCommand.d.ts +50 -0
  92. package/dist-types/ts3.4/commands/PublishPortalCommand.d.ts +50 -0
  93. package/dist-types/ts3.4/commands/PutPortalProductSharingPolicyCommand.d.ts +51 -0
  94. package/dist-types/ts3.4/commands/UpdatePortalCommand.d.ts +47 -0
  95. package/dist-types/ts3.4/commands/UpdatePortalProductCommand.d.ts +51 -0
  96. package/dist-types/ts3.4/commands/UpdateProductPageCommand.d.ts +51 -0
  97. package/dist-types/ts3.4/commands/UpdateProductRestEndpointPageCommand.d.ts +51 -0
  98. package/dist-types/ts3.4/commands/index.d.ts +26 -0
  99. package/dist-types/ts3.4/index.d.ts +3 -1
  100. package/dist-types/ts3.4/models/enums.d.ts +127 -0
  101. package/dist-types/ts3.4/models/errors.d.ts +40 -0
  102. package/dist-types/ts3.4/models/models_0.d.ts +417 -142
  103. package/dist-types/ts3.4/schemas/schemas_0.d.ts +101 -0
  104. package/package.json +12 -12
  105. package/dist-es/models/index.js +0 -1
  106. package/dist-types/models/index.d.ts +0 -1
  107. package/dist-types/ts3.4/models/index.d.ts +0 -1
@@ -0,0 +1,110 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { ApiGatewayV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ApiGatewayV2Client";
4
+ import { GetProductRestEndpointPageRequest, GetProductRestEndpointPageResponse } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link GetProductRestEndpointPageCommand}.
14
+ */
15
+ export interface GetProductRestEndpointPageCommandInput extends GetProductRestEndpointPageRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link GetProductRestEndpointPageCommand}.
21
+ */
22
+ export interface GetProductRestEndpointPageCommandOutput extends GetProductRestEndpointPageResponse, __MetadataBearer {
23
+ }
24
+ declare const GetProductRestEndpointPageCommand_base: {
25
+ new (input: GetProductRestEndpointPageCommandInput): import("@smithy/smithy-client").CommandImpl<GetProductRestEndpointPageCommandInput, GetProductRestEndpointPageCommandOutput, ApiGatewayV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (input: GetProductRestEndpointPageCommandInput): import("@smithy/smithy-client").CommandImpl<GetProductRestEndpointPageCommandInput, GetProductRestEndpointPageCommandOutput, ApiGatewayV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Gets a product REST endpoint page.</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { ApiGatewayV2Client, GetProductRestEndpointPageCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import
35
+ * // const { ApiGatewayV2Client, GetProductRestEndpointPageCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import
36
+ * // import type { ApiGatewayV2ClientConfig } from "@aws-sdk/client-apigatewayv2";
37
+ * const config = {}; // type is ApiGatewayV2ClientConfig
38
+ * const client = new ApiGatewayV2Client(config);
39
+ * const input = { // GetProductRestEndpointPageRequest
40
+ * IncludeRawDisplayContent: "STRING_VALUE",
41
+ * PortalProductId: "STRING_VALUE", // required
42
+ * ProductRestEndpointPageId: "STRING_VALUE", // required
43
+ * ResourceOwnerAccountId: "STRING_VALUE",
44
+ * };
45
+ * const command = new GetProductRestEndpointPageCommand(input);
46
+ * const response = await client.send(command);
47
+ * // { // GetProductRestEndpointPageResponse
48
+ * // DisplayContent: { // EndpointDisplayContentResponse
49
+ * // Body: "STRING_VALUE",
50
+ * // Endpoint: "STRING_VALUE", // required
51
+ * // OperationName: "STRING_VALUE",
52
+ * // },
53
+ * // LastModified: new Date("TIMESTAMP"),
54
+ * // ProductRestEndpointPageArn: "STRING_VALUE",
55
+ * // ProductRestEndpointPageId: "STRING_VALUE",
56
+ * // RawDisplayContent: "STRING_VALUE",
57
+ * // RestEndpointIdentifier: { // RestEndpointIdentifier
58
+ * // IdentifierParts: { // IdentifierParts
59
+ * // Method: "STRING_VALUE", // required
60
+ * // Path: "STRING_VALUE", // required
61
+ * // RestApiId: "STRING_VALUE", // required
62
+ * // Stage: "STRING_VALUE", // required
63
+ * // },
64
+ * // },
65
+ * // Status: "AVAILABLE" || "IN_PROGRESS" || "FAILED",
66
+ * // StatusException: { // StatusException
67
+ * // Exception: "STRING_VALUE",
68
+ * // Message: "STRING_VALUE",
69
+ * // },
70
+ * // TryItState: "ENABLED" || "DISABLED",
71
+ * // };
72
+ *
73
+ * ```
74
+ *
75
+ * @param GetProductRestEndpointPageCommandInput - {@link GetProductRestEndpointPageCommandInput}
76
+ * @returns {@link GetProductRestEndpointPageCommandOutput}
77
+ * @see {@link GetProductRestEndpointPageCommandInput} for command's `input` shape.
78
+ * @see {@link GetProductRestEndpointPageCommandOutput} for command's `response` shape.
79
+ * @see {@link ApiGatewayV2ClientResolvedConfig | config} for ApiGatewayV2Client's `config` shape.
80
+ *
81
+ * @throws {@link AccessDeniedException} (client fault)
82
+ *
83
+ * @throws {@link BadRequestException} (client fault)
84
+ * <p>The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.</p>
85
+ *
86
+ * @throws {@link NotFoundException} (client fault)
87
+ * <p>The resource specified in the request was not found. See the message field for more information.</p>
88
+ *
89
+ * @throws {@link TooManyRequestsException} (client fault)
90
+ * <p>A limit has been exceeded. See the accompanying error message for details.</p>
91
+ *
92
+ * @throws {@link ApiGatewayV2ServiceException}
93
+ * <p>Base exception class for all service exceptions from ApiGatewayV2 service.</p>
94
+ *
95
+ *
96
+ * @public
97
+ */
98
+ export declare class GetProductRestEndpointPageCommand extends GetProductRestEndpointPageCommand_base {
99
+ /** @internal type navigation helper, not in runtime. */
100
+ protected static __types: {
101
+ api: {
102
+ input: GetProductRestEndpointPageRequest;
103
+ output: GetProductRestEndpointPageResponse;
104
+ };
105
+ sdk: {
106
+ input: GetProductRestEndpointPageCommandInput;
107
+ output: GetProductRestEndpointPageCommandOutput;
108
+ };
109
+ };
110
+ }
@@ -0,0 +1,96 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { ApiGatewayV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ApiGatewayV2Client";
4
+ import { ListPortalProductsRequest, ListPortalProductsResponse } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link ListPortalProductsCommand}.
14
+ */
15
+ export interface ListPortalProductsCommandInput extends ListPortalProductsRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link ListPortalProductsCommand}.
21
+ */
22
+ export interface ListPortalProductsCommandOutput extends ListPortalProductsResponse, __MetadataBearer {
23
+ }
24
+ declare const ListPortalProductsCommand_base: {
25
+ new (input: ListPortalProductsCommandInput): import("@smithy/smithy-client").CommandImpl<ListPortalProductsCommandInput, ListPortalProductsCommandOutput, ApiGatewayV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (...[input]: [] | [ListPortalProductsCommandInput]): import("@smithy/smithy-client").CommandImpl<ListPortalProductsCommandInput, ListPortalProductsCommandOutput, ApiGatewayV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Lists portal products.</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { ApiGatewayV2Client, ListPortalProductsCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import
35
+ * // const { ApiGatewayV2Client, ListPortalProductsCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import
36
+ * // import type { ApiGatewayV2ClientConfig } from "@aws-sdk/client-apigatewayv2";
37
+ * const config = {}; // type is ApiGatewayV2ClientConfig
38
+ * const client = new ApiGatewayV2Client(config);
39
+ * const input = { // ListPortalProductsRequest
40
+ * MaxResults: "STRING_VALUE",
41
+ * NextToken: "STRING_VALUE",
42
+ * ResourceOwner: "STRING_VALUE",
43
+ * };
44
+ * const command = new ListPortalProductsCommand(input);
45
+ * const response = await client.send(command);
46
+ * // { // ListPortalProductsResponse
47
+ * // Items: [ // __listOfPortalProductSummary
48
+ * // { // PortalProductSummary
49
+ * // Description: "STRING_VALUE", // required
50
+ * // DisplayName: "STRING_VALUE", // required
51
+ * // LastModified: new Date("TIMESTAMP"), // required
52
+ * // PortalProductArn: "STRING_VALUE", // required
53
+ * // PortalProductId: "STRING_VALUE", // required
54
+ * // Tags: { // Tags
55
+ * // "<keys>": "STRING_VALUE",
56
+ * // },
57
+ * // },
58
+ * // ],
59
+ * // NextToken: "STRING_VALUE",
60
+ * // };
61
+ *
62
+ * ```
63
+ *
64
+ * @param ListPortalProductsCommandInput - {@link ListPortalProductsCommandInput}
65
+ * @returns {@link ListPortalProductsCommandOutput}
66
+ * @see {@link ListPortalProductsCommandInput} for command's `input` shape.
67
+ * @see {@link ListPortalProductsCommandOutput} for command's `response` shape.
68
+ * @see {@link ApiGatewayV2ClientResolvedConfig | config} for ApiGatewayV2Client's `config` shape.
69
+ *
70
+ * @throws {@link AccessDeniedException} (client fault)
71
+ *
72
+ * @throws {@link BadRequestException} (client fault)
73
+ * <p>The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.</p>
74
+ *
75
+ * @throws {@link TooManyRequestsException} (client fault)
76
+ * <p>A limit has been exceeded. See the accompanying error message for details.</p>
77
+ *
78
+ * @throws {@link ApiGatewayV2ServiceException}
79
+ * <p>Base exception class for all service exceptions from ApiGatewayV2 service.</p>
80
+ *
81
+ *
82
+ * @public
83
+ */
84
+ export declare class ListPortalProductsCommand extends ListPortalProductsCommand_base {
85
+ /** @internal type navigation helper, not in runtime. */
86
+ protected static __types: {
87
+ api: {
88
+ input: ListPortalProductsRequest;
89
+ output: ListPortalProductsResponse;
90
+ };
91
+ sdk: {
92
+ input: ListPortalProductsCommandInput;
93
+ output: ListPortalProductsCommandOutput;
94
+ };
95
+ };
96
+ }
@@ -0,0 +1,141 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { ApiGatewayV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ApiGatewayV2Client";
4
+ import { ListPortalsRequest, ListPortalsResponse } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link ListPortalsCommand}.
14
+ */
15
+ export interface ListPortalsCommandInput extends ListPortalsRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link ListPortalsCommand}.
21
+ */
22
+ export interface ListPortalsCommandOutput extends ListPortalsResponse, __MetadataBearer {
23
+ }
24
+ declare const ListPortalsCommand_base: {
25
+ new (input: ListPortalsCommandInput): import("@smithy/smithy-client").CommandImpl<ListPortalsCommandInput, ListPortalsCommandOutput, ApiGatewayV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (...[input]: [] | [ListPortalsCommandInput]): import("@smithy/smithy-client").CommandImpl<ListPortalsCommandInput, ListPortalsCommandOutput, ApiGatewayV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Lists portals.</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { ApiGatewayV2Client, ListPortalsCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import
35
+ * // const { ApiGatewayV2Client, ListPortalsCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import
36
+ * // import type { ApiGatewayV2ClientConfig } from "@aws-sdk/client-apigatewayv2";
37
+ * const config = {}; // type is ApiGatewayV2ClientConfig
38
+ * const client = new ApiGatewayV2Client(config);
39
+ * const input = { // ListPortalsRequest
40
+ * MaxResults: "STRING_VALUE",
41
+ * NextToken: "STRING_VALUE",
42
+ * };
43
+ * const command = new ListPortalsCommand(input);
44
+ * const response = await client.send(command);
45
+ * // { // ListPortalsResponse
46
+ * // Items: [ // __listOfPortalSummary
47
+ * // { // PortalSummary
48
+ * // Authorization: { // Authorization
49
+ * // CognitoConfig: { // CognitoConfig
50
+ * // AppClientId: "STRING_VALUE", // required
51
+ * // UserPoolArn: "STRING_VALUE", // required
52
+ * // UserPoolDomain: "STRING_VALUE", // required
53
+ * // },
54
+ * // None: {},
55
+ * // },
56
+ * // EndpointConfiguration: { // EndpointConfigurationResponse
57
+ * // CertificateArn: "STRING_VALUE",
58
+ * // DomainName: "STRING_VALUE",
59
+ * // PortalDefaultDomainName: "STRING_VALUE", // required
60
+ * // PortalDomainHostedZoneId: "STRING_VALUE", // required
61
+ * // },
62
+ * // IncludedPortalProductArns: [ // __listOf__stringMin20Max2048 // required
63
+ * // "STRING_VALUE",
64
+ * // ],
65
+ * // LastModified: new Date("TIMESTAMP"), // required
66
+ * // LastPublished: new Date("TIMESTAMP"),
67
+ * // LastPublishedDescription: "STRING_VALUE",
68
+ * // PortalArn: "STRING_VALUE", // required
69
+ * // PortalContent: { // PortalContent
70
+ * // Description: "STRING_VALUE",
71
+ * // DisplayName: "STRING_VALUE", // required
72
+ * // Theme: { // PortalTheme
73
+ * // CustomColors: { // CustomColors
74
+ * // AccentColor: "STRING_VALUE", // required
75
+ * // BackgroundColor: "STRING_VALUE", // required
76
+ * // ErrorValidationColor: "STRING_VALUE", // required
77
+ * // HeaderColor: "STRING_VALUE", // required
78
+ * // NavigationColor: "STRING_VALUE", // required
79
+ * // TextColor: "STRING_VALUE", // required
80
+ * // },
81
+ * // LogoLastUploaded: new Date("TIMESTAMP"),
82
+ * // },
83
+ * // },
84
+ * // PortalId: "STRING_VALUE", // required
85
+ * // Preview: { // Preview
86
+ * // PreviewStatus: "PREVIEW_IN_PROGRESS" || "PREVIEW_FAILED" || "PREVIEW_READY", // required
87
+ * // PreviewUrl: "STRING_VALUE",
88
+ * // StatusException: { // StatusException
89
+ * // Exception: "STRING_VALUE",
90
+ * // Message: "STRING_VALUE",
91
+ * // },
92
+ * // },
93
+ * // PublishStatus: "PUBLISHED" || "PUBLISH_IN_PROGRESS" || "PUBLISH_FAILED" || "DISABLED",
94
+ * // RumAppMonitorName: "STRING_VALUE",
95
+ * // StatusException: {
96
+ * // Exception: "STRING_VALUE",
97
+ * // Message: "STRING_VALUE",
98
+ * // },
99
+ * // Tags: { // Tags
100
+ * // "<keys>": "STRING_VALUE",
101
+ * // },
102
+ * // },
103
+ * // ],
104
+ * // NextToken: "STRING_VALUE",
105
+ * // };
106
+ *
107
+ * ```
108
+ *
109
+ * @param ListPortalsCommandInput - {@link ListPortalsCommandInput}
110
+ * @returns {@link ListPortalsCommandOutput}
111
+ * @see {@link ListPortalsCommandInput} for command's `input` shape.
112
+ * @see {@link ListPortalsCommandOutput} for command's `response` shape.
113
+ * @see {@link ApiGatewayV2ClientResolvedConfig | config} for ApiGatewayV2Client's `config` shape.
114
+ *
115
+ * @throws {@link AccessDeniedException} (client fault)
116
+ *
117
+ * @throws {@link BadRequestException} (client fault)
118
+ * <p>The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.</p>
119
+ *
120
+ * @throws {@link TooManyRequestsException} (client fault)
121
+ * <p>A limit has been exceeded. See the accompanying error message for details.</p>
122
+ *
123
+ * @throws {@link ApiGatewayV2ServiceException}
124
+ * <p>Base exception class for all service exceptions from ApiGatewayV2 service.</p>
125
+ *
126
+ *
127
+ * @public
128
+ */
129
+ export declare class ListPortalsCommand extends ListPortalsCommand_base {
130
+ /** @internal type navigation helper, not in runtime. */
131
+ protected static __types: {
132
+ api: {
133
+ input: ListPortalsRequest;
134
+ output: ListPortalsResponse;
135
+ };
136
+ sdk: {
137
+ input: ListPortalsCommandInput;
138
+ output: ListPortalsCommandOutput;
139
+ };
140
+ };
141
+ }
@@ -0,0 +1,96 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { ApiGatewayV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ApiGatewayV2Client";
4
+ import { ListProductPagesRequest, ListProductPagesResponse } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link ListProductPagesCommand}.
14
+ */
15
+ export interface ListProductPagesCommandInput extends ListProductPagesRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link ListProductPagesCommand}.
21
+ */
22
+ export interface ListProductPagesCommandOutput extends ListProductPagesResponse, __MetadataBearer {
23
+ }
24
+ declare const ListProductPagesCommand_base: {
25
+ new (input: ListProductPagesCommandInput): import("@smithy/smithy-client").CommandImpl<ListProductPagesCommandInput, ListProductPagesCommandOutput, ApiGatewayV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (input: ListProductPagesCommandInput): import("@smithy/smithy-client").CommandImpl<ListProductPagesCommandInput, ListProductPagesCommandOutput, ApiGatewayV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Lists the product pages for a portal product.</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { ApiGatewayV2Client, ListProductPagesCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import
35
+ * // const { ApiGatewayV2Client, ListProductPagesCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import
36
+ * // import type { ApiGatewayV2ClientConfig } from "@aws-sdk/client-apigatewayv2";
37
+ * const config = {}; // type is ApiGatewayV2ClientConfig
38
+ * const client = new ApiGatewayV2Client(config);
39
+ * const input = { // ListProductPagesRequest
40
+ * MaxResults: "STRING_VALUE",
41
+ * NextToken: "STRING_VALUE",
42
+ * PortalProductId: "STRING_VALUE", // required
43
+ * ResourceOwnerAccountId: "STRING_VALUE",
44
+ * };
45
+ * const command = new ListProductPagesCommand(input);
46
+ * const response = await client.send(command);
47
+ * // { // ListProductPagesResponse
48
+ * // Items: [ // __listOfProductPageSummaryNoBody
49
+ * // { // ProductPageSummaryNoBody
50
+ * // LastModified: new Date("TIMESTAMP"), // required
51
+ * // PageTitle: "STRING_VALUE", // required
52
+ * // ProductPageArn: "STRING_VALUE", // required
53
+ * // ProductPageId: "STRING_VALUE", // required
54
+ * // },
55
+ * // ],
56
+ * // NextToken: "STRING_VALUE",
57
+ * // };
58
+ *
59
+ * ```
60
+ *
61
+ * @param ListProductPagesCommandInput - {@link ListProductPagesCommandInput}
62
+ * @returns {@link ListProductPagesCommandOutput}
63
+ * @see {@link ListProductPagesCommandInput} for command's `input` shape.
64
+ * @see {@link ListProductPagesCommandOutput} for command's `response` shape.
65
+ * @see {@link ApiGatewayV2ClientResolvedConfig | config} for ApiGatewayV2Client's `config` shape.
66
+ *
67
+ * @throws {@link AccessDeniedException} (client fault)
68
+ *
69
+ * @throws {@link BadRequestException} (client fault)
70
+ * <p>The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.</p>
71
+ *
72
+ * @throws {@link NotFoundException} (client fault)
73
+ * <p>The resource specified in the request was not found. See the message field for more information.</p>
74
+ *
75
+ * @throws {@link TooManyRequestsException} (client fault)
76
+ * <p>A limit has been exceeded. See the accompanying error message for details.</p>
77
+ *
78
+ * @throws {@link ApiGatewayV2ServiceException}
79
+ * <p>Base exception class for all service exceptions from ApiGatewayV2 service.</p>
80
+ *
81
+ *
82
+ * @public
83
+ */
84
+ export declare class ListProductPagesCommand extends ListProductPagesCommand_base {
85
+ /** @internal type navigation helper, not in runtime. */
86
+ protected static __types: {
87
+ api: {
88
+ input: ListProductPagesRequest;
89
+ output: ListProductPagesResponse;
90
+ };
91
+ sdk: {
92
+ input: ListProductPagesCommandInput;
93
+ output: ListProductPagesCommandOutput;
94
+ };
95
+ };
96
+ }
@@ -0,0 +1,111 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { ApiGatewayV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ApiGatewayV2Client";
4
+ import { ListProductRestEndpointPagesRequest, ListProductRestEndpointPagesResponse } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link ListProductRestEndpointPagesCommand}.
14
+ */
15
+ export interface ListProductRestEndpointPagesCommandInput extends ListProductRestEndpointPagesRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link ListProductRestEndpointPagesCommand}.
21
+ */
22
+ export interface ListProductRestEndpointPagesCommandOutput extends ListProductRestEndpointPagesResponse, __MetadataBearer {
23
+ }
24
+ declare const ListProductRestEndpointPagesCommand_base: {
25
+ new (input: ListProductRestEndpointPagesCommandInput): import("@smithy/smithy-client").CommandImpl<ListProductRestEndpointPagesCommandInput, ListProductRestEndpointPagesCommandOutput, ApiGatewayV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (input: ListProductRestEndpointPagesCommandInput): import("@smithy/smithy-client").CommandImpl<ListProductRestEndpointPagesCommandInput, ListProductRestEndpointPagesCommandOutput, ApiGatewayV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Lists the product REST endpoint pages of a portal product.</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { ApiGatewayV2Client, ListProductRestEndpointPagesCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import
35
+ * // const { ApiGatewayV2Client, ListProductRestEndpointPagesCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import
36
+ * // import type { ApiGatewayV2ClientConfig } from "@aws-sdk/client-apigatewayv2";
37
+ * const config = {}; // type is ApiGatewayV2ClientConfig
38
+ * const client = new ApiGatewayV2Client(config);
39
+ * const input = { // ListProductRestEndpointPagesRequest
40
+ * MaxResults: "STRING_VALUE",
41
+ * NextToken: "STRING_VALUE",
42
+ * PortalProductId: "STRING_VALUE", // required
43
+ * ResourceOwnerAccountId: "STRING_VALUE",
44
+ * };
45
+ * const command = new ListProductRestEndpointPagesCommand(input);
46
+ * const response = await client.send(command);
47
+ * // { // ListProductRestEndpointPagesResponse
48
+ * // Items: [ // __listOfProductRestEndpointPageSummaryNoBody
49
+ * // { // ProductRestEndpointPageSummaryNoBody
50
+ * // Endpoint: "STRING_VALUE", // required
51
+ * // LastModified: new Date("TIMESTAMP"), // required
52
+ * // OperationName: "STRING_VALUE",
53
+ * // ProductRestEndpointPageArn: "STRING_VALUE", // required
54
+ * // ProductRestEndpointPageId: "STRING_VALUE", // required
55
+ * // RestEndpointIdentifier: { // RestEndpointIdentifier
56
+ * // IdentifierParts: { // IdentifierParts
57
+ * // Method: "STRING_VALUE", // required
58
+ * // Path: "STRING_VALUE", // required
59
+ * // RestApiId: "STRING_VALUE", // required
60
+ * // Stage: "STRING_VALUE", // required
61
+ * // },
62
+ * // },
63
+ * // Status: "AVAILABLE" || "IN_PROGRESS" || "FAILED", // required
64
+ * // StatusException: { // StatusException
65
+ * // Exception: "STRING_VALUE",
66
+ * // Message: "STRING_VALUE",
67
+ * // },
68
+ * // TryItState: "ENABLED" || "DISABLED", // required
69
+ * // },
70
+ * // ],
71
+ * // NextToken: "STRING_VALUE",
72
+ * // };
73
+ *
74
+ * ```
75
+ *
76
+ * @param ListProductRestEndpointPagesCommandInput - {@link ListProductRestEndpointPagesCommandInput}
77
+ * @returns {@link ListProductRestEndpointPagesCommandOutput}
78
+ * @see {@link ListProductRestEndpointPagesCommandInput} for command's `input` shape.
79
+ * @see {@link ListProductRestEndpointPagesCommandOutput} for command's `response` shape.
80
+ * @see {@link ApiGatewayV2ClientResolvedConfig | config} for ApiGatewayV2Client's `config` shape.
81
+ *
82
+ * @throws {@link AccessDeniedException} (client fault)
83
+ *
84
+ * @throws {@link BadRequestException} (client fault)
85
+ * <p>The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.</p>
86
+ *
87
+ * @throws {@link NotFoundException} (client fault)
88
+ * <p>The resource specified in the request was not found. See the message field for more information.</p>
89
+ *
90
+ * @throws {@link TooManyRequestsException} (client fault)
91
+ * <p>A limit has been exceeded. See the accompanying error message for details.</p>
92
+ *
93
+ * @throws {@link ApiGatewayV2ServiceException}
94
+ * <p>Base exception class for all service exceptions from ApiGatewayV2 service.</p>
95
+ *
96
+ *
97
+ * @public
98
+ */
99
+ export declare class ListProductRestEndpointPagesCommand extends ListProductRestEndpointPagesCommand_base {
100
+ /** @internal type navigation helper, not in runtime. */
101
+ protected static __types: {
102
+ api: {
103
+ input: ListProductRestEndpointPagesRequest;
104
+ output: ListProductRestEndpointPagesResponse;
105
+ };
106
+ sdk: {
107
+ input: ListProductRestEndpointPagesCommandInput;
108
+ output: ListProductRestEndpointPagesCommandOutput;
109
+ };
110
+ };
111
+ }
@@ -0,0 +1,86 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { ApiGatewayV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ApiGatewayV2Client";
4
+ import { PreviewPortalRequest, PreviewPortalResponse } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link PreviewPortalCommand}.
14
+ */
15
+ export interface PreviewPortalCommandInput extends PreviewPortalRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link PreviewPortalCommand}.
21
+ */
22
+ export interface PreviewPortalCommandOutput extends PreviewPortalResponse, __MetadataBearer {
23
+ }
24
+ declare const PreviewPortalCommand_base: {
25
+ new (input: PreviewPortalCommandInput): import("@smithy/smithy-client").CommandImpl<PreviewPortalCommandInput, PreviewPortalCommandOutput, ApiGatewayV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (input: PreviewPortalCommandInput): import("@smithy/smithy-client").CommandImpl<PreviewPortalCommandInput, PreviewPortalCommandOutput, ApiGatewayV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Creates a portal preview.</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { ApiGatewayV2Client, PreviewPortalCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import
35
+ * // const { ApiGatewayV2Client, PreviewPortalCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import
36
+ * // import type { ApiGatewayV2ClientConfig } from "@aws-sdk/client-apigatewayv2";
37
+ * const config = {}; // type is ApiGatewayV2ClientConfig
38
+ * const client = new ApiGatewayV2Client(config);
39
+ * const input = { // PreviewPortalRequest
40
+ * PortalId: "STRING_VALUE", // required
41
+ * };
42
+ * const command = new PreviewPortalCommand(input);
43
+ * const response = await client.send(command);
44
+ * // {};
45
+ *
46
+ * ```
47
+ *
48
+ * @param PreviewPortalCommandInput - {@link PreviewPortalCommandInput}
49
+ * @returns {@link PreviewPortalCommandOutput}
50
+ * @see {@link PreviewPortalCommandInput} for command's `input` shape.
51
+ * @see {@link PreviewPortalCommandOutput} for command's `response` shape.
52
+ * @see {@link ApiGatewayV2ClientResolvedConfig | config} for ApiGatewayV2Client's `config` shape.
53
+ *
54
+ * @throws {@link AccessDeniedException} (client fault)
55
+ *
56
+ * @throws {@link BadRequestException} (client fault)
57
+ * <p>The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.</p>
58
+ *
59
+ * @throws {@link ConflictException} (client fault)
60
+ * <p>The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.</p>
61
+ *
62
+ * @throws {@link NotFoundException} (client fault)
63
+ * <p>The resource specified in the request was not found. See the message field for more information.</p>
64
+ *
65
+ * @throws {@link TooManyRequestsException} (client fault)
66
+ * <p>A limit has been exceeded. See the accompanying error message for details.</p>
67
+ *
68
+ * @throws {@link ApiGatewayV2ServiceException}
69
+ * <p>Base exception class for all service exceptions from ApiGatewayV2 service.</p>
70
+ *
71
+ *
72
+ * @public
73
+ */
74
+ export declare class PreviewPortalCommand extends PreviewPortalCommand_base {
75
+ /** @internal type navigation helper, not in runtime. */
76
+ protected static __types: {
77
+ api: {
78
+ input: PreviewPortalRequest;
79
+ output: {};
80
+ };
81
+ sdk: {
82
+ input: PreviewPortalCommandInput;
83
+ output: PreviewPortalCommandOutput;
84
+ };
85
+ };
86
+ }