{ "version":"2.0", "metadata":{ "apiVersion":"2017-07-25", "endpointPrefix":"amplify", "jsonVersion":"1.1", "protocol":"rest-json", "serviceAbbreviation":"Amplify", "serviceFullName":"AWS Amplify", "serviceId":"Amplify", "signatureVersion":"v4", "signingName":"amplify", "uid":"amplify-2017-07-25" }, "operations":{ "CreateApp":{ "name":"CreateApp", "http":{ "method":"POST", "requestUri":"/apps" }, "input":{"shape":"CreateAppRequest"}, "output":{"shape":"CreateAppResult"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"UnauthorizedException"}, {"shape":"InternalFailureException"}, {"shape":"LimitExceededException"}, {"shape":"DependentServiceFailureException"} ], "documentation":"
Creates a new Amplify app.
" }, "CreateBackendEnvironment":{ "name":"CreateBackendEnvironment", "http":{ "method":"POST", "requestUri":"/apps/{appId}/backendenvironments" }, "input":{"shape":"CreateBackendEnvironmentRequest"}, "output":{"shape":"CreateBackendEnvironmentResult"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"InternalFailureException"}, {"shape":"LimitExceededException"} ], "documentation":"Creates a new backend environment for an Amplify app.
" }, "CreateBranch":{ "name":"CreateBranch", "http":{ "method":"POST", "requestUri":"/apps/{appId}/branches" }, "input":{"shape":"CreateBranchRequest"}, "output":{"shape":"CreateBranchResult"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"InternalFailureException"}, {"shape":"LimitExceededException"}, {"shape":"DependentServiceFailureException"} ], "documentation":"Creates a new branch for an Amplify app.
" }, "CreateDeployment":{ "name":"CreateDeployment", "http":{ "method":"POST", "requestUri":"/apps/{appId}/branches/{branchName}/deployments" }, "input":{"shape":"CreateDeploymentRequest"}, "output":{"shape":"CreateDeploymentResult"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"UnauthorizedException"}, {"shape":"InternalFailureException"}, {"shape":"LimitExceededException"} ], "documentation":"Creates a deployment for a manually deployed Amplify app. Manually deployed apps are not connected to a repository.
" }, "CreateDomainAssociation":{ "name":"CreateDomainAssociation", "http":{ "method":"POST", "requestUri":"/apps/{appId}/domains" }, "input":{"shape":"CreateDomainAssociationRequest"}, "output":{"shape":"CreateDomainAssociationResult"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"InternalFailureException"}, {"shape":"LimitExceededException"}, {"shape":"DependentServiceFailureException"} ], "documentation":"Creates a new domain association for an Amplify app. This action associates a custom domain with the Amplify app
" }, "CreateWebhook":{ "name":"CreateWebhook", "http":{ "method":"POST", "requestUri":"/apps/{appId}/webhooks" }, "input":{"shape":"CreateWebhookRequest"}, "output":{"shape":"CreateWebhookResult"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"InternalFailureException"}, {"shape":"LimitExceededException"}, {"shape":"DependentServiceFailureException"} ], "documentation":"Creates a new webhook on an Amplify app.
" }, "DeleteApp":{ "name":"DeleteApp", "http":{ "method":"DELETE", "requestUri":"/apps/{appId}" }, "input":{"shape":"DeleteAppRequest"}, "output":{"shape":"DeleteAppResult"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"NotFoundException"}, {"shape":"UnauthorizedException"}, {"shape":"InternalFailureException"}, {"shape":"DependentServiceFailureException"} ], "documentation":"Deletes an existing Amplify app specified by an app ID.
" }, "DeleteBackendEnvironment":{ "name":"DeleteBackendEnvironment", "http":{ "method":"DELETE", "requestUri":"/apps/{appId}/backendenvironments/{environmentName}" }, "input":{"shape":"DeleteBackendEnvironmentRequest"}, "output":{"shape":"DeleteBackendEnvironmentResult"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"InternalFailureException"}, {"shape":"DependentServiceFailureException"} ], "documentation":"Deletes a backend environment for an Amplify app.
" }, "DeleteBranch":{ "name":"DeleteBranch", "http":{ "method":"DELETE", "requestUri":"/apps/{appId}/branches/{branchName}" }, "input":{"shape":"DeleteBranchRequest"}, "output":{"shape":"DeleteBranchResult"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"InternalFailureException"}, {"shape":"DependentServiceFailureException"} ], "documentation":"Deletes a branch for an Amplify app.
" }, "DeleteDomainAssociation":{ "name":"DeleteDomainAssociation", "http":{ "method":"DELETE", "requestUri":"/apps/{appId}/domains/{domainName}" }, "input":{"shape":"DeleteDomainAssociationRequest"}, "output":{"shape":"DeleteDomainAssociationResult"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"InternalFailureException"}, {"shape":"DependentServiceFailureException"} ], "documentation":"Deletes a domain association for an Amplify app.
" }, "DeleteJob":{ "name":"DeleteJob", "http":{ "method":"DELETE", "requestUri":"/apps/{appId}/branches/{branchName}/jobs/{jobId}" }, "input":{"shape":"DeleteJobRequest"}, "output":{"shape":"DeleteJobResult"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"UnauthorizedException"}, {"shape":"InternalFailureException"}, {"shape":"NotFoundException"}, {"shape":"LimitExceededException"} ], "documentation":"Deletes a job for a branch of an Amplify app.
" }, "DeleteWebhook":{ "name":"DeleteWebhook", "http":{ "method":"DELETE", "requestUri":"/webhooks/{webhookId}" }, "input":{"shape":"DeleteWebhookRequest"}, "output":{"shape":"DeleteWebhookResult"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"UnauthorizedException"}, {"shape":"InternalFailureException"}, {"shape":"NotFoundException"}, {"shape":"LimitExceededException"} ], "documentation":"Deletes a webhook.
" }, "GenerateAccessLogs":{ "name":"GenerateAccessLogs", "http":{ "method":"POST", "requestUri":"/apps/{appId}/accesslogs" }, "input":{"shape":"GenerateAccessLogsRequest"}, "output":{"shape":"GenerateAccessLogsResult"}, "errors":[ {"shape":"NotFoundException"}, {"shape":"BadRequestException"}, {"shape":"UnauthorizedException"}, {"shape":"InternalFailureException"} ], "documentation":"Returns the website access logs for a specific time range using a presigned URL.
" }, "GetApp":{ "name":"GetApp", "http":{ "method":"GET", "requestUri":"/apps/{appId}" }, "input":{"shape":"GetAppRequest"}, "output":{"shape":"GetAppResult"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"NotFoundException"}, {"shape":"UnauthorizedException"}, {"shape":"InternalFailureException"} ], "documentation":"Returns an existing Amplify app by appID.
" }, "GetArtifactUrl":{ "name":"GetArtifactUrl", "http":{ "method":"GET", "requestUri":"/artifacts/{artifactId}" }, "input":{"shape":"GetArtifactUrlRequest"}, "output":{"shape":"GetArtifactUrlResult"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"UnauthorizedException"}, {"shape":"InternalFailureException"}, {"shape":"NotFoundException"}, {"shape":"LimitExceededException"} ], "documentation":"Returns the artifact info that corresponds to an artifact id.
" }, "GetBackendEnvironment":{ "name":"GetBackendEnvironment", "http":{ "method":"GET", "requestUri":"/apps/{appId}/backendenvironments/{environmentName}" }, "input":{"shape":"GetBackendEnvironmentRequest"}, "output":{"shape":"GetBackendEnvironmentResult"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"InternalFailureException"} ], "documentation":"Returns a backend environment for an Amplify app.
" }, "GetBranch":{ "name":"GetBranch", "http":{ "method":"GET", "requestUri":"/apps/{appId}/branches/{branchName}" }, "input":{"shape":"GetBranchRequest"}, "output":{"shape":"GetBranchResult"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"InternalFailureException"} ], "documentation":"Returns a branch for an Amplify app.
" }, "GetDomainAssociation":{ "name":"GetDomainAssociation", "http":{ "method":"GET", "requestUri":"/apps/{appId}/domains/{domainName}" }, "input":{"shape":"GetDomainAssociationRequest"}, "output":{"shape":"GetDomainAssociationResult"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"InternalFailureException"} ], "documentation":"Returns the domain information for an Amplify app.
" }, "GetJob":{ "name":"GetJob", "http":{ "method":"GET", "requestUri":"/apps/{appId}/branches/{branchName}/jobs/{jobId}" }, "input":{"shape":"GetJobRequest"}, "output":{"shape":"GetJobResult"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"UnauthorizedException"}, {"shape":"InternalFailureException"}, {"shape":"NotFoundException"}, {"shape":"LimitExceededException"} ], "documentation":"Returns a job for a branch of an Amplify app.
" }, "GetWebhook":{ "name":"GetWebhook", "http":{ "method":"GET", "requestUri":"/webhooks/{webhookId}" }, "input":{"shape":"GetWebhookRequest"}, "output":{"shape":"GetWebhookResult"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"UnauthorizedException"}, {"shape":"InternalFailureException"}, {"shape":"NotFoundException"}, {"shape":"LimitExceededException"} ], "documentation":"Returns the webhook information that corresponds to a specified webhook ID.
" }, "ListApps":{ "name":"ListApps", "http":{ "method":"GET", "requestUri":"/apps" }, "input":{"shape":"ListAppsRequest"}, "output":{"shape":"ListAppsResult"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"UnauthorizedException"}, {"shape":"InternalFailureException"} ], "documentation":"Returns a list of the existing Amplify apps.
" }, "ListArtifacts":{ "name":"ListArtifacts", "http":{ "method":"GET", "requestUri":"/apps/{appId}/branches/{branchName}/jobs/{jobId}/artifacts" }, "input":{"shape":"ListArtifactsRequest"}, "output":{"shape":"ListArtifactsResult"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"UnauthorizedException"}, {"shape":"InternalFailureException"}, {"shape":"LimitExceededException"} ], "documentation":"Returns a list of artifacts for a specified app, branch, and job.
" }, "ListBackendEnvironments":{ "name":"ListBackendEnvironments", "http":{ "method":"GET", "requestUri":"/apps/{appId}/backendenvironments" }, "input":{"shape":"ListBackendEnvironmentsRequest"}, "output":{"shape":"ListBackendEnvironmentsResult"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"UnauthorizedException"}, {"shape":"InternalFailureException"} ], "documentation":"Lists the backend environments for an Amplify app.
" }, "ListBranches":{ "name":"ListBranches", "http":{ "method":"GET", "requestUri":"/apps/{appId}/branches" }, "input":{"shape":"ListBranchesRequest"}, "output":{"shape":"ListBranchesResult"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"UnauthorizedException"}, {"shape":"InternalFailureException"} ], "documentation":"Lists the branches of an Amplify app.
" }, "ListDomainAssociations":{ "name":"ListDomainAssociations", "http":{ "method":"GET", "requestUri":"/apps/{appId}/domains" }, "input":{"shape":"ListDomainAssociationsRequest"}, "output":{"shape":"ListDomainAssociationsResult"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"UnauthorizedException"}, {"shape":"InternalFailureException"} ], "documentation":"Returns the domain associations for an Amplify app.
" }, "ListJobs":{ "name":"ListJobs", "http":{ "method":"GET", "requestUri":"/apps/{appId}/branches/{branchName}/jobs" }, "input":{"shape":"ListJobsRequest"}, "output":{"shape":"ListJobsResult"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"UnauthorizedException"}, {"shape":"InternalFailureException"}, {"shape":"LimitExceededException"} ], "documentation":"Lists the jobs for a branch of an Amplify app.
" }, "ListTagsForResource":{ "name":"ListTagsForResource", "http":{ "method":"GET", "requestUri":"/tags/{resourceArn}" }, "input":{"shape":"ListTagsForResourceRequest"}, "output":{"shape":"ListTagsForResourceResponse"}, "errors":[ {"shape":"InternalFailureException"}, {"shape":"BadRequestException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"Returns a list of tags for a specified Amazon Resource Name (ARN).
" }, "ListWebhooks":{ "name":"ListWebhooks", "http":{ "method":"GET", "requestUri":"/apps/{appId}/webhooks" }, "input":{"shape":"ListWebhooksRequest"}, "output":{"shape":"ListWebhooksResult"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"UnauthorizedException"}, {"shape":"InternalFailureException"}, {"shape":"LimitExceededException"} ], "documentation":"Returns a list of webhooks for an Amplify app.
" }, "StartDeployment":{ "name":"StartDeployment", "http":{ "method":"POST", "requestUri":"/apps/{appId}/branches/{branchName}/deployments/start" }, "input":{"shape":"StartDeploymentRequest"}, "output":{"shape":"StartDeploymentResult"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"UnauthorizedException"}, {"shape":"InternalFailureException"}, {"shape":"NotFoundException"}, {"shape":"LimitExceededException"} ], "documentation":"Starts a deployment for a manually deployed app. Manually deployed apps are not connected to a repository.
" }, "StartJob":{ "name":"StartJob", "http":{ "method":"POST", "requestUri":"/apps/{appId}/branches/{branchName}/jobs" }, "input":{"shape":"StartJobRequest"}, "output":{"shape":"StartJobResult"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"UnauthorizedException"}, {"shape":"InternalFailureException"}, {"shape":"NotFoundException"}, {"shape":"LimitExceededException"} ], "documentation":"Starts a new job for a branch of an Amplify app.
" }, "StopJob":{ "name":"StopJob", "http":{ "method":"DELETE", "requestUri":"/apps/{appId}/branches/{branchName}/jobs/{jobId}/stop" }, "input":{"shape":"StopJobRequest"}, "output":{"shape":"StopJobResult"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"UnauthorizedException"}, {"shape":"InternalFailureException"}, {"shape":"NotFoundException"}, {"shape":"LimitExceededException"} ], "documentation":"Stops a job that is in progress for a branch of an Amplify app.
" }, "TagResource":{ "name":"TagResource", "http":{ "method":"POST", "requestUri":"/tags/{resourceArn}" }, "input":{"shape":"TagResourceRequest"}, "output":{"shape":"TagResourceResponse"}, "errors":[ {"shape":"InternalFailureException"}, {"shape":"BadRequestException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"Tags the resource with a tag key and value.
" }, "UntagResource":{ "name":"UntagResource", "http":{ "method":"DELETE", "requestUri":"/tags/{resourceArn}" }, "input":{"shape":"UntagResourceRequest"}, "output":{"shape":"UntagResourceResponse"}, "errors":[ {"shape":"InternalFailureException"}, {"shape":"BadRequestException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"Untags a resource with a specified Amazon Resource Name (ARN).
" }, "UpdateApp":{ "name":"UpdateApp", "http":{ "method":"POST", "requestUri":"/apps/{appId}" }, "input":{"shape":"UpdateAppRequest"}, "output":{"shape":"UpdateAppResult"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"NotFoundException"}, {"shape":"UnauthorizedException"}, {"shape":"InternalFailureException"} ], "documentation":"Updates an existing Amplify app.
" }, "UpdateBranch":{ "name":"UpdateBranch", "http":{ "method":"POST", "requestUri":"/apps/{appId}/branches/{branchName}" }, "input":{"shape":"UpdateBranchRequest"}, "output":{"shape":"UpdateBranchResult"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"InternalFailureException"}, {"shape":"DependentServiceFailureException"} ], "documentation":"Updates a branch for an Amplify app.
" }, "UpdateDomainAssociation":{ "name":"UpdateDomainAssociation", "http":{ "method":"POST", "requestUri":"/apps/{appId}/domains/{domainName}" }, "input":{"shape":"UpdateDomainAssociationRequest"}, "output":{"shape":"UpdateDomainAssociationResult"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"InternalFailureException"}, {"shape":"DependentServiceFailureException"} ], "documentation":"Creates a new domain association for an Amplify app.
" }, "UpdateWebhook":{ "name":"UpdateWebhook", "http":{ "method":"POST", "requestUri":"/webhooks/{webhookId}" }, "input":{"shape":"UpdateWebhookRequest"}, "output":{"shape":"UpdateWebhookResult"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"InternalFailureException"}, {"shape":"DependentServiceFailureException"} ], "documentation":"Updates a webhook.
" } }, "shapes":{ "AccessToken":{ "type":"string", "max":255, "min":1, "sensitive":true }, "ActiveJobId":{ "type":"string", "max":1000 }, "App":{ "type":"structure", "required":[ "appId", "appArn", "name", "description", "repository", "platform", "createTime", "updateTime", "environmentVariables", "defaultDomain", "enableBranchAutoBuild", "enableBasicAuth" ], "members":{ "appId":{ "shape":"AppId", "documentation":"The unique ID of the Amplify app.
" }, "appArn":{ "shape":"AppArn", "documentation":"The Amazon Resource Name (ARN) of the Amplify app.
" }, "name":{ "shape":"Name", "documentation":"The name for the Amplify app.
" }, "tags":{ "shape":"TagMap", "documentation":"The tag for the Amplify app.
" }, "description":{ "shape":"Description", "documentation":"The description for the Amplify app.
" }, "repository":{ "shape":"Repository", "documentation":"The repository for the Amplify app.
" }, "platform":{ "shape":"Platform", "documentation":"The platform for the Amplify app.
" }, "createTime":{ "shape":"CreateTime", "documentation":"Creates a date and time for the Amplify app.
" }, "updateTime":{ "shape":"UpdateTime", "documentation":"Updates the date and time for the Amplify app.
" }, "iamServiceRoleArn":{ "shape":"ServiceRoleArn", "documentation":"The AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) of the Amplify app.
" }, "environmentVariables":{ "shape":"EnvironmentVariables", "documentation":"The environment variables for the Amplify app.
" }, "defaultDomain":{ "shape":"DefaultDomain", "documentation":"The default domain for the Amplify app.
" }, "enableBranchAutoBuild":{ "shape":"EnableBranchAutoBuild", "documentation":"Enables the auto-building of branches for the Amplify app.
" }, "enableBranchAutoDeletion":{ "shape":"EnableBranchAutoDeletion", "documentation":"Automatically disconnect a branch in the Amplify Console when you delete a branch from your Git repository.
" }, "enableBasicAuth":{ "shape":"EnableBasicAuth", "documentation":"Enables basic authorization for the Amplify app's branches.
" }, "basicAuthCredentials":{ "shape":"BasicAuthCredentials", "documentation":"The basic authorization credentials for branches for the Amplify app.
" }, "customRules":{ "shape":"CustomRules", "documentation":"Describes the custom redirect and rewrite rules for the Amplify app.
" }, "productionBranch":{ "shape":"ProductionBranch", "documentation":"Describes the information about a production branch of the Amplify app.
" }, "buildSpec":{ "shape":"BuildSpec", "documentation":"Describes the content of the build specification (build spec) for the Amplify app.
" }, "customHeaders":{ "shape":"CustomHeaders", "documentation":"Describes the custom HTTP headers for the Amplify app.
" }, "enableAutoBranchCreation":{ "shape":"EnableAutoBranchCreation", "documentation":"Enables automated branch creation for the Amplify app.
" }, "autoBranchCreationPatterns":{ "shape":"AutoBranchCreationPatterns", "documentation":"Describes the automated branch creation glob patterns for the Amplify app.
" }, "autoBranchCreationConfig":{ "shape":"AutoBranchCreationConfig", "documentation":"Describes the automated branch creation configuration for the Amplify app.
" } }, "documentation":"Represents the different branches of a repository for building, deploying, and hosting an Amplify app.
" }, "AppArn":{ "type":"string", "max":1000 }, "AppId":{ "type":"string", "max":20, "min":1, "pattern":"d[a-z0-9]+" }, "Apps":{ "type":"list", "member":{"shape":"App"} }, "Artifact":{ "type":"structure", "required":[ "artifactFileName", "artifactId" ], "members":{ "artifactFileName":{ "shape":"ArtifactFileName", "documentation":"The file name for the artifact.
" }, "artifactId":{ "shape":"ArtifactId", "documentation":"The unique ID for the artifact.
" } }, "documentation":"Describes an artifact.
" }, "ArtifactFileName":{ "type":"string", "max":1000 }, "ArtifactId":{ "type":"string", "max":255 }, "ArtifactUrl":{ "type":"string", "max":1000 }, "Artifacts":{ "type":"list", "member":{"shape":"Artifact"} }, "ArtifactsUrl":{ "type":"string", "max":1000 }, "AssociatedResource":{ "type":"string", "max":2048, "min":1 }, "AssociatedResources":{ "type":"list", "member":{"shape":"AssociatedResource"} }, "AutoBranchCreationConfig":{ "type":"structure", "members":{ "stage":{ "shape":"Stage", "documentation":"Describes the current stage for the autocreated branch.
" }, "framework":{ "shape":"Framework", "documentation":"The framework for the autocreated branch.
" }, "enableAutoBuild":{ "shape":"EnableAutoBuild", "documentation":"Enables auto building for the autocreated branch.
" }, "environmentVariables":{ "shape":"EnvironmentVariables", "documentation":"The environment variables for the autocreated branch.
" }, "basicAuthCredentials":{ "shape":"BasicAuthCredentials", "documentation":"The basic authorization credentials for the autocreated branch.
" }, "enableBasicAuth":{ "shape":"EnableBasicAuth", "documentation":"Enables basic authorization for the autocreated branch.
" }, "enablePerformanceMode":{ "shape":"EnablePerformanceMode", "documentation":"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.
" }, "buildSpec":{ "shape":"BuildSpec", "documentation":"The build specification (build spec) for the autocreated branch.
" }, "enablePullRequestPreview":{ "shape":"EnablePullRequestPreview", "documentation":"Enables pull request previews for the autocreated branch.
" }, "pullRequestEnvironmentName":{ "shape":"PullRequestEnvironmentName", "documentation":"The Amplify environment name for the pull request.
" } }, "documentation":"Describes the automated branch creation configuration.
" }, "AutoBranchCreationPattern":{ "type":"string", "max":2048, "min":1 }, "AutoBranchCreationPatterns":{ "type":"list", "member":{"shape":"AutoBranchCreationPattern"} }, "AutoSubDomainCreationPattern":{ "type":"string", "max":2048, "min":1 }, "AutoSubDomainCreationPatterns":{ "type":"list", "member":{"shape":"AutoSubDomainCreationPattern"} }, "AutoSubDomainIAMRole":{ "type":"string", "max":1000, "pattern":"^$|^arn:aws:iam::\\d{12}:role.+" }, "BackendEnvironment":{ "type":"structure", "required":[ "backendEnvironmentArn", "environmentName", "createTime", "updateTime" ], "members":{ "backendEnvironmentArn":{ "shape":"BackendEnvironmentArn", "documentation":"The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.
" }, "environmentName":{ "shape":"EnvironmentName", "documentation":"The name for a backend environment that is part of an Amplify app.
" }, "stackName":{ "shape":"StackName", "documentation":"The AWS CloudFormation stack name of a backend environment.
" }, "deploymentArtifacts":{ "shape":"DeploymentArtifacts", "documentation":"The name of deployment artifacts.
" }, "createTime":{ "shape":"CreateTime", "documentation":"The creation date and time for a backend environment that is part of an Amplify app.
" }, "updateTime":{ "shape":"UpdateTime", "documentation":"The last updated date and time for a backend environment that is part of an Amplify app.
" } }, "documentation":"Describes the backend environment for an Amplify app.
" }, "BackendEnvironmentArn":{ "type":"string", "max":1000, "min":1 }, "BackendEnvironments":{ "type":"list", "member":{"shape":"BackendEnvironment"} }, "BadRequestException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"A request contains unexpected data.
", "error":{"httpStatusCode":400}, "exception":true }, "BasicAuthCredentials":{ "type":"string", "max":2000, "sensitive":true }, "Branch":{ "type":"structure", "required":[ "branchArn", "branchName", "description", "stage", "displayName", "enableNotification", "createTime", "updateTime", "environmentVariables", "enableAutoBuild", "customDomains", "framework", "activeJobId", "totalNumberOfJobs", "enableBasicAuth", "ttl", "enablePullRequestPreview" ], "members":{ "branchArn":{ "shape":"BranchArn", "documentation":"The Amazon Resource Name (ARN) for a branch that is part of an Amplify app.
" }, "branchName":{ "shape":"BranchName", "documentation":"The name for the branch that is part of an Amplify app.
" }, "description":{ "shape":"Description", "documentation":"The description for the branch that is part of an Amplify app.
" }, "tags":{ "shape":"TagMap", "documentation":"The tag for the branch of an Amplify app.
" }, "stage":{ "shape":"Stage", "documentation":"The current stage for the branch that is part of an Amplify app.
" }, "displayName":{ "shape":"DisplayName", "documentation":"The display name for the branch. This is used as the default domain prefix.
" }, "enableNotification":{ "shape":"EnableNotification", "documentation":"Enables notifications for a branch that is part of an Amplify app.
" }, "createTime":{ "shape":"CreateTime", "documentation":"The creation date and time for a branch that is part of an Amplify app.
" }, "updateTime":{ "shape":"UpdateTime", "documentation":"The last updated date and time for a branch that is part of an Amplify app.
" }, "environmentVariables":{ "shape":"EnvironmentVariables", "documentation":"The environment variables specific to a branch of an Amplify app.
" }, "enableAutoBuild":{ "shape":"EnableAutoBuild", "documentation":"Enables auto-building on push for a branch of an Amplify app.
" }, "customDomains":{ "shape":"CustomDomains", "documentation":"The custom domains for a branch of an Amplify app.
" }, "framework":{ "shape":"Framework", "documentation":"The framework for a branch of an Amplify app.
" }, "activeJobId":{ "shape":"ActiveJobId", "documentation":"The ID of the active job for a branch of an Amplify app.
" }, "totalNumberOfJobs":{ "shape":"TotalNumberOfJobs", "documentation":"The total number of jobs that are part of an Amplify app.
" }, "enableBasicAuth":{ "shape":"EnableBasicAuth", "documentation":"Enables basic authorization for a branch of an Amplify app.
" }, "enablePerformanceMode":{ "shape":"EnablePerformanceMode", "documentation":"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.
" }, "thumbnailUrl":{ "shape":"ThumbnailUrl", "documentation":"The thumbnail URL for the branch of an Amplify app.
" }, "basicAuthCredentials":{ "shape":"BasicAuthCredentials", "documentation":"The basic authorization credentials for a branch of an Amplify app.
" }, "buildSpec":{ "shape":"BuildSpec", "documentation":"The build specification (build spec) content for the branch of an Amplify app.
" }, "ttl":{ "shape":"TTL", "documentation":"The content Time to Live (TTL) for the website in seconds.
" }, "associatedResources":{ "shape":"AssociatedResources", "documentation":"A list of custom resources that are linked to this branch.
" }, "enablePullRequestPreview":{ "shape":"EnablePullRequestPreview", "documentation":"Enables pull request previews for the branch.
" }, "pullRequestEnvironmentName":{ "shape":"PullRequestEnvironmentName", "documentation":"The Amplify environment name for the pull request.
" }, "destinationBranch":{ "shape":"BranchName", "documentation":"The destination branch if the branch is a pull request branch.
" }, "sourceBranch":{ "shape":"BranchName", "documentation":"The source branch if the branch is a pull request branch.
" }, "backendEnvironmentArn":{ "shape":"BackendEnvironmentArn", "documentation":"The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.
" } }, "documentation":"The branch for an Amplify app, which maps to a third-party repository branch.
" }, "BranchArn":{ "type":"string", "max":1000 }, "BranchName":{ "type":"string", "max":255, "min":1 }, "Branches":{ "type":"list", "member":{"shape":"Branch"}, "max":255 }, "BuildSpec":{ "type":"string", "documentation":"The build specification (build spec) file for an Amplify app build.
", "max":25000, "min":1 }, "CertificateVerificationDNSRecord":{ "type":"string", "max":1000 }, "Code":{"type":"string"}, "CommitId":{ "type":"string", "max":255 }, "CommitMessage":{ "type":"string", "max":10000 }, "CommitTime":{"type":"timestamp"}, "Condition":{ "type":"string", "max":2048, "min":1 }, "Context":{"type":"string"}, "CreateAppRequest":{ "type":"structure", "required":["name"], "members":{ "name":{ "shape":"Name", "documentation":"The name for an Amplify app.
" }, "description":{ "shape":"Description", "documentation":"The description for an Amplify app.
" }, "repository":{ "shape":"Repository", "documentation":"The repository for an Amplify app.
" }, "platform":{ "shape":"Platform", "documentation":"The platform or framework for an Amplify app.
" }, "iamServiceRoleArn":{ "shape":"ServiceRoleArn", "documentation":"The AWS Identity and Access Management (IAM) service role for an Amplify app.
" }, "oauthToken":{ "shape":"OauthToken", "documentation":"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.
" }, "accessToken":{ "shape":"AccessToken", "documentation":"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.
" }, "environmentVariables":{ "shape":"EnvironmentVariables", "documentation":"The environment variables map for an Amplify app.
" }, "enableBranchAutoBuild":{ "shape":"EnableBranchAutoBuild", "documentation":"Enables the auto building of branches for an Amplify app.
" }, "enableBranchAutoDeletion":{ "shape":"EnableBranchAutoDeletion", "documentation":"Automatically disconnects a branch in the Amplify Console when you delete a branch from your Git repository.
" }, "enableBasicAuth":{ "shape":"EnableBasicAuth", "documentation":"Enables basic authorization for an Amplify app. This will apply to all branches that are part of this app.
" }, "basicAuthCredentials":{ "shape":"BasicAuthCredentials", "documentation":"The credentials for basic authorization for an Amplify app.
" }, "customRules":{ "shape":"CustomRules", "documentation":"The custom rewrite and redirect rules for an Amplify app.
" }, "tags":{ "shape":"TagMap", "documentation":"The tag for an Amplify app.
" }, "buildSpec":{ "shape":"BuildSpec", "documentation":"The build specification (build spec) for an Amplify app.
" }, "customHeaders":{ "shape":"CustomHeaders", "documentation":"The custom HTTP headers for an Amplify app.
" }, "enableAutoBranchCreation":{ "shape":"EnableAutoBranchCreation", "documentation":"Enables automated branch creation for an Amplify app.
" }, "autoBranchCreationPatterns":{ "shape":"AutoBranchCreationPatterns", "documentation":"The automated branch creation glob patterns for an Amplify app.
" }, "autoBranchCreationConfig":{ "shape":"AutoBranchCreationConfig", "documentation":"The automated branch creation configuration for an Amplify app.
" } }, "documentation":"The request structure used to create apps in Amplify.
" }, "CreateAppResult":{ "type":"structure", "required":["app"], "members":{ "app":{"shape":"App"} } }, "CreateBackendEnvironmentRequest":{ "type":"structure", "required":[ "appId", "environmentName" ], "members":{ "appId":{ "shape":"AppId", "documentation":"The unique ID for an Amplify app.
", "location":"uri", "locationName":"appId" }, "environmentName":{ "shape":"EnvironmentName", "documentation":"The name for the backend environment.
" }, "stackName":{ "shape":"StackName", "documentation":"The AWS CloudFormation stack name of a backend environment.
" }, "deploymentArtifacts":{ "shape":"DeploymentArtifacts", "documentation":"The name of deployment artifacts.
" } }, "documentation":"The request structure for the backend environment create request.
" }, "CreateBackendEnvironmentResult":{ "type":"structure", "required":["backendEnvironment"], "members":{ "backendEnvironment":{ "shape":"BackendEnvironment", "documentation":"Describes the backend environment for an Amplify app.
" } }, "documentation":"The result structure for the create backend environment request.
" }, "CreateBranchRequest":{ "type":"structure", "required":[ "appId", "branchName" ], "members":{ "appId":{ "shape":"AppId", "documentation":"The unique ID for an Amplify app.
", "location":"uri", "locationName":"appId" }, "branchName":{ "shape":"BranchName", "documentation":"The name for the branch.
" }, "description":{ "shape":"Description", "documentation":"The description for the branch.
" }, "stage":{ "shape":"Stage", "documentation":"Describes the current stage for the branch.
" }, "framework":{ "shape":"Framework", "documentation":"The framework for the branch.
" }, "enableNotification":{ "shape":"EnableNotification", "documentation":"Enables notifications for the branch.
" }, "enableAutoBuild":{ "shape":"EnableAutoBuild", "documentation":"Enables auto building for the branch.
" }, "environmentVariables":{ "shape":"EnvironmentVariables", "documentation":"The environment variables for the branch.
" }, "basicAuthCredentials":{ "shape":"BasicAuthCredentials", "documentation":"The basic authorization credentials for the branch.
" }, "enableBasicAuth":{ "shape":"EnableBasicAuth", "documentation":"Enables basic authorization for the branch.
" }, "enablePerformanceMode":{ "shape":"EnablePerformanceMode", "documentation":"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.
" }, "tags":{ "shape":"TagMap", "documentation":"The tag for the branch.
" }, "buildSpec":{ "shape":"BuildSpec", "documentation":"The build specification (build spec) for the branch.
" }, "ttl":{ "shape":"TTL", "documentation":"The content Time To Live (TTL) for the website in seconds.
" }, "displayName":{ "shape":"DisplayName", "documentation":"The display name for a branch. This is used as the default domain prefix.
" }, "enablePullRequestPreview":{ "shape":"EnablePullRequestPreview", "documentation":"Enables pull request previews for this branch.
" }, "pullRequestEnvironmentName":{ "shape":"PullRequestEnvironmentName", "documentation":"The Amplify environment name for the pull request.
" }, "backendEnvironmentArn":{ "shape":"BackendEnvironmentArn", "documentation":"The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.
" } }, "documentation":"The request structure for the create branch request.
" }, "CreateBranchResult":{ "type":"structure", "required":["branch"], "members":{ "branch":{ "shape":"Branch", "documentation":"Describes the branch for an Amplify app, which maps to a third-party repository branch.
" } }, "documentation":"The result structure for create branch request.
" }, "CreateDeploymentRequest":{ "type":"structure", "required":[ "appId", "branchName" ], "members":{ "appId":{ "shape":"AppId", "documentation":"The unique ID for an Amplify app.
", "location":"uri", "locationName":"appId" }, "branchName":{ "shape":"BranchName", "documentation":"The name for the branch, for the job.
", "location":"uri", "locationName":"branchName" }, "fileMap":{ "shape":"FileMap", "documentation":"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.
" } }, "documentation":"The request structure for the create a new deployment request.
" }, "CreateDeploymentResult":{ "type":"structure", "required":[ "fileUploadUrls", "zipUploadUrl" ], "members":{ "jobId":{ "shape":"JobId", "documentation":"The job ID for this deployment. will supply to start deployment api.
" }, "fileUploadUrls":{ "shape":"FileUploadUrls", "documentation":" When the fileMap
argument is provided in the request, fileUploadUrls
will contain a map of file names to upload URLs.
When the fileMap
argument is not provided in the request, this zipUploadUrl
is returned.
The result structure for the create a new deployment request.
" }, "CreateDomainAssociationRequest":{ "type":"structure", "required":[ "appId", "domainName", "subDomainSettings" ], "members":{ "appId":{ "shape":"AppId", "documentation":"The unique ID for an Amplify app.
", "location":"uri", "locationName":"appId" }, "domainName":{ "shape":"DomainName", "documentation":"The domain name for the domain association.
" }, "enableAutoSubDomain":{ "shape":"EnableAutoSubDomain", "documentation":"Enables the automated creation of subdomains for branches.
" }, "subDomainSettings":{ "shape":"SubDomainSettings", "documentation":"The setting for the subdomain.
" }, "autoSubDomainCreationPatterns":{ "shape":"AutoSubDomainCreationPatterns", "documentation":"Sets the branch patterns for automatic subdomain creation.
" }, "autoSubDomainIAMRole":{ "shape":"AutoSubDomainIAMRole", "documentation":"The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.
" } }, "documentation":"The request structure for the create domain association request.
" }, "CreateDomainAssociationResult":{ "type":"structure", "required":["domainAssociation"], "members":{ "domainAssociation":{ "shape":"DomainAssociation", "documentation":"Describes the structure of a domain association, which associates a custom domain with an Amplify app.
" } }, "documentation":"The result structure for the create domain association request.
" }, "CreateTime":{"type":"timestamp"}, "CreateWebhookRequest":{ "type":"structure", "required":[ "appId", "branchName" ], "members":{ "appId":{ "shape":"AppId", "documentation":"The unique ID for an Amplify app.
", "location":"uri", "locationName":"appId" }, "branchName":{ "shape":"BranchName", "documentation":"The name for a branch that is part of an Amplify app.
" }, "description":{ "shape":"Description", "documentation":"The description for a webhook.
" } }, "documentation":"The request structure for the create webhook request.
" }, "CreateWebhookResult":{ "type":"structure", "required":["webhook"], "members":{ "webhook":{ "shape":"Webhook", "documentation":"Describes a webhook that connects repository events to an Amplify app.
" } }, "documentation":"The result structure for the create webhook request.
" }, "CustomDomain":{ "type":"string", "max":255 }, "CustomDomains":{ "type":"list", "member":{"shape":"CustomDomain"}, "max":255 }, "CustomHeaders":{ "type":"string", "max":25000, "min":1 }, "CustomRule":{ "type":"structure", "required":[ "source", "target" ], "members":{ "source":{ "shape":"Source", "documentation":"The source pattern for a URL rewrite or redirect rule.
" }, "target":{ "shape":"Target", "documentation":"The target pattern for a URL rewrite or redirect rule.
" }, "status":{ "shape":"Status", "documentation":"The status code for a URL rewrite or redirect rule.
Represents a 200 rewrite rule.
Represents a 301 (moved pemanently) redirect rule. This and all future requests should be directed to the target URL.
Represents a 302 temporary redirect rule.
Represents a 404 redirect rule.
Represents a 404 rewrite rule.
The condition for a URL rewrite or redirect rule, such as a country code.
" } }, "documentation":"Describes a custom rewrite or redirect rule.
" }, "CustomRules":{ "type":"list", "member":{"shape":"CustomRule"} }, "DNSRecord":{ "type":"string", "max":1000 }, "DefaultDomain":{ "type":"string", "max":1000, "min":1 }, "DeleteAppRequest":{ "type":"structure", "required":["appId"], "members":{ "appId":{ "shape":"AppId", "documentation":"The unique ID for an Amplify app.
", "location":"uri", "locationName":"appId" } }, "documentation":"Describes the request structure for the delete app request.
" }, "DeleteAppResult":{ "type":"structure", "required":["app"], "members":{ "app":{"shape":"App"} }, "documentation":"The result structure for the delete app request.
" }, "DeleteBackendEnvironmentRequest":{ "type":"structure", "required":[ "appId", "environmentName" ], "members":{ "appId":{ "shape":"AppId", "documentation":"The unique ID of an Amplify app.
", "location":"uri", "locationName":"appId" }, "environmentName":{ "shape":"EnvironmentName", "documentation":"The name of a backend environment of an Amplify app.
", "location":"uri", "locationName":"environmentName" } }, "documentation":"The request structure for the delete backend environment request.
" }, "DeleteBackendEnvironmentResult":{ "type":"structure", "required":["backendEnvironment"], "members":{ "backendEnvironment":{ "shape":"BackendEnvironment", "documentation":"Describes the backend environment for an Amplify app.
" } }, "documentation":"The result structure of the delete backend environment result.
" }, "DeleteBranchRequest":{ "type":"structure", "required":[ "appId", "branchName" ], "members":{ "appId":{ "shape":"AppId", "documentation":"The unique ID for an Amplify app.
", "location":"uri", "locationName":"appId" }, "branchName":{ "shape":"BranchName", "documentation":"The name for the branch.
", "location":"uri", "locationName":"branchName" } }, "documentation":"The request structure for the delete branch request.
" }, "DeleteBranchResult":{ "type":"structure", "required":["branch"], "members":{ "branch":{ "shape":"Branch", "documentation":"The branch for an Amplify app, which maps to a third-party repository branch.
" } }, "documentation":"The result structure for the delete branch request.
" }, "DeleteDomainAssociationRequest":{ "type":"structure", "required":[ "appId", "domainName" ], "members":{ "appId":{ "shape":"AppId", "documentation":"The unique id for an Amplify app.
", "location":"uri", "locationName":"appId" }, "domainName":{ "shape":"DomainName", "documentation":"The name of the domain.
", "location":"uri", "locationName":"domainName" } }, "documentation":"The request structure for the delete domain association request.
" }, "DeleteDomainAssociationResult":{ "type":"structure", "required":["domainAssociation"], "members":{ "domainAssociation":{"shape":"DomainAssociation"} } }, "DeleteJobRequest":{ "type":"structure", "required":[ "appId", "branchName", "jobId" ], "members":{ "appId":{ "shape":"AppId", "documentation":"The unique ID for an Amplify app.
", "location":"uri", "locationName":"appId" }, "branchName":{ "shape":"BranchName", "documentation":"The name for the branch, for the job.
", "location":"uri", "locationName":"branchName" }, "jobId":{ "shape":"JobId", "documentation":"The unique ID for the job.
", "location":"uri", "locationName":"jobId" } }, "documentation":"The request structure for the delete job request.
" }, "DeleteJobResult":{ "type":"structure", "required":["jobSummary"], "members":{ "jobSummary":{"shape":"JobSummary"} }, "documentation":"The result structure for the delete job request.
" }, "DeleteWebhookRequest":{ "type":"structure", "required":["webhookId"], "members":{ "webhookId":{ "shape":"WebhookId", "documentation":"The unique ID for a webhook.
", "location":"uri", "locationName":"webhookId" } }, "documentation":"The request structure for the delete webhook request.
" }, "DeleteWebhookResult":{ "type":"structure", "required":["webhook"], "members":{ "webhook":{ "shape":"Webhook", "documentation":"Describes a webhook that connects repository events to an Amplify app.
" } }, "documentation":"The result structure for the delete webhook request.
" }, "DependentServiceFailureException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"An operation failed because a dependent service threw an exception.
", "error":{"httpStatusCode":503}, "exception":true }, "DeploymentArtifacts":{ "type":"string", "max":1000, "min":1 }, "Description":{ "type":"string", "max":1000 }, "DisplayName":{ "type":"string", "max":255 }, "DomainAssociation":{ "type":"structure", "required":[ "domainAssociationArn", "domainName", "enableAutoSubDomain", "domainStatus", "statusReason", "subDomains" ], "members":{ "domainAssociationArn":{ "shape":"DomainAssociationArn", "documentation":"The Amazon Resource Name (ARN) for the domain association.
" }, "domainName":{ "shape":"DomainName", "documentation":"The name of the domain.
" }, "enableAutoSubDomain":{ "shape":"EnableAutoSubDomain", "documentation":"Enables the automated creation of subdomains for branches.
" }, "autoSubDomainCreationPatterns":{ "shape":"AutoSubDomainCreationPatterns", "documentation":"Sets branch patterns for automatic subdomain creation.
" }, "autoSubDomainIAMRole":{ "shape":"AutoSubDomainIAMRole", "documentation":"The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.
" }, "domainStatus":{ "shape":"DomainStatus", "documentation":"The current status of the domain association.
" }, "statusReason":{ "shape":"StatusReason", "documentation":"The reason for the current status of the domain association.
" }, "certificateVerificationDNSRecord":{ "shape":"CertificateVerificationDNSRecord", "documentation":"The DNS record for certificate verification.
" }, "subDomains":{ "shape":"SubDomains", "documentation":"The subdomains for the domain association.
" } }, "documentation":"Describes a domain association that associates a custom domain with an Amplify app.
" }, "DomainAssociationArn":{ "type":"string", "max":1000 }, "DomainAssociations":{ "type":"list", "member":{"shape":"DomainAssociation"}, "max":255 }, "DomainName":{ "type":"string", "max":255 }, "DomainPrefix":{ "type":"string", "max":255 }, "DomainStatus":{ "type":"string", "enum":[ "PENDING_VERIFICATION", "IN_PROGRESS", "AVAILABLE", "PENDING_DEPLOYMENT", "FAILED", "CREATING", "REQUESTING_CERTIFICATE", "UPDATING" ] }, "EnableAutoBranchCreation":{"type":"boolean"}, "EnableAutoBuild":{"type":"boolean"}, "EnableAutoSubDomain":{"type":"boolean"}, "EnableBasicAuth":{"type":"boolean"}, "EnableBranchAutoBuild":{"type":"boolean"}, "EnableBranchAutoDeletion":{"type":"boolean"}, "EnableNotification":{"type":"boolean"}, "EnablePerformanceMode":{"type":"boolean"}, "EnablePullRequestPreview":{"type":"boolean"}, "EndTime":{"type":"timestamp"}, "EnvKey":{ "type":"string", "max":255 }, "EnvValue":{ "type":"string", "max":1000 }, "EnvironmentName":{ "type":"string", "max":255, "min":1 }, "EnvironmentVariables":{ "type":"map", "key":{"shape":"EnvKey"}, "value":{"shape":"EnvValue"} }, "ErrorMessage":{ "type":"string", "max":255 }, "FileMap":{ "type":"map", "key":{"shape":"FileName"}, "value":{"shape":"MD5Hash"} }, "FileName":{ "type":"string", "max":255 }, "FileUploadUrls":{ "type":"map", "key":{"shape":"FileName"}, "value":{"shape":"UploadUrl"} }, "Framework":{ "type":"string", "max":255 }, "GenerateAccessLogsRequest":{ "type":"structure", "required":[ "domainName", "appId" ], "members":{ "startTime":{ "shape":"StartTime", "documentation":"The time at which the logs should start. The time range specified is inclusive of the start time.
" }, "endTime":{ "shape":"EndTime", "documentation":"The time at which the logs should end. The time range specified is inclusive of the end time.
" }, "domainName":{ "shape":"DomainName", "documentation":"The name of the domain.
" }, "appId":{ "shape":"AppId", "documentation":"The unique ID for an Amplify app.
", "location":"uri", "locationName":"appId" } }, "documentation":"The request structure for the generate access logs request.
" }, "GenerateAccessLogsResult":{ "type":"structure", "members":{ "logUrl":{ "shape":"LogUrl", "documentation":"The pre-signed URL for the requested access logs.
" } }, "documentation":"The result structure for the generate access logs request.
" }, "GetAppRequest":{ "type":"structure", "required":["appId"], "members":{ "appId":{ "shape":"AppId", "documentation":"The unique ID for an Amplify app.
", "location":"uri", "locationName":"appId" } }, "documentation":"The request structure for the get app request.
" }, "GetAppResult":{ "type":"structure", "required":["app"], "members":{ "app":{"shape":"App"} } }, "GetArtifactUrlRequest":{ "type":"structure", "required":["artifactId"], "members":{ "artifactId":{ "shape":"ArtifactId", "documentation":"The unique ID for an artifact.
", "location":"uri", "locationName":"artifactId" } }, "documentation":"Returns the request structure for the get artifact request.
" }, "GetArtifactUrlResult":{ "type":"structure", "required":[ "artifactId", "artifactUrl" ], "members":{ "artifactId":{ "shape":"ArtifactId", "documentation":"The unique ID for an artifact.
" }, "artifactUrl":{ "shape":"ArtifactUrl", "documentation":"The presigned URL for the artifact.
" } }, "documentation":"Returns the result structure for the get artifact request.
" }, "GetBackendEnvironmentRequest":{ "type":"structure", "required":[ "appId", "environmentName" ], "members":{ "appId":{ "shape":"AppId", "documentation":"The unique id for an Amplify app.
", "location":"uri", "locationName":"appId" }, "environmentName":{ "shape":"EnvironmentName", "documentation":"The name for the backend environment.
", "location":"uri", "locationName":"environmentName" } }, "documentation":"The request structure for the get backend environment request.
" }, "GetBackendEnvironmentResult":{ "type":"structure", "required":["backendEnvironment"], "members":{ "backendEnvironment":{ "shape":"BackendEnvironment", "documentation":"Describes the backend environment for an Amplify app.
" } }, "documentation":"The result structure for the get backend environment result.
" }, "GetBranchRequest":{ "type":"structure", "required":[ "appId", "branchName" ], "members":{ "appId":{ "shape":"AppId", "documentation":"The unique ID for an Amplify app.
", "location":"uri", "locationName":"appId" }, "branchName":{ "shape":"BranchName", "documentation":"The name for the branch.
", "location":"uri", "locationName":"branchName" } }, "documentation":"The request structure for the get branch request.
" }, "GetBranchResult":{ "type":"structure", "required":["branch"], "members":{ "branch":{"shape":"Branch"} } }, "GetDomainAssociationRequest":{ "type":"structure", "required":[ "appId", "domainName" ], "members":{ "appId":{ "shape":"AppId", "documentation":"The unique id for an Amplify app.
", "location":"uri", "locationName":"appId" }, "domainName":{ "shape":"DomainName", "documentation":"The name of the domain.
", "location":"uri", "locationName":"domainName" } }, "documentation":"The request structure for the get domain association request.
" }, "GetDomainAssociationResult":{ "type":"structure", "required":["domainAssociation"], "members":{ "domainAssociation":{ "shape":"DomainAssociation", "documentation":"Describes the structure of a domain association, which associates a custom domain with an Amplify app.
" } }, "documentation":"The result structure for the get domain association request.
" }, "GetJobRequest":{ "type":"structure", "required":[ "appId", "branchName", "jobId" ], "members":{ "appId":{ "shape":"AppId", "documentation":"The unique ID for an Amplify app.
", "location":"uri", "locationName":"appId" }, "branchName":{ "shape":"BranchName", "documentation":"The branch name for the job.
", "location":"uri", "locationName":"branchName" }, "jobId":{ "shape":"JobId", "documentation":"The unique ID for the job.
", "location":"uri", "locationName":"jobId" } }, "documentation":"The request structure for the get job request.
" }, "GetJobResult":{ "type":"structure", "required":["job"], "members":{ "job":{"shape":"Job"} } }, "GetWebhookRequest":{ "type":"structure", "required":["webhookId"], "members":{ "webhookId":{ "shape":"WebhookId", "documentation":"The unique ID for a webhook.
", "location":"uri", "locationName":"webhookId" } }, "documentation":"The request structure for the get webhook request.
" }, "GetWebhookResult":{ "type":"structure", "required":["webhook"], "members":{ "webhook":{ "shape":"Webhook", "documentation":"Describes the structure of a webhook.
" } }, "documentation":"The result structure for the get webhook request.
" }, "InternalFailureException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"The service failed to perform an operation due to an internal issue.
", "error":{"httpStatusCode":500}, "exception":true, "fault":true }, "Job":{ "type":"structure", "required":[ "summary", "steps" ], "members":{ "summary":{ "shape":"JobSummary", "documentation":"Describes the summary for an execution job for an Amplify app.
" }, "steps":{ "shape":"Steps", "documentation":"The execution steps for an execution job, for an Amplify app.
" } }, "documentation":"Describes an execution job for an Amplify app.
" }, "JobArn":{ "type":"string", "max":1000 }, "JobId":{ "type":"string", "max":255 }, "JobReason":{ "type":"string", "max":255 }, "JobStatus":{ "type":"string", "enum":[ "PENDING", "PROVISIONING", "RUNNING", "FAILED", "SUCCEED", "CANCELLING", "CANCELLED" ] }, "JobSummaries":{ "type":"list", "member":{"shape":"JobSummary"} }, "JobSummary":{ "type":"structure", "required":[ "jobArn", "jobId", "commitId", "commitMessage", "commitTime", "startTime", "status", "jobType" ], "members":{ "jobArn":{ "shape":"JobArn", "documentation":"The Amazon Resource Name (ARN) for the job.
" }, "jobId":{ "shape":"JobId", "documentation":"The unique ID for the job.
" }, "commitId":{ "shape":"CommitId", "documentation":"The commit ID from a third-party repository provider for the job.
" }, "commitMessage":{ "shape":"CommitMessage", "documentation":"The commit message from a third-party repository provider for the job.
" }, "commitTime":{ "shape":"CommitTime", "documentation":"The commit date and time for the job.
" }, "startTime":{ "shape":"StartTime", "documentation":"The start date and time for the job.
" }, "status":{ "shape":"JobStatus", "documentation":"The current status for the job.
" }, "endTime":{ "shape":"EndTime", "documentation":"The end date and time for the job.
" }, "jobType":{ "shape":"JobType", "documentation":" 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.
Describes the summary for an execution job for an Amplify app.
" }, "JobType":{ "type":"string", "enum":[ "RELEASE", "RETRY", "MANUAL", "WEB_HOOK" ], "max":10 }, "LastDeployTime":{"type":"timestamp"}, "LimitExceededException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"A resource could not be created because service quotas were exceeded.
", "error":{"httpStatusCode":429}, "exception":true }, "ListAppsRequest":{ "type":"structure", "members":{ "nextToken":{ "shape":"NextToken", "documentation":"A pagination token. If non-null, the pagination token is returned in a result. Pass its value in another request to retrieve more entries.
", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of records to list in a single response.
", "location":"querystring", "locationName":"maxResults" } }, "documentation":"The request structure for the list apps request.
" }, "ListAppsResult":{ "type":"structure", "required":["apps"], "members":{ "apps":{ "shape":"Apps", "documentation":"A list of Amplify apps.
" }, "nextToken":{ "shape":"NextToken", "documentation":"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.
" } }, "documentation":"The result structure for an Amplify app list request.
" }, "ListArtifactsRequest":{ "type":"structure", "required":[ "appId", "branchName", "jobId" ], "members":{ "appId":{ "shape":"AppId", "documentation":"The unique ID for an Amplify app.
", "location":"uri", "locationName":"appId" }, "branchName":{ "shape":"BranchName", "documentation":"The name of a branch that is part of an Amplify app.
", "location":"uri", "locationName":"branchName" }, "jobId":{ "shape":"JobId", "documentation":"The unique ID for a job.
", "location":"uri", "locationName":"jobId" }, "nextToken":{ "shape":"NextToken", "documentation":"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.
", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of records to list in a single response.
", "location":"querystring", "locationName":"maxResults" } }, "documentation":"Describes the request structure for the list artifacts request.
" }, "ListArtifactsResult":{ "type":"structure", "required":["artifacts"], "members":{ "artifacts":{ "shape":"Artifacts", "documentation":"A list of artifacts.
" }, "nextToken":{ "shape":"NextToken", "documentation":"A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries.
" } }, "documentation":"The result structure for the list artifacts request.
" }, "ListBackendEnvironmentsRequest":{ "type":"structure", "required":["appId"], "members":{ "appId":{ "shape":"AppId", "documentation":"The unique ID for an Amplify app.
", "location":"uri", "locationName":"appId" }, "environmentName":{ "shape":"EnvironmentName", "documentation":"The name of the backend environment
", "location":"querystring", "locationName":"environmentName" }, "nextToken":{ "shape":"NextToken", "documentation":"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.
", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of records to list in a single response.
", "location":"querystring", "locationName":"maxResults" } }, "documentation":"The request structure for the list backend environments request.
" }, "ListBackendEnvironmentsResult":{ "type":"structure", "required":["backendEnvironments"], "members":{ "backendEnvironments":{ "shape":"BackendEnvironments", "documentation":"The list of backend environments for an Amplify app.
" }, "nextToken":{ "shape":"NextToken", "documentation":"A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries.
" } }, "documentation":"The result structure for the list backend environments result.
" }, "ListBranchesRequest":{ "type":"structure", "required":["appId"], "members":{ "appId":{ "shape":"AppId", "documentation":"The unique ID for an Amplify app.
", "location":"uri", "locationName":"appId" }, "nextToken":{ "shape":"NextToken", "documentation":"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.
", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of records to list in a single response.
", "location":"querystring", "locationName":"maxResults" } }, "documentation":"The request structure for the list branches request.
" }, "ListBranchesResult":{ "type":"structure", "required":["branches"], "members":{ "branches":{ "shape":"Branches", "documentation":"A list of branches for an Amplify app.
" }, "nextToken":{ "shape":"NextToken", "documentation":"A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries.
" } }, "documentation":"The result structure for the list branches request.
" }, "ListDomainAssociationsRequest":{ "type":"structure", "required":["appId"], "members":{ "appId":{ "shape":"AppId", "documentation":"The unique ID for an Amplify app.
", "location":"uri", "locationName":"appId" }, "nextToken":{ "shape":"NextToken", "documentation":"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.
", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of records to list in a single response.
", "location":"querystring", "locationName":"maxResults" } }, "documentation":"The request structure for the list domain associations request.
" }, "ListDomainAssociationsResult":{ "type":"structure", "required":["domainAssociations"], "members":{ "domainAssociations":{ "shape":"DomainAssociations", "documentation":"A list of domain associations.
" }, "nextToken":{ "shape":"NextToken", "documentation":"A pagination token. If non-null, a pagination token is returned in a result. Pass its value in another request to retrieve more entries.
" } }, "documentation":"The result structure for the list domain association request.
" }, "ListJobsRequest":{ "type":"structure", "required":[ "appId", "branchName" ], "members":{ "appId":{ "shape":"AppId", "documentation":"The unique ID for an Amplify app.
", "location":"uri", "locationName":"appId" }, "branchName":{ "shape":"BranchName", "documentation":"The name for a branch.
", "location":"uri", "locationName":"branchName" }, "nextToken":{ "shape":"NextToken", "documentation":"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.
", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of records to list in a single response.
", "location":"querystring", "locationName":"maxResults" } }, "documentation":"The request structure for the list jobs request.
" }, "ListJobsResult":{ "type":"structure", "required":["jobSummaries"], "members":{ "jobSummaries":{ "shape":"JobSummaries", "documentation":"The result structure for the list job result request.
" }, "nextToken":{ "shape":"NextToken", "documentation":"A pagination token. If non-null the pagination token is returned in a result. Pass its value in another request to retrieve more entries.
" } }, "documentation":"The maximum number of records to list in a single response.
" }, "ListTagsForResourceRequest":{ "type":"structure", "required":["resourceArn"], "members":{ "resourceArn":{ "shape":"ResourceArn", "documentation":"The Amazon Resource Name (ARN) to use to list tags.
", "location":"uri", "locationName":"resourceArn" } }, "documentation":"The request structure to use to list tags for a resource.
" }, "ListTagsForResourceResponse":{ "type":"structure", "members":{ "tags":{ "shape":"TagMap", "documentation":"A list of tags for the specified The Amazon Resource Name (ARN).
" } }, "documentation":"The response for the list tags for resource request.
" }, "ListWebhooksRequest":{ "type":"structure", "required":["appId"], "members":{ "appId":{ "shape":"AppId", "documentation":"The unique ID for an Amplify app.
", "location":"uri", "locationName":"appId" }, "nextToken":{ "shape":"NextToken", "documentation":"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.
", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of records to list in a single response.
", "location":"querystring", "locationName":"maxResults" } }, "documentation":"The request structure for the list webhooks request.
" }, "ListWebhooksResult":{ "type":"structure", "required":["webhooks"], "members":{ "webhooks":{ "shape":"Webhooks", "documentation":"A list of webhooks.
" }, "nextToken":{ "shape":"NextToken", "documentation":"A pagination token. If non-null, the pagination token is returned in a result. Pass its value in another request to retrieve more entries.
" } }, "documentation":"The result structure for the list webhooks request.
" }, "LogUrl":{ "type":"string", "max":1000 }, "MD5Hash":{ "type":"string", "max":32 }, "MaxResults":{ "type":"integer", "max":100, "min":0 }, "Name":{ "type":"string", "max":255, "min":1 }, "NextToken":{ "type":"string", "max":2000 }, "NotFoundException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"An entity was not found during an operation.
", "error":{"httpStatusCode":404}, "exception":true }, "OauthToken":{ "type":"string", "max":1000, "sensitive":true }, "Platform":{ "type":"string", "enum":["WEB"] }, "ProductionBranch":{ "type":"structure", "members":{ "lastDeployTime":{ "shape":"LastDeployTime", "documentation":"The last deploy time of the production branch.
" }, "status":{ "shape":"Status", "documentation":"The status of the production branch.
" }, "thumbnailUrl":{ "shape":"ThumbnailUrl", "documentation":"The thumbnail URL for the production branch.
" }, "branchName":{ "shape":"BranchName", "documentation":"The branch name for the production branch.
" } }, "documentation":"Describes the information about a production branch for an Amplify app.
" }, "PullRequestEnvironmentName":{ "type":"string", "max":20 }, "Repository":{ "type":"string", "max":1000 }, "ResourceArn":{ "type":"string", "pattern":"^arn:aws:amplify:.*" }, "ResourceNotFoundException":{ "type":"structure", "required":[ "code", "message" ], "members":{ "code":{"shape":"Code"}, "message":{"shape":"ErrorMessage"} }, "documentation":"An operation failed due to a non-existent resource.
", "error":{"httpStatusCode":404}, "exception":true }, "Screenshots":{ "type":"map", "key":{"shape":"ThumbnailName"}, "value":{"shape":"ThumbnailUrl"} }, "ServiceRoleArn":{ "type":"string", "max":1000, "min":1 }, "Source":{ "type":"string", "max":2048, "min":1 }, "SourceUrl":{ "type":"string", "max":1000 }, "StackName":{ "type":"string", "max":255, "min":1 }, "Stage":{ "type":"string", "enum":[ "PRODUCTION", "BETA", "DEVELOPMENT", "EXPERIMENTAL", "PULL_REQUEST" ] }, "StartDeploymentRequest":{ "type":"structure", "required":[ "appId", "branchName" ], "members":{ "appId":{ "shape":"AppId", "documentation":"The unique ID for an Amplify app.
", "location":"uri", "locationName":"appId" }, "branchName":{ "shape":"BranchName", "documentation":"The name for the branch, for the job.
", "location":"uri", "locationName":"branchName" }, "jobId":{ "shape":"JobId", "documentation":"The job ID for this deployment, generated by the create deployment request.
" }, "sourceUrl":{ "shape":"SourceUrl", "documentation":"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.
" } }, "documentation":"The request structure for the start a deployment request.
" }, "StartDeploymentResult":{ "type":"structure", "required":["jobSummary"], "members":{ "jobSummary":{ "shape":"JobSummary", "documentation":"The summary for the job.
" } }, "documentation":"The result structure for the start a deployment request.
" }, "StartJobRequest":{ "type":"structure", "required":[ "appId", "branchName", "jobType" ], "members":{ "appId":{ "shape":"AppId", "documentation":"The unique ID for an Amplify app.
", "location":"uri", "locationName":"appId" }, "branchName":{ "shape":"BranchName", "documentation":"The branch name for the job.
", "location":"uri", "locationName":"branchName" }, "jobId":{ "shape":"JobId", "documentation":" The unique ID for an existing job. This is required if the value of jobType
is RETRY
.
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.
A descriptive reason for starting this job.
" }, "commitId":{ "shape":"CommitId", "documentation":"The commit ID from a third-party repository provider for the job.
" }, "commitMessage":{ "shape":"CommitMessage", "documentation":"The commit message from a third-party repository provider for the job.
" }, "commitTime":{ "shape":"CommitTime", "documentation":"The commit date and time for the job.
" } }, "documentation":"The request structure for the start job request.
" }, "StartJobResult":{ "type":"structure", "required":["jobSummary"], "members":{ "jobSummary":{ "shape":"JobSummary", "documentation":"The summary for the job.
" } }, "documentation":"The result structure for the run job request.
" }, "StartTime":{"type":"timestamp"}, "Status":{ "type":"string", "max":7, "min":3 }, "StatusReason":{ "type":"string", "max":1000 }, "Step":{ "type":"structure", "required":[ "stepName", "startTime", "status", "endTime" ], "members":{ "stepName":{ "shape":"StepName", "documentation":"The name of the execution step.
" }, "startTime":{ "shape":"StartTime", "documentation":"The start date and time of the execution step.
" }, "status":{ "shape":"JobStatus", "documentation":"The status of the execution step.
" }, "endTime":{ "shape":"EndTime", "documentation":"The end date and time of the execution step.
" }, "logUrl":{ "shape":"LogUrl", "documentation":"The URL to the logs for the execution step.
" }, "artifactsUrl":{ "shape":"ArtifactsUrl", "documentation":"The URL to the artifact for the execution step.
" }, "testArtifactsUrl":{ "shape":"TestArtifactsUrl", "documentation":"The URL to the test artifact for the execution step.
" }, "testConfigUrl":{ "shape":"TestConfigUrl", "documentation":"The URL to the test configuration for the execution step.
" }, "screenshots":{ "shape":"Screenshots", "documentation":"The list of screenshot URLs for the execution step, if relevant.
" }, "statusReason":{ "shape":"StatusReason", "documentation":"The reason for the current step status.
" }, "context":{ "shape":"Context", "documentation":"The context for the current step. Includes a build image if the step is build.
" } }, "documentation":"Describes an execution step, for an execution job, for an Amplify app.
" }, "StepName":{ "type":"string", "max":255 }, "Steps":{ "type":"list", "member":{"shape":"Step"} }, "StopJobRequest":{ "type":"structure", "required":[ "appId", "branchName", "jobId" ], "members":{ "appId":{ "shape":"AppId", "documentation":"The unique ID for an Amplify app.
", "location":"uri", "locationName":"appId" }, "branchName":{ "shape":"BranchName", "documentation":"The name for the branch, for the job.
", "location":"uri", "locationName":"branchName" }, "jobId":{ "shape":"JobId", "documentation":"The unique id for the job.
", "location":"uri", "locationName":"jobId" } }, "documentation":"The request structure for the stop job request.
" }, "StopJobResult":{ "type":"structure", "required":["jobSummary"], "members":{ "jobSummary":{ "shape":"JobSummary", "documentation":"The summary for the job.
" } }, "documentation":"The result structure for the stop job request.
" }, "SubDomain":{ "type":"structure", "required":[ "subDomainSetting", "verified", "dnsRecord" ], "members":{ "subDomainSetting":{ "shape":"SubDomainSetting", "documentation":"Describes the settings for the subdomain.
" }, "verified":{ "shape":"Verified", "documentation":"The verified status of the subdomain
" }, "dnsRecord":{ "shape":"DNSRecord", "documentation":"The DNS record for the subdomain.
" } }, "documentation":"The subdomain for the domain association.
" }, "SubDomainSetting":{ "type":"structure", "required":[ "prefix", "branchName" ], "members":{ "prefix":{ "shape":"DomainPrefix", "documentation":"The prefix setting for the subdomain.
" }, "branchName":{ "shape":"BranchName", "documentation":"The branch name setting for the subdomain.
" } }, "documentation":"Describes the settings for the subdomain.
" }, "SubDomainSettings":{ "type":"list", "member":{"shape":"SubDomainSetting"}, "max":255 }, "SubDomains":{ "type":"list", "member":{"shape":"SubDomain"}, "max":255 }, "TTL":{ "type":"string", "documentation":"The content Time to Live (TTL) for the website in seconds.
" }, "TagKey":{ "type":"string", "max":128, "min":1, "pattern":"^(?!aws:)[a-zA-Z+-=._:/]+$" }, "TagKeyList":{ "type":"list", "member":{"shape":"TagKey"}, "max":50, "min":1 }, "TagMap":{ "type":"map", "key":{"shape":"TagKey"}, "value":{"shape":"TagValue"}, "max":50, "min":1 }, "TagResourceRequest":{ "type":"structure", "required":[ "resourceArn", "tags" ], "members":{ "resourceArn":{ "shape":"ResourceArn", "documentation":"The Amazon Resource Name (ARN) to use to tag a resource.
", "location":"uri", "locationName":"resourceArn" }, "tags":{ "shape":"TagMap", "documentation":"The tags used to tag the resource.
" } }, "documentation":"The request structure to tag a resource with a tag key and value.
" }, "TagResourceResponse":{ "type":"structure", "members":{ }, "documentation":"The response for the tag resource request.
" }, "TagValue":{ "type":"string", "max":256 }, "Target":{ "type":"string", "max":2048, "min":1 }, "TestArtifactsUrl":{ "type":"string", "max":1000 }, "TestConfigUrl":{ "type":"string", "max":1000 }, "ThumbnailName":{ "type":"string", "max":256 }, "ThumbnailUrl":{ "type":"string", "max":2000, "min":1 }, "TotalNumberOfJobs":{ "type":"string", "max":1000 }, "UnauthorizedException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"An operation failed due to a lack of access.
", "error":{"httpStatusCode":401}, "exception":true }, "UntagResourceRequest":{ "type":"structure", "required":[ "resourceArn", "tagKeys" ], "members":{ "resourceArn":{ "shape":"ResourceArn", "documentation":"The Amazon Resource Name (ARN) to use to untag a resource.
", "location":"uri", "locationName":"resourceArn" }, "tagKeys":{ "shape":"TagKeyList", "documentation":"The tag keys to use to untag a resource.
", "location":"querystring", "locationName":"tagKeys" } }, "documentation":"The request structure for the untag resource request.
" }, "UntagResourceResponse":{ "type":"structure", "members":{ }, "documentation":"The response for the untag resource request.
" }, "UpdateAppRequest":{ "type":"structure", "required":["appId"], "members":{ "appId":{ "shape":"AppId", "documentation":"The unique ID for an Amplify app.
", "location":"uri", "locationName":"appId" }, "name":{ "shape":"Name", "documentation":"The name for an Amplify app.
" }, "description":{ "shape":"Description", "documentation":"The description for an Amplify app.
" }, "platform":{ "shape":"Platform", "documentation":"The platform for an Amplify app.
" }, "iamServiceRoleArn":{ "shape":"ServiceRoleArn", "documentation":"The AWS Identity and Access Management (IAM) service role for an Amplify app.
" }, "environmentVariables":{ "shape":"EnvironmentVariables", "documentation":"The environment variables for an Amplify app.
" }, "enableBranchAutoBuild":{ "shape":"EnableAutoBuild", "documentation":"Enables branch auto-building for an Amplify app.
" }, "enableBranchAutoDeletion":{ "shape":"EnableBranchAutoDeletion", "documentation":"Automatically disconnects a branch in the Amplify Console when you delete a branch from your Git repository.
" }, "enableBasicAuth":{ "shape":"EnableBasicAuth", "documentation":"Enables basic authorization for an Amplify app.
" }, "basicAuthCredentials":{ "shape":"BasicAuthCredentials", "documentation":"The basic authorization credentials for an Amplify app.
" }, "customRules":{ "shape":"CustomRules", "documentation":"The custom redirect and rewrite rules for an Amplify app.
" }, "buildSpec":{ "shape":"BuildSpec", "documentation":"The build specification (build spec) for an Amplify app.
" }, "customHeaders":{ "shape":"CustomHeaders", "documentation":"The custom HTTP headers for an Amplify app.
" }, "enableAutoBranchCreation":{ "shape":"EnableAutoBranchCreation", "documentation":"Enables automated branch creation for an Amplify app.
" }, "autoBranchCreationPatterns":{ "shape":"AutoBranchCreationPatterns", "documentation":"Describes the automated branch creation glob patterns for an Amplify app.
" }, "autoBranchCreationConfig":{ "shape":"AutoBranchCreationConfig", "documentation":"The automated branch creation configuration for an Amplify app.
" }, "repository":{ "shape":"Repository", "documentation":"The name of the repository for an Amplify app
" }, "oauthToken":{ "shape":"OauthToken", "documentation":"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.
" }, "accessToken":{ "shape":"AccessToken", "documentation":"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.
" } }, "documentation":"The request structure for the update app request.
" }, "UpdateAppResult":{ "type":"structure", "required":["app"], "members":{ "app":{ "shape":"App", "documentation":"Represents the updated Amplify app.
" } }, "documentation":"The result structure for an Amplify app update request.
" }, "UpdateBranchRequest":{ "type":"structure", "required":[ "appId", "branchName" ], "members":{ "appId":{ "shape":"AppId", "documentation":"The unique ID for an Amplify app.
", "location":"uri", "locationName":"appId" }, "branchName":{ "shape":"BranchName", "documentation":"The name for the branch.
", "location":"uri", "locationName":"branchName" }, "description":{ "shape":"Description", "documentation":"The description for the branch.
" }, "framework":{ "shape":"Framework", "documentation":"The framework for the branch.
" }, "stage":{ "shape":"Stage", "documentation":"Describes the current stage for the branch.
" }, "enableNotification":{ "shape":"EnableNotification", "documentation":"Enables notifications for the branch.
" }, "enableAutoBuild":{ "shape":"EnableAutoBuild", "documentation":"Enables auto building for the branch.
" }, "environmentVariables":{ "shape":"EnvironmentVariables", "documentation":"The environment variables for the branch.
" }, "basicAuthCredentials":{ "shape":"BasicAuthCredentials", "documentation":"The basic authorization credentials for the branch.
" }, "enableBasicAuth":{ "shape":"EnableBasicAuth", "documentation":"Enables basic authorization for the branch.
" }, "enablePerformanceMode":{ "shape":"EnablePerformanceMode", "documentation":"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.
" }, "buildSpec":{ "shape":"BuildSpec", "documentation":"The build specification (build spec) for the branch.
" }, "ttl":{ "shape":"TTL", "documentation":"The content Time to Live (TTL) for the website in seconds.
" }, "displayName":{ "shape":"DisplayName", "documentation":"The display name for a branch. This is used as the default domain prefix.
" }, "enablePullRequestPreview":{ "shape":"EnablePullRequestPreview", "documentation":"Enables pull request previews for this branch.
" }, "pullRequestEnvironmentName":{ "shape":"PullRequestEnvironmentName", "documentation":"The Amplify environment name for the pull request.
" }, "backendEnvironmentArn":{ "shape":"BackendEnvironmentArn", "documentation":"The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.
" } }, "documentation":"The request structure for the update branch request.
" }, "UpdateBranchResult":{ "type":"structure", "required":["branch"], "members":{ "branch":{ "shape":"Branch", "documentation":"The branch for an Amplify app, which maps to a third-party repository branch.
" } }, "documentation":"The result structure for the update branch request.
" }, "UpdateDomainAssociationRequest":{ "type":"structure", "required":[ "appId", "domainName", "subDomainSettings" ], "members":{ "appId":{ "shape":"AppId", "documentation":"The unique ID for an Amplify app.
", "location":"uri", "locationName":"appId" }, "domainName":{ "shape":"DomainName", "documentation":"The name of the domain.
", "location":"uri", "locationName":"domainName" }, "enableAutoSubDomain":{ "shape":"EnableAutoSubDomain", "documentation":"Enables the automated creation of subdomains for branches.
" }, "subDomainSettings":{ "shape":"SubDomainSettings", "documentation":"Describes the settings for the subdomain.
" }, "autoSubDomainCreationPatterns":{ "shape":"AutoSubDomainCreationPatterns", "documentation":"Sets the branch patterns for automatic subdomain creation.
" }, "autoSubDomainIAMRole":{ "shape":"AutoSubDomainIAMRole", "documentation":"The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.
" } }, "documentation":"The request structure for the update domain association request.
" }, "UpdateDomainAssociationResult":{ "type":"structure", "required":["domainAssociation"], "members":{ "domainAssociation":{ "shape":"DomainAssociation", "documentation":"Describes a domain association, which associates a custom domain with an Amplify app.
" } }, "documentation":"The result structure for the update domain association request.
" }, "UpdateTime":{"type":"timestamp"}, "UpdateWebhookRequest":{ "type":"structure", "required":["webhookId"], "members":{ "webhookId":{ "shape":"WebhookId", "documentation":"The unique ID for a webhook.
", "location":"uri", "locationName":"webhookId" }, "branchName":{ "shape":"BranchName", "documentation":"The name for a branch that is part of an Amplify app.
" }, "description":{ "shape":"Description", "documentation":"The description for a webhook.
" } }, "documentation":"The request structure for the update webhook request.
" }, "UpdateWebhookResult":{ "type":"structure", "required":["webhook"], "members":{ "webhook":{ "shape":"Webhook", "documentation":"Describes a webhook that connects repository events to an Amplify app.
" } }, "documentation":"The result structure for the update webhook request.
" }, "UploadUrl":{ "type":"string", "max":1000 }, "Verified":{"type":"boolean"}, "Webhook":{ "type":"structure", "required":[ "webhookArn", "webhookId", "webhookUrl", "branchName", "description", "createTime", "updateTime" ], "members":{ "webhookArn":{ "shape":"WebhookArn", "documentation":"The Amazon Resource Name (ARN) for the webhook.
" }, "webhookId":{ "shape":"WebhookId", "documentation":"The ID of the webhook.
" }, "webhookUrl":{ "shape":"WebhookUrl", "documentation":"The URL of the webhook.
" }, "branchName":{ "shape":"BranchName", "documentation":"The name for a branch that is part of an Amplify app.
" }, "description":{ "shape":"Description", "documentation":"The description for a webhook.
" }, "createTime":{ "shape":"CreateTime", "documentation":"The create date and time for a webhook.
" }, "updateTime":{ "shape":"UpdateTime", "documentation":"Updates the date and time for a webhook.
" } }, "documentation":"Describes a webhook that connects repository events to an Amplify app.
" }, "WebhookArn":{ "type":"string", "max":1000 }, "WebhookId":{ "type":"string", "max":255 }, "WebhookUrl":{ "type":"string", "max":1000 }, "Webhooks":{ "type":"list", "member":{"shape":"Webhook"} } }, "documentation":"Amplify enables developers to develop and deploy cloud-powered mobile and web apps. The Amplify Console provides a continuous delivery and hosting service for web applications. For more information, see the Amplify Console User Guide. The Amplify Framework is a comprehensive set of SDKs, libraries, tools, and documentation for client app development. For more information, see the Amplify Framework.
" }