@aws-sdk/client-apigatewayv2 3.933.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.
- package/README.md +215 -7
- package/dist-cjs/index.js +4158 -1317
- package/dist-es/ApiGatewayV2.js +52 -0
- package/dist-es/commands/CreatePortalCommand.js +16 -0
- package/dist-es/commands/CreatePortalProductCommand.js +16 -0
- package/dist-es/commands/CreateProductPageCommand.js +16 -0
- package/dist-es/commands/CreateProductRestEndpointPageCommand.js +16 -0
- package/dist-es/commands/DeletePortalCommand.js +16 -0
- package/dist-es/commands/DeletePortalProductCommand.js +16 -0
- package/dist-es/commands/DeletePortalProductSharingPolicyCommand.js +16 -0
- package/dist-es/commands/DeleteProductPageCommand.js +16 -0
- package/dist-es/commands/DeleteProductRestEndpointPageCommand.js +16 -0
- package/dist-es/commands/DisablePortalCommand.js +16 -0
- package/dist-es/commands/GetPortalCommand.js +16 -0
- package/dist-es/commands/GetPortalProductCommand.js +16 -0
- package/dist-es/commands/GetPortalProductSharingPolicyCommand.js +16 -0
- package/dist-es/commands/GetProductPageCommand.js +16 -0
- package/dist-es/commands/GetProductRestEndpointPageCommand.js +16 -0
- package/dist-es/commands/ListPortalProductsCommand.js +16 -0
- package/dist-es/commands/ListPortalsCommand.js +16 -0
- package/dist-es/commands/ListProductPagesCommand.js +16 -0
- package/dist-es/commands/ListProductRestEndpointPagesCommand.js +16 -0
- package/dist-es/commands/PreviewPortalCommand.js +16 -0
- package/dist-es/commands/PublishPortalCommand.js +16 -0
- package/dist-es/commands/PutPortalProductSharingPolicyCommand.js +16 -0
- package/dist-es/commands/UpdatePortalCommand.js +16 -0
- package/dist-es/commands/UpdatePortalProductCommand.js +16 -0
- package/dist-es/commands/UpdateProductPageCommand.js +16 -0
- package/dist-es/commands/UpdateProductRestEndpointPageCommand.js +16 -0
- package/dist-es/commands/index.js +26 -0
- package/dist-es/index.js +2 -1
- package/dist-es/models/enums.js +97 -0
- package/dist-es/models/errors.js +75 -0
- package/dist-es/models/models_0.js +1 -152
- package/dist-es/schemas/schemas_0.js +4211 -1758
- package/dist-types/ApiGatewayV2.d.ts +184 -0
- package/dist-types/ApiGatewayV2Client.d.ts +28 -2
- package/dist-types/commands/CreatePortalCommand.d.ts +164 -0
- package/dist-types/commands/CreatePortalProductCommand.d.ts +107 -0
- package/dist-types/commands/CreateProductPageCommand.d.ts +95 -0
- package/dist-types/commands/CreateProductRestEndpointPageCommand.d.ts +123 -0
- package/dist-types/commands/DeletePortalCommand.d.ts +80 -0
- package/dist-types/commands/DeletePortalProductCommand.d.ts +83 -0
- package/dist-types/commands/DeletePortalProductSharingPolicyCommand.d.ts +83 -0
- package/dist-types/commands/DeleteProductPageCommand.d.ts +84 -0
- package/dist-types/commands/DeleteProductRestEndpointPageCommand.d.ts +84 -0
- package/dist-types/commands/DisablePortalCommand.d.ts +86 -0
- package/dist-types/commands/GetPortalCommand.d.ts +138 -0
- package/dist-types/commands/GetPortalProductCommand.d.ts +107 -0
- package/dist-types/commands/GetPortalProductSharingPolicyCommand.d.ts +86 -0
- package/dist-types/commands/GetProductPageCommand.d.ts +93 -0
- package/dist-types/commands/GetProductRestEndpointPageCommand.d.ts +110 -0
- package/dist-types/commands/ListPortalProductsCommand.d.ts +96 -0
- package/dist-types/commands/ListPortalsCommand.d.ts +141 -0
- package/dist-types/commands/ListProductPagesCommand.d.ts +96 -0
- package/dist-types/commands/ListProductRestEndpointPagesCommand.d.ts +111 -0
- package/dist-types/commands/PreviewPortalCommand.d.ts +86 -0
- package/dist-types/commands/PublishPortalCommand.d.ts +87 -0
- package/dist-types/commands/PutPortalProductSharingPolicyCommand.d.ts +84 -0
- package/dist-types/commands/UpdatePortalCommand.d.ts +176 -0
- package/dist-types/commands/UpdatePortalProductCommand.d.ts +122 -0
- package/dist-types/commands/UpdateProductPageCommand.d.ts +96 -0
- package/dist-types/commands/UpdateProductRestEndpointPageCommand.d.ts +116 -0
- package/dist-types/commands/index.d.ts +26 -0
- package/dist-types/index.d.ts +3 -1
- package/dist-types/models/enums.d.ts +257 -0
- package/dist-types/models/errors.d.ts +92 -0
- package/dist-types/models/models_0.d.ts +2564 -1172
- package/dist-types/schemas/schemas_0.d.ts +101 -0
- package/dist-types/ts3.4/ApiGatewayV2.d.ts +444 -0
- package/dist-types/ts3.4/ApiGatewayV2Client.d.ts +156 -0
- package/dist-types/ts3.4/commands/CreatePortalCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/CreatePortalProductCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/CreateProductPageCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/CreateProductRestEndpointPageCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeletePortalCommand.d.ts +45 -0
- package/dist-types/ts3.4/commands/DeletePortalProductCommand.d.ts +46 -0
- package/dist-types/ts3.4/commands/DeletePortalProductSharingPolicyCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/DeleteProductPageCommand.d.ts +46 -0
- package/dist-types/ts3.4/commands/DeleteProductRestEndpointPageCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/DisablePortalCommand.d.ts +45 -0
- package/dist-types/ts3.4/commands/GetPortalCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/GetPortalProductCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/GetPortalProductSharingPolicyCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetProductPageCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/GetProductRestEndpointPageCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListPortalProductsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListPortalsCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/ListProductPagesCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/ListProductRestEndpointPagesCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/PreviewPortalCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/PublishPortalCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/PutPortalProductSharingPolicyCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/UpdatePortalCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/UpdatePortalProductCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/UpdateProductPageCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/UpdateProductRestEndpointPageCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/index.d.ts +26 -0
- package/dist-types/ts3.4/index.d.ts +3 -1
- package/dist-types/ts3.4/models/enums.d.ts +127 -0
- package/dist-types/ts3.4/models/errors.d.ts +40 -0
- package/dist-types/ts3.4/models/models_0.d.ts +417 -142
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +101 -0
- package/package.json +12 -12
- package/dist-es/models/index.js +0 -1
- package/dist-types/models/index.d.ts +0 -1
- package/dist-types/ts3.4/models/index.d.ts +0 -1
|
@@ -0,0 +1,84 @@
|
|
|
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 { DeleteProductRestEndpointPageRequest } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link DeleteProductRestEndpointPageCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface DeleteProductRestEndpointPageCommandInput extends DeleteProductRestEndpointPageRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link DeleteProductRestEndpointPageCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface DeleteProductRestEndpointPageCommandOutput extends __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const DeleteProductRestEndpointPageCommand_base: {
|
|
25
|
+
new (input: DeleteProductRestEndpointPageCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteProductRestEndpointPageCommandInput, DeleteProductRestEndpointPageCommandOutput, ApiGatewayV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: DeleteProductRestEndpointPageCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteProductRestEndpointPageCommandInput, DeleteProductRestEndpointPageCommandOutput, ApiGatewayV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Deletes 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, DeleteProductRestEndpointPageCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import
|
|
35
|
+
* // const { ApiGatewayV2Client, DeleteProductRestEndpointPageCommand } = 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 = { // DeleteProductRestEndpointPageRequest
|
|
40
|
+
* PortalProductId: "STRING_VALUE", // required
|
|
41
|
+
* ProductRestEndpointPageId: "STRING_VALUE", // required
|
|
42
|
+
* };
|
|
43
|
+
* const command = new DeleteProductRestEndpointPageCommand(input);
|
|
44
|
+
* const response = await client.send(command);
|
|
45
|
+
* // {};
|
|
46
|
+
*
|
|
47
|
+
* ```
|
|
48
|
+
*
|
|
49
|
+
* @param DeleteProductRestEndpointPageCommandInput - {@link DeleteProductRestEndpointPageCommandInput}
|
|
50
|
+
* @returns {@link DeleteProductRestEndpointPageCommandOutput}
|
|
51
|
+
* @see {@link DeleteProductRestEndpointPageCommandInput} for command's `input` shape.
|
|
52
|
+
* @see {@link DeleteProductRestEndpointPageCommandOutput} for command's `response` shape.
|
|
53
|
+
* @see {@link ApiGatewayV2ClientResolvedConfig | config} for ApiGatewayV2Client's `config` shape.
|
|
54
|
+
*
|
|
55
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
56
|
+
*
|
|
57
|
+
* @throws {@link BadRequestException} (client fault)
|
|
58
|
+
* <p>The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.</p>
|
|
59
|
+
*
|
|
60
|
+
* @throws {@link NotFoundException} (client fault)
|
|
61
|
+
* <p>The resource specified in the request was not found. See the message field for more information.</p>
|
|
62
|
+
*
|
|
63
|
+
* @throws {@link TooManyRequestsException} (client fault)
|
|
64
|
+
* <p>A limit has been exceeded. See the accompanying error message for details.</p>
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link ApiGatewayV2ServiceException}
|
|
67
|
+
* <p>Base exception class for all service exceptions from ApiGatewayV2 service.</p>
|
|
68
|
+
*
|
|
69
|
+
*
|
|
70
|
+
* @public
|
|
71
|
+
*/
|
|
72
|
+
export declare class DeleteProductRestEndpointPageCommand extends DeleteProductRestEndpointPageCommand_base {
|
|
73
|
+
/** @internal type navigation helper, not in runtime. */
|
|
74
|
+
protected static __types: {
|
|
75
|
+
api: {
|
|
76
|
+
input: DeleteProductRestEndpointPageRequest;
|
|
77
|
+
output: {};
|
|
78
|
+
};
|
|
79
|
+
sdk: {
|
|
80
|
+
input: DeleteProductRestEndpointPageCommandInput;
|
|
81
|
+
output: DeleteProductRestEndpointPageCommandOutput;
|
|
82
|
+
};
|
|
83
|
+
};
|
|
84
|
+
}
|
|
@@ -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 { DisablePortalRequest } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link DisablePortalCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface DisablePortalCommandInput extends DisablePortalRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link DisablePortalCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface DisablePortalCommandOutput extends __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const DisablePortalCommand_base: {
|
|
25
|
+
new (input: DisablePortalCommandInput): import("@smithy/smithy-client").CommandImpl<DisablePortalCommandInput, DisablePortalCommandOutput, ApiGatewayV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: DisablePortalCommandInput): import("@smithy/smithy-client").CommandImpl<DisablePortalCommandInput, DisablePortalCommandOutput, ApiGatewayV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Deletes the publication of a portal portal.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { ApiGatewayV2Client, DisablePortalCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import
|
|
35
|
+
* // const { ApiGatewayV2Client, DisablePortalCommand } = 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 = { // DisablePortalRequest
|
|
40
|
+
* PortalId: "STRING_VALUE", // required
|
|
41
|
+
* };
|
|
42
|
+
* const command = new DisablePortalCommand(input);
|
|
43
|
+
* const response = await client.send(command);
|
|
44
|
+
* // {};
|
|
45
|
+
*
|
|
46
|
+
* ```
|
|
47
|
+
*
|
|
48
|
+
* @param DisablePortalCommandInput - {@link DisablePortalCommandInput}
|
|
49
|
+
* @returns {@link DisablePortalCommandOutput}
|
|
50
|
+
* @see {@link DisablePortalCommandInput} for command's `input` shape.
|
|
51
|
+
* @see {@link DisablePortalCommandOutput} 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 DisablePortalCommand extends DisablePortalCommand_base {
|
|
75
|
+
/** @internal type navigation helper, not in runtime. */
|
|
76
|
+
protected static __types: {
|
|
77
|
+
api: {
|
|
78
|
+
input: DisablePortalRequest;
|
|
79
|
+
output: {};
|
|
80
|
+
};
|
|
81
|
+
sdk: {
|
|
82
|
+
input: DisablePortalCommandInput;
|
|
83
|
+
output: DisablePortalCommandOutput;
|
|
84
|
+
};
|
|
85
|
+
};
|
|
86
|
+
}
|
|
@@ -0,0 +1,138 @@
|
|
|
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 { GetPortalRequest, GetPortalResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetPortalCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetPortalCommandInput extends GetPortalRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetPortalCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetPortalCommandOutput extends GetPortalResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetPortalCommand_base: {
|
|
25
|
+
new (input: GetPortalCommandInput): import("@smithy/smithy-client").CommandImpl<GetPortalCommandInput, GetPortalCommandOutput, ApiGatewayV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: GetPortalCommandInput): import("@smithy/smithy-client").CommandImpl<GetPortalCommandInput, GetPortalCommandOutput, ApiGatewayV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Gets a portal.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { ApiGatewayV2Client, GetPortalCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import
|
|
35
|
+
* // const { ApiGatewayV2Client, GetPortalCommand } = 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 = { // GetPortalRequest
|
|
40
|
+
* PortalId: "STRING_VALUE", // required
|
|
41
|
+
* };
|
|
42
|
+
* const command = new GetPortalCommand(input);
|
|
43
|
+
* const response = await client.send(command);
|
|
44
|
+
* // { // GetPortalResponse
|
|
45
|
+
* // Authorization: { // Authorization
|
|
46
|
+
* // CognitoConfig: { // CognitoConfig
|
|
47
|
+
* // AppClientId: "STRING_VALUE", // required
|
|
48
|
+
* // UserPoolArn: "STRING_VALUE", // required
|
|
49
|
+
* // UserPoolDomain: "STRING_VALUE", // required
|
|
50
|
+
* // },
|
|
51
|
+
* // None: {},
|
|
52
|
+
* // },
|
|
53
|
+
* // EndpointConfiguration: { // EndpointConfigurationResponse
|
|
54
|
+
* // CertificateArn: "STRING_VALUE",
|
|
55
|
+
* // DomainName: "STRING_VALUE",
|
|
56
|
+
* // PortalDefaultDomainName: "STRING_VALUE", // required
|
|
57
|
+
* // PortalDomainHostedZoneId: "STRING_VALUE", // required
|
|
58
|
+
* // },
|
|
59
|
+
* // IncludedPortalProductArns: [ // __listOf__stringMin20Max2048
|
|
60
|
+
* // "STRING_VALUE",
|
|
61
|
+
* // ],
|
|
62
|
+
* // LastModified: new Date("TIMESTAMP"),
|
|
63
|
+
* // LastPublished: new Date("TIMESTAMP"),
|
|
64
|
+
* // LastPublishedDescription: "STRING_VALUE",
|
|
65
|
+
* // PortalArn: "STRING_VALUE",
|
|
66
|
+
* // PortalContent: { // PortalContent
|
|
67
|
+
* // Description: "STRING_VALUE",
|
|
68
|
+
* // DisplayName: "STRING_VALUE", // required
|
|
69
|
+
* // Theme: { // PortalTheme
|
|
70
|
+
* // CustomColors: { // CustomColors
|
|
71
|
+
* // AccentColor: "STRING_VALUE", // required
|
|
72
|
+
* // BackgroundColor: "STRING_VALUE", // required
|
|
73
|
+
* // ErrorValidationColor: "STRING_VALUE", // required
|
|
74
|
+
* // HeaderColor: "STRING_VALUE", // required
|
|
75
|
+
* // NavigationColor: "STRING_VALUE", // required
|
|
76
|
+
* // TextColor: "STRING_VALUE", // required
|
|
77
|
+
* // },
|
|
78
|
+
* // LogoLastUploaded: new Date("TIMESTAMP"),
|
|
79
|
+
* // },
|
|
80
|
+
* // },
|
|
81
|
+
* // PortalId: "STRING_VALUE",
|
|
82
|
+
* // Preview: { // Preview
|
|
83
|
+
* // PreviewStatus: "PREVIEW_IN_PROGRESS" || "PREVIEW_FAILED" || "PREVIEW_READY", // required
|
|
84
|
+
* // PreviewUrl: "STRING_VALUE",
|
|
85
|
+
* // StatusException: { // StatusException
|
|
86
|
+
* // Exception: "STRING_VALUE",
|
|
87
|
+
* // Message: "STRING_VALUE",
|
|
88
|
+
* // },
|
|
89
|
+
* // },
|
|
90
|
+
* // PublishStatus: "PUBLISHED" || "PUBLISH_IN_PROGRESS" || "PUBLISH_FAILED" || "DISABLED",
|
|
91
|
+
* // RumAppMonitorName: "STRING_VALUE",
|
|
92
|
+
* // StatusException: {
|
|
93
|
+
* // Exception: "STRING_VALUE",
|
|
94
|
+
* // Message: "STRING_VALUE",
|
|
95
|
+
* // },
|
|
96
|
+
* // Tags: { // Tags
|
|
97
|
+
* // "<keys>": "STRING_VALUE",
|
|
98
|
+
* // },
|
|
99
|
+
* // };
|
|
100
|
+
*
|
|
101
|
+
* ```
|
|
102
|
+
*
|
|
103
|
+
* @param GetPortalCommandInput - {@link GetPortalCommandInput}
|
|
104
|
+
* @returns {@link GetPortalCommandOutput}
|
|
105
|
+
* @see {@link GetPortalCommandInput} for command's `input` shape.
|
|
106
|
+
* @see {@link GetPortalCommandOutput} for command's `response` shape.
|
|
107
|
+
* @see {@link ApiGatewayV2ClientResolvedConfig | config} for ApiGatewayV2Client's `config` shape.
|
|
108
|
+
*
|
|
109
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
110
|
+
*
|
|
111
|
+
* @throws {@link BadRequestException} (client fault)
|
|
112
|
+
* <p>The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.</p>
|
|
113
|
+
*
|
|
114
|
+
* @throws {@link NotFoundException} (client fault)
|
|
115
|
+
* <p>The resource specified in the request was not found. See the message field for more information.</p>
|
|
116
|
+
*
|
|
117
|
+
* @throws {@link TooManyRequestsException} (client fault)
|
|
118
|
+
* <p>A limit has been exceeded. See the accompanying error message for details.</p>
|
|
119
|
+
*
|
|
120
|
+
* @throws {@link ApiGatewayV2ServiceException}
|
|
121
|
+
* <p>Base exception class for all service exceptions from ApiGatewayV2 service.</p>
|
|
122
|
+
*
|
|
123
|
+
*
|
|
124
|
+
* @public
|
|
125
|
+
*/
|
|
126
|
+
export declare class GetPortalCommand extends GetPortalCommand_base {
|
|
127
|
+
/** @internal type navigation helper, not in runtime. */
|
|
128
|
+
protected static __types: {
|
|
129
|
+
api: {
|
|
130
|
+
input: GetPortalRequest;
|
|
131
|
+
output: GetPortalResponse;
|
|
132
|
+
};
|
|
133
|
+
sdk: {
|
|
134
|
+
input: GetPortalCommandInput;
|
|
135
|
+
output: GetPortalCommandOutput;
|
|
136
|
+
};
|
|
137
|
+
};
|
|
138
|
+
}
|
|
@@ -0,0 +1,107 @@
|
|
|
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 { GetPortalProductRequest, GetPortalProductResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetPortalProductCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetPortalProductCommandInput extends GetPortalProductRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetPortalProductCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetPortalProductCommandOutput extends GetPortalProductResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetPortalProductCommand_base: {
|
|
25
|
+
new (input: GetPortalProductCommandInput): import("@smithy/smithy-client").CommandImpl<GetPortalProductCommandInput, GetPortalProductCommandOutput, ApiGatewayV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: GetPortalProductCommandInput): import("@smithy/smithy-client").CommandImpl<GetPortalProductCommandInput, GetPortalProductCommandOutput, ApiGatewayV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Gets 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, GetPortalProductCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import
|
|
35
|
+
* // const { ApiGatewayV2Client, GetPortalProductCommand } = 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 = { // GetPortalProductRequest
|
|
40
|
+
* PortalProductId: "STRING_VALUE", // required
|
|
41
|
+
* ResourceOwnerAccountId: "STRING_VALUE",
|
|
42
|
+
* };
|
|
43
|
+
* const command = new GetPortalProductCommand(input);
|
|
44
|
+
* const response = await client.send(command);
|
|
45
|
+
* // { // GetPortalProductResponse
|
|
46
|
+
* // Description: "STRING_VALUE",
|
|
47
|
+
* // DisplayName: "STRING_VALUE",
|
|
48
|
+
* // DisplayOrder: { // DisplayOrder
|
|
49
|
+
* // Contents: [ // __listOfSection
|
|
50
|
+
* // { // Section
|
|
51
|
+
* // ProductRestEndpointPageArns: [ // __listOf__stringMin20Max2048 // required
|
|
52
|
+
* // "STRING_VALUE",
|
|
53
|
+
* // ],
|
|
54
|
+
* // SectionName: "STRING_VALUE", // required
|
|
55
|
+
* // },
|
|
56
|
+
* // ],
|
|
57
|
+
* // OverviewPageArn: "STRING_VALUE",
|
|
58
|
+
* // ProductPageArns: [
|
|
59
|
+
* // "STRING_VALUE",
|
|
60
|
+
* // ],
|
|
61
|
+
* // },
|
|
62
|
+
* // LastModified: new Date("TIMESTAMP"),
|
|
63
|
+
* // PortalProductArn: "STRING_VALUE",
|
|
64
|
+
* // PortalProductId: "STRING_VALUE",
|
|
65
|
+
* // Tags: { // Tags
|
|
66
|
+
* // "<keys>": "STRING_VALUE",
|
|
67
|
+
* // },
|
|
68
|
+
* // };
|
|
69
|
+
*
|
|
70
|
+
* ```
|
|
71
|
+
*
|
|
72
|
+
* @param GetPortalProductCommandInput - {@link GetPortalProductCommandInput}
|
|
73
|
+
* @returns {@link GetPortalProductCommandOutput}
|
|
74
|
+
* @see {@link GetPortalProductCommandInput} for command's `input` shape.
|
|
75
|
+
* @see {@link GetPortalProductCommandOutput} for command's `response` shape.
|
|
76
|
+
* @see {@link ApiGatewayV2ClientResolvedConfig | config} for ApiGatewayV2Client's `config` shape.
|
|
77
|
+
*
|
|
78
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link BadRequestException} (client fault)
|
|
81
|
+
* <p>The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.</p>
|
|
82
|
+
*
|
|
83
|
+
* @throws {@link NotFoundException} (client fault)
|
|
84
|
+
* <p>The resource specified in the request was not found. See the message field for more information.</p>
|
|
85
|
+
*
|
|
86
|
+
* @throws {@link TooManyRequestsException} (client fault)
|
|
87
|
+
* <p>A limit has been exceeded. See the accompanying error message for details.</p>
|
|
88
|
+
*
|
|
89
|
+
* @throws {@link ApiGatewayV2ServiceException}
|
|
90
|
+
* <p>Base exception class for all service exceptions from ApiGatewayV2 service.</p>
|
|
91
|
+
*
|
|
92
|
+
*
|
|
93
|
+
* @public
|
|
94
|
+
*/
|
|
95
|
+
export declare class GetPortalProductCommand extends GetPortalProductCommand_base {
|
|
96
|
+
/** @internal type navigation helper, not in runtime. */
|
|
97
|
+
protected static __types: {
|
|
98
|
+
api: {
|
|
99
|
+
input: GetPortalProductRequest;
|
|
100
|
+
output: GetPortalProductResponse;
|
|
101
|
+
};
|
|
102
|
+
sdk: {
|
|
103
|
+
input: GetPortalProductCommandInput;
|
|
104
|
+
output: GetPortalProductCommandOutput;
|
|
105
|
+
};
|
|
106
|
+
};
|
|
107
|
+
}
|
|
@@ -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 { GetPortalProductSharingPolicyRequest, GetPortalProductSharingPolicyResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetPortalProductSharingPolicyCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetPortalProductSharingPolicyCommandInput extends GetPortalProductSharingPolicyRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetPortalProductSharingPolicyCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetPortalProductSharingPolicyCommandOutput extends GetPortalProductSharingPolicyResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetPortalProductSharingPolicyCommand_base: {
|
|
25
|
+
new (input: GetPortalProductSharingPolicyCommandInput): import("@smithy/smithy-client").CommandImpl<GetPortalProductSharingPolicyCommandInput, GetPortalProductSharingPolicyCommandOutput, ApiGatewayV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: GetPortalProductSharingPolicyCommandInput): import("@smithy/smithy-client").CommandImpl<GetPortalProductSharingPolicyCommandInput, GetPortalProductSharingPolicyCommandOutput, ApiGatewayV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Gets the sharing policy 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, GetPortalProductSharingPolicyCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import
|
|
35
|
+
* // const { ApiGatewayV2Client, GetPortalProductSharingPolicyCommand } = 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 = { // GetPortalProductSharingPolicyRequest
|
|
40
|
+
* PortalProductId: "STRING_VALUE", // required
|
|
41
|
+
* };
|
|
42
|
+
* const command = new GetPortalProductSharingPolicyCommand(input);
|
|
43
|
+
* const response = await client.send(command);
|
|
44
|
+
* // { // GetPortalProductSharingPolicyResponse
|
|
45
|
+
* // PolicyDocument: "STRING_VALUE",
|
|
46
|
+
* // PortalProductId: "STRING_VALUE",
|
|
47
|
+
* // };
|
|
48
|
+
*
|
|
49
|
+
* ```
|
|
50
|
+
*
|
|
51
|
+
* @param GetPortalProductSharingPolicyCommandInput - {@link GetPortalProductSharingPolicyCommandInput}
|
|
52
|
+
* @returns {@link GetPortalProductSharingPolicyCommandOutput}
|
|
53
|
+
* @see {@link GetPortalProductSharingPolicyCommandInput} for command's `input` shape.
|
|
54
|
+
* @see {@link GetPortalProductSharingPolicyCommandOutput} for command's `response` shape.
|
|
55
|
+
* @see {@link ApiGatewayV2ClientResolvedConfig | config} for ApiGatewayV2Client's `config` shape.
|
|
56
|
+
*
|
|
57
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
58
|
+
*
|
|
59
|
+
* @throws {@link BadRequestException} (client fault)
|
|
60
|
+
* <p>The request is not valid, for example, the input is incomplete or incorrect. 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 GetPortalProductSharingPolicyCommand extends GetPortalProductSharingPolicyCommand_base {
|
|
75
|
+
/** @internal type navigation helper, not in runtime. */
|
|
76
|
+
protected static __types: {
|
|
77
|
+
api: {
|
|
78
|
+
input: GetPortalProductSharingPolicyRequest;
|
|
79
|
+
output: GetPortalProductSharingPolicyResponse;
|
|
80
|
+
};
|
|
81
|
+
sdk: {
|
|
82
|
+
input: GetPortalProductSharingPolicyCommandInput;
|
|
83
|
+
output: GetPortalProductSharingPolicyCommandOutput;
|
|
84
|
+
};
|
|
85
|
+
};
|
|
86
|
+
}
|
|
@@ -0,0 +1,93 @@
|
|
|
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 { GetProductPageRequest, GetProductPageResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetProductPageCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetProductPageCommandInput extends GetProductPageRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetProductPageCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetProductPageCommandOutput extends GetProductPageResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetProductPageCommand_base: {
|
|
25
|
+
new (input: GetProductPageCommandInput): import("@smithy/smithy-client").CommandImpl<GetProductPageCommandInput, GetProductPageCommandOutput, ApiGatewayV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: GetProductPageCommandInput): import("@smithy/smithy-client").CommandImpl<GetProductPageCommandInput, GetProductPageCommandOutput, ApiGatewayV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Gets a product page 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, GetProductPageCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import
|
|
35
|
+
* // const { ApiGatewayV2Client, GetProductPageCommand } = 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 = { // GetProductPageRequest
|
|
40
|
+
* PortalProductId: "STRING_VALUE", // required
|
|
41
|
+
* ProductPageId: "STRING_VALUE", // required
|
|
42
|
+
* ResourceOwnerAccountId: "STRING_VALUE",
|
|
43
|
+
* };
|
|
44
|
+
* const command = new GetProductPageCommand(input);
|
|
45
|
+
* const response = await client.send(command);
|
|
46
|
+
* // { // GetProductPageResponse
|
|
47
|
+
* // DisplayContent: { // DisplayContent
|
|
48
|
+
* // Body: "STRING_VALUE", // required
|
|
49
|
+
* // Title: "STRING_VALUE", // required
|
|
50
|
+
* // },
|
|
51
|
+
* // LastModified: new Date("TIMESTAMP"),
|
|
52
|
+
* // ProductPageArn: "STRING_VALUE",
|
|
53
|
+
* // ProductPageId: "STRING_VALUE",
|
|
54
|
+
* // };
|
|
55
|
+
*
|
|
56
|
+
* ```
|
|
57
|
+
*
|
|
58
|
+
* @param GetProductPageCommandInput - {@link GetProductPageCommandInput}
|
|
59
|
+
* @returns {@link GetProductPageCommandOutput}
|
|
60
|
+
* @see {@link GetProductPageCommandInput} for command's `input` shape.
|
|
61
|
+
* @see {@link GetProductPageCommandOutput} for command's `response` shape.
|
|
62
|
+
* @see {@link ApiGatewayV2ClientResolvedConfig | config} for ApiGatewayV2Client's `config` shape.
|
|
63
|
+
*
|
|
64
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link BadRequestException} (client fault)
|
|
67
|
+
* <p>The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.</p>
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link NotFoundException} (client fault)
|
|
70
|
+
* <p>The resource specified in the request was not found. See the message field for more information.</p>
|
|
71
|
+
*
|
|
72
|
+
* @throws {@link TooManyRequestsException} (client fault)
|
|
73
|
+
* <p>A limit has been exceeded. See the accompanying error message for details.</p>
|
|
74
|
+
*
|
|
75
|
+
* @throws {@link ApiGatewayV2ServiceException}
|
|
76
|
+
* <p>Base exception class for all service exceptions from ApiGatewayV2 service.</p>
|
|
77
|
+
*
|
|
78
|
+
*
|
|
79
|
+
* @public
|
|
80
|
+
*/
|
|
81
|
+
export declare class GetProductPageCommand extends GetProductPageCommand_base {
|
|
82
|
+
/** @internal type navigation helper, not in runtime. */
|
|
83
|
+
protected static __types: {
|
|
84
|
+
api: {
|
|
85
|
+
input: GetProductPageRequest;
|
|
86
|
+
output: GetProductPageResponse;
|
|
87
|
+
};
|
|
88
|
+
sdk: {
|
|
89
|
+
input: GetProductPageCommandInput;
|
|
90
|
+
output: GetProductPageCommandOutput;
|
|
91
|
+
};
|
|
92
|
+
};
|
|
93
|
+
}
|