@aws-sdk/client-amplify 3.321.1 → 3.326.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/dist-types/commands/CreateAppCommand.d.ts +62 -0
- package/dist-types/commands/CreateBackendEnvironmentCommand.d.ts +13 -0
- package/dist-types/commands/CreateBranchCommand.d.ts +42 -0
- package/dist-types/commands/CreateDeploymentCommand.d.ts +10 -0
- package/dist-types/commands/CreateDomainAssociationCommand.d.ts +27 -0
- package/dist-types/commands/CreateWebhookCommand.d.ts +14 -0
- package/dist-types/commands/DeleteAppCommand.d.ts +62 -0
- package/dist-types/commands/DeleteBackendEnvironmentCommand.d.ts +13 -0
- package/dist-types/commands/DeleteBranchCommand.d.ts +42 -0
- package/dist-types/commands/DeleteDomainAssociationCommand.d.ts +27 -0
- package/dist-types/commands/DeleteJobCommand.d.ts +16 -0
- package/dist-types/commands/DeleteWebhookCommand.d.ts +14 -0
- package/dist-types/commands/GenerateAccessLogsCommand.d.ts +6 -0
- package/dist-types/commands/GetAppCommand.d.ts +62 -0
- package/dist-types/commands/GetArtifactUrlCommand.d.ts +7 -0
- package/dist-types/commands/GetBackendEnvironmentCommand.d.ts +13 -0
- package/dist-types/commands/GetBranchCommand.d.ts +42 -0
- package/dist-types/commands/GetDomainAssociationCommand.d.ts +27 -0
- package/dist-types/commands/GetJobCommand.d.ts +35 -0
- package/dist-types/commands/GetWebhookCommand.d.ts +14 -0
- package/dist-types/commands/ListAppsCommand.d.ts +65 -0
- package/dist-types/commands/ListArtifactsCommand.d.ts +12 -0
- package/dist-types/commands/ListBackendEnvironmentsCommand.d.ts +16 -0
- package/dist-types/commands/ListBranchesCommand.d.ts +45 -0
- package/dist-types/commands/ListDomainAssociationsCommand.d.ts +30 -0
- package/dist-types/commands/ListJobsCommand.d.ts +19 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +8 -0
- package/dist-types/commands/ListWebhooksCommand.d.ts +17 -0
- package/dist-types/commands/StartDeploymentCommand.d.ts +16 -0
- package/dist-types/commands/StartJobCommand.d.ts +16 -0
- package/dist-types/commands/StopJobCommand.d.ts +16 -0
- package/dist-types/commands/TagResourceCommand.d.ts +4 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +4 -0
- package/dist-types/commands/UpdateAppCommand.d.ts +62 -0
- package/dist-types/commands/UpdateBranchCommand.d.ts +42 -0
- package/dist-types/commands/UpdateDomainAssociationCommand.d.ts +27 -0
- package/dist-types/commands/UpdateWebhookCommand.d.ts +14 -0
- package/package.json +16 -16
|
@@ -32,6 +32,17 @@ export interface GetBackendEnvironmentCommandOutput extends GetBackendEnvironmen
|
|
|
32
32
|
* };
|
|
33
33
|
* const command = new GetBackendEnvironmentCommand(input);
|
|
34
34
|
* const response = await client.send(command);
|
|
35
|
+
* // { // GetBackendEnvironmentResult
|
|
36
|
+
* // backendEnvironment: { // BackendEnvironment
|
|
37
|
+
* // backendEnvironmentArn: "STRING_VALUE", // required
|
|
38
|
+
* // environmentName: "STRING_VALUE", // required
|
|
39
|
+
* // stackName: "STRING_VALUE",
|
|
40
|
+
* // deploymentArtifacts: "STRING_VALUE",
|
|
41
|
+
* // createTime: new Date("TIMESTAMP"), // required
|
|
42
|
+
* // updateTime: new Date("TIMESTAMP"), // required
|
|
43
|
+
* // },
|
|
44
|
+
* // };
|
|
45
|
+
*
|
|
35
46
|
* ```
|
|
36
47
|
*
|
|
37
48
|
* @param GetBackendEnvironmentCommandInput - {@link GetBackendEnvironmentCommandInput}
|
|
@@ -52,6 +63,8 @@ export interface GetBackendEnvironmentCommandOutput extends GetBackendEnvironmen
|
|
|
52
63
|
* @throws {@link UnauthorizedException} (client fault)
|
|
53
64
|
* <p> An operation failed due to a lack of access. </p>
|
|
54
65
|
*
|
|
66
|
+
* @throws {@link AmplifyServiceException}
|
|
67
|
+
* <p>Base exception class for all service exceptions from Amplify service.</p>
|
|
55
68
|
*
|
|
56
69
|
*/
|
|
57
70
|
export declare class GetBackendEnvironmentCommand extends $Command<GetBackendEnvironmentCommandInput, GetBackendEnvironmentCommandOutput, AmplifyClientResolvedConfig> {
|
|
@@ -32,6 +32,46 @@ export interface GetBranchCommandOutput extends GetBranchResult, __MetadataBeare
|
|
|
32
32
|
* };
|
|
33
33
|
* const command = new GetBranchCommand(input);
|
|
34
34
|
* const response = await client.send(command);
|
|
35
|
+
* // { // GetBranchResult
|
|
36
|
+
* // branch: { // Branch
|
|
37
|
+
* // branchArn: "STRING_VALUE", // required
|
|
38
|
+
* // branchName: "STRING_VALUE", // required
|
|
39
|
+
* // description: "STRING_VALUE", // required
|
|
40
|
+
* // tags: { // TagMap
|
|
41
|
+
* // "<keys>": "STRING_VALUE",
|
|
42
|
+
* // },
|
|
43
|
+
* // stage: "PRODUCTION" || "BETA" || "DEVELOPMENT" || "EXPERIMENTAL" || "PULL_REQUEST", // required
|
|
44
|
+
* // displayName: "STRING_VALUE", // required
|
|
45
|
+
* // enableNotification: true || false, // required
|
|
46
|
+
* // createTime: new Date("TIMESTAMP"), // required
|
|
47
|
+
* // updateTime: new Date("TIMESTAMP"), // required
|
|
48
|
+
* // environmentVariables: { // EnvironmentVariables // required
|
|
49
|
+
* // "<keys>": "STRING_VALUE",
|
|
50
|
+
* // },
|
|
51
|
+
* // enableAutoBuild: true || false, // required
|
|
52
|
+
* // customDomains: [ // CustomDomains // required
|
|
53
|
+
* // "STRING_VALUE",
|
|
54
|
+
* // ],
|
|
55
|
+
* // framework: "STRING_VALUE", // required
|
|
56
|
+
* // activeJobId: "STRING_VALUE", // required
|
|
57
|
+
* // totalNumberOfJobs: "STRING_VALUE", // required
|
|
58
|
+
* // enableBasicAuth: true || false, // required
|
|
59
|
+
* // enablePerformanceMode: true || false,
|
|
60
|
+
* // thumbnailUrl: "STRING_VALUE",
|
|
61
|
+
* // basicAuthCredentials: "STRING_VALUE",
|
|
62
|
+
* // buildSpec: "STRING_VALUE",
|
|
63
|
+
* // ttl: "STRING_VALUE", // required
|
|
64
|
+
* // associatedResources: [ // AssociatedResources
|
|
65
|
+
* // "STRING_VALUE",
|
|
66
|
+
* // ],
|
|
67
|
+
* // enablePullRequestPreview: true || false, // required
|
|
68
|
+
* // pullRequestEnvironmentName: "STRING_VALUE",
|
|
69
|
+
* // destinationBranch: "STRING_VALUE",
|
|
70
|
+
* // sourceBranch: "STRING_VALUE",
|
|
71
|
+
* // backendEnvironmentArn: "STRING_VALUE",
|
|
72
|
+
* // },
|
|
73
|
+
* // };
|
|
74
|
+
*
|
|
35
75
|
* ```
|
|
36
76
|
*
|
|
37
77
|
* @param GetBranchCommandInput - {@link GetBranchCommandInput}
|
|
@@ -52,6 +92,8 @@ export interface GetBranchCommandOutput extends GetBranchResult, __MetadataBeare
|
|
|
52
92
|
* @throws {@link UnauthorizedException} (client fault)
|
|
53
93
|
* <p> An operation failed due to a lack of access. </p>
|
|
54
94
|
*
|
|
95
|
+
* @throws {@link AmplifyServiceException}
|
|
96
|
+
* <p>Base exception class for all service exceptions from Amplify service.</p>
|
|
55
97
|
*
|
|
56
98
|
*/
|
|
57
99
|
export declare class GetBranchCommand extends $Command<GetBranchCommandInput, GetBranchCommandOutput, AmplifyClientResolvedConfig> {
|
|
@@ -32,6 +32,31 @@ export interface GetDomainAssociationCommandOutput extends GetDomainAssociationR
|
|
|
32
32
|
* };
|
|
33
33
|
* const command = new GetDomainAssociationCommand(input);
|
|
34
34
|
* const response = await client.send(command);
|
|
35
|
+
* // { // GetDomainAssociationResult
|
|
36
|
+
* // domainAssociation: { // DomainAssociation
|
|
37
|
+
* // domainAssociationArn: "STRING_VALUE", // required
|
|
38
|
+
* // domainName: "STRING_VALUE", // required
|
|
39
|
+
* // enableAutoSubDomain: true || false, // required
|
|
40
|
+
* // autoSubDomainCreationPatterns: [ // AutoSubDomainCreationPatterns
|
|
41
|
+
* // "STRING_VALUE",
|
|
42
|
+
* // ],
|
|
43
|
+
* // autoSubDomainIAMRole: "STRING_VALUE",
|
|
44
|
+
* // domainStatus: "PENDING_VERIFICATION" || "IN_PROGRESS" || "AVAILABLE" || "PENDING_DEPLOYMENT" || "FAILED" || "CREATING" || "REQUESTING_CERTIFICATE" || "UPDATING", // required
|
|
45
|
+
* // statusReason: "STRING_VALUE", // required
|
|
46
|
+
* // certificateVerificationDNSRecord: "STRING_VALUE",
|
|
47
|
+
* // subDomains: [ // SubDomains // required
|
|
48
|
+
* // { // SubDomain
|
|
49
|
+
* // subDomainSetting: { // SubDomainSetting
|
|
50
|
+
* // prefix: "STRING_VALUE", // required
|
|
51
|
+
* // branchName: "STRING_VALUE", // required
|
|
52
|
+
* // },
|
|
53
|
+
* // verified: true || false, // required
|
|
54
|
+
* // dnsRecord: "STRING_VALUE", // required
|
|
55
|
+
* // },
|
|
56
|
+
* // ],
|
|
57
|
+
* // },
|
|
58
|
+
* // };
|
|
59
|
+
*
|
|
35
60
|
* ```
|
|
36
61
|
*
|
|
37
62
|
* @param GetDomainAssociationCommandInput - {@link GetDomainAssociationCommandInput}
|
|
@@ -52,6 +77,8 @@ export interface GetDomainAssociationCommandOutput extends GetDomainAssociationR
|
|
|
52
77
|
* @throws {@link UnauthorizedException} (client fault)
|
|
53
78
|
* <p> An operation failed due to a lack of access. </p>
|
|
54
79
|
*
|
|
80
|
+
* @throws {@link AmplifyServiceException}
|
|
81
|
+
* <p>Base exception class for all service exceptions from Amplify service.</p>
|
|
55
82
|
*
|
|
56
83
|
*/
|
|
57
84
|
export declare class GetDomainAssociationCommand extends $Command<GetDomainAssociationCommandInput, GetDomainAssociationCommandOutput, AmplifyClientResolvedConfig> {
|
|
@@ -33,6 +33,39 @@ export interface GetJobCommandOutput extends GetJobResult, __MetadataBearer {
|
|
|
33
33
|
* };
|
|
34
34
|
* const command = new GetJobCommand(input);
|
|
35
35
|
* const response = await client.send(command);
|
|
36
|
+
* // { // GetJobResult
|
|
37
|
+
* // job: { // Job
|
|
38
|
+
* // summary: { // JobSummary
|
|
39
|
+
* // jobArn: "STRING_VALUE", // required
|
|
40
|
+
* // jobId: "STRING_VALUE", // required
|
|
41
|
+
* // commitId: "STRING_VALUE", // required
|
|
42
|
+
* // commitMessage: "STRING_VALUE", // required
|
|
43
|
+
* // commitTime: new Date("TIMESTAMP"), // required
|
|
44
|
+
* // startTime: new Date("TIMESTAMP"), // required
|
|
45
|
+
* // status: "PENDING" || "PROVISIONING" || "RUNNING" || "FAILED" || "SUCCEED" || "CANCELLING" || "CANCELLED", // required
|
|
46
|
+
* // endTime: new Date("TIMESTAMP"),
|
|
47
|
+
* // jobType: "RELEASE" || "RETRY" || "MANUAL" || "WEB_HOOK", // required
|
|
48
|
+
* // },
|
|
49
|
+
* // steps: [ // Steps // required
|
|
50
|
+
* // { // Step
|
|
51
|
+
* // stepName: "STRING_VALUE", // required
|
|
52
|
+
* // startTime: new Date("TIMESTAMP"), // required
|
|
53
|
+
* // status: "PENDING" || "PROVISIONING" || "RUNNING" || "FAILED" || "SUCCEED" || "CANCELLING" || "CANCELLED", // required
|
|
54
|
+
* // endTime: new Date("TIMESTAMP"), // required
|
|
55
|
+
* // logUrl: "STRING_VALUE",
|
|
56
|
+
* // artifactsUrl: "STRING_VALUE",
|
|
57
|
+
* // testArtifactsUrl: "STRING_VALUE",
|
|
58
|
+
* // testConfigUrl: "STRING_VALUE",
|
|
59
|
+
* // screenshots: { // Screenshots
|
|
60
|
+
* // "<keys>": "STRING_VALUE",
|
|
61
|
+
* // },
|
|
62
|
+
* // statusReason: "STRING_VALUE",
|
|
63
|
+
* // context: "STRING_VALUE",
|
|
64
|
+
* // },
|
|
65
|
+
* // ],
|
|
66
|
+
* // },
|
|
67
|
+
* // };
|
|
68
|
+
*
|
|
36
69
|
* ```
|
|
37
70
|
*
|
|
38
71
|
* @param GetJobCommandInput - {@link GetJobCommandInput}
|
|
@@ -56,6 +89,8 @@ export interface GetJobCommandOutput extends GetJobResult, __MetadataBearer {
|
|
|
56
89
|
* @throws {@link UnauthorizedException} (client fault)
|
|
57
90
|
* <p> An operation failed due to a lack of access. </p>
|
|
58
91
|
*
|
|
92
|
+
* @throws {@link AmplifyServiceException}
|
|
93
|
+
* <p>Base exception class for all service exceptions from Amplify service.</p>
|
|
59
94
|
*
|
|
60
95
|
*/
|
|
61
96
|
export declare class GetJobCommand extends $Command<GetJobCommandInput, GetJobCommandOutput, AmplifyClientResolvedConfig> {
|
|
@@ -31,6 +31,18 @@ export interface GetWebhookCommandOutput extends GetWebhookResult, __MetadataBea
|
|
|
31
31
|
* };
|
|
32
32
|
* const command = new GetWebhookCommand(input);
|
|
33
33
|
* const response = await client.send(command);
|
|
34
|
+
* // { // GetWebhookResult
|
|
35
|
+
* // webhook: { // Webhook
|
|
36
|
+
* // webhookArn: "STRING_VALUE", // required
|
|
37
|
+
* // webhookId: "STRING_VALUE", // required
|
|
38
|
+
* // webhookUrl: "STRING_VALUE", // required
|
|
39
|
+
* // branchName: "STRING_VALUE", // required
|
|
40
|
+
* // description: "STRING_VALUE", // required
|
|
41
|
+
* // createTime: new Date("TIMESTAMP"), // required
|
|
42
|
+
* // updateTime: new Date("TIMESTAMP"), // required
|
|
43
|
+
* // },
|
|
44
|
+
* // };
|
|
45
|
+
*
|
|
34
46
|
* ```
|
|
35
47
|
*
|
|
36
48
|
* @param GetWebhookCommandInput - {@link GetWebhookCommandInput}
|
|
@@ -54,6 +66,8 @@ export interface GetWebhookCommandOutput extends GetWebhookResult, __MetadataBea
|
|
|
54
66
|
* @throws {@link UnauthorizedException} (client fault)
|
|
55
67
|
* <p> An operation failed due to a lack of access. </p>
|
|
56
68
|
*
|
|
69
|
+
* @throws {@link AmplifyServiceException}
|
|
70
|
+
* <p>Base exception class for all service exceptions from Amplify service.</p>
|
|
57
71
|
*
|
|
58
72
|
*/
|
|
59
73
|
export declare class GetWebhookCommand extends $Command<GetWebhookCommandInput, GetWebhookCommandOutput, AmplifyClientResolvedConfig> {
|
|
@@ -32,6 +32,69 @@ export interface ListAppsCommandOutput extends ListAppsResult, __MetadataBearer
|
|
|
32
32
|
* };
|
|
33
33
|
* const command = new ListAppsCommand(input);
|
|
34
34
|
* const response = await client.send(command);
|
|
35
|
+
* // { // ListAppsResult
|
|
36
|
+
* // apps: [ // Apps // required
|
|
37
|
+
* // { // App
|
|
38
|
+
* // appId: "STRING_VALUE", // required
|
|
39
|
+
* // appArn: "STRING_VALUE", // required
|
|
40
|
+
* // name: "STRING_VALUE", // required
|
|
41
|
+
* // tags: { // TagMap
|
|
42
|
+
* // "<keys>": "STRING_VALUE",
|
|
43
|
+
* // },
|
|
44
|
+
* // description: "STRING_VALUE", // required
|
|
45
|
+
* // repository: "STRING_VALUE", // required
|
|
46
|
+
* // platform: "WEB" || "WEB_DYNAMIC" || "WEB_COMPUTE", // required
|
|
47
|
+
* // createTime: new Date("TIMESTAMP"), // required
|
|
48
|
+
* // updateTime: new Date("TIMESTAMP"), // required
|
|
49
|
+
* // iamServiceRoleArn: "STRING_VALUE",
|
|
50
|
+
* // environmentVariables: { // EnvironmentVariables // required
|
|
51
|
+
* // "<keys>": "STRING_VALUE",
|
|
52
|
+
* // },
|
|
53
|
+
* // defaultDomain: "STRING_VALUE", // required
|
|
54
|
+
* // enableBranchAutoBuild: true || false, // required
|
|
55
|
+
* // enableBranchAutoDeletion: true || false,
|
|
56
|
+
* // enableBasicAuth: true || false, // required
|
|
57
|
+
* // basicAuthCredentials: "STRING_VALUE",
|
|
58
|
+
* // customRules: [ // CustomRules
|
|
59
|
+
* // { // CustomRule
|
|
60
|
+
* // source: "STRING_VALUE", // required
|
|
61
|
+
* // target: "STRING_VALUE", // required
|
|
62
|
+
* // status: "STRING_VALUE",
|
|
63
|
+
* // condition: "STRING_VALUE",
|
|
64
|
+
* // },
|
|
65
|
+
* // ],
|
|
66
|
+
* // productionBranch: { // ProductionBranch
|
|
67
|
+
* // lastDeployTime: new Date("TIMESTAMP"),
|
|
68
|
+
* // status: "STRING_VALUE",
|
|
69
|
+
* // thumbnailUrl: "STRING_VALUE",
|
|
70
|
+
* // branchName: "STRING_VALUE",
|
|
71
|
+
* // },
|
|
72
|
+
* // buildSpec: "STRING_VALUE",
|
|
73
|
+
* // customHeaders: "STRING_VALUE",
|
|
74
|
+
* // enableAutoBranchCreation: true || false,
|
|
75
|
+
* // autoBranchCreationPatterns: [ // AutoBranchCreationPatterns
|
|
76
|
+
* // "STRING_VALUE",
|
|
77
|
+
* // ],
|
|
78
|
+
* // autoBranchCreationConfig: { // AutoBranchCreationConfig
|
|
79
|
+
* // stage: "PRODUCTION" || "BETA" || "DEVELOPMENT" || "EXPERIMENTAL" || "PULL_REQUEST",
|
|
80
|
+
* // framework: "STRING_VALUE",
|
|
81
|
+
* // enableAutoBuild: true || false,
|
|
82
|
+
* // environmentVariables: {
|
|
83
|
+
* // "<keys>": "STRING_VALUE",
|
|
84
|
+
* // },
|
|
85
|
+
* // basicAuthCredentials: "STRING_VALUE",
|
|
86
|
+
* // enableBasicAuth: true || false,
|
|
87
|
+
* // enablePerformanceMode: true || false,
|
|
88
|
+
* // buildSpec: "STRING_VALUE",
|
|
89
|
+
* // enablePullRequestPreview: true || false,
|
|
90
|
+
* // pullRequestEnvironmentName: "STRING_VALUE",
|
|
91
|
+
* // },
|
|
92
|
+
* // repositoryCloneMethod: "SSH" || "TOKEN" || "SIGV4",
|
|
93
|
+
* // },
|
|
94
|
+
* // ],
|
|
95
|
+
* // nextToken: "STRING_VALUE",
|
|
96
|
+
* // };
|
|
97
|
+
*
|
|
35
98
|
* ```
|
|
36
99
|
*
|
|
37
100
|
* @param ListAppsCommandInput - {@link ListAppsCommandInput}
|
|
@@ -49,6 +112,8 @@ export interface ListAppsCommandOutput extends ListAppsResult, __MetadataBearer
|
|
|
49
112
|
* @throws {@link UnauthorizedException} (client fault)
|
|
50
113
|
* <p> An operation failed due to a lack of access. </p>
|
|
51
114
|
*
|
|
115
|
+
* @throws {@link AmplifyServiceException}
|
|
116
|
+
* <p>Base exception class for all service exceptions from Amplify service.</p>
|
|
52
117
|
*
|
|
53
118
|
*/
|
|
54
119
|
export declare class ListAppsCommand extends $Command<ListAppsCommandInput, ListAppsCommandOutput, AmplifyClientResolvedConfig> {
|
|
@@ -35,6 +35,16 @@ export interface ListArtifactsCommandOutput extends ListArtifactsResult, __Metad
|
|
|
35
35
|
* };
|
|
36
36
|
* const command = new ListArtifactsCommand(input);
|
|
37
37
|
* const response = await client.send(command);
|
|
38
|
+
* // { // ListArtifactsResult
|
|
39
|
+
* // artifacts: [ // Artifacts // required
|
|
40
|
+
* // { // Artifact
|
|
41
|
+
* // artifactFileName: "STRING_VALUE", // required
|
|
42
|
+
* // artifactId: "STRING_VALUE", // required
|
|
43
|
+
* // },
|
|
44
|
+
* // ],
|
|
45
|
+
* // nextToken: "STRING_VALUE",
|
|
46
|
+
* // };
|
|
47
|
+
*
|
|
38
48
|
* ```
|
|
39
49
|
*
|
|
40
50
|
* @param ListArtifactsCommandInput - {@link ListArtifactsCommandInput}
|
|
@@ -55,6 +65,8 @@ export interface ListArtifactsCommandOutput extends ListArtifactsResult, __Metad
|
|
|
55
65
|
* @throws {@link UnauthorizedException} (client fault)
|
|
56
66
|
* <p> An operation failed due to a lack of access. </p>
|
|
57
67
|
*
|
|
68
|
+
* @throws {@link AmplifyServiceException}
|
|
69
|
+
* <p>Base exception class for all service exceptions from Amplify service.</p>
|
|
58
70
|
*
|
|
59
71
|
*/
|
|
60
72
|
export declare class ListArtifactsCommand extends $Command<ListArtifactsCommandInput, ListArtifactsCommandOutput, AmplifyClientResolvedConfig> {
|
|
@@ -34,6 +34,20 @@ export interface ListBackendEnvironmentsCommandOutput extends ListBackendEnviron
|
|
|
34
34
|
* };
|
|
35
35
|
* const command = new ListBackendEnvironmentsCommand(input);
|
|
36
36
|
* const response = await client.send(command);
|
|
37
|
+
* // { // ListBackendEnvironmentsResult
|
|
38
|
+
* // backendEnvironments: [ // BackendEnvironments // required
|
|
39
|
+
* // { // BackendEnvironment
|
|
40
|
+
* // backendEnvironmentArn: "STRING_VALUE", // required
|
|
41
|
+
* // environmentName: "STRING_VALUE", // required
|
|
42
|
+
* // stackName: "STRING_VALUE",
|
|
43
|
+
* // deploymentArtifacts: "STRING_VALUE",
|
|
44
|
+
* // createTime: new Date("TIMESTAMP"), // required
|
|
45
|
+
* // updateTime: new Date("TIMESTAMP"), // required
|
|
46
|
+
* // },
|
|
47
|
+
* // ],
|
|
48
|
+
* // nextToken: "STRING_VALUE",
|
|
49
|
+
* // };
|
|
50
|
+
*
|
|
37
51
|
* ```
|
|
38
52
|
*
|
|
39
53
|
* @param ListBackendEnvironmentsCommandInput - {@link ListBackendEnvironmentsCommandInput}
|
|
@@ -51,6 +65,8 @@ export interface ListBackendEnvironmentsCommandOutput extends ListBackendEnviron
|
|
|
51
65
|
* @throws {@link UnauthorizedException} (client fault)
|
|
52
66
|
* <p> An operation failed due to a lack of access. </p>
|
|
53
67
|
*
|
|
68
|
+
* @throws {@link AmplifyServiceException}
|
|
69
|
+
* <p>Base exception class for all service exceptions from Amplify service.</p>
|
|
54
70
|
*
|
|
55
71
|
*/
|
|
56
72
|
export declare class ListBackendEnvironmentsCommand extends $Command<ListBackendEnvironmentsCommandInput, ListBackendEnvironmentsCommandOutput, AmplifyClientResolvedConfig> {
|
|
@@ -33,6 +33,49 @@ export interface ListBranchesCommandOutput extends ListBranchesResult, __Metadat
|
|
|
33
33
|
* };
|
|
34
34
|
* const command = new ListBranchesCommand(input);
|
|
35
35
|
* const response = await client.send(command);
|
|
36
|
+
* // { // ListBranchesResult
|
|
37
|
+
* // branches: [ // Branches // required
|
|
38
|
+
* // { // Branch
|
|
39
|
+
* // branchArn: "STRING_VALUE", // required
|
|
40
|
+
* // branchName: "STRING_VALUE", // required
|
|
41
|
+
* // description: "STRING_VALUE", // required
|
|
42
|
+
* // tags: { // TagMap
|
|
43
|
+
* // "<keys>": "STRING_VALUE",
|
|
44
|
+
* // },
|
|
45
|
+
* // stage: "PRODUCTION" || "BETA" || "DEVELOPMENT" || "EXPERIMENTAL" || "PULL_REQUEST", // required
|
|
46
|
+
* // displayName: "STRING_VALUE", // required
|
|
47
|
+
* // enableNotification: true || false, // required
|
|
48
|
+
* // createTime: new Date("TIMESTAMP"), // required
|
|
49
|
+
* // updateTime: new Date("TIMESTAMP"), // required
|
|
50
|
+
* // environmentVariables: { // EnvironmentVariables // required
|
|
51
|
+
* // "<keys>": "STRING_VALUE",
|
|
52
|
+
* // },
|
|
53
|
+
* // enableAutoBuild: true || false, // required
|
|
54
|
+
* // customDomains: [ // CustomDomains // required
|
|
55
|
+
* // "STRING_VALUE",
|
|
56
|
+
* // ],
|
|
57
|
+
* // framework: "STRING_VALUE", // required
|
|
58
|
+
* // activeJobId: "STRING_VALUE", // required
|
|
59
|
+
* // totalNumberOfJobs: "STRING_VALUE", // required
|
|
60
|
+
* // enableBasicAuth: true || false, // required
|
|
61
|
+
* // enablePerformanceMode: true || false,
|
|
62
|
+
* // thumbnailUrl: "STRING_VALUE",
|
|
63
|
+
* // basicAuthCredentials: "STRING_VALUE",
|
|
64
|
+
* // buildSpec: "STRING_VALUE",
|
|
65
|
+
* // ttl: "STRING_VALUE", // required
|
|
66
|
+
* // associatedResources: [ // AssociatedResources
|
|
67
|
+
* // "STRING_VALUE",
|
|
68
|
+
* // ],
|
|
69
|
+
* // enablePullRequestPreview: true || false, // required
|
|
70
|
+
* // pullRequestEnvironmentName: "STRING_VALUE",
|
|
71
|
+
* // destinationBranch: "STRING_VALUE",
|
|
72
|
+
* // sourceBranch: "STRING_VALUE",
|
|
73
|
+
* // backendEnvironmentArn: "STRING_VALUE",
|
|
74
|
+
* // },
|
|
75
|
+
* // ],
|
|
76
|
+
* // nextToken: "STRING_VALUE",
|
|
77
|
+
* // };
|
|
78
|
+
*
|
|
36
79
|
* ```
|
|
37
80
|
*
|
|
38
81
|
* @param ListBranchesCommandInput - {@link ListBranchesCommandInput}
|
|
@@ -50,6 +93,8 @@ export interface ListBranchesCommandOutput extends ListBranchesResult, __Metadat
|
|
|
50
93
|
* @throws {@link UnauthorizedException} (client fault)
|
|
51
94
|
* <p> An operation failed due to a lack of access. </p>
|
|
52
95
|
*
|
|
96
|
+
* @throws {@link AmplifyServiceException}
|
|
97
|
+
* <p>Base exception class for all service exceptions from Amplify service.</p>
|
|
53
98
|
*
|
|
54
99
|
*/
|
|
55
100
|
export declare class ListBranchesCommand extends $Command<ListBranchesCommandInput, ListBranchesCommandOutput, AmplifyClientResolvedConfig> {
|
|
@@ -33,6 +33,34 @@ export interface ListDomainAssociationsCommandOutput extends ListDomainAssociati
|
|
|
33
33
|
* };
|
|
34
34
|
* const command = new ListDomainAssociationsCommand(input);
|
|
35
35
|
* const response = await client.send(command);
|
|
36
|
+
* // { // ListDomainAssociationsResult
|
|
37
|
+
* // domainAssociations: [ // DomainAssociations // required
|
|
38
|
+
* // { // DomainAssociation
|
|
39
|
+
* // domainAssociationArn: "STRING_VALUE", // required
|
|
40
|
+
* // domainName: "STRING_VALUE", // required
|
|
41
|
+
* // enableAutoSubDomain: true || false, // required
|
|
42
|
+
* // autoSubDomainCreationPatterns: [ // AutoSubDomainCreationPatterns
|
|
43
|
+
* // "STRING_VALUE",
|
|
44
|
+
* // ],
|
|
45
|
+
* // autoSubDomainIAMRole: "STRING_VALUE",
|
|
46
|
+
* // domainStatus: "PENDING_VERIFICATION" || "IN_PROGRESS" || "AVAILABLE" || "PENDING_DEPLOYMENT" || "FAILED" || "CREATING" || "REQUESTING_CERTIFICATE" || "UPDATING", // required
|
|
47
|
+
* // statusReason: "STRING_VALUE", // required
|
|
48
|
+
* // certificateVerificationDNSRecord: "STRING_VALUE",
|
|
49
|
+
* // subDomains: [ // SubDomains // required
|
|
50
|
+
* // { // SubDomain
|
|
51
|
+
* // subDomainSetting: { // SubDomainSetting
|
|
52
|
+
* // prefix: "STRING_VALUE", // required
|
|
53
|
+
* // branchName: "STRING_VALUE", // required
|
|
54
|
+
* // },
|
|
55
|
+
* // verified: true || false, // required
|
|
56
|
+
* // dnsRecord: "STRING_VALUE", // required
|
|
57
|
+
* // },
|
|
58
|
+
* // ],
|
|
59
|
+
* // },
|
|
60
|
+
* // ],
|
|
61
|
+
* // nextToken: "STRING_VALUE",
|
|
62
|
+
* // };
|
|
63
|
+
*
|
|
36
64
|
* ```
|
|
37
65
|
*
|
|
38
66
|
* @param ListDomainAssociationsCommandInput - {@link ListDomainAssociationsCommandInput}
|
|
@@ -50,6 +78,8 @@ export interface ListDomainAssociationsCommandOutput extends ListDomainAssociati
|
|
|
50
78
|
* @throws {@link UnauthorizedException} (client fault)
|
|
51
79
|
* <p> An operation failed due to a lack of access. </p>
|
|
52
80
|
*
|
|
81
|
+
* @throws {@link AmplifyServiceException}
|
|
82
|
+
* <p>Base exception class for all service exceptions from Amplify service.</p>
|
|
53
83
|
*
|
|
54
84
|
*/
|
|
55
85
|
export declare class ListDomainAssociationsCommand extends $Command<ListDomainAssociationsCommandInput, ListDomainAssociationsCommandOutput, AmplifyClientResolvedConfig> {
|
|
@@ -34,6 +34,23 @@ export interface ListJobsCommandOutput extends ListJobsResult, __MetadataBearer
|
|
|
34
34
|
* };
|
|
35
35
|
* const command = new ListJobsCommand(input);
|
|
36
36
|
* const response = await client.send(command);
|
|
37
|
+
* // { // ListJobsResult
|
|
38
|
+
* // jobSummaries: [ // JobSummaries // required
|
|
39
|
+
* // { // JobSummary
|
|
40
|
+
* // jobArn: "STRING_VALUE", // required
|
|
41
|
+
* // jobId: "STRING_VALUE", // required
|
|
42
|
+
* // commitId: "STRING_VALUE", // required
|
|
43
|
+
* // commitMessage: "STRING_VALUE", // required
|
|
44
|
+
* // commitTime: new Date("TIMESTAMP"), // required
|
|
45
|
+
* // startTime: new Date("TIMESTAMP"), // required
|
|
46
|
+
* // status: "PENDING" || "PROVISIONING" || "RUNNING" || "FAILED" || "SUCCEED" || "CANCELLING" || "CANCELLED", // required
|
|
47
|
+
* // endTime: new Date("TIMESTAMP"),
|
|
48
|
+
* // jobType: "RELEASE" || "RETRY" || "MANUAL" || "WEB_HOOK", // required
|
|
49
|
+
* // },
|
|
50
|
+
* // ],
|
|
51
|
+
* // nextToken: "STRING_VALUE",
|
|
52
|
+
* // };
|
|
53
|
+
*
|
|
37
54
|
* ```
|
|
38
55
|
*
|
|
39
56
|
* @param ListJobsCommandInput - {@link ListJobsCommandInput}
|
|
@@ -54,6 +71,8 @@ export interface ListJobsCommandOutput extends ListJobsResult, __MetadataBearer
|
|
|
54
71
|
* @throws {@link UnauthorizedException} (client fault)
|
|
55
72
|
* <p> An operation failed due to a lack of access. </p>
|
|
56
73
|
*
|
|
74
|
+
* @throws {@link AmplifyServiceException}
|
|
75
|
+
* <p>Base exception class for all service exceptions from Amplify service.</p>
|
|
57
76
|
*
|
|
58
77
|
*/
|
|
59
78
|
export declare class ListJobsCommand extends $Command<ListJobsCommandInput, ListJobsCommandOutput, AmplifyClientResolvedConfig> {
|
|
@@ -31,6 +31,12 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
|
|
|
31
31
|
* };
|
|
32
32
|
* const command = new ListTagsForResourceCommand(input);
|
|
33
33
|
* const response = await client.send(command);
|
|
34
|
+
* // { // ListTagsForResourceResponse
|
|
35
|
+
* // tags: { // TagMap
|
|
36
|
+
* // "<keys>": "STRING_VALUE",
|
|
37
|
+
* // },
|
|
38
|
+
* // };
|
|
39
|
+
*
|
|
34
40
|
* ```
|
|
35
41
|
*
|
|
36
42
|
* @param ListTagsForResourceCommandInput - {@link ListTagsForResourceCommandInput}
|
|
@@ -48,6 +54,8 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
|
|
|
48
54
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
49
55
|
* <p> An operation failed due to a non-existent resource. </p>
|
|
50
56
|
*
|
|
57
|
+
* @throws {@link AmplifyServiceException}
|
|
58
|
+
* <p>Base exception class for all service exceptions from Amplify service.</p>
|
|
51
59
|
*
|
|
52
60
|
*/
|
|
53
61
|
export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, AmplifyClientResolvedConfig> {
|
|
@@ -33,6 +33,21 @@ export interface ListWebhooksCommandOutput extends ListWebhooksResult, __Metadat
|
|
|
33
33
|
* };
|
|
34
34
|
* const command = new ListWebhooksCommand(input);
|
|
35
35
|
* const response = await client.send(command);
|
|
36
|
+
* // { // ListWebhooksResult
|
|
37
|
+
* // webhooks: [ // Webhooks // required
|
|
38
|
+
* // { // Webhook
|
|
39
|
+
* // webhookArn: "STRING_VALUE", // required
|
|
40
|
+
* // webhookId: "STRING_VALUE", // required
|
|
41
|
+
* // webhookUrl: "STRING_VALUE", // required
|
|
42
|
+
* // branchName: "STRING_VALUE", // required
|
|
43
|
+
* // description: "STRING_VALUE", // required
|
|
44
|
+
* // createTime: new Date("TIMESTAMP"), // required
|
|
45
|
+
* // updateTime: new Date("TIMESTAMP"), // required
|
|
46
|
+
* // },
|
|
47
|
+
* // ],
|
|
48
|
+
* // nextToken: "STRING_VALUE",
|
|
49
|
+
* // };
|
|
50
|
+
*
|
|
36
51
|
* ```
|
|
37
52
|
*
|
|
38
53
|
* @param ListWebhooksCommandInput - {@link ListWebhooksCommandInput}
|
|
@@ -53,6 +68,8 @@ export interface ListWebhooksCommandOutput extends ListWebhooksResult, __Metadat
|
|
|
53
68
|
* @throws {@link UnauthorizedException} (client fault)
|
|
54
69
|
* <p> An operation failed due to a lack of access. </p>
|
|
55
70
|
*
|
|
71
|
+
* @throws {@link AmplifyServiceException}
|
|
72
|
+
* <p>Base exception class for all service exceptions from Amplify service.</p>
|
|
56
73
|
*
|
|
57
74
|
*/
|
|
58
75
|
export declare class ListWebhooksCommand extends $Command<ListWebhooksCommandInput, ListWebhooksCommandOutput, AmplifyClientResolvedConfig> {
|
|
@@ -35,6 +35,20 @@ export interface StartDeploymentCommandOutput extends StartDeploymentResult, __M
|
|
|
35
35
|
* };
|
|
36
36
|
* const command = new StartDeploymentCommand(input);
|
|
37
37
|
* const response = await client.send(command);
|
|
38
|
+
* // { // StartDeploymentResult
|
|
39
|
+
* // jobSummary: { // JobSummary
|
|
40
|
+
* // jobArn: "STRING_VALUE", // required
|
|
41
|
+
* // jobId: "STRING_VALUE", // required
|
|
42
|
+
* // commitId: "STRING_VALUE", // required
|
|
43
|
+
* // commitMessage: "STRING_VALUE", // required
|
|
44
|
+
* // commitTime: new Date("TIMESTAMP"), // required
|
|
45
|
+
* // startTime: new Date("TIMESTAMP"), // required
|
|
46
|
+
* // status: "PENDING" || "PROVISIONING" || "RUNNING" || "FAILED" || "SUCCEED" || "CANCELLING" || "CANCELLED", // required
|
|
47
|
+
* // endTime: new Date("TIMESTAMP"),
|
|
48
|
+
* // jobType: "RELEASE" || "RETRY" || "MANUAL" || "WEB_HOOK", // required
|
|
49
|
+
* // },
|
|
50
|
+
* // };
|
|
51
|
+
*
|
|
38
52
|
* ```
|
|
39
53
|
*
|
|
40
54
|
* @param StartDeploymentCommandInput - {@link StartDeploymentCommandInput}
|
|
@@ -58,6 +72,8 @@ export interface StartDeploymentCommandOutput extends StartDeploymentResult, __M
|
|
|
58
72
|
* @throws {@link UnauthorizedException} (client fault)
|
|
59
73
|
* <p> An operation failed due to a lack of access. </p>
|
|
60
74
|
*
|
|
75
|
+
* @throws {@link AmplifyServiceException}
|
|
76
|
+
* <p>Base exception class for all service exceptions from Amplify service.</p>
|
|
61
77
|
*
|
|
62
78
|
*/
|
|
63
79
|
export declare class StartDeploymentCommand extends $Command<StartDeploymentCommandInput, StartDeploymentCommandOutput, AmplifyClientResolvedConfig> {
|
|
@@ -38,6 +38,20 @@ export interface StartJobCommandOutput extends StartJobResult, __MetadataBearer
|
|
|
38
38
|
* };
|
|
39
39
|
* const command = new StartJobCommand(input);
|
|
40
40
|
* const response = await client.send(command);
|
|
41
|
+
* // { // StartJobResult
|
|
42
|
+
* // jobSummary: { // JobSummary
|
|
43
|
+
* // jobArn: "STRING_VALUE", // required
|
|
44
|
+
* // jobId: "STRING_VALUE", // required
|
|
45
|
+
* // commitId: "STRING_VALUE", // required
|
|
46
|
+
* // commitMessage: "STRING_VALUE", // required
|
|
47
|
+
* // commitTime: new Date("TIMESTAMP"), // required
|
|
48
|
+
* // startTime: new Date("TIMESTAMP"), // required
|
|
49
|
+
* // status: "PENDING" || "PROVISIONING" || "RUNNING" || "FAILED" || "SUCCEED" || "CANCELLING" || "CANCELLED", // required
|
|
50
|
+
* // endTime: new Date("TIMESTAMP"),
|
|
51
|
+
* // jobType: "RELEASE" || "RETRY" || "MANUAL" || "WEB_HOOK", // required
|
|
52
|
+
* // },
|
|
53
|
+
* // };
|
|
54
|
+
*
|
|
41
55
|
* ```
|
|
42
56
|
*
|
|
43
57
|
* @param StartJobCommandInput - {@link StartJobCommandInput}
|
|
@@ -61,6 +75,8 @@ export interface StartJobCommandOutput extends StartJobResult, __MetadataBearer
|
|
|
61
75
|
* @throws {@link UnauthorizedException} (client fault)
|
|
62
76
|
* <p> An operation failed due to a lack of access. </p>
|
|
63
77
|
*
|
|
78
|
+
* @throws {@link AmplifyServiceException}
|
|
79
|
+
* <p>Base exception class for all service exceptions from Amplify service.</p>
|
|
64
80
|
*
|
|
65
81
|
*/
|
|
66
82
|
export declare class StartJobCommand extends $Command<StartJobCommandInput, StartJobCommandOutput, AmplifyClientResolvedConfig> {
|
|
@@ -33,6 +33,20 @@ export interface StopJobCommandOutput extends StopJobResult, __MetadataBearer {
|
|
|
33
33
|
* };
|
|
34
34
|
* const command = new StopJobCommand(input);
|
|
35
35
|
* const response = await client.send(command);
|
|
36
|
+
* // { // StopJobResult
|
|
37
|
+
* // jobSummary: { // JobSummary
|
|
38
|
+
* // jobArn: "STRING_VALUE", // required
|
|
39
|
+
* // jobId: "STRING_VALUE", // required
|
|
40
|
+
* // commitId: "STRING_VALUE", // required
|
|
41
|
+
* // commitMessage: "STRING_VALUE", // required
|
|
42
|
+
* // commitTime: new Date("TIMESTAMP"), // required
|
|
43
|
+
* // startTime: new Date("TIMESTAMP"), // required
|
|
44
|
+
* // status: "PENDING" || "PROVISIONING" || "RUNNING" || "FAILED" || "SUCCEED" || "CANCELLING" || "CANCELLED", // required
|
|
45
|
+
* // endTime: new Date("TIMESTAMP"),
|
|
46
|
+
* // jobType: "RELEASE" || "RETRY" || "MANUAL" || "WEB_HOOK", // required
|
|
47
|
+
* // },
|
|
48
|
+
* // };
|
|
49
|
+
*
|
|
36
50
|
* ```
|
|
37
51
|
*
|
|
38
52
|
* @param StopJobCommandInput - {@link StopJobCommandInput}
|
|
@@ -56,6 +70,8 @@ export interface StopJobCommandOutput extends StopJobResult, __MetadataBearer {
|
|
|
56
70
|
* @throws {@link UnauthorizedException} (client fault)
|
|
57
71
|
* <p> An operation failed due to a lack of access. </p>
|
|
58
72
|
*
|
|
73
|
+
* @throws {@link AmplifyServiceException}
|
|
74
|
+
* <p>Base exception class for all service exceptions from Amplify service.</p>
|
|
59
75
|
*
|
|
60
76
|
*/
|
|
61
77
|
export declare class StopJobCommand extends $Command<StopJobCommandInput, StopJobCommandOutput, AmplifyClientResolvedConfig> {
|
|
@@ -34,6 +34,8 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
|
|
|
34
34
|
* };
|
|
35
35
|
* const command = new TagResourceCommand(input);
|
|
36
36
|
* const response = await client.send(command);
|
|
37
|
+
* // {};
|
|
38
|
+
*
|
|
37
39
|
* ```
|
|
38
40
|
*
|
|
39
41
|
* @param TagResourceCommandInput - {@link TagResourceCommandInput}
|
|
@@ -51,6 +53,8 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
|
|
|
51
53
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
52
54
|
* <p> An operation failed due to a non-existent resource. </p>
|
|
53
55
|
*
|
|
56
|
+
* @throws {@link AmplifyServiceException}
|
|
57
|
+
* <p>Base exception class for all service exceptions from Amplify service.</p>
|
|
54
58
|
*
|
|
55
59
|
*/
|
|
56
60
|
export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, AmplifyClientResolvedConfig> {
|