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