/ cloudformation-templates / node_modules / aws-cdk / node_modules / aws-sdk / clients / amplify.d.ts
amplify.d.ts
1 import {Request} from '../lib/request'; 2 import {Response} from '../lib/response'; 3 import {AWSError} from '../lib/error'; 4 import {Service} from '../lib/service'; 5 import {ServiceConfigurationOptions} from '../lib/service'; 6 import {ConfigBase as Config} from '../lib/config-base'; 7 interface Blob {} 8 declare class Amplify extends Service { 9 /** 10 * Constructs a service object. This object has one method for each API operation. 11 */ 12 constructor(options?: Amplify.Types.ClientConfiguration) 13 config: Config & Amplify.Types.ClientConfiguration; 14 /** 15 * Creates a new Amplify app. 16 */ 17 createApp(params: Amplify.Types.CreateAppRequest, callback?: (err: AWSError, data: Amplify.Types.CreateAppResult) => void): Request<Amplify.Types.CreateAppResult, AWSError>; 18 /** 19 * Creates a new Amplify app. 20 */ 21 createApp(callback?: (err: AWSError, data: Amplify.Types.CreateAppResult) => void): Request<Amplify.Types.CreateAppResult, AWSError>; 22 /** 23 * Creates a new backend environment for an Amplify app. 24 */ 25 createBackendEnvironment(params: Amplify.Types.CreateBackendEnvironmentRequest, callback?: (err: AWSError, data: Amplify.Types.CreateBackendEnvironmentResult) => void): Request<Amplify.Types.CreateBackendEnvironmentResult, AWSError>; 26 /** 27 * Creates a new backend environment for an Amplify app. 28 */ 29 createBackendEnvironment(callback?: (err: AWSError, data: Amplify.Types.CreateBackendEnvironmentResult) => void): Request<Amplify.Types.CreateBackendEnvironmentResult, AWSError>; 30 /** 31 * Creates a new branch for an Amplify app. 32 */ 33 createBranch(params: Amplify.Types.CreateBranchRequest, callback?: (err: AWSError, data: Amplify.Types.CreateBranchResult) => void): Request<Amplify.Types.CreateBranchResult, AWSError>; 34 /** 35 * Creates a new branch for an Amplify app. 36 */ 37 createBranch(callback?: (err: AWSError, data: Amplify.Types.CreateBranchResult) => void): Request<Amplify.Types.CreateBranchResult, AWSError>; 38 /** 39 * Creates a deployment for a manually deployed Amplify app. Manually deployed apps are not connected to a repository. 40 */ 41 createDeployment(params: Amplify.Types.CreateDeploymentRequest, callback?: (err: AWSError, data: Amplify.Types.CreateDeploymentResult) => void): Request<Amplify.Types.CreateDeploymentResult, AWSError>; 42 /** 43 * Creates a deployment for a manually deployed Amplify app. Manually deployed apps are not connected to a repository. 44 */ 45 createDeployment(callback?: (err: AWSError, data: Amplify.Types.CreateDeploymentResult) => void): Request<Amplify.Types.CreateDeploymentResult, AWSError>; 46 /** 47 * Creates a new domain association for an Amplify app. This action associates a custom domain with the Amplify app 48 */ 49 createDomainAssociation(params: Amplify.Types.CreateDomainAssociationRequest, callback?: (err: AWSError, data: Amplify.Types.CreateDomainAssociationResult) => void): Request<Amplify.Types.CreateDomainAssociationResult, AWSError>; 50 /** 51 * Creates a new domain association for an Amplify app. This action associates a custom domain with the Amplify app 52 */ 53 createDomainAssociation(callback?: (err: AWSError, data: Amplify.Types.CreateDomainAssociationResult) => void): Request<Amplify.Types.CreateDomainAssociationResult, AWSError>; 54 /** 55 * Creates a new webhook on an Amplify app. 56 */ 57 createWebhook(params: Amplify.Types.CreateWebhookRequest, callback?: (err: AWSError, data: Amplify.Types.CreateWebhookResult) => void): Request<Amplify.Types.CreateWebhookResult, AWSError>; 58 /** 59 * Creates a new webhook on an Amplify app. 60 */ 61 createWebhook(callback?: (err: AWSError, data: Amplify.Types.CreateWebhookResult) => void): Request<Amplify.Types.CreateWebhookResult, AWSError>; 62 /** 63 * Deletes an existing Amplify app specified by an app ID. 64 */ 65 deleteApp(params: Amplify.Types.DeleteAppRequest, callback?: (err: AWSError, data: Amplify.Types.DeleteAppResult) => void): Request<Amplify.Types.DeleteAppResult, AWSError>; 66 /** 67 * Deletes an existing Amplify app specified by an app ID. 68 */ 69 deleteApp(callback?: (err: AWSError, data: Amplify.Types.DeleteAppResult) => void): Request<Amplify.Types.DeleteAppResult, AWSError>; 70 /** 71 * Deletes a backend environment for an Amplify app. 72 */ 73 deleteBackendEnvironment(params: Amplify.Types.DeleteBackendEnvironmentRequest, callback?: (err: AWSError, data: Amplify.Types.DeleteBackendEnvironmentResult) => void): Request<Amplify.Types.DeleteBackendEnvironmentResult, AWSError>; 74 /** 75 * Deletes a backend environment for an Amplify app. 76 */ 77 deleteBackendEnvironment(callback?: (err: AWSError, data: Amplify.Types.DeleteBackendEnvironmentResult) => void): Request<Amplify.Types.DeleteBackendEnvironmentResult, AWSError>; 78 /** 79 * Deletes a branch for an Amplify app. 80 */ 81 deleteBranch(params: Amplify.Types.DeleteBranchRequest, callback?: (err: AWSError, data: Amplify.Types.DeleteBranchResult) => void): Request<Amplify.Types.DeleteBranchResult, AWSError>; 82 /** 83 * Deletes a branch for an Amplify app. 84 */ 85 deleteBranch(callback?: (err: AWSError, data: Amplify.Types.DeleteBranchResult) => void): Request<Amplify.Types.DeleteBranchResult, AWSError>; 86 /** 87 * Deletes a domain association for an Amplify app. 88 */ 89 deleteDomainAssociation(params: Amplify.Types.DeleteDomainAssociationRequest, callback?: (err: AWSError, data: Amplify.Types.DeleteDomainAssociationResult) => void): Request<Amplify.Types.DeleteDomainAssociationResult, AWSError>; 90 /** 91 * Deletes a domain association for an Amplify app. 92 */ 93 deleteDomainAssociation(callback?: (err: AWSError, data: Amplify.Types.DeleteDomainAssociationResult) => void): Request<Amplify.Types.DeleteDomainAssociationResult, AWSError>; 94 /** 95 * Deletes a job for a branch of an Amplify app. 96 */ 97 deleteJob(params: Amplify.Types.DeleteJobRequest, callback?: (err: AWSError, data: Amplify.Types.DeleteJobResult) => void): Request<Amplify.Types.DeleteJobResult, AWSError>; 98 /** 99 * Deletes a job for a branch of an Amplify app. 100 */ 101 deleteJob(callback?: (err: AWSError, data: Amplify.Types.DeleteJobResult) => void): Request<Amplify.Types.DeleteJobResult, AWSError>; 102 /** 103 * Deletes a webhook. 104 */ 105 deleteWebhook(params: Amplify.Types.DeleteWebhookRequest, callback?: (err: AWSError, data: Amplify.Types.DeleteWebhookResult) => void): Request<Amplify.Types.DeleteWebhookResult, AWSError>; 106 /** 107 * Deletes a webhook. 108 */ 109 deleteWebhook(callback?: (err: AWSError, data: Amplify.Types.DeleteWebhookResult) => void): Request<Amplify.Types.DeleteWebhookResult, AWSError>; 110 /** 111 * Returns the website access logs for a specific time range using a presigned URL. 112 */ 113 generateAccessLogs(params: Amplify.Types.GenerateAccessLogsRequest, callback?: (err: AWSError, data: Amplify.Types.GenerateAccessLogsResult) => void): Request<Amplify.Types.GenerateAccessLogsResult, AWSError>; 114 /** 115 * Returns the website access logs for a specific time range using a presigned URL. 116 */ 117 generateAccessLogs(callback?: (err: AWSError, data: Amplify.Types.GenerateAccessLogsResult) => void): Request<Amplify.Types.GenerateAccessLogsResult, AWSError>; 118 /** 119 * Returns an existing Amplify app by appID. 120 */ 121 getApp(params: Amplify.Types.GetAppRequest, callback?: (err: AWSError, data: Amplify.Types.GetAppResult) => void): Request<Amplify.Types.GetAppResult, AWSError>; 122 /** 123 * Returns an existing Amplify app by appID. 124 */ 125 getApp(callback?: (err: AWSError, data: Amplify.Types.GetAppResult) => void): Request<Amplify.Types.GetAppResult, AWSError>; 126 /** 127 * Returns the artifact info that corresponds to an artifact id. 128 */ 129 getArtifactUrl(params: Amplify.Types.GetArtifactUrlRequest, callback?: (err: AWSError, data: Amplify.Types.GetArtifactUrlResult) => void): Request<Amplify.Types.GetArtifactUrlResult, AWSError>; 130 /** 131 * Returns the artifact info that corresponds to an artifact id. 132 */ 133 getArtifactUrl(callback?: (err: AWSError, data: Amplify.Types.GetArtifactUrlResult) => void): Request<Amplify.Types.GetArtifactUrlResult, AWSError>; 134 /** 135 * Returns a backend environment for an Amplify app. 136 */ 137 getBackendEnvironment(params: Amplify.Types.GetBackendEnvironmentRequest, callback?: (err: AWSError, data: Amplify.Types.GetBackendEnvironmentResult) => void): Request<Amplify.Types.GetBackendEnvironmentResult, AWSError>; 138 /** 139 * Returns a backend environment for an Amplify app. 140 */ 141 getBackendEnvironment(callback?: (err: AWSError, data: Amplify.Types.GetBackendEnvironmentResult) => void): Request<Amplify.Types.GetBackendEnvironmentResult, AWSError>; 142 /** 143 * Returns a branch for an Amplify app. 144 */ 145 getBranch(params: Amplify.Types.GetBranchRequest, callback?: (err: AWSError, data: Amplify.Types.GetBranchResult) => void): Request<Amplify.Types.GetBranchResult, AWSError>; 146 /** 147 * Returns a branch for an Amplify app. 148 */ 149 getBranch(callback?: (err: AWSError, data: Amplify.Types.GetBranchResult) => void): Request<Amplify.Types.GetBranchResult, AWSError>; 150 /** 151 * Returns the domain information for an Amplify app. 152 */ 153 getDomainAssociation(params: Amplify.Types.GetDomainAssociationRequest, callback?: (err: AWSError, data: Amplify.Types.GetDomainAssociationResult) => void): Request<Amplify.Types.GetDomainAssociationResult, AWSError>; 154 /** 155 * Returns the domain information for an Amplify app. 156 */ 157 getDomainAssociation(callback?: (err: AWSError, data: Amplify.Types.GetDomainAssociationResult) => void): Request<Amplify.Types.GetDomainAssociationResult, AWSError>; 158 /** 159 * Returns a job for a branch of an Amplify app. 160 */ 161 getJob(params: Amplify.Types.GetJobRequest, callback?: (err: AWSError, data: Amplify.Types.GetJobResult) => void): Request<Amplify.Types.GetJobResult, AWSError>; 162 /** 163 * Returns a job for a branch of an Amplify app. 164 */ 165 getJob(callback?: (err: AWSError, data: Amplify.Types.GetJobResult) => void): Request<Amplify.Types.GetJobResult, AWSError>; 166 /** 167 * Returns the webhook information that corresponds to a specified webhook ID. 168 */ 169 getWebhook(params: Amplify.Types.GetWebhookRequest, callback?: (err: AWSError, data: Amplify.Types.GetWebhookResult) => void): Request<Amplify.Types.GetWebhookResult, AWSError>; 170 /** 171 * Returns the webhook information that corresponds to a specified webhook ID. 172 */ 173 getWebhook(callback?: (err: AWSError, data: Amplify.Types.GetWebhookResult) => void): Request<Amplify.Types.GetWebhookResult, AWSError>; 174 /** 175 * Returns a list of the existing Amplify apps. 176 */ 177 listApps(params: Amplify.Types.ListAppsRequest, callback?: (err: AWSError, data: Amplify.Types.ListAppsResult) => void): Request<Amplify.Types.ListAppsResult, AWSError>; 178 /** 179 * Returns a list of the existing Amplify apps. 180 */ 181 listApps(callback?: (err: AWSError, data: Amplify.Types.ListAppsResult) => void): Request<Amplify.Types.ListAppsResult, AWSError>; 182 /** 183 * Returns a list of artifacts for a specified app, branch, and job. 184 */ 185 listArtifacts(params: Amplify.Types.ListArtifactsRequest, callback?: (err: AWSError, data: Amplify.Types.ListArtifactsResult) => void): Request<Amplify.Types.ListArtifactsResult, AWSError>; 186 /** 187 * Returns a list of artifacts for a specified app, branch, and job. 188 */ 189 listArtifacts(callback?: (err: AWSError, data: Amplify.Types.ListArtifactsResult) => void): Request<Amplify.Types.ListArtifactsResult, AWSError>; 190 /** 191 * Lists the backend environments for an Amplify app. 192 */ 193 listBackendEnvironments(params: Amplify.Types.ListBackendEnvironmentsRequest, callback?: (err: AWSError, data: Amplify.Types.ListBackendEnvironmentsResult) => void): Request<Amplify.Types.ListBackendEnvironmentsResult, AWSError>; 194 /** 195 * Lists the backend environments for an Amplify app. 196 */ 197 listBackendEnvironments(callback?: (err: AWSError, data: Amplify.Types.ListBackendEnvironmentsResult) => void): Request<Amplify.Types.ListBackendEnvironmentsResult, AWSError>; 198 /** 199 * Lists the branches of an Amplify app. 200 */ 201 listBranches(params: Amplify.Types.ListBranchesRequest, callback?: (err: AWSError, data: Amplify.Types.ListBranchesResult) => void): Request<Amplify.Types.ListBranchesResult, AWSError>; 202 /** 203 * Lists the branches of an Amplify app. 204 */ 205 listBranches(callback?: (err: AWSError, data: Amplify.Types.ListBranchesResult) => void): Request<Amplify.Types.ListBranchesResult, AWSError>; 206 /** 207 * Returns the domain associations for an Amplify app. 208 */ 209 listDomainAssociations(params: Amplify.Types.ListDomainAssociationsRequest, callback?: (err: AWSError, data: Amplify.Types.ListDomainAssociationsResult) => void): Request<Amplify.Types.ListDomainAssociationsResult, AWSError>; 210 /** 211 * Returns the domain associations for an Amplify app. 212 */ 213 listDomainAssociations(callback?: (err: AWSError, data: Amplify.Types.ListDomainAssociationsResult) => void): Request<Amplify.Types.ListDomainAssociationsResult, AWSError>; 214 /** 215 * Lists the jobs for a branch of an Amplify app. 216 */ 217 listJobs(params: Amplify.Types.ListJobsRequest, callback?: (err: AWSError, data: Amplify.Types.ListJobsResult) => void): Request<Amplify.Types.ListJobsResult, AWSError>; 218 /** 219 * Lists the jobs for a branch of an Amplify app. 220 */ 221 listJobs(callback?: (err: AWSError, data: Amplify.Types.ListJobsResult) => void): Request<Amplify.Types.ListJobsResult, AWSError>; 222 /** 223 * Returns a list of tags for a specified Amazon Resource Name (ARN). 224 */ 225 listTagsForResource(params: Amplify.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: Amplify.Types.ListTagsForResourceResponse) => void): Request<Amplify.Types.ListTagsForResourceResponse, AWSError>; 226 /** 227 * Returns a list of tags for a specified Amazon Resource Name (ARN). 228 */ 229 listTagsForResource(callback?: (err: AWSError, data: Amplify.Types.ListTagsForResourceResponse) => void): Request<Amplify.Types.ListTagsForResourceResponse, AWSError>; 230 /** 231 * Returns a list of webhooks for an Amplify app. 232 */ 233 listWebhooks(params: Amplify.Types.ListWebhooksRequest, callback?: (err: AWSError, data: Amplify.Types.ListWebhooksResult) => void): Request<Amplify.Types.ListWebhooksResult, AWSError>; 234 /** 235 * Returns a list of webhooks for an Amplify app. 236 */ 237 listWebhooks(callback?: (err: AWSError, data: Amplify.Types.ListWebhooksResult) => void): Request<Amplify.Types.ListWebhooksResult, AWSError>; 238 /** 239 * Starts a deployment for a manually deployed app. Manually deployed apps are not connected to a repository. 240 */ 241 startDeployment(params: Amplify.Types.StartDeploymentRequest, callback?: (err: AWSError, data: Amplify.Types.StartDeploymentResult) => void): Request<Amplify.Types.StartDeploymentResult, AWSError>; 242 /** 243 * Starts a deployment for a manually deployed app. Manually deployed apps are not connected to a repository. 244 */ 245 startDeployment(callback?: (err: AWSError, data: Amplify.Types.StartDeploymentResult) => void): Request<Amplify.Types.StartDeploymentResult, AWSError>; 246 /** 247 * Starts a new job for a branch of an Amplify app. 248 */ 249 startJob(params: Amplify.Types.StartJobRequest, callback?: (err: AWSError, data: Amplify.Types.StartJobResult) => void): Request<Amplify.Types.StartJobResult, AWSError>; 250 /** 251 * Starts a new job for a branch of an Amplify app. 252 */ 253 startJob(callback?: (err: AWSError, data: Amplify.Types.StartJobResult) => void): Request<Amplify.Types.StartJobResult, AWSError>; 254 /** 255 * Stops a job that is in progress for a branch of an Amplify app. 256 */ 257 stopJob(params: Amplify.Types.StopJobRequest, callback?: (err: AWSError, data: Amplify.Types.StopJobResult) => void): Request<Amplify.Types.StopJobResult, AWSError>; 258 /** 259 * Stops a job that is in progress for a branch of an Amplify app. 260 */ 261 stopJob(callback?: (err: AWSError, data: Amplify.Types.StopJobResult) => void): Request<Amplify.Types.StopJobResult, AWSError>; 262 /** 263 * Tags the resource with a tag key and value. 264 */ 265 tagResource(params: Amplify.Types.TagResourceRequest, callback?: (err: AWSError, data: Amplify.Types.TagResourceResponse) => void): Request<Amplify.Types.TagResourceResponse, AWSError>; 266 /** 267 * Tags the resource with a tag key and value. 268 */ 269 tagResource(callback?: (err: AWSError, data: Amplify.Types.TagResourceResponse) => void): Request<Amplify.Types.TagResourceResponse, AWSError>; 270 /** 271 * Untags a resource with a specified Amazon Resource Name (ARN). 272 */ 273 untagResource(params: Amplify.Types.UntagResourceRequest, callback?: (err: AWSError, data: Amplify.Types.UntagResourceResponse) => void): Request<Amplify.Types.UntagResourceResponse, AWSError>; 274 /** 275 * Untags a resource with a specified Amazon Resource Name (ARN). 276 */ 277 untagResource(callback?: (err: AWSError, data: Amplify.Types.UntagResourceResponse) => void): Request<Amplify.Types.UntagResourceResponse, AWSError>; 278 /** 279 * Updates an existing Amplify app. 280 */ 281 updateApp(params: Amplify.Types.UpdateAppRequest, callback?: (err: AWSError, data: Amplify.Types.UpdateAppResult) => void): Request<Amplify.Types.UpdateAppResult, AWSError>; 282 /** 283 * Updates an existing Amplify app. 284 */ 285 updateApp(callback?: (err: AWSError, data: Amplify.Types.UpdateAppResult) => void): Request<Amplify.Types.UpdateAppResult, AWSError>; 286 /** 287 * Updates a branch for an Amplify app. 288 */ 289 updateBranch(params: Amplify.Types.UpdateBranchRequest, callback?: (err: AWSError, data: Amplify.Types.UpdateBranchResult) => void): Request<Amplify.Types.UpdateBranchResult, AWSError>; 290 /** 291 * Updates a branch for an Amplify app. 292 */ 293 updateBranch(callback?: (err: AWSError, data: Amplify.Types.UpdateBranchResult) => void): Request<Amplify.Types.UpdateBranchResult, AWSError>; 294 /** 295 * Creates a new domain association for an Amplify app. 296 */ 297 updateDomainAssociation(params: Amplify.Types.UpdateDomainAssociationRequest, callback?: (err: AWSError, data: Amplify.Types.UpdateDomainAssociationResult) => void): Request<Amplify.Types.UpdateDomainAssociationResult, AWSError>; 298 /** 299 * Creates a new domain association for an Amplify app. 300 */ 301 updateDomainAssociation(callback?: (err: AWSError, data: Amplify.Types.UpdateDomainAssociationResult) => void): Request<Amplify.Types.UpdateDomainAssociationResult, AWSError>; 302 /** 303 * Updates a webhook. 304 */ 305 updateWebhook(params: Amplify.Types.UpdateWebhookRequest, callback?: (err: AWSError, data: Amplify.Types.UpdateWebhookResult) => void): Request<Amplify.Types.UpdateWebhookResult, AWSError>; 306 /** 307 * Updates a webhook. 308 */ 309 updateWebhook(callback?: (err: AWSError, data: Amplify.Types.UpdateWebhookResult) => void): Request<Amplify.Types.UpdateWebhookResult, AWSError>; 310 } 311 declare namespace Amplify { 312 export type AccessToken = string; 313 export type ActiveJobId = string; 314 export interface App { 315 /** 316 * The unique ID of the Amplify app. 317 */ 318 appId: AppId; 319 /** 320 * The Amazon Resource Name (ARN) of the Amplify app. 321 */ 322 appArn: AppArn; 323 /** 324 * The name for the Amplify app. 325 */ 326 name: Name; 327 /** 328 * The tag for the Amplify app. 329 */ 330 tags?: TagMap; 331 /** 332 * The description for the Amplify app. 333 */ 334 description: Description; 335 /** 336 * The repository for the Amplify app. 337 */ 338 repository: Repository; 339 /** 340 * The platform for the Amplify app. 341 */ 342 platform: Platform; 343 /** 344 * Creates a date and time for the Amplify app. 345 */ 346 createTime: CreateTime; 347 /** 348 * Updates the date and time for the Amplify app. 349 */ 350 updateTime: UpdateTime; 351 /** 352 * The AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) of the Amplify app. 353 */ 354 iamServiceRoleArn?: ServiceRoleArn; 355 /** 356 * The environment variables for the Amplify app. 357 */ 358 environmentVariables: EnvironmentVariables; 359 /** 360 * The default domain for the Amplify app. 361 */ 362 defaultDomain: DefaultDomain; 363 /** 364 * Enables the auto-building of branches for the Amplify app. 365 */ 366 enableBranchAutoBuild: EnableBranchAutoBuild; 367 /** 368 * Automatically disconnect a branch in the Amplify Console when you delete a branch from your Git repository. 369 */ 370 enableBranchAutoDeletion?: EnableBranchAutoDeletion; 371 /** 372 * Enables basic authorization for the Amplify app's branches. 373 */ 374 enableBasicAuth: EnableBasicAuth; 375 /** 376 * The basic authorization credentials for branches for the Amplify app. 377 */ 378 basicAuthCredentials?: BasicAuthCredentials; 379 /** 380 * Describes the custom redirect and rewrite rules for the Amplify app. 381 */ 382 customRules?: CustomRules; 383 /** 384 * Describes the information about a production branch of the Amplify app. 385 */ 386 productionBranch?: ProductionBranch; 387 /** 388 * Describes the content of the build specification (build spec) for the Amplify app. 389 */ 390 buildSpec?: BuildSpec; 391 /** 392 * Describes the custom HTTP headers for the Amplify app. 393 */ 394 customHeaders?: CustomHeaders; 395 /** 396 * Enables automated branch creation for the Amplify app. 397 */ 398 enableAutoBranchCreation?: EnableAutoBranchCreation; 399 /** 400 * Describes the automated branch creation glob patterns for the Amplify app. 401 */ 402 autoBranchCreationPatterns?: AutoBranchCreationPatterns; 403 /** 404 * Describes the automated branch creation configuration for the Amplify app. 405 */ 406 autoBranchCreationConfig?: AutoBranchCreationConfig; 407 } 408 export type AppArn = string; 409 export type AppId = string; 410 export type Apps = App[]; 411 export interface Artifact { 412 /** 413 * The file name for the artifact. 414 */ 415 artifactFileName: ArtifactFileName; 416 /** 417 * The unique ID for the artifact. 418 */ 419 artifactId: ArtifactId; 420 } 421 export type ArtifactFileName = string; 422 export type ArtifactId = string; 423 export type ArtifactUrl = string; 424 export type Artifacts = Artifact[]; 425 export type ArtifactsUrl = string; 426 export type AssociatedResource = string; 427 export type AssociatedResources = AssociatedResource[]; 428 export interface AutoBranchCreationConfig { 429 /** 430 * Describes the current stage for the autocreated branch. 431 */ 432 stage?: Stage; 433 /** 434 * The framework for the autocreated branch. 435 */ 436 framework?: Framework; 437 /** 438 * Enables auto building for the autocreated branch. 439 */ 440 enableAutoBuild?: EnableAutoBuild; 441 /** 442 * The environment variables for the autocreated branch. 443 */ 444 environmentVariables?: EnvironmentVariables; 445 /** 446 * The basic authorization credentials for the autocreated branch. 447 */ 448 basicAuthCredentials?: BasicAuthCredentials; 449 /** 450 * Enables basic authorization for the autocreated branch. 451 */ 452 enableBasicAuth?: EnableBasicAuth; 453 /** 454 * Enables performance mode for the branch. Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out. 455 */ 456 enablePerformanceMode?: EnablePerformanceMode; 457 /** 458 * The build specification (build spec) for the autocreated branch. 459 */ 460 buildSpec?: BuildSpec; 461 /** 462 * Enables pull request previews for the autocreated branch. 463 */ 464 enablePullRequestPreview?: EnablePullRequestPreview; 465 /** 466 * The Amplify environment name for the pull request. 467 */ 468 pullRequestEnvironmentName?: PullRequestEnvironmentName; 469 } 470 export type AutoBranchCreationPattern = string; 471 export type AutoBranchCreationPatterns = AutoBranchCreationPattern[]; 472 export type AutoSubDomainCreationPattern = string; 473 export type AutoSubDomainCreationPatterns = AutoSubDomainCreationPattern[]; 474 export type AutoSubDomainIAMRole = string; 475 export interface BackendEnvironment { 476 /** 477 * The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app. 478 */ 479 backendEnvironmentArn: BackendEnvironmentArn; 480 /** 481 * The name for a backend environment that is part of an Amplify app. 482 */ 483 environmentName: EnvironmentName; 484 /** 485 * The AWS CloudFormation stack name of a backend environment. 486 */ 487 stackName?: StackName; 488 /** 489 * The name of deployment artifacts. 490 */ 491 deploymentArtifacts?: DeploymentArtifacts; 492 /** 493 * The creation date and time for a backend environment that is part of an Amplify app. 494 */ 495 createTime: CreateTime; 496 /** 497 * The last updated date and time for a backend environment that is part of an Amplify app. 498 */ 499 updateTime: UpdateTime; 500 } 501 export type BackendEnvironmentArn = string; 502 export type BackendEnvironments = BackendEnvironment[]; 503 export type BasicAuthCredentials = string; 504 export interface Branch { 505 /** 506 * The Amazon Resource Name (ARN) for a branch that is part of an Amplify app. 507 */ 508 branchArn: BranchArn; 509 /** 510 * The name for the branch that is part of an Amplify app. 511 */ 512 branchName: BranchName; 513 /** 514 * The description for the branch that is part of an Amplify app. 515 */ 516 description: Description; 517 /** 518 * The tag for the branch of an Amplify app. 519 */ 520 tags?: TagMap; 521 /** 522 * The current stage for the branch that is part of an Amplify app. 523 */ 524 stage: Stage; 525 /** 526 * The display name for the branch. This is used as the default domain prefix. 527 */ 528 displayName: DisplayName; 529 /** 530 * Enables notifications for a branch that is part of an Amplify app. 531 */ 532 enableNotification: EnableNotification; 533 /** 534 * The creation date and time for a branch that is part of an Amplify app. 535 */ 536 createTime: CreateTime; 537 /** 538 * The last updated date and time for a branch that is part of an Amplify app. 539 */ 540 updateTime: UpdateTime; 541 /** 542 * The environment variables specific to a branch of an Amplify app. 543 */ 544 environmentVariables: EnvironmentVariables; 545 /** 546 * Enables auto-building on push for a branch of an Amplify app. 547 */ 548 enableAutoBuild: EnableAutoBuild; 549 /** 550 * The custom domains for a branch of an Amplify app. 551 */ 552 customDomains: CustomDomains; 553 /** 554 * The framework for a branch of an Amplify app. 555 */ 556 framework: Framework; 557 /** 558 * The ID of the active job for a branch of an Amplify app. 559 */ 560 activeJobId: ActiveJobId; 561 /** 562 * The total number of jobs that are part of an Amplify app. 563 */ 564 totalNumberOfJobs: TotalNumberOfJobs; 565 /** 566 * Enables basic authorization for a branch of an Amplify app. 567 */ 568 enableBasicAuth: EnableBasicAuth; 569 /** 570 * Enables performance mode for the branch. Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out. 571 */ 572 enablePerformanceMode?: EnablePerformanceMode; 573 /** 574 * The thumbnail URL for the branch of an Amplify app. 575 */ 576 thumbnailUrl?: ThumbnailUrl; 577 /** 578 * The basic authorization credentials for a branch of an Amplify app. 579 */ 580 basicAuthCredentials?: BasicAuthCredentials; 581 /** 582 * The build specification (build spec) content for the branch of an Amplify app. 583 */ 584 buildSpec?: BuildSpec; 585 /** 586 * The content Time to Live (TTL) for the website in seconds. 587 */ 588 ttl: TTL; 589 /** 590 * A list of custom resources that are linked to this branch. 591 */ 592 associatedResources?: AssociatedResources; 593 /** 594 * Enables pull request previews for the branch. 595 */ 596 enablePullRequestPreview: EnablePullRequestPreview; 597 /** 598 * The Amplify environment name for the pull request. 599 */ 600 pullRequestEnvironmentName?: PullRequestEnvironmentName; 601 /** 602 * The destination branch if the branch is a pull request branch. 603 */ 604 destinationBranch?: BranchName; 605 /** 606 * The source branch if the branch is a pull request branch. 607 */ 608 sourceBranch?: BranchName; 609 /** 610 * The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app. 611 */ 612 backendEnvironmentArn?: BackendEnvironmentArn; 613 } 614 export type BranchArn = string; 615 export type BranchName = string; 616 export type Branches = Branch[]; 617 export type BuildSpec = string; 618 export type CertificateVerificationDNSRecord = string; 619 export type CommitId = string; 620 export type CommitMessage = string; 621 export type CommitTime = Date; 622 export type Condition = string; 623 export type Context = string; 624 export interface CreateAppRequest { 625 /** 626 * The name for an Amplify app. 627 */ 628 name: Name; 629 /** 630 * The description for an Amplify app. 631 */ 632 description?: Description; 633 /** 634 * The repository for an Amplify app. 635 */ 636 repository?: Repository; 637 /** 638 * The platform or framework for an Amplify app. 639 */ 640 platform?: Platform; 641 /** 642 * The AWS Identity and Access Management (IAM) service role for an Amplify app. 643 */ 644 iamServiceRoleArn?: ServiceRoleArn; 645 /** 646 * The OAuth token for a third-party source control system for an Amplify app. The OAuth token is used to create a webhook and a read-only deploy key. The OAuth token is not stored. 647 */ 648 oauthToken?: OauthToken; 649 /** 650 * The personal access token for a third-party source control system for an Amplify app. The personal access token is used to create a webhook and a read-only deploy key. The token is not stored. 651 */ 652 accessToken?: AccessToken; 653 /** 654 * The environment variables map for an Amplify app. 655 */ 656 environmentVariables?: EnvironmentVariables; 657 /** 658 * Enables the auto building of branches for an Amplify app. 659 */ 660 enableBranchAutoBuild?: EnableBranchAutoBuild; 661 /** 662 * Automatically disconnects a branch in the Amplify Console when you delete a branch from your Git repository. 663 */ 664 enableBranchAutoDeletion?: EnableBranchAutoDeletion; 665 /** 666 * Enables basic authorization for an Amplify app. This will apply to all branches that are part of this app. 667 */ 668 enableBasicAuth?: EnableBasicAuth; 669 /** 670 * The credentials for basic authorization for an Amplify app. 671 */ 672 basicAuthCredentials?: BasicAuthCredentials; 673 /** 674 * The custom rewrite and redirect rules for an Amplify app. 675 */ 676 customRules?: CustomRules; 677 /** 678 * The tag for an Amplify app. 679 */ 680 tags?: TagMap; 681 /** 682 * The build specification (build spec) for an Amplify app. 683 */ 684 buildSpec?: BuildSpec; 685 /** 686 * The custom HTTP headers for an Amplify app. 687 */ 688 customHeaders?: CustomHeaders; 689 /** 690 * Enables automated branch creation for an Amplify app. 691 */ 692 enableAutoBranchCreation?: EnableAutoBranchCreation; 693 /** 694 * The automated branch creation glob patterns for an Amplify app. 695 */ 696 autoBranchCreationPatterns?: AutoBranchCreationPatterns; 697 /** 698 * The automated branch creation configuration for an Amplify app. 699 */ 700 autoBranchCreationConfig?: AutoBranchCreationConfig; 701 } 702 export interface CreateAppResult { 703 app: App; 704 } 705 export interface CreateBackendEnvironmentRequest { 706 /** 707 * The unique ID for an Amplify app. 708 */ 709 appId: AppId; 710 /** 711 * The name for the backend environment. 712 */ 713 environmentName: EnvironmentName; 714 /** 715 * The AWS CloudFormation stack name of a backend environment. 716 */ 717 stackName?: StackName; 718 /** 719 * The name of deployment artifacts. 720 */ 721 deploymentArtifacts?: DeploymentArtifacts; 722 } 723 export interface CreateBackendEnvironmentResult { 724 /** 725 * Describes the backend environment for an Amplify app. 726 */ 727 backendEnvironment: BackendEnvironment; 728 } 729 export interface CreateBranchRequest { 730 /** 731 * The unique ID for an Amplify app. 732 */ 733 appId: AppId; 734 /** 735 * The name for the branch. 736 */ 737 branchName: BranchName; 738 /** 739 * The description for the branch. 740 */ 741 description?: Description; 742 /** 743 * Describes the current stage for the branch. 744 */ 745 stage?: Stage; 746 /** 747 * The framework for the branch. 748 */ 749 framework?: Framework; 750 /** 751 * Enables notifications for the branch. 752 */ 753 enableNotification?: EnableNotification; 754 /** 755 * Enables auto building for the branch. 756 */ 757 enableAutoBuild?: EnableAutoBuild; 758 /** 759 * The environment variables for the branch. 760 */ 761 environmentVariables?: EnvironmentVariables; 762 /** 763 * The basic authorization credentials for the branch. 764 */ 765 basicAuthCredentials?: BasicAuthCredentials; 766 /** 767 * Enables basic authorization for the branch. 768 */ 769 enableBasicAuth?: EnableBasicAuth; 770 /** 771 * Enables performance mode for the branch. Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out. 772 */ 773 enablePerformanceMode?: EnablePerformanceMode; 774 /** 775 * The tag for the branch. 776 */ 777 tags?: TagMap; 778 /** 779 * The build specification (build spec) for the branch. 780 */ 781 buildSpec?: BuildSpec; 782 /** 783 * The content Time To Live (TTL) for the website in seconds. 784 */ 785 ttl?: TTL; 786 /** 787 * The display name for a branch. This is used as the default domain prefix. 788 */ 789 displayName?: DisplayName; 790 /** 791 * Enables pull request previews for this branch. 792 */ 793 enablePullRequestPreview?: EnablePullRequestPreview; 794 /** 795 * The Amplify environment name for the pull request. 796 */ 797 pullRequestEnvironmentName?: PullRequestEnvironmentName; 798 /** 799 * The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app. 800 */ 801 backendEnvironmentArn?: BackendEnvironmentArn; 802 } 803 export interface CreateBranchResult { 804 /** 805 * Describes the branch for an Amplify app, which maps to a third-party repository branch. 806 */ 807 branch: Branch; 808 } 809 export interface CreateDeploymentRequest { 810 /** 811 * The unique ID for an Amplify app. 812 */ 813 appId: AppId; 814 /** 815 * The name for the branch, for the job. 816 */ 817 branchName: BranchName; 818 /** 819 * An optional file map that contains the file name as the key and the file content md5 hash as the value. If this argument is provided, the service will generate a unique upload URL per file. Otherwise, the service will only generate a single upload URL for the zipped files. 820 */ 821 fileMap?: FileMap; 822 } 823 export interface CreateDeploymentResult { 824 /** 825 * The job ID for this deployment. will supply to start deployment api. 826 */ 827 jobId?: JobId; 828 /** 829 * When the fileMap argument is provided in the request, fileUploadUrls will contain a map of file names to upload URLs. 830 */ 831 fileUploadUrls: FileUploadUrls; 832 /** 833 * When the fileMap argument is not provided in the request, this zipUploadUrl is returned. 834 */ 835 zipUploadUrl: UploadUrl; 836 } 837 export interface CreateDomainAssociationRequest { 838 /** 839 * The unique ID for an Amplify app. 840 */ 841 appId: AppId; 842 /** 843 * The domain name for the domain association. 844 */ 845 domainName: DomainName; 846 /** 847 * Enables the automated creation of subdomains for branches. 848 */ 849 enableAutoSubDomain?: EnableAutoSubDomain; 850 /** 851 * The setting for the subdomain. 852 */ 853 subDomainSettings: SubDomainSettings; 854 /** 855 * Sets the branch patterns for automatic subdomain creation. 856 */ 857 autoSubDomainCreationPatterns?: AutoSubDomainCreationPatterns; 858 /** 859 * The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains. 860 */ 861 autoSubDomainIAMRole?: AutoSubDomainIAMRole; 862 } 863 export interface CreateDomainAssociationResult { 864 /** 865 * Describes the structure of a domain association, which associates a custom domain with an Amplify app. 866 */ 867 domainAssociation: DomainAssociation; 868 } 869 export type CreateTime = Date; 870 export interface CreateWebhookRequest { 871 /** 872 * The unique ID for an Amplify app. 873 */ 874 appId: AppId; 875 /** 876 * The name for a branch that is part of an Amplify app. 877 */ 878 branchName: BranchName; 879 /** 880 * The description for a webhook. 881 */ 882 description?: Description; 883 } 884 export interface CreateWebhookResult { 885 /** 886 * Describes a webhook that connects repository events to an Amplify app. 887 */ 888 webhook: Webhook; 889 } 890 export type CustomDomain = string; 891 export type CustomDomains = CustomDomain[]; 892 export type CustomHeaders = string; 893 export interface CustomRule { 894 /** 895 * The source pattern for a URL rewrite or redirect rule. 896 */ 897 source: Source; 898 /** 899 * The target pattern for a URL rewrite or redirect rule. 900 */ 901 target: Target; 902 /** 903 * The status code for a URL rewrite or redirect rule. 200 Represents a 200 rewrite rule. 301 Represents a 301 (moved pemanently) redirect rule. This and all future requests should be directed to the target URL. 302 Represents a 302 temporary redirect rule. 404 Represents a 404 redirect rule. 404-200 Represents a 404 rewrite rule. 904 */ 905 status?: Status; 906 /** 907 * The condition for a URL rewrite or redirect rule, such as a country code. 908 */ 909 condition?: Condition; 910 } 911 export type CustomRules = CustomRule[]; 912 export type DNSRecord = string; 913 export type DefaultDomain = string; 914 export interface DeleteAppRequest { 915 /** 916 * The unique ID for an Amplify app. 917 */ 918 appId: AppId; 919 } 920 export interface DeleteAppResult { 921 app: App; 922 } 923 export interface DeleteBackendEnvironmentRequest { 924 /** 925 * The unique ID of an Amplify app. 926 */ 927 appId: AppId; 928 /** 929 * The name of a backend environment of an Amplify app. 930 */ 931 environmentName: EnvironmentName; 932 } 933 export interface DeleteBackendEnvironmentResult { 934 /** 935 * Describes the backend environment for an Amplify app. 936 */ 937 backendEnvironment: BackendEnvironment; 938 } 939 export interface DeleteBranchRequest { 940 /** 941 * The unique ID for an Amplify app. 942 */ 943 appId: AppId; 944 /** 945 * The name for the branch. 946 */ 947 branchName: BranchName; 948 } 949 export interface DeleteBranchResult { 950 /** 951 * The branch for an Amplify app, which maps to a third-party repository branch. 952 */ 953 branch: Branch; 954 } 955 export interface DeleteDomainAssociationRequest { 956 /** 957 * The unique id for an Amplify app. 958 */ 959 appId: AppId; 960 /** 961 * The name of the domain. 962 */ 963 domainName: DomainName; 964 } 965 export interface DeleteDomainAssociationResult { 966 domainAssociation: DomainAssociation; 967 } 968 export interface DeleteJobRequest { 969 /** 970 * The unique ID for an Amplify app. 971 */ 972 appId: AppId; 973 /** 974 * The name for the branch, for the job. 975 */ 976 branchName: BranchName; 977 /** 978 * The unique ID for the job. 979 */ 980 jobId: JobId; 981 } 982 export interface DeleteJobResult { 983 jobSummary: JobSummary; 984 } 985 export interface DeleteWebhookRequest { 986 /** 987 * The unique ID for a webhook. 988 */ 989 webhookId: WebhookId; 990 } 991 export interface DeleteWebhookResult { 992 /** 993 * Describes a webhook that connects repository events to an Amplify app. 994 */ 995 webhook: Webhook; 996 } 997 export type DeploymentArtifacts = string; 998 export type Description = string; 999 export type DisplayName = string; 1000 export interface DomainAssociation { 1001 /** 1002 * The Amazon Resource Name (ARN) for the domain association. 1003 */ 1004 domainAssociationArn: DomainAssociationArn; 1005 /** 1006 * The name of the domain. 1007 */ 1008 domainName: DomainName; 1009 /** 1010 * Enables the automated creation of subdomains for branches. 1011 */ 1012 enableAutoSubDomain: EnableAutoSubDomain; 1013 /** 1014 * Sets branch patterns for automatic subdomain creation. 1015 */ 1016 autoSubDomainCreationPatterns?: AutoSubDomainCreationPatterns; 1017 /** 1018 * The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains. 1019 */ 1020 autoSubDomainIAMRole?: AutoSubDomainIAMRole; 1021 /** 1022 * The current status of the domain association. 1023 */ 1024 domainStatus: DomainStatus; 1025 /** 1026 * The reason for the current status of the domain association. 1027 */ 1028 statusReason: StatusReason; 1029 /** 1030 * The DNS record for certificate verification. 1031 */ 1032 certificateVerificationDNSRecord?: CertificateVerificationDNSRecord; 1033 /** 1034 * The subdomains for the domain association. 1035 */ 1036 subDomains: SubDomains; 1037 } 1038 export type DomainAssociationArn = string; 1039 export type DomainAssociations = DomainAssociation[]; 1040 export type DomainName = string; 1041 export type DomainPrefix = string; 1042 export type DomainStatus = "PENDING_VERIFICATION"|"IN_PROGRESS"|"AVAILABLE"|"PENDING_DEPLOYMENT"|"FAILED"|"CREATING"|"REQUESTING_CERTIFICATE"|"UPDATING"|string; 1043 export type EnableAutoBranchCreation = boolean; 1044 export type EnableAutoBuild = boolean; 1045 export type EnableAutoSubDomain = boolean; 1046 export type EnableBasicAuth = boolean; 1047 export type EnableBranchAutoBuild = boolean; 1048 export type EnableBranchAutoDeletion = boolean; 1049 export type EnableNotification = boolean; 1050 export type EnablePerformanceMode = boolean; 1051 export type EnablePullRequestPreview = boolean; 1052 export type EndTime = Date; 1053 export type EnvKey = string; 1054 export type EnvValue = string; 1055 export type EnvironmentName = string; 1056 export type EnvironmentVariables = {[key: string]: EnvValue}; 1057 export type FileMap = {[key: string]: MD5Hash}; 1058 export type FileName = string; 1059 export type FileUploadUrls = {[key: string]: UploadUrl}; 1060 export type Framework = string; 1061 export interface GenerateAccessLogsRequest { 1062 /** 1063 * The time at which the logs should start. The time range specified is inclusive of the start time. 1064 */ 1065 startTime?: StartTime; 1066 /** 1067 * The time at which the logs should end. The time range specified is inclusive of the end time. 1068 */ 1069 endTime?: EndTime; 1070 /** 1071 * The name of the domain. 1072 */ 1073 domainName: DomainName; 1074 /** 1075 * The unique ID for an Amplify app. 1076 */ 1077 appId: AppId; 1078 } 1079 export interface GenerateAccessLogsResult { 1080 /** 1081 * The pre-signed URL for the requested access logs. 1082 */ 1083 logUrl?: LogUrl; 1084 } 1085 export interface GetAppRequest { 1086 /** 1087 * The unique ID for an Amplify app. 1088 */ 1089 appId: AppId; 1090 } 1091 export interface GetAppResult { 1092 app: App; 1093 } 1094 export interface GetArtifactUrlRequest { 1095 /** 1096 * The unique ID for an artifact. 1097 */ 1098 artifactId: ArtifactId; 1099 } 1100 export interface GetArtifactUrlResult { 1101 /** 1102 * The unique ID for an artifact. 1103 */ 1104 artifactId: ArtifactId; 1105 /** 1106 * The presigned URL for the artifact. 1107 */ 1108 artifactUrl: ArtifactUrl; 1109 } 1110 export interface GetBackendEnvironmentRequest { 1111 /** 1112 * The unique id for an Amplify app. 1113 */ 1114 appId: AppId; 1115 /** 1116 * The name for the backend environment. 1117 */ 1118 environmentName: EnvironmentName; 1119 } 1120 export interface GetBackendEnvironmentResult { 1121 /** 1122 * Describes the backend environment for an Amplify app. 1123 */ 1124 backendEnvironment: BackendEnvironment; 1125 } 1126 export interface GetBranchRequest { 1127 /** 1128 * The unique ID for an Amplify app. 1129 */ 1130 appId: AppId; 1131 /** 1132 * The name for the branch. 1133 */ 1134 branchName: BranchName; 1135 } 1136 export interface GetBranchResult { 1137 branch: Branch; 1138 } 1139 export interface GetDomainAssociationRequest { 1140 /** 1141 * The unique id for an Amplify app. 1142 */ 1143 appId: AppId; 1144 /** 1145 * The name of the domain. 1146 */ 1147 domainName: DomainName; 1148 } 1149 export interface GetDomainAssociationResult { 1150 /** 1151 * Describes the structure of a domain association, which associates a custom domain with an Amplify app. 1152 */ 1153 domainAssociation: DomainAssociation; 1154 } 1155 export interface GetJobRequest { 1156 /** 1157 * The unique ID for an Amplify app. 1158 */ 1159 appId: AppId; 1160 /** 1161 * The branch name for the job. 1162 */ 1163 branchName: BranchName; 1164 /** 1165 * The unique ID for the job. 1166 */ 1167 jobId: JobId; 1168 } 1169 export interface GetJobResult { 1170 job: Job; 1171 } 1172 export interface GetWebhookRequest { 1173 /** 1174 * The unique ID for a webhook. 1175 */ 1176 webhookId: WebhookId; 1177 } 1178 export interface GetWebhookResult { 1179 /** 1180 * Describes the structure of a webhook. 1181 */ 1182 webhook: Webhook; 1183 } 1184 export interface Job { 1185 /** 1186 * Describes the summary for an execution job for an Amplify app. 1187 */ 1188 summary: JobSummary; 1189 /** 1190 * The execution steps for an execution job, for an Amplify app. 1191 */ 1192 steps: Steps; 1193 } 1194 export type JobArn = string; 1195 export type JobId = string; 1196 export type JobReason = string; 1197 export type JobStatus = "PENDING"|"PROVISIONING"|"RUNNING"|"FAILED"|"SUCCEED"|"CANCELLING"|"CANCELLED"|string; 1198 export type JobSummaries = JobSummary[]; 1199 export interface JobSummary { 1200 /** 1201 * The Amazon Resource Name (ARN) for the job. 1202 */ 1203 jobArn: JobArn; 1204 /** 1205 * The unique ID for the job. 1206 */ 1207 jobId: JobId; 1208 /** 1209 * The commit ID from a third-party repository provider for the job. 1210 */ 1211 commitId: CommitId; 1212 /** 1213 * The commit message from a third-party repository provider for the job. 1214 */ 1215 commitMessage: CommitMessage; 1216 /** 1217 * The commit date and time for the job. 1218 */ 1219 commitTime: CommitTime; 1220 /** 1221 * The start date and time for the job. 1222 */ 1223 startTime: StartTime; 1224 /** 1225 * The current status for the job. 1226 */ 1227 status: JobStatus; 1228 /** 1229 * The end date and time for the job. 1230 */ 1231 endTime?: EndTime; 1232 /** 1233 * The type for the job. If the value is RELEASE, the job was manually released from its source by using the StartJob API. If the value is RETRY, the job was manually retried using the StartJob API. If the value is WEB_HOOK, the job was automatically triggered by webhooks. 1234 */ 1235 jobType: JobType; 1236 } 1237 export type JobType = "RELEASE"|"RETRY"|"MANUAL"|"WEB_HOOK"|string; 1238 export type LastDeployTime = Date; 1239 export interface ListAppsRequest { 1240 /** 1241 * A pagination token. If non-null, the pagination token is returned in a result. Pass its value in another request to retrieve more entries. 1242 */ 1243 nextToken?: NextToken; 1244 /** 1245 * The maximum number of records to list in a single response. 1246 */ 1247 maxResults?: MaxResults; 1248 } 1249 export interface ListAppsResult { 1250 /** 1251 * A list of Amplify apps. 1252 */ 1253 apps: Apps; 1254 /** 1255 * A pagination token. Set to null to start listing apps from start. If non-null, the pagination token is returned in a result. Pass its value in here to list more projects. 1256 */ 1257 nextToken?: NextToken; 1258 } 1259 export interface ListArtifactsRequest { 1260 /** 1261 * The unique ID for an Amplify app. 1262 */ 1263 appId: AppId; 1264 /** 1265 * The name of a branch that is part of an Amplify app. 1266 */ 1267 branchName: BranchName; 1268 /** 1269 * The unique ID for a job. 1270 */ 1271 jobId: JobId; 1272 /** 1273 * A pagination token. Set to null to start listing artifacts from start. If a non-null pagination token is returned in a result, pass its value in here to list more artifacts. 1274 */ 1275 nextToken?: NextToken; 1276 /** 1277 * The maximum number of records to list in a single response. 1278 */ 1279 maxResults?: MaxResults; 1280 } 1281 export interface ListArtifactsResult { 1282 /** 1283 * A list of artifacts. 1284 */ 1285 artifacts: Artifacts; 1286 /** 1287 * A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries. 1288 */ 1289 nextToken?: NextToken; 1290 } 1291 export interface ListBackendEnvironmentsRequest { 1292 /** 1293 * The unique ID for an Amplify app. 1294 */ 1295 appId: AppId; 1296 /** 1297 * The name of the backend environment 1298 */ 1299 environmentName?: EnvironmentName; 1300 /** 1301 * A pagination token. Set to null to start listing backend environments from the start. If a non-null pagination token is returned in a result, pass its value in here to list more backend environments. 1302 */ 1303 nextToken?: NextToken; 1304 /** 1305 * The maximum number of records to list in a single response. 1306 */ 1307 maxResults?: MaxResults; 1308 } 1309 export interface ListBackendEnvironmentsResult { 1310 /** 1311 * The list of backend environments for an Amplify app. 1312 */ 1313 backendEnvironments: BackendEnvironments; 1314 /** 1315 * A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries. 1316 */ 1317 nextToken?: NextToken; 1318 } 1319 export interface ListBranchesRequest { 1320 /** 1321 * The unique ID for an Amplify app. 1322 */ 1323 appId: AppId; 1324 /** 1325 * A pagination token. Set to null to start listing branches from the start. If a non-null pagination token is returned in a result, pass its value in here to list more branches. 1326 */ 1327 nextToken?: NextToken; 1328 /** 1329 * The maximum number of records to list in a single response. 1330 */ 1331 maxResults?: MaxResults; 1332 } 1333 export interface ListBranchesResult { 1334 /** 1335 * A list of branches for an Amplify app. 1336 */ 1337 branches: Branches; 1338 /** 1339 * A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries. 1340 */ 1341 nextToken?: NextToken; 1342 } 1343 export interface ListDomainAssociationsRequest { 1344 /** 1345 * The unique ID for an Amplify app. 1346 */ 1347 appId: AppId; 1348 /** 1349 * A pagination token. Set to null to start listing apps from the start. If non-null, a pagination token is returned in a result. Pass its value in here to list more projects. 1350 */ 1351 nextToken?: NextToken; 1352 /** 1353 * The maximum number of records to list in a single response. 1354 */ 1355 maxResults?: MaxResults; 1356 } 1357 export interface ListDomainAssociationsResult { 1358 /** 1359 * A list of domain associations. 1360 */ 1361 domainAssociations: DomainAssociations; 1362 /** 1363 * A pagination token. If non-null, a pagination token is returned in a result. Pass its value in another request to retrieve more entries. 1364 */ 1365 nextToken?: NextToken; 1366 } 1367 export interface ListJobsRequest { 1368 /** 1369 * The unique ID for an Amplify app. 1370 */ 1371 appId: AppId; 1372 /** 1373 * The name for a branch. 1374 */ 1375 branchName: BranchName; 1376 /** 1377 * A pagination token. Set to null to start listing steps from the start. If a non-null pagination token is returned in a result, pass its value in here to list more steps. 1378 */ 1379 nextToken?: NextToken; 1380 /** 1381 * The maximum number of records to list in a single response. 1382 */ 1383 maxResults?: MaxResults; 1384 } 1385 export interface ListJobsResult { 1386 /** 1387 * The result structure for the list job result request. 1388 */ 1389 jobSummaries: JobSummaries; 1390 /** 1391 * A pagination token. If non-null the pagination token is returned in a result. Pass its value in another request to retrieve more entries. 1392 */ 1393 nextToken?: NextToken; 1394 } 1395 export interface ListTagsForResourceRequest { 1396 /** 1397 * The Amazon Resource Name (ARN) to use to list tags. 1398 */ 1399 resourceArn: ResourceArn; 1400 } 1401 export interface ListTagsForResourceResponse { 1402 /** 1403 * A list of tags for the specified The Amazon Resource Name (ARN). 1404 */ 1405 tags?: TagMap; 1406 } 1407 export interface ListWebhooksRequest { 1408 /** 1409 * The unique ID for an Amplify app. 1410 */ 1411 appId: AppId; 1412 /** 1413 * A pagination token. Set to null to start listing webhooks from the start. If non-null,the pagination token is returned in a result. Pass its value in here to list more webhooks. 1414 */ 1415 nextToken?: NextToken; 1416 /** 1417 * The maximum number of records to list in a single response. 1418 */ 1419 maxResults?: MaxResults; 1420 } 1421 export interface ListWebhooksResult { 1422 /** 1423 * A list of webhooks. 1424 */ 1425 webhooks: Webhooks; 1426 /** 1427 * A pagination token. If non-null, the pagination token is returned in a result. Pass its value in another request to retrieve more entries. 1428 */ 1429 nextToken?: NextToken; 1430 } 1431 export type LogUrl = string; 1432 export type MD5Hash = string; 1433 export type MaxResults = number; 1434 export type Name = string; 1435 export type NextToken = string; 1436 export type OauthToken = string; 1437 export type Platform = "WEB"|string; 1438 export interface ProductionBranch { 1439 /** 1440 * The last deploy time of the production branch. 1441 */ 1442 lastDeployTime?: LastDeployTime; 1443 /** 1444 * The status of the production branch. 1445 */ 1446 status?: Status; 1447 /** 1448 * The thumbnail URL for the production branch. 1449 */ 1450 thumbnailUrl?: ThumbnailUrl; 1451 /** 1452 * The branch name for the production branch. 1453 */ 1454 branchName?: BranchName; 1455 } 1456 export type PullRequestEnvironmentName = string; 1457 export type Repository = string; 1458 export type ResourceArn = string; 1459 export type Screenshots = {[key: string]: ThumbnailUrl}; 1460 export type ServiceRoleArn = string; 1461 export type Source = string; 1462 export type SourceUrl = string; 1463 export type StackName = string; 1464 export type Stage = "PRODUCTION"|"BETA"|"DEVELOPMENT"|"EXPERIMENTAL"|"PULL_REQUEST"|string; 1465 export interface StartDeploymentRequest { 1466 /** 1467 * The unique ID for an Amplify app. 1468 */ 1469 appId: AppId; 1470 /** 1471 * The name for the branch, for the job. 1472 */ 1473 branchName: BranchName; 1474 /** 1475 * The job ID for this deployment, generated by the create deployment request. 1476 */ 1477 jobId?: JobId; 1478 /** 1479 * The source URL for this deployment, used when calling start deployment without create deployment. The source URL can be any HTTP GET URL that is publicly accessible and downloads a single .zip file. 1480 */ 1481 sourceUrl?: SourceUrl; 1482 } 1483 export interface StartDeploymentResult { 1484 /** 1485 * The summary for the job. 1486 */ 1487 jobSummary: JobSummary; 1488 } 1489 export interface StartJobRequest { 1490 /** 1491 * The unique ID for an Amplify app. 1492 */ 1493 appId: AppId; 1494 /** 1495 * The branch name for the job. 1496 */ 1497 branchName: BranchName; 1498 /** 1499 * The unique ID for an existing job. This is required if the value of jobType is RETRY. 1500 */ 1501 jobId?: JobId; 1502 /** 1503 * Describes the type for the job. The job type RELEASE starts a new job with the latest change from the specified branch. This value is available only for apps that are connected to a repository. The job type RETRY retries an existing job. If the job type value is RETRY, the jobId is also required. 1504 */ 1505 jobType: JobType; 1506 /** 1507 * A descriptive reason for starting this job. 1508 */ 1509 jobReason?: JobReason; 1510 /** 1511 * The commit ID from a third-party repository provider for the job. 1512 */ 1513 commitId?: CommitId; 1514 /** 1515 * The commit message from a third-party repository provider for the job. 1516 */ 1517 commitMessage?: CommitMessage; 1518 /** 1519 * The commit date and time for the job. 1520 */ 1521 commitTime?: CommitTime; 1522 } 1523 export interface StartJobResult { 1524 /** 1525 * The summary for the job. 1526 */ 1527 jobSummary: JobSummary; 1528 } 1529 export type StartTime = Date; 1530 export type Status = string; 1531 export type StatusReason = string; 1532 export interface Step { 1533 /** 1534 * The name of the execution step. 1535 */ 1536 stepName: StepName; 1537 /** 1538 * The start date and time of the execution step. 1539 */ 1540 startTime: StartTime; 1541 /** 1542 * The status of the execution step. 1543 */ 1544 status: JobStatus; 1545 /** 1546 * The end date and time of the execution step. 1547 */ 1548 endTime: EndTime; 1549 /** 1550 * The URL to the logs for the execution step. 1551 */ 1552 logUrl?: LogUrl; 1553 /** 1554 * The URL to the artifact for the execution step. 1555 */ 1556 artifactsUrl?: ArtifactsUrl; 1557 /** 1558 * The URL to the test artifact for the execution step. 1559 */ 1560 testArtifactsUrl?: TestArtifactsUrl; 1561 /** 1562 * The URL to the test configuration for the execution step. 1563 */ 1564 testConfigUrl?: TestConfigUrl; 1565 /** 1566 * The list of screenshot URLs for the execution step, if relevant. 1567 */ 1568 screenshots?: Screenshots; 1569 /** 1570 * The reason for the current step status. 1571 */ 1572 statusReason?: StatusReason; 1573 /** 1574 * The context for the current step. Includes a build image if the step is build. 1575 */ 1576 context?: Context; 1577 } 1578 export type StepName = string; 1579 export type Steps = Step[]; 1580 export interface StopJobRequest { 1581 /** 1582 * The unique ID for an Amplify app. 1583 */ 1584 appId: AppId; 1585 /** 1586 * The name for the branch, for the job. 1587 */ 1588 branchName: BranchName; 1589 /** 1590 * The unique id for the job. 1591 */ 1592 jobId: JobId; 1593 } 1594 export interface StopJobResult { 1595 /** 1596 * The summary for the job. 1597 */ 1598 jobSummary: JobSummary; 1599 } 1600 export interface SubDomain { 1601 /** 1602 * Describes the settings for the subdomain. 1603 */ 1604 subDomainSetting: SubDomainSetting; 1605 /** 1606 * The verified status of the subdomain 1607 */ 1608 verified: Verified; 1609 /** 1610 * The DNS record for the subdomain. 1611 */ 1612 dnsRecord: DNSRecord; 1613 } 1614 export interface SubDomainSetting { 1615 /** 1616 * The prefix setting for the subdomain. 1617 */ 1618 prefix: DomainPrefix; 1619 /** 1620 * The branch name setting for the subdomain. 1621 */ 1622 branchName: BranchName; 1623 } 1624 export type SubDomainSettings = SubDomainSetting[]; 1625 export type SubDomains = SubDomain[]; 1626 export type TTL = string; 1627 export type TagKey = string; 1628 export type TagKeyList = TagKey[]; 1629 export type TagMap = {[key: string]: TagValue}; 1630 export interface TagResourceRequest { 1631 /** 1632 * The Amazon Resource Name (ARN) to use to tag a resource. 1633 */ 1634 resourceArn: ResourceArn; 1635 /** 1636 * The tags used to tag the resource. 1637 */ 1638 tags: TagMap; 1639 } 1640 export interface TagResourceResponse { 1641 } 1642 export type TagValue = string; 1643 export type Target = string; 1644 export type TestArtifactsUrl = string; 1645 export type TestConfigUrl = string; 1646 export type ThumbnailName = string; 1647 export type ThumbnailUrl = string; 1648 export type TotalNumberOfJobs = string; 1649 export interface UntagResourceRequest { 1650 /** 1651 * The Amazon Resource Name (ARN) to use to untag a resource. 1652 */ 1653 resourceArn: ResourceArn; 1654 /** 1655 * The tag keys to use to untag a resource. 1656 */ 1657 tagKeys: TagKeyList; 1658 } 1659 export interface UntagResourceResponse { 1660 } 1661 export interface UpdateAppRequest { 1662 /** 1663 * The unique ID for an Amplify app. 1664 */ 1665 appId: AppId; 1666 /** 1667 * The name for an Amplify app. 1668 */ 1669 name?: Name; 1670 /** 1671 * The description for an Amplify app. 1672 */ 1673 description?: Description; 1674 /** 1675 * The platform for an Amplify app. 1676 */ 1677 platform?: Platform; 1678 /** 1679 * The AWS Identity and Access Management (IAM) service role for an Amplify app. 1680 */ 1681 iamServiceRoleArn?: ServiceRoleArn; 1682 /** 1683 * The environment variables for an Amplify app. 1684 */ 1685 environmentVariables?: EnvironmentVariables; 1686 /** 1687 * Enables branch auto-building for an Amplify app. 1688 */ 1689 enableBranchAutoBuild?: EnableAutoBuild; 1690 /** 1691 * Automatically disconnects a branch in the Amplify Console when you delete a branch from your Git repository. 1692 */ 1693 enableBranchAutoDeletion?: EnableBranchAutoDeletion; 1694 /** 1695 * Enables basic authorization for an Amplify app. 1696 */ 1697 enableBasicAuth?: EnableBasicAuth; 1698 /** 1699 * The basic authorization credentials for an Amplify app. 1700 */ 1701 basicAuthCredentials?: BasicAuthCredentials; 1702 /** 1703 * The custom redirect and rewrite rules for an Amplify app. 1704 */ 1705 customRules?: CustomRules; 1706 /** 1707 * The build specification (build spec) for an Amplify app. 1708 */ 1709 buildSpec?: BuildSpec; 1710 /** 1711 * The custom HTTP headers for an Amplify app. 1712 */ 1713 customHeaders?: CustomHeaders; 1714 /** 1715 * Enables automated branch creation for an Amplify app. 1716 */ 1717 enableAutoBranchCreation?: EnableAutoBranchCreation; 1718 /** 1719 * Describes the automated branch creation glob patterns for an Amplify app. 1720 */ 1721 autoBranchCreationPatterns?: AutoBranchCreationPatterns; 1722 /** 1723 * The automated branch creation configuration for an Amplify app. 1724 */ 1725 autoBranchCreationConfig?: AutoBranchCreationConfig; 1726 /** 1727 * The name of the repository for an Amplify app 1728 */ 1729 repository?: Repository; 1730 /** 1731 * The OAuth token for a third-party source control system for an Amplify app. The token is used to create a webhook and a read-only deploy key. The OAuth token is not stored. 1732 */ 1733 oauthToken?: OauthToken; 1734 /** 1735 * The personal access token for a third-party source control system for an Amplify app. The token is used to create webhook and a read-only deploy key. The token is not stored. 1736 */ 1737 accessToken?: AccessToken; 1738 } 1739 export interface UpdateAppResult { 1740 /** 1741 * Represents the updated Amplify app. 1742 */ 1743 app: App; 1744 } 1745 export interface UpdateBranchRequest { 1746 /** 1747 * The unique ID for an Amplify app. 1748 */ 1749 appId: AppId; 1750 /** 1751 * The name for the branch. 1752 */ 1753 branchName: BranchName; 1754 /** 1755 * The description for the branch. 1756 */ 1757 description?: Description; 1758 /** 1759 * The framework for the branch. 1760 */ 1761 framework?: Framework; 1762 /** 1763 * Describes the current stage for the branch. 1764 */ 1765 stage?: Stage; 1766 /** 1767 * Enables notifications for the branch. 1768 */ 1769 enableNotification?: EnableNotification; 1770 /** 1771 * Enables auto building for the branch. 1772 */ 1773 enableAutoBuild?: EnableAutoBuild; 1774 /** 1775 * The environment variables for the branch. 1776 */ 1777 environmentVariables?: EnvironmentVariables; 1778 /** 1779 * The basic authorization credentials for the branch. 1780 */ 1781 basicAuthCredentials?: BasicAuthCredentials; 1782 /** 1783 * Enables basic authorization for the branch. 1784 */ 1785 enableBasicAuth?: EnableBasicAuth; 1786 /** 1787 * Enables performance mode for the branch. Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out. 1788 */ 1789 enablePerformanceMode?: EnablePerformanceMode; 1790 /** 1791 * The build specification (build spec) for the branch. 1792 */ 1793 buildSpec?: BuildSpec; 1794 /** 1795 * The content Time to Live (TTL) for the website in seconds. 1796 */ 1797 ttl?: TTL; 1798 /** 1799 * The display name for a branch. This is used as the default domain prefix. 1800 */ 1801 displayName?: DisplayName; 1802 /** 1803 * Enables pull request previews for this branch. 1804 */ 1805 enablePullRequestPreview?: EnablePullRequestPreview; 1806 /** 1807 * The Amplify environment name for the pull request. 1808 */ 1809 pullRequestEnvironmentName?: PullRequestEnvironmentName; 1810 /** 1811 * The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app. 1812 */ 1813 backendEnvironmentArn?: BackendEnvironmentArn; 1814 } 1815 export interface UpdateBranchResult { 1816 /** 1817 * The branch for an Amplify app, which maps to a third-party repository branch. 1818 */ 1819 branch: Branch; 1820 } 1821 export interface UpdateDomainAssociationRequest { 1822 /** 1823 * The unique ID for an Amplify app. 1824 */ 1825 appId: AppId; 1826 /** 1827 * The name of the domain. 1828 */ 1829 domainName: DomainName; 1830 /** 1831 * Enables the automated creation of subdomains for branches. 1832 */ 1833 enableAutoSubDomain?: EnableAutoSubDomain; 1834 /** 1835 * Describes the settings for the subdomain. 1836 */ 1837 subDomainSettings: SubDomainSettings; 1838 /** 1839 * Sets the branch patterns for automatic subdomain creation. 1840 */ 1841 autoSubDomainCreationPatterns?: AutoSubDomainCreationPatterns; 1842 /** 1843 * The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains. 1844 */ 1845 autoSubDomainIAMRole?: AutoSubDomainIAMRole; 1846 } 1847 export interface UpdateDomainAssociationResult { 1848 /** 1849 * Describes a domain association, which associates a custom domain with an Amplify app. 1850 */ 1851 domainAssociation: DomainAssociation; 1852 } 1853 export type UpdateTime = Date; 1854 export interface UpdateWebhookRequest { 1855 /** 1856 * The unique ID for a webhook. 1857 */ 1858 webhookId: WebhookId; 1859 /** 1860 * The name for a branch that is part of an Amplify app. 1861 */ 1862 branchName?: BranchName; 1863 /** 1864 * The description for a webhook. 1865 */ 1866 description?: Description; 1867 } 1868 export interface UpdateWebhookResult { 1869 /** 1870 * Describes a webhook that connects repository events to an Amplify app. 1871 */ 1872 webhook: Webhook; 1873 } 1874 export type UploadUrl = string; 1875 export type Verified = boolean; 1876 export interface Webhook { 1877 /** 1878 * The Amazon Resource Name (ARN) for the webhook. 1879 */ 1880 webhookArn: WebhookArn; 1881 /** 1882 * The ID of the webhook. 1883 */ 1884 webhookId: WebhookId; 1885 /** 1886 * The URL of the webhook. 1887 */ 1888 webhookUrl: WebhookUrl; 1889 /** 1890 * The name for a branch that is part of an Amplify app. 1891 */ 1892 branchName: BranchName; 1893 /** 1894 * The description for a webhook. 1895 */ 1896 description: Description; 1897 /** 1898 * The create date and time for a webhook. 1899 */ 1900 createTime: CreateTime; 1901 /** 1902 * Updates the date and time for a webhook. 1903 */ 1904 updateTime: UpdateTime; 1905 } 1906 export type WebhookArn = string; 1907 export type WebhookId = string; 1908 export type WebhookUrl = string; 1909 export type Webhooks = Webhook[]; 1910 /** 1911 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. 1912 */ 1913 export type apiVersion = "2017-07-25"|"latest"|string; 1914 export interface ClientApiVersions { 1915 /** 1916 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. 1917 */ 1918 apiVersion?: apiVersion; 1919 } 1920 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; 1921 /** 1922 * Contains interfaces for use with the Amplify client. 1923 */ 1924 export import Types = Amplify; 1925 } 1926 export = Amplify;