@aws-sdk/client-amplify 3.325.0 → 3.327.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (38) hide show
  1. package/dist-types/commands/CreateAppCommand.d.ts +62 -0
  2. package/dist-types/commands/CreateBackendEnvironmentCommand.d.ts +13 -0
  3. package/dist-types/commands/CreateBranchCommand.d.ts +42 -0
  4. package/dist-types/commands/CreateDeploymentCommand.d.ts +10 -0
  5. package/dist-types/commands/CreateDomainAssociationCommand.d.ts +27 -0
  6. package/dist-types/commands/CreateWebhookCommand.d.ts +14 -0
  7. package/dist-types/commands/DeleteAppCommand.d.ts +62 -0
  8. package/dist-types/commands/DeleteBackendEnvironmentCommand.d.ts +13 -0
  9. package/dist-types/commands/DeleteBranchCommand.d.ts +42 -0
  10. package/dist-types/commands/DeleteDomainAssociationCommand.d.ts +27 -0
  11. package/dist-types/commands/DeleteJobCommand.d.ts +16 -0
  12. package/dist-types/commands/DeleteWebhookCommand.d.ts +14 -0
  13. package/dist-types/commands/GenerateAccessLogsCommand.d.ts +6 -0
  14. package/dist-types/commands/GetAppCommand.d.ts +62 -0
  15. package/dist-types/commands/GetArtifactUrlCommand.d.ts +7 -0
  16. package/dist-types/commands/GetBackendEnvironmentCommand.d.ts +13 -0
  17. package/dist-types/commands/GetBranchCommand.d.ts +42 -0
  18. package/dist-types/commands/GetDomainAssociationCommand.d.ts +27 -0
  19. package/dist-types/commands/GetJobCommand.d.ts +35 -0
  20. package/dist-types/commands/GetWebhookCommand.d.ts +14 -0
  21. package/dist-types/commands/ListAppsCommand.d.ts +65 -0
  22. package/dist-types/commands/ListArtifactsCommand.d.ts +12 -0
  23. package/dist-types/commands/ListBackendEnvironmentsCommand.d.ts +16 -0
  24. package/dist-types/commands/ListBranchesCommand.d.ts +45 -0
  25. package/dist-types/commands/ListDomainAssociationsCommand.d.ts +30 -0
  26. package/dist-types/commands/ListJobsCommand.d.ts +19 -0
  27. package/dist-types/commands/ListTagsForResourceCommand.d.ts +8 -0
  28. package/dist-types/commands/ListWebhooksCommand.d.ts +17 -0
  29. package/dist-types/commands/StartDeploymentCommand.d.ts +16 -0
  30. package/dist-types/commands/StartJobCommand.d.ts +16 -0
  31. package/dist-types/commands/StopJobCommand.d.ts +16 -0
  32. package/dist-types/commands/TagResourceCommand.d.ts +4 -0
  33. package/dist-types/commands/UntagResourceCommand.d.ts +4 -0
  34. package/dist-types/commands/UpdateAppCommand.d.ts +62 -0
  35. package/dist-types/commands/UpdateBranchCommand.d.ts +42 -0
  36. package/dist-types/commands/UpdateDomainAssociationCommand.d.ts +27 -0
  37. package/dist-types/commands/UpdateWebhookCommand.d.ts +14 -0
  38. package/package.json +7 -7
package/dist-types/commands/CreateAppCommand.d.ts CHANGED
@@ -75,6 +75,66 @@ export interface CreateAppCommandOutput extends CreateAppResult, __MetadataBeare
75
75
  * };
76
76
  * const command = new CreateAppCommand(input);
77
77
  * const response = await client.send(command);
78
+ * // { // CreateAppResult
79
+ * // app: { // App
80
+ * // appId: "STRING_VALUE", // required
81
+ * // appArn: "STRING_VALUE", // required
82
+ * // name: "STRING_VALUE", // required
83
+ * // tags: { // TagMap
84
+ * // "<keys>": "STRING_VALUE",
85
+ * // },
86
+ * // description: "STRING_VALUE", // required
87
+ * // repository: "STRING_VALUE", // required
88
+ * // platform: "WEB" || "WEB_DYNAMIC" || "WEB_COMPUTE", // required
89
+ * // createTime: new Date("TIMESTAMP"), // required
90
+ * // updateTime: new Date("TIMESTAMP"), // required
91
+ * // iamServiceRoleArn: "STRING_VALUE",
92
+ * // environmentVariables: { // EnvironmentVariables // required
93
+ * // "<keys>": "STRING_VALUE",
94
+ * // },
95
+ * // defaultDomain: "STRING_VALUE", // required
96
+ * // enableBranchAutoBuild: true || false, // required
97
+ * // enableBranchAutoDeletion: true || false,
98
+ * // enableBasicAuth: true || false, // required
99
+ * // basicAuthCredentials: "STRING_VALUE",
100
+ * // customRules: [ // CustomRules
101
+ * // { // CustomRule
102
+ * // source: "STRING_VALUE", // required
103
+ * // target: "STRING_VALUE", // required
104
+ * // status: "STRING_VALUE",
105
+ * // condition: "STRING_VALUE",
106
+ * // },
107
+ * // ],
108
+ * // productionBranch: { // ProductionBranch
109
+ * // lastDeployTime: new Date("TIMESTAMP"),
110
+ * // status: "STRING_VALUE",
111
+ * // thumbnailUrl: "STRING_VALUE",
112
+ * // branchName: "STRING_VALUE",
113
+ * // },
114
+ * // buildSpec: "STRING_VALUE",
115
+ * // customHeaders: "STRING_VALUE",
116
+ * // enableAutoBranchCreation: true || false,
117
+ * // autoBranchCreationPatterns: [ // AutoBranchCreationPatterns
118
+ * // "STRING_VALUE",
119
+ * // ],
120
+ * // autoBranchCreationConfig: { // AutoBranchCreationConfig
121
+ * // stage: "PRODUCTION" || "BETA" || "DEVELOPMENT" || "EXPERIMENTAL" || "PULL_REQUEST",
122
+ * // framework: "STRING_VALUE",
123
+ * // enableAutoBuild: true || false,
124
+ * // environmentVariables: {
125
+ * // "<keys>": "STRING_VALUE",
126
+ * // },
127
+ * // basicAuthCredentials: "STRING_VALUE",
128
+ * // enableBasicAuth: true || false,
129
+ * // enablePerformanceMode: true || false,
130
+ * // buildSpec: "STRING_VALUE",
131
+ * // enablePullRequestPreview: true || false,
132
+ * // pullRequestEnvironmentName: "STRING_VALUE",
133
+ * // },
134
+ * // repositoryCloneMethod: "SSH" || "TOKEN" || "SIGV4",
135
+ * // },
136
+ * // };
137
+ *
78
138
  * ```
79
139
  *
80
140
  * @param CreateAppCommandInput - {@link CreateAppCommandInput}
@@ -98,6 +158,8 @@ export interface CreateAppCommandOutput extends CreateAppResult, __MetadataBeare
98
158
  * @throws {@link UnauthorizedException} (client fault)
99
159
  * <p> An operation failed due to a lack of access. </p>
100
160
  *
161
+ * @throws {@link AmplifyServiceException}
162
+ * <p>Base exception class for all service exceptions from Amplify service.</p>
101
163
  *
102
164
  */
103
165
  export declare class CreateAppCommand extends $Command<CreateAppCommandInput, CreateAppCommandOutput, AmplifyClientResolvedConfig> {
package/dist-types/commands/CreateBackendEnvironmentCommand.d.ts CHANGED
@@ -34,6 +34,17 @@ export interface CreateBackendEnvironmentCommandOutput extends CreateBackendEnvi
34
34
  * };
35
35
  * const command = new CreateBackendEnvironmentCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // { // CreateBackendEnvironmentResult
38
+ * // backendEnvironment: { // BackendEnvironment
39
+ * // backendEnvironmentArn: "STRING_VALUE", // required
40
+ * // environmentName: "STRING_VALUE", // required
41
+ * // stackName: "STRING_VALUE",
42
+ * // deploymentArtifacts: "STRING_VALUE",
43
+ * // createTime: new Date("TIMESTAMP"), // required
44
+ * // updateTime: new Date("TIMESTAMP"), // required
45
+ * // },
46
+ * // };
47
+ *
37
48
  * ```
38
49
  *
39
50
  * @param CreateBackendEnvironmentCommandInput - {@link CreateBackendEnvironmentCommandInput}
@@ -57,6 +68,8 @@ export interface CreateBackendEnvironmentCommandOutput extends CreateBackendEnvi
57
68
  * @throws {@link UnauthorizedException} (client fault)
58
69
  * <p> An operation failed due to a lack of access. </p>
59
70
  *
71
+ * @throws {@link AmplifyServiceException}
72
+ * <p>Base exception class for all service exceptions from Amplify service.</p>
60
73
  *
61
74
  */
62
75
  export declare class CreateBackendEnvironmentCommand extends $Command<CreateBackendEnvironmentCommandInput, CreateBackendEnvironmentCommandOutput, AmplifyClientResolvedConfig> {
package/dist-types/commands/CreateBranchCommand.d.ts CHANGED
@@ -52,6 +52,46 @@ export interface CreateBranchCommandOutput extends CreateBranchResult, __Metadat
52
52
  * };
53
53
  * const command = new CreateBranchCommand(input);
54
54
  * const response = await client.send(command);
55
+ * // { // CreateBranchResult
56
+ * // branch: { // Branch
57
+ * // branchArn: "STRING_VALUE", // required
58
+ * // branchName: "STRING_VALUE", // required
59
+ * // description: "STRING_VALUE", // required
60
+ * // tags: { // TagMap
61
+ * // "<keys>": "STRING_VALUE",
62
+ * // },
63
+ * // stage: "PRODUCTION" || "BETA" || "DEVELOPMENT" || "EXPERIMENTAL" || "PULL_REQUEST", // required
64
+ * // displayName: "STRING_VALUE", // required
65
+ * // enableNotification: true || false, // required
66
+ * // createTime: new Date("TIMESTAMP"), // required
67
+ * // updateTime: new Date("TIMESTAMP"), // required
68
+ * // environmentVariables: { // EnvironmentVariables // required
69
+ * // "<keys>": "STRING_VALUE",
70
+ * // },
71
+ * // enableAutoBuild: true || false, // required
72
+ * // customDomains: [ // CustomDomains // required
73
+ * // "STRING_VALUE",
74
+ * // ],
75
+ * // framework: "STRING_VALUE", // required
76
+ * // activeJobId: "STRING_VALUE", // required
77
+ * // totalNumberOfJobs: "STRING_VALUE", // required
78
+ * // enableBasicAuth: true || false, // required
79
+ * // enablePerformanceMode: true || false,
80
+ * // thumbnailUrl: "STRING_VALUE",
81
+ * // basicAuthCredentials: "STRING_VALUE",
82
+ * // buildSpec: "STRING_VALUE",
83
+ * // ttl: "STRING_VALUE", // required
84
+ * // associatedResources: [ // AssociatedResources
85
+ * // "STRING_VALUE",
86
+ * // ],
87
+ * // enablePullRequestPreview: true || false, // required
88
+ * // pullRequestEnvironmentName: "STRING_VALUE",
89
+ * // destinationBranch: "STRING_VALUE",
90
+ * // sourceBranch: "STRING_VALUE",
91
+ * // backendEnvironmentArn: "STRING_VALUE",
92
+ * // },
93
+ * // };
94
+ *
55
95
  * ```
56
96
  *
57
97
  * @param CreateBranchCommandInput - {@link CreateBranchCommandInput}
@@ -78,6 +118,8 @@ export interface CreateBranchCommandOutput extends CreateBranchResult, __Metadat
78
118
  * @throws {@link UnauthorizedException} (client fault)
79
119
  * <p> An operation failed due to a lack of access. </p>
80
120
  *
121
+ * @throws {@link AmplifyServiceException}
122
+ * <p>Base exception class for all service exceptions from Amplify service.</p>
81
123
  *
82
124
  */
83
125
  export declare class CreateBranchCommand extends $Command<CreateBranchCommandInput, CreateBranchCommandOutput, AmplifyClientResolvedConfig> {
package/dist-types/commands/CreateDeploymentCommand.d.ts CHANGED
@@ -36,6 +36,14 @@ export interface CreateDeploymentCommandOutput extends CreateDeploymentResult, _
36
36
  * };
37
37
  * const command = new CreateDeploymentCommand(input);
38
38
  * const response = await client.send(command);
39
+ * // { // CreateDeploymentResult
40
+ * // jobId: "STRING_VALUE",
41
+ * // fileUploadUrls: { // FileUploadUrls // required
42
+ * // "<keys>": "STRING_VALUE",
43
+ * // },
44
+ * // zipUploadUrl: "STRING_VALUE", // required
45
+ * // };
46
+ *
39
47
  * ```
40
48
  *
41
49
  * @param CreateDeploymentCommandInput - {@link CreateDeploymentCommandInput}
@@ -56,6 +64,8 @@ export interface CreateDeploymentCommandOutput extends CreateDeploymentResult, _
56
64
  * @throws {@link UnauthorizedException} (client fault)
57
65
  * <p> An operation failed due to a lack of access. </p>
58
66
  *
67
+ * @throws {@link AmplifyServiceException}
68
+ * <p>Base exception class for all service exceptions from Amplify service.</p>
59
69
  *
60
70
  */
61
71
  export declare class CreateDeploymentCommand extends $Command<CreateDeploymentCommandInput, CreateDeploymentCommandOutput, AmplifyClientResolvedConfig> {
package/dist-types/commands/CreateDomainAssociationCommand.d.ts CHANGED
@@ -44,6 +44,31 @@ export interface CreateDomainAssociationCommandOutput extends CreateDomainAssoci
44
44
  * };
45
45
  * const command = new CreateDomainAssociationCommand(input);
46
46
  * const response = await client.send(command);
47
+ * // { // CreateDomainAssociationResult
48
+ * // domainAssociation: { // DomainAssociation
49
+ * // domainAssociationArn: "STRING_VALUE", // required
50
+ * // domainName: "STRING_VALUE", // required
51
+ * // enableAutoSubDomain: true || false, // required
52
+ * // autoSubDomainCreationPatterns: [ // AutoSubDomainCreationPatterns
53
+ * // "STRING_VALUE",
54
+ * // ],
55
+ * // autoSubDomainIAMRole: "STRING_VALUE",
56
+ * // domainStatus: "PENDING_VERIFICATION" || "IN_PROGRESS" || "AVAILABLE" || "PENDING_DEPLOYMENT" || "FAILED" || "CREATING" || "REQUESTING_CERTIFICATE" || "UPDATING", // required
57
+ * // statusReason: "STRING_VALUE", // required
58
+ * // certificateVerificationDNSRecord: "STRING_VALUE",
59
+ * // subDomains: [ // SubDomains // required
60
+ * // { // SubDomain
61
+ * // subDomainSetting: { // SubDomainSetting
62
+ * // prefix: "STRING_VALUE", // required
63
+ * // branchName: "STRING_VALUE", // required
64
+ * // },
65
+ * // verified: true || false, // required
66
+ * // dnsRecord: "STRING_VALUE", // required
67
+ * // },
68
+ * // ],
69
+ * // },
70
+ * // };
71
+ *
47
72
  * ```
48
73
  *
49
74
  * @param CreateDomainAssociationCommandInput - {@link CreateDomainAssociationCommandInput}
@@ -70,6 +95,8 @@ export interface CreateDomainAssociationCommandOutput extends CreateDomainAssoci
70
95
  * @throws {@link UnauthorizedException} (client fault)
71
96
  * <p> An operation failed due to a lack of access. </p>
72
97
  *
98
+ * @throws {@link AmplifyServiceException}
99
+ * <p>Base exception class for all service exceptions from Amplify service.</p>
73
100
  *
74
101
  */
75
102
  export declare class CreateDomainAssociationCommand extends $Command<CreateDomainAssociationCommandInput, CreateDomainAssociationCommandOutput, AmplifyClientResolvedConfig> {
package/dist-types/commands/CreateWebhookCommand.d.ts CHANGED
@@ -33,6 +33,18 @@ export interface CreateWebhookCommandOutput extends CreateWebhookResult, __Metad
33
33
  * };
34
34
  * const command = new CreateWebhookCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // CreateWebhookResult
37
+ * // webhook: { // Webhook
38
+ * // webhookArn: "STRING_VALUE", // required
39
+ * // webhookId: "STRING_VALUE", // required
40
+ * // webhookUrl: "STRING_VALUE", // required
41
+ * // branchName: "STRING_VALUE", // required
42
+ * // description: "STRING_VALUE", // required
43
+ * // createTime: new Date("TIMESTAMP"), // required
44
+ * // updateTime: new Date("TIMESTAMP"), // required
45
+ * // },
46
+ * // };
47
+ *
36
48
  * ```
37
49
  *
38
50
  * @param CreateWebhookCommandInput - {@link CreateWebhookCommandInput}
@@ -59,6 +71,8 @@ export interface CreateWebhookCommandOutput extends CreateWebhookResult, __Metad
59
71
  * @throws {@link UnauthorizedException} (client fault)
60
72
  * <p> An operation failed due to a lack of access. </p>
61
73
  *
74
+ * @throws {@link AmplifyServiceException}
75
+ * <p>Base exception class for all service exceptions from Amplify service.</p>
62
76
  *
63
77
  */
64
78
  export declare class CreateWebhookCommand extends $Command<CreateWebhookCommandInput, CreateWebhookCommandOutput, AmplifyClientResolvedConfig> {
package/dist-types/commands/DeleteAppCommand.d.ts CHANGED
@@ -31,6 +31,66 @@ export interface DeleteAppCommandOutput extends DeleteAppResult, __MetadataBeare
31
31
  * };
32
32
  * const command = new DeleteAppCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // DeleteAppResult
35
+ * // app: { // App
36
+ * // appId: "STRING_VALUE", // required
37
+ * // appArn: "STRING_VALUE", // required
38
+ * // name: "STRING_VALUE", // required
39
+ * // tags: { // TagMap
40
+ * // "<keys>": "STRING_VALUE",
41
+ * // },
42
+ * // description: "STRING_VALUE", // required
43
+ * // repository: "STRING_VALUE", // required
44
+ * // platform: "WEB" || "WEB_DYNAMIC" || "WEB_COMPUTE", // required
45
+ * // createTime: new Date("TIMESTAMP"), // required
46
+ * // updateTime: new Date("TIMESTAMP"), // required
47
+ * // iamServiceRoleArn: "STRING_VALUE",
48
+ * // environmentVariables: { // EnvironmentVariables // required
49
+ * // "<keys>": "STRING_VALUE",
50
+ * // },
51
+ * // defaultDomain: "STRING_VALUE", // required
52
+ * // enableBranchAutoBuild: true || false, // required
53
+ * // enableBranchAutoDeletion: true || false,
54
+ * // enableBasicAuth: true || false, // required
55
+ * // basicAuthCredentials: "STRING_VALUE",
56
+ * // customRules: [ // CustomRules
57
+ * // { // CustomRule
58
+ * // source: "STRING_VALUE", // required
59
+ * // target: "STRING_VALUE", // required
60
+ * // status: "STRING_VALUE",
61
+ * // condition: "STRING_VALUE",
62
+ * // },
63
+ * // ],
64
+ * // productionBranch: { // ProductionBranch
65
+ * // lastDeployTime: new Date("TIMESTAMP"),
66
+ * // status: "STRING_VALUE",
67
+ * // thumbnailUrl: "STRING_VALUE",
68
+ * // branchName: "STRING_VALUE",
69
+ * // },
70
+ * // buildSpec: "STRING_VALUE",
71
+ * // customHeaders: "STRING_VALUE",
72
+ * // enableAutoBranchCreation: true || false,
73
+ * // autoBranchCreationPatterns: [ // AutoBranchCreationPatterns
74
+ * // "STRING_VALUE",
75
+ * // ],
76
+ * // autoBranchCreationConfig: { // AutoBranchCreationConfig
77
+ * // stage: "PRODUCTION" || "BETA" || "DEVELOPMENT" || "EXPERIMENTAL" || "PULL_REQUEST",
78
+ * // framework: "STRING_VALUE",
79
+ * // enableAutoBuild: true || false,
80
+ * // environmentVariables: {
81
+ * // "<keys>": "STRING_VALUE",
82
+ * // },
83
+ * // basicAuthCredentials: "STRING_VALUE",
84
+ * // enableBasicAuth: true || false,
85
+ * // enablePerformanceMode: true || false,
86
+ * // buildSpec: "STRING_VALUE",
87
+ * // enablePullRequestPreview: true || false,
88
+ * // pullRequestEnvironmentName: "STRING_VALUE",
89
+ * // },
90
+ * // repositoryCloneMethod: "SSH" || "TOKEN" || "SIGV4",
91
+ * // },
92
+ * // };
93
+ *
34
94
  * ```
35
95
  *
36
96
  * @param DeleteAppCommandInput - {@link DeleteAppCommandInput}
@@ -54,6 +114,8 @@ export interface DeleteAppCommandOutput extends DeleteAppResult, __MetadataBeare
54
114
  * @throws {@link UnauthorizedException} (client fault)
55
115
  * <p> An operation failed due to a lack of access. </p>
56
116
  *
117
+ * @throws {@link AmplifyServiceException}
118
+ * <p>Base exception class for all service exceptions from Amplify service.</p>
57
119
  *
58
120
  */
59
121
  export declare class DeleteAppCommand extends $Command<DeleteAppCommandInput, DeleteAppCommandOutput, AmplifyClientResolvedConfig> {
package/dist-types/commands/DeleteBackendEnvironmentCommand.d.ts CHANGED
@@ -32,6 +32,17 @@ export interface DeleteBackendEnvironmentCommandOutput extends DeleteBackendEnvi
32
32
  * };
33
33
  * const command = new DeleteBackendEnvironmentCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // DeleteBackendEnvironmentResult
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 DeleteBackendEnvironmentCommandInput - {@link DeleteBackendEnvironmentCommandInput}
@@ -55,6 +66,8 @@ export interface DeleteBackendEnvironmentCommandOutput extends DeleteBackendEnvi
55
66
  * @throws {@link UnauthorizedException} (client fault)
56
67
  * <p> An operation failed due to a lack of access. </p>
57
68
  *
69
+ * @throws {@link AmplifyServiceException}
70
+ * <p>Base exception class for all service exceptions from Amplify service.</p>
58
71
  *
59
72
  */
60
73
  export declare class DeleteBackendEnvironmentCommand extends $Command<DeleteBackendEnvironmentCommandInput, DeleteBackendEnvironmentCommandOutput, AmplifyClientResolvedConfig> {
package/dist-types/commands/DeleteBranchCommand.d.ts CHANGED
@@ -32,6 +32,46 @@ export interface DeleteBranchCommandOutput extends DeleteBranchResult, __Metadat
32
32
  * };
33
33
  * const command = new DeleteBranchCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // DeleteBranchResult
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 DeleteBranchCommandInput - {@link DeleteBranchCommandInput}
@@ -55,6 +95,8 @@ export interface DeleteBranchCommandOutput extends DeleteBranchResult, __Metadat
55
95
  * @throws {@link UnauthorizedException} (client fault)
56
96
  * <p> An operation failed due to a lack of access. </p>
57
97
  *
98
+ * @throws {@link AmplifyServiceException}
99
+ * <p>Base exception class for all service exceptions from Amplify service.</p>
58
100
  *
59
101
  */
60
102
  export declare class DeleteBranchCommand extends $Command<DeleteBranchCommandInput, DeleteBranchCommandOutput, AmplifyClientResolvedConfig> {
package/dist-types/commands/DeleteDomainAssociationCommand.d.ts CHANGED
@@ -32,6 +32,31 @@ export interface DeleteDomainAssociationCommandOutput extends DeleteDomainAssoci
32
32
  * };
33
33
  * const command = new DeleteDomainAssociationCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // DeleteDomainAssociationResult
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 DeleteDomainAssociationCommandInput - {@link DeleteDomainAssociationCommandInput}
@@ -55,6 +80,8 @@ export interface DeleteDomainAssociationCommandOutput extends DeleteDomainAssoci
55
80
  * @throws {@link UnauthorizedException} (client fault)
56
81
  * <p> An operation failed due to a lack of access. </p>
57
82
  *
83
+ * @throws {@link AmplifyServiceException}
84
+ * <p>Base exception class for all service exceptions from Amplify service.</p>
58
85
  *
59
86
  */
60
87
  export declare class DeleteDomainAssociationCommand extends $Command<DeleteDomainAssociationCommandInput, DeleteDomainAssociationCommandOutput, AmplifyClientResolvedConfig> {
package/dist-types/commands/DeleteJobCommand.d.ts CHANGED
@@ -33,6 +33,20 @@ export interface DeleteJobCommandOutput extends DeleteJobResult, __MetadataBeare
33
33
  * };
34
34
  * const command = new DeleteJobCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // DeleteJobResult
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 DeleteJobCommandInput - {@link DeleteJobCommandInput}
@@ -56,6 +70,8 @@ export interface DeleteJobCommandOutput extends DeleteJobResult, __MetadataBeare
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 DeleteJobCommand extends $Command<DeleteJobCommandInput, DeleteJobCommandOutput, AmplifyClientResolvedConfig> {
package/dist-types/commands/DeleteWebhookCommand.d.ts CHANGED
@@ -31,6 +31,18 @@ export interface DeleteWebhookCommandOutput extends DeleteWebhookResult, __Metad
31
31
  * };
32
32
  * const command = new DeleteWebhookCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // DeleteWebhookResult
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 DeleteWebhookCommandInput - {@link DeleteWebhookCommandInput}
@@ -54,6 +66,8 @@ export interface DeleteWebhookCommandOutput extends DeleteWebhookResult, __Metad
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 DeleteWebhookCommand extends $Command<DeleteWebhookCommandInput, DeleteWebhookCommandOutput, AmplifyClientResolvedConfig> {
package/dist-types/commands/GenerateAccessLogsCommand.d.ts CHANGED
@@ -35,6 +35,10 @@ export interface GenerateAccessLogsCommandOutput extends GenerateAccessLogsResul
35
35
  * };
36
36
  * const command = new GenerateAccessLogsCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // { // GenerateAccessLogsResult
39
+ * // logUrl: "STRING_VALUE",
40
+ * // };
41
+ *
38
42
  * ```
39
43
  *
40
44
  * @param GenerateAccessLogsCommandInput - {@link GenerateAccessLogsCommandInput}
@@ -55,6 +59,8 @@ export interface GenerateAccessLogsCommandOutput extends GenerateAccessLogsResul
55
59
  * @throws {@link UnauthorizedException} (client fault)
56
60
  * <p> An operation failed due to a lack of access. </p>
57
61
  *
62
+ * @throws {@link AmplifyServiceException}
63
+ * <p>Base exception class for all service exceptions from Amplify service.</p>
58
64
  *
59
65
  */
60
66
  export declare class GenerateAccessLogsCommand extends $Command<GenerateAccessLogsCommandInput, GenerateAccessLogsCommandOutput, AmplifyClientResolvedConfig> {
package/dist-types/commands/GetAppCommand.d.ts CHANGED
@@ -31,6 +31,66 @@ export interface GetAppCommandOutput extends GetAppResult, __MetadataBearer {
31
31
  * };
32
32
  * const command = new GetAppCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // GetAppResult
35
+ * // app: { // App
36
+ * // appId: "STRING_VALUE", // required
37
+ * // appArn: "STRING_VALUE", // required
38
+ * // name: "STRING_VALUE", // required
39
+ * // tags: { // TagMap
40
+ * // "<keys>": "STRING_VALUE",
41
+ * // },
42
+ * // description: "STRING_VALUE", // required
43
+ * // repository: "STRING_VALUE", // required
44
+ * // platform: "WEB" || "WEB_DYNAMIC" || "WEB_COMPUTE", // required
45
+ * // createTime: new Date("TIMESTAMP"), // required
46
+ * // updateTime: new Date("TIMESTAMP"), // required
47
+ * // iamServiceRoleArn: "STRING_VALUE",
48
+ * // environmentVariables: { // EnvironmentVariables // required
49
+ * // "<keys>": "STRING_VALUE",
50
+ * // },
51
+ * // defaultDomain: "STRING_VALUE", // required
52
+ * // enableBranchAutoBuild: true || false, // required
53
+ * // enableBranchAutoDeletion: true || false,
54
+ * // enableBasicAuth: true || false, // required
55
+ * // basicAuthCredentials: "STRING_VALUE",
56
+ * // customRules: [ // CustomRules
57
+ * // { // CustomRule
58
+ * // source: "STRING_VALUE", // required
59
+ * // target: "STRING_VALUE", // required
60
+ * // status: "STRING_VALUE",
61
+ * // condition: "STRING_VALUE",
62
+ * // },
63
+ * // ],
64
+ * // productionBranch: { // ProductionBranch
65
+ * // lastDeployTime: new Date("TIMESTAMP"),
66
+ * // status: "STRING_VALUE",
67
+ * // thumbnailUrl: "STRING_VALUE",
68
+ * // branchName: "STRING_VALUE",
69
+ * // },
70
+ * // buildSpec: "STRING_VALUE",
71
+ * // customHeaders: "STRING_VALUE",
72
+ * // enableAutoBranchCreation: true || false,
73
+ * // autoBranchCreationPatterns: [ // AutoBranchCreationPatterns
74
+ * // "STRING_VALUE",
75
+ * // ],
76
+ * // autoBranchCreationConfig: { // AutoBranchCreationConfig
77
+ * // stage: "PRODUCTION" || "BETA" || "DEVELOPMENT" || "EXPERIMENTAL" || "PULL_REQUEST",
78
+ * // framework: "STRING_VALUE",
79
+ * // enableAutoBuild: true || false,
80
+ * // environmentVariables: {
81
+ * // "<keys>": "STRING_VALUE",
82
+ * // },
83
+ * // basicAuthCredentials: "STRING_VALUE",
84
+ * // enableBasicAuth: true || false,
85
+ * // enablePerformanceMode: true || false,
86
+ * // buildSpec: "STRING_VALUE",
87
+ * // enablePullRequestPreview: true || false,
88
+ * // pullRequestEnvironmentName: "STRING_VALUE",
89
+ * // },
90
+ * // repositoryCloneMethod: "SSH" || "TOKEN" || "SIGV4",
91
+ * // },
92
+ * // };
93
+ *
34
94
  * ```
35
95
  *
36
96
  * @param GetAppCommandInput - {@link GetAppCommandInput}
@@ -51,6 +111,8 @@ export interface GetAppCommandOutput extends GetAppResult, __MetadataBearer {
51
111
  * @throws {@link UnauthorizedException} (client fault)
52
112
  * <p> An operation failed due to a lack of access. </p>
53
113
  *
114
+ * @throws {@link AmplifyServiceException}
115
+ * <p>Base exception class for all service exceptions from Amplify service.</p>
54
116
  *
55
117
  */
56
118
  export declare class GetAppCommand extends $Command<GetAppCommandInput, GetAppCommandOutput, AmplifyClientResolvedConfig> {
package/dist-types/commands/GetArtifactUrlCommand.d.ts CHANGED
@@ -31,6 +31,11 @@ export interface GetArtifactUrlCommandOutput extends GetArtifactUrlResult, __Met
31
31
  * };
32
32
  * const command = new GetArtifactUrlCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // GetArtifactUrlResult
35
+ * // artifactId: "STRING_VALUE", // required
36
+ * // artifactUrl: "STRING_VALUE", // required
37
+ * // };
38
+ *
34
39
  * ```
35
40
  *
36
41
  * @param GetArtifactUrlCommandInput - {@link GetArtifactUrlCommandInput}
@@ -54,6 +59,8 @@ export interface GetArtifactUrlCommandOutput extends GetArtifactUrlResult, __Met
54
59
  * @throws {@link UnauthorizedException} (client fault)
55
60
  * <p> An operation failed due to a lack of access. </p>
56
61
  *
62
+ * @throws {@link AmplifyServiceException}
63
+ * <p>Base exception class for all service exceptions from Amplify service.</p>
57
64
  *
58
65
  */
59
66
  export declare class GetArtifactUrlCommand extends $Command<GetArtifactUrlCommandInput, GetArtifactUrlCommandOutput, AmplifyClientResolvedConfig> {