@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,87 @@
|
|
|
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 { PublishPortalRequest, PublishPortalResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link PublishPortalCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface PublishPortalCommandInput extends PublishPortalRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link PublishPortalCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface PublishPortalCommandOutput extends PublishPortalResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const PublishPortalCommand_base: {
|
|
25
|
+
new (input: PublishPortalCommandInput): import("@smithy/smithy-client").CommandImpl<PublishPortalCommandInput, PublishPortalCommandOutput, ApiGatewayV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: PublishPortalCommandInput): import("@smithy/smithy-client").CommandImpl<PublishPortalCommandInput, PublishPortalCommandOutput, ApiGatewayV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Publishes 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, PublishPortalCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import
|
|
35
|
+
* // const { ApiGatewayV2Client, PublishPortalCommand } = 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 = { // PublishPortalRequest
|
|
40
|
+
* Description: "STRING_VALUE",
|
|
41
|
+
* PortalId: "STRING_VALUE", // required
|
|
42
|
+
* };
|
|
43
|
+
* const command = new PublishPortalCommand(input);
|
|
44
|
+
* const response = await client.send(command);
|
|
45
|
+
* // {};
|
|
46
|
+
*
|
|
47
|
+
* ```
|
|
48
|
+
*
|
|
49
|
+
* @param PublishPortalCommandInput - {@link PublishPortalCommandInput}
|
|
50
|
+
* @returns {@link PublishPortalCommandOutput}
|
|
51
|
+
* @see {@link PublishPortalCommandInput} for command's `input` shape.
|
|
52
|
+
* @see {@link PublishPortalCommandOutput} 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 ConflictException} (client fault)
|
|
61
|
+
* <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>
|
|
62
|
+
*
|
|
63
|
+
* @throws {@link NotFoundException} (client fault)
|
|
64
|
+
* <p>The resource specified in the request was not found. See the message field for more information.</p>
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link TooManyRequestsException} (client fault)
|
|
67
|
+
* <p>A limit has been exceeded. See the accompanying error message for details.</p>
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link ApiGatewayV2ServiceException}
|
|
70
|
+
* <p>Base exception class for all service exceptions from ApiGatewayV2 service.</p>
|
|
71
|
+
*
|
|
72
|
+
*
|
|
73
|
+
* @public
|
|
74
|
+
*/
|
|
75
|
+
export declare class PublishPortalCommand extends PublishPortalCommand_base {
|
|
76
|
+
/** @internal type navigation helper, not in runtime. */
|
|
77
|
+
protected static __types: {
|
|
78
|
+
api: {
|
|
79
|
+
input: PublishPortalRequest;
|
|
80
|
+
output: {};
|
|
81
|
+
};
|
|
82
|
+
sdk: {
|
|
83
|
+
input: PublishPortalCommandInput;
|
|
84
|
+
output: PublishPortalCommandOutput;
|
|
85
|
+
};
|
|
86
|
+
};
|
|
87
|
+
}
|
|
@@ -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 { PutPortalProductSharingPolicyRequest, PutPortalProductSharingPolicyResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link PutPortalProductSharingPolicyCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface PutPortalProductSharingPolicyCommandInput extends PutPortalProductSharingPolicyRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link PutPortalProductSharingPolicyCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface PutPortalProductSharingPolicyCommandOutput extends PutPortalProductSharingPolicyResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const PutPortalProductSharingPolicyCommand_base: {
|
|
25
|
+
new (input: PutPortalProductSharingPolicyCommandInput): import("@smithy/smithy-client").CommandImpl<PutPortalProductSharingPolicyCommandInput, PutPortalProductSharingPolicyCommandOutput, ApiGatewayV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: PutPortalProductSharingPolicyCommandInput): import("@smithy/smithy-client").CommandImpl<PutPortalProductSharingPolicyCommandInput, PutPortalProductSharingPolicyCommandOutput, ApiGatewayV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Updates 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, PutPortalProductSharingPolicyCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import
|
|
35
|
+
* // const { ApiGatewayV2Client, PutPortalProductSharingPolicyCommand } = 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 = { // PutPortalProductSharingPolicyRequest
|
|
40
|
+
* PolicyDocument: "STRING_VALUE", // required
|
|
41
|
+
* PortalProductId: "STRING_VALUE", // required
|
|
42
|
+
* };
|
|
43
|
+
* const command = new PutPortalProductSharingPolicyCommand(input);
|
|
44
|
+
* const response = await client.send(command);
|
|
45
|
+
* // {};
|
|
46
|
+
*
|
|
47
|
+
* ```
|
|
48
|
+
*
|
|
49
|
+
* @param PutPortalProductSharingPolicyCommandInput - {@link PutPortalProductSharingPolicyCommandInput}
|
|
50
|
+
* @returns {@link PutPortalProductSharingPolicyCommandOutput}
|
|
51
|
+
* @see {@link PutPortalProductSharingPolicyCommandInput} for command's `input` shape.
|
|
52
|
+
* @see {@link PutPortalProductSharingPolicyCommandOutput} 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 PutPortalProductSharingPolicyCommand extends PutPortalProductSharingPolicyCommand_base {
|
|
73
|
+
/** @internal type navigation helper, not in runtime. */
|
|
74
|
+
protected static __types: {
|
|
75
|
+
api: {
|
|
76
|
+
input: PutPortalProductSharingPolicyRequest;
|
|
77
|
+
output: {};
|
|
78
|
+
};
|
|
79
|
+
sdk: {
|
|
80
|
+
input: PutPortalProductSharingPolicyCommandInput;
|
|
81
|
+
output: PutPortalProductSharingPolicyCommandOutput;
|
|
82
|
+
};
|
|
83
|
+
};
|
|
84
|
+
}
|
|
@@ -0,0 +1,176 @@
|
|
|
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 { UpdatePortalRequest, UpdatePortalResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link UpdatePortalCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface UpdatePortalCommandInput extends UpdatePortalRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link UpdatePortalCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface UpdatePortalCommandOutput extends UpdatePortalResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const UpdatePortalCommand_base: {
|
|
25
|
+
new (input: UpdatePortalCommandInput): import("@smithy/smithy-client").CommandImpl<UpdatePortalCommandInput, UpdatePortalCommandOutput, ApiGatewayV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: UpdatePortalCommandInput): import("@smithy/smithy-client").CommandImpl<UpdatePortalCommandInput, UpdatePortalCommandOutput, ApiGatewayV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Updates 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, UpdatePortalCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import
|
|
35
|
+
* // const { ApiGatewayV2Client, UpdatePortalCommand } = 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 = { // UpdatePortalRequest
|
|
40
|
+
* Authorization: { // Authorization
|
|
41
|
+
* CognitoConfig: { // CognitoConfig
|
|
42
|
+
* AppClientId: "STRING_VALUE", // required
|
|
43
|
+
* UserPoolArn: "STRING_VALUE", // required
|
|
44
|
+
* UserPoolDomain: "STRING_VALUE", // required
|
|
45
|
+
* },
|
|
46
|
+
* None: {},
|
|
47
|
+
* },
|
|
48
|
+
* EndpointConfiguration: { // EndpointConfigurationRequest
|
|
49
|
+
* AcmManaged: { // ACMManaged
|
|
50
|
+
* CertificateArn: "STRING_VALUE", // required
|
|
51
|
+
* DomainName: "STRING_VALUE", // required
|
|
52
|
+
* },
|
|
53
|
+
* None: {},
|
|
54
|
+
* },
|
|
55
|
+
* IncludedPortalProductArns: [ // __listOf__stringMin20Max2048
|
|
56
|
+
* "STRING_VALUE",
|
|
57
|
+
* ],
|
|
58
|
+
* LogoUri: "STRING_VALUE",
|
|
59
|
+
* PortalContent: { // PortalContent
|
|
60
|
+
* Description: "STRING_VALUE",
|
|
61
|
+
* DisplayName: "STRING_VALUE", // required
|
|
62
|
+
* Theme: { // PortalTheme
|
|
63
|
+
* CustomColors: { // CustomColors
|
|
64
|
+
* AccentColor: "STRING_VALUE", // required
|
|
65
|
+
* BackgroundColor: "STRING_VALUE", // required
|
|
66
|
+
* ErrorValidationColor: "STRING_VALUE", // required
|
|
67
|
+
* HeaderColor: "STRING_VALUE", // required
|
|
68
|
+
* NavigationColor: "STRING_VALUE", // required
|
|
69
|
+
* TextColor: "STRING_VALUE", // required
|
|
70
|
+
* },
|
|
71
|
+
* LogoLastUploaded: new Date("TIMESTAMP"),
|
|
72
|
+
* },
|
|
73
|
+
* },
|
|
74
|
+
* PortalId: "STRING_VALUE", // required
|
|
75
|
+
* RumAppMonitorName: "STRING_VALUE",
|
|
76
|
+
* };
|
|
77
|
+
* const command = new UpdatePortalCommand(input);
|
|
78
|
+
* const response = await client.send(command);
|
|
79
|
+
* // { // UpdatePortalResponse
|
|
80
|
+
* // Authorization: { // Authorization
|
|
81
|
+
* // CognitoConfig: { // CognitoConfig
|
|
82
|
+
* // AppClientId: "STRING_VALUE", // required
|
|
83
|
+
* // UserPoolArn: "STRING_VALUE", // required
|
|
84
|
+
* // UserPoolDomain: "STRING_VALUE", // required
|
|
85
|
+
* // },
|
|
86
|
+
* // None: {},
|
|
87
|
+
* // },
|
|
88
|
+
* // EndpointConfiguration: { // EndpointConfigurationResponse
|
|
89
|
+
* // CertificateArn: "STRING_VALUE",
|
|
90
|
+
* // DomainName: "STRING_VALUE",
|
|
91
|
+
* // PortalDefaultDomainName: "STRING_VALUE", // required
|
|
92
|
+
* // PortalDomainHostedZoneId: "STRING_VALUE", // required
|
|
93
|
+
* // },
|
|
94
|
+
* // IncludedPortalProductArns: [ // __listOf__stringMin20Max2048
|
|
95
|
+
* // "STRING_VALUE",
|
|
96
|
+
* // ],
|
|
97
|
+
* // LastModified: new Date("TIMESTAMP"),
|
|
98
|
+
* // LastPublished: new Date("TIMESTAMP"),
|
|
99
|
+
* // LastPublishedDescription: "STRING_VALUE",
|
|
100
|
+
* // PortalArn: "STRING_VALUE",
|
|
101
|
+
* // PortalContent: { // PortalContent
|
|
102
|
+
* // Description: "STRING_VALUE",
|
|
103
|
+
* // DisplayName: "STRING_VALUE", // required
|
|
104
|
+
* // Theme: { // PortalTheme
|
|
105
|
+
* // CustomColors: { // CustomColors
|
|
106
|
+
* // AccentColor: "STRING_VALUE", // required
|
|
107
|
+
* // BackgroundColor: "STRING_VALUE", // required
|
|
108
|
+
* // ErrorValidationColor: "STRING_VALUE", // required
|
|
109
|
+
* // HeaderColor: "STRING_VALUE", // required
|
|
110
|
+
* // NavigationColor: "STRING_VALUE", // required
|
|
111
|
+
* // TextColor: "STRING_VALUE", // required
|
|
112
|
+
* // },
|
|
113
|
+
* // LogoLastUploaded: new Date("TIMESTAMP"),
|
|
114
|
+
* // },
|
|
115
|
+
* // },
|
|
116
|
+
* // PortalId: "STRING_VALUE",
|
|
117
|
+
* // Preview: { // Preview
|
|
118
|
+
* // PreviewStatus: "PREVIEW_IN_PROGRESS" || "PREVIEW_FAILED" || "PREVIEW_READY", // required
|
|
119
|
+
* // PreviewUrl: "STRING_VALUE",
|
|
120
|
+
* // StatusException: { // StatusException
|
|
121
|
+
* // Exception: "STRING_VALUE",
|
|
122
|
+
* // Message: "STRING_VALUE",
|
|
123
|
+
* // },
|
|
124
|
+
* // },
|
|
125
|
+
* // PublishStatus: "PUBLISHED" || "PUBLISH_IN_PROGRESS" || "PUBLISH_FAILED" || "DISABLED",
|
|
126
|
+
* // RumAppMonitorName: "STRING_VALUE",
|
|
127
|
+
* // StatusException: {
|
|
128
|
+
* // Exception: "STRING_VALUE",
|
|
129
|
+
* // Message: "STRING_VALUE",
|
|
130
|
+
* // },
|
|
131
|
+
* // Tags: { // Tags
|
|
132
|
+
* // "<keys>": "STRING_VALUE",
|
|
133
|
+
* // },
|
|
134
|
+
* // };
|
|
135
|
+
*
|
|
136
|
+
* ```
|
|
137
|
+
*
|
|
138
|
+
* @param UpdatePortalCommandInput - {@link UpdatePortalCommandInput}
|
|
139
|
+
* @returns {@link UpdatePortalCommandOutput}
|
|
140
|
+
* @see {@link UpdatePortalCommandInput} for command's `input` shape.
|
|
141
|
+
* @see {@link UpdatePortalCommandOutput} for command's `response` shape.
|
|
142
|
+
* @see {@link ApiGatewayV2ClientResolvedConfig | config} for ApiGatewayV2Client's `config` shape.
|
|
143
|
+
*
|
|
144
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
145
|
+
*
|
|
146
|
+
* @throws {@link BadRequestException} (client fault)
|
|
147
|
+
* <p>The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.</p>
|
|
148
|
+
*
|
|
149
|
+
* @throws {@link ConflictException} (client fault)
|
|
150
|
+
* <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>
|
|
151
|
+
*
|
|
152
|
+
* @throws {@link NotFoundException} (client fault)
|
|
153
|
+
* <p>The resource specified in the request was not found. See the message field for more information.</p>
|
|
154
|
+
*
|
|
155
|
+
* @throws {@link TooManyRequestsException} (client fault)
|
|
156
|
+
* <p>A limit has been exceeded. See the accompanying error message for details.</p>
|
|
157
|
+
*
|
|
158
|
+
* @throws {@link ApiGatewayV2ServiceException}
|
|
159
|
+
* <p>Base exception class for all service exceptions from ApiGatewayV2 service.</p>
|
|
160
|
+
*
|
|
161
|
+
*
|
|
162
|
+
* @public
|
|
163
|
+
*/
|
|
164
|
+
export declare class UpdatePortalCommand extends UpdatePortalCommand_base {
|
|
165
|
+
/** @internal type navigation helper, not in runtime. */
|
|
166
|
+
protected static __types: {
|
|
167
|
+
api: {
|
|
168
|
+
input: UpdatePortalRequest;
|
|
169
|
+
output: UpdatePortalResponse;
|
|
170
|
+
};
|
|
171
|
+
sdk: {
|
|
172
|
+
input: UpdatePortalCommandInput;
|
|
173
|
+
output: UpdatePortalCommandOutput;
|
|
174
|
+
};
|
|
175
|
+
};
|
|
176
|
+
}
|
|
@@ -0,0 +1,122 @@
|
|
|
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 { UpdatePortalProductRequest, UpdatePortalProductResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link UpdatePortalProductCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface UpdatePortalProductCommandInput extends UpdatePortalProductRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link UpdatePortalProductCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface UpdatePortalProductCommandOutput extends UpdatePortalProductResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const UpdatePortalProductCommand_base: {
|
|
25
|
+
new (input: UpdatePortalProductCommandInput): import("@smithy/smithy-client").CommandImpl<UpdatePortalProductCommandInput, UpdatePortalProductCommandOutput, ApiGatewayV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: UpdatePortalProductCommandInput): import("@smithy/smithy-client").CommandImpl<UpdatePortalProductCommandInput, UpdatePortalProductCommandOutput, ApiGatewayV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Updates the 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, UpdatePortalProductCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import
|
|
35
|
+
* // const { ApiGatewayV2Client, UpdatePortalProductCommand } = 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 = { // UpdatePortalProductRequest
|
|
40
|
+
* Description: "STRING_VALUE",
|
|
41
|
+
* DisplayName: "STRING_VALUE",
|
|
42
|
+
* DisplayOrder: { // DisplayOrder
|
|
43
|
+
* Contents: [ // __listOfSection
|
|
44
|
+
* { // Section
|
|
45
|
+
* ProductRestEndpointPageArns: [ // __listOf__stringMin20Max2048 // required
|
|
46
|
+
* "STRING_VALUE",
|
|
47
|
+
* ],
|
|
48
|
+
* SectionName: "STRING_VALUE", // required
|
|
49
|
+
* },
|
|
50
|
+
* ],
|
|
51
|
+
* OverviewPageArn: "STRING_VALUE",
|
|
52
|
+
* ProductPageArns: [
|
|
53
|
+
* "STRING_VALUE",
|
|
54
|
+
* ],
|
|
55
|
+
* },
|
|
56
|
+
* PortalProductId: "STRING_VALUE", // required
|
|
57
|
+
* };
|
|
58
|
+
* const command = new UpdatePortalProductCommand(input);
|
|
59
|
+
* const response = await client.send(command);
|
|
60
|
+
* // { // UpdatePortalProductResponse
|
|
61
|
+
* // Description: "STRING_VALUE",
|
|
62
|
+
* // DisplayName: "STRING_VALUE",
|
|
63
|
+
* // DisplayOrder: { // DisplayOrder
|
|
64
|
+
* // Contents: [ // __listOfSection
|
|
65
|
+
* // { // Section
|
|
66
|
+
* // ProductRestEndpointPageArns: [ // __listOf__stringMin20Max2048 // required
|
|
67
|
+
* // "STRING_VALUE",
|
|
68
|
+
* // ],
|
|
69
|
+
* // SectionName: "STRING_VALUE", // required
|
|
70
|
+
* // },
|
|
71
|
+
* // ],
|
|
72
|
+
* // OverviewPageArn: "STRING_VALUE",
|
|
73
|
+
* // ProductPageArns: [
|
|
74
|
+
* // "STRING_VALUE",
|
|
75
|
+
* // ],
|
|
76
|
+
* // },
|
|
77
|
+
* // LastModified: new Date("TIMESTAMP"),
|
|
78
|
+
* // PortalProductArn: "STRING_VALUE",
|
|
79
|
+
* // PortalProductId: "STRING_VALUE",
|
|
80
|
+
* // Tags: { // Tags
|
|
81
|
+
* // "<keys>": "STRING_VALUE",
|
|
82
|
+
* // },
|
|
83
|
+
* // };
|
|
84
|
+
*
|
|
85
|
+
* ```
|
|
86
|
+
*
|
|
87
|
+
* @param UpdatePortalProductCommandInput - {@link UpdatePortalProductCommandInput}
|
|
88
|
+
* @returns {@link UpdatePortalProductCommandOutput}
|
|
89
|
+
* @see {@link UpdatePortalProductCommandInput} for command's `input` shape.
|
|
90
|
+
* @see {@link UpdatePortalProductCommandOutput} for command's `response` shape.
|
|
91
|
+
* @see {@link ApiGatewayV2ClientResolvedConfig | config} for ApiGatewayV2Client's `config` shape.
|
|
92
|
+
*
|
|
93
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
94
|
+
*
|
|
95
|
+
* @throws {@link BadRequestException} (client fault)
|
|
96
|
+
* <p>The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.</p>
|
|
97
|
+
*
|
|
98
|
+
* @throws {@link NotFoundException} (client fault)
|
|
99
|
+
* <p>The resource specified in the request was not found. See the message field for more information.</p>
|
|
100
|
+
*
|
|
101
|
+
* @throws {@link TooManyRequestsException} (client fault)
|
|
102
|
+
* <p>A limit has been exceeded. See the accompanying error message for details.</p>
|
|
103
|
+
*
|
|
104
|
+
* @throws {@link ApiGatewayV2ServiceException}
|
|
105
|
+
* <p>Base exception class for all service exceptions from ApiGatewayV2 service.</p>
|
|
106
|
+
*
|
|
107
|
+
*
|
|
108
|
+
* @public
|
|
109
|
+
*/
|
|
110
|
+
export declare class UpdatePortalProductCommand extends UpdatePortalProductCommand_base {
|
|
111
|
+
/** @internal type navigation helper, not in runtime. */
|
|
112
|
+
protected static __types: {
|
|
113
|
+
api: {
|
|
114
|
+
input: UpdatePortalProductRequest;
|
|
115
|
+
output: UpdatePortalProductResponse;
|
|
116
|
+
};
|
|
117
|
+
sdk: {
|
|
118
|
+
input: UpdatePortalProductCommandInput;
|
|
119
|
+
output: UpdatePortalProductCommandOutput;
|
|
120
|
+
};
|
|
121
|
+
};
|
|
122
|
+
}
|
|
@@ -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 { UpdateProductPageRequest, UpdateProductPageResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link UpdateProductPageCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface UpdateProductPageCommandInput extends UpdateProductPageRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link UpdateProductPageCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface UpdateProductPageCommandOutput extends UpdateProductPageResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const UpdateProductPageCommand_base: {
|
|
25
|
+
new (input: UpdateProductPageCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateProductPageCommandInput, UpdateProductPageCommandOutput, ApiGatewayV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: UpdateProductPageCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateProductPageCommandInput, UpdateProductPageCommandOutput, ApiGatewayV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Updates 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, UpdateProductPageCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import
|
|
35
|
+
* // const { ApiGatewayV2Client, UpdateProductPageCommand } = 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 = { // UpdateProductPageRequest
|
|
40
|
+
* DisplayContent: { // DisplayContent
|
|
41
|
+
* Body: "STRING_VALUE", // required
|
|
42
|
+
* Title: "STRING_VALUE", // required
|
|
43
|
+
* },
|
|
44
|
+
* PortalProductId: "STRING_VALUE", // required
|
|
45
|
+
* ProductPageId: "STRING_VALUE", // required
|
|
46
|
+
* };
|
|
47
|
+
* const command = new UpdateProductPageCommand(input);
|
|
48
|
+
* const response = await client.send(command);
|
|
49
|
+
* // { // UpdateProductPageResponse
|
|
50
|
+
* // DisplayContent: { // DisplayContent
|
|
51
|
+
* // Body: "STRING_VALUE", // required
|
|
52
|
+
* // Title: "STRING_VALUE", // required
|
|
53
|
+
* // },
|
|
54
|
+
* // LastModified: new Date("TIMESTAMP"),
|
|
55
|
+
* // ProductPageArn: "STRING_VALUE",
|
|
56
|
+
* // ProductPageId: "STRING_VALUE",
|
|
57
|
+
* // };
|
|
58
|
+
*
|
|
59
|
+
* ```
|
|
60
|
+
*
|
|
61
|
+
* @param UpdateProductPageCommandInput - {@link UpdateProductPageCommandInput}
|
|
62
|
+
* @returns {@link UpdateProductPageCommandOutput}
|
|
63
|
+
* @see {@link UpdateProductPageCommandInput} for command's `input` shape.
|
|
64
|
+
* @see {@link UpdateProductPageCommandOutput} 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 UpdateProductPageCommand extends UpdateProductPageCommand_base {
|
|
85
|
+
/** @internal type navigation helper, not in runtime. */
|
|
86
|
+
protected static __types: {
|
|
87
|
+
api: {
|
|
88
|
+
input: UpdateProductPageRequest;
|
|
89
|
+
output: UpdateProductPageResponse;
|
|
90
|
+
};
|
|
91
|
+
sdk: {
|
|
92
|
+
input: UpdateProductPageCommandInput;
|
|
93
|
+
output: UpdateProductPageCommandOutput;
|
|
94
|
+
};
|
|
95
|
+
};
|
|
96
|
+
}
|