{ "smithy": "2.0", "metadata": { "suppressions": [ { "id": "HttpMethodSemantics", "namespace": "*" }, { "id": "HttpResponseCodeSemantics", "namespace": "*" }, { "id": "PaginatedTrait", "namespace": "*" }, { "id": "HttpHeaderTrait", "namespace": "*" }, { "id": "HttpUriConflict", "namespace": "*" }, { "id": "Service", "namespace": "*" } ] }, "shapes": { "com.amazonaws.amplify#AccessToken": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 4096 }, "smithy.api#pattern": "^(?s).+$", "smithy.api#sensitive": {} } }, "com.amazonaws.amplify#ActiveJobId": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1000 } } }, "com.amazonaws.amplify#Amplify": { "type": "service", "version": "2017-07-25", "operations": [ { "target": "com.amazonaws.amplify#CreateApp" }, { "target": "com.amazonaws.amplify#CreateBackendEnvironment" }, { "target": "com.amazonaws.amplify#CreateBranch" }, { "target": "com.amazonaws.amplify#CreateDeployment" }, { "target": "com.amazonaws.amplify#CreateDomainAssociation" }, { "target": "com.amazonaws.amplify#CreateWebhook" }, { "target": "com.amazonaws.amplify#DeleteApp" }, { "target": "com.amazonaws.amplify#DeleteBackendEnvironment" }, { "target": "com.amazonaws.amplify#DeleteBranch" }, { "target": "com.amazonaws.amplify#DeleteDomainAssociation" }, { "target": "com.amazonaws.amplify#DeleteJob" }, { "target": "com.amazonaws.amplify#DeleteWebhook" }, { "target": "com.amazonaws.amplify#GenerateAccessLogs" }, { "target": "com.amazonaws.amplify#GetApp" }, { "target": "com.amazonaws.amplify#GetArtifactUrl" }, { "target": "com.amazonaws.amplify#GetBackendEnvironment" }, { "target": "com.amazonaws.amplify#GetBranch" }, { "target": "com.amazonaws.amplify#GetDomainAssociation" }, { "target": "com.amazonaws.amplify#GetJob" }, { "target": "com.amazonaws.amplify#GetWebhook" }, { "target": "com.amazonaws.amplify#ListApps" }, { "target": "com.amazonaws.amplify#ListArtifacts" }, { "target": "com.amazonaws.amplify#ListBackendEnvironments" }, { "target": "com.amazonaws.amplify#ListBranches" }, { "target": "com.amazonaws.amplify#ListDomainAssociations" }, { "target": "com.amazonaws.amplify#ListJobs" }, { "target": "com.amazonaws.amplify#ListTagsForResource" }, { "target": "com.amazonaws.amplify#ListWebhooks" }, { "target": "com.amazonaws.amplify#StartDeployment" }, { "target": "com.amazonaws.amplify#StartJob" }, { "target": "com.amazonaws.amplify#StopJob" }, { "target": "com.amazonaws.amplify#TagResource" }, { "target": "com.amazonaws.amplify#UntagResource" }, { "target": "com.amazonaws.amplify#UpdateApp" }, { "target": "com.amazonaws.amplify#UpdateBranch" }, { "target": "com.amazonaws.amplify#UpdateDomainAssociation" }, { "target": "com.amazonaws.amplify#UpdateWebhook" } ], "traits": { "aws.api#service": { "sdkId": "Amplify", "arnNamespace": "amplify", "cloudFormationName": "Amplify", "cloudTrailEventSource": "amplify.amazonaws.com", "endpointPrefix": "amplify" }, "aws.auth#sigv4": { "name": "amplify" }, "aws.protocols#restJson1": {}, "smithy.api#documentation": "
Amplify enables developers to develop and deploy cloud-powered mobile and web apps.\n Amplify Hosting provides a continuous delivery and hosting service for web applications.\n For more information, see the Amplify Hosting User Guide. The\n Amplify Framework is a comprehensive set of SDKs, libraries, tools, and documentation\n for client app development. For more information, see the Amplify Framework.\n
", "smithy.api#title": "AWS Amplify", "smithy.api#xmlNamespace": { "uri": "http://amplify.amazonaws.com" }, "smithy.rules#endpointBdd": { "version": "1.1", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "results": [ { "conditions": [], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://amplify-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://amplify-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://amplify.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://amplify.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "root": 2, "nodeCount": 13, "nodes": "/////wAAAAH/////AAAAAAAAAAwAAAADAAAAAQAAAAQF9eELAAAAAgAAAAUF9eELAAAAAwAAAAgAAAAGAAAABAAAAAcF9eEKAAAABQX14QgF9eEJAAAABAAAAAoAAAAJAAAABgX14QYF9eEHAAAABQAAAAsF9eEFAAAABgX14QQF9eEFAAAAAwX14QEAAAANAAAABAX14QIF9eED" }, "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] } ], "rules": [ { "conditions": [ { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] } ] }, { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://amplify-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://amplify-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://amplify.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } ], "type": "tree" }, { "conditions": [], "endpoint": { "url": "https://amplify.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ] }, "smithy.rules#endpointTests": { "testCases": [ { "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://amplify.ap-east-1.amazonaws.com" } }, "params": { "Region": "ap-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://amplify.ap-northeast-1.amazonaws.com" } }, "params": { "Region": "ap-northeast-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://amplify.ap-northeast-2.amazonaws.com" } }, "params": { "Region": "ap-northeast-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://amplify.ap-south-1.amazonaws.com" } }, "params": { "Region": "ap-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://amplify.ap-southeast-1.amazonaws.com" } }, "params": { "Region": "ap-southeast-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://amplify.ap-southeast-2.amazonaws.com" } }, "params": { "Region": "ap-southeast-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://amplify.ca-central-1.amazonaws.com" } }, "params": { "Region": "ca-central-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://amplify.eu-central-1.amazonaws.com" } }, "params": { "Region": "eu-central-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://amplify.eu-north-1.amazonaws.com" } }, "params": { "Region": "eu-north-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://amplify.eu-south-1.amazonaws.com" } }, "params": { "Region": "eu-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://amplify.eu-west-1.amazonaws.com" } }, "params": { "Region": "eu-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://amplify.eu-west-2.amazonaws.com" } }, "params": { "Region": "eu-west-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://amplify.eu-west-3.amazonaws.com" } }, "params": { "Region": "eu-west-3", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://amplify.me-south-1.amazonaws.com" } }, "params": { "Region": "me-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://amplify.sa-east-1.amazonaws.com" } }, "params": { "Region": "sa-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://amplify.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://amplify.us-east-2.amazonaws.com" } }, "params": { "Region": "us-east-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://amplify.us-west-1.amazonaws.com" } }, "params": { "Region": "us-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://amplify.us-west-2.amazonaws.com" } }, "params": { "Region": "us-west-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://amplify-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://amplify-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://amplify.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://amplify-fips.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://amplify-fips.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://amplify.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://amplify.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://amplify-fips.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://amplify-fips.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://amplify.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://amplify.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://amplify-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://amplify.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://amplify-fips.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://amplify.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips enabled and dualstack disabled", "expect": { "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips disabled and dualstack enabled", "expect": { "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true, "Endpoint": "https://example.com" } }, { "documentation": "Missing region", "expect": { "error": "Invalid Configuration: Missing Region" } } ], "version": "1.0" } } }, "com.amazonaws.amplify#App": { "type": "structure", "members": { "appId": { "target": "com.amazonaws.amplify#AppId", "traits": { "smithy.api#documentation": "The unique ID of the Amplify app.
", "smithy.api#required": {} } }, "appArn": { "target": "com.amazonaws.amplify#AppArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amplify app.
", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.amplify#Name", "traits": { "smithy.api#documentation": "The name for the Amplify app.
", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.amplify#TagMap", "traits": { "smithy.api#documentation": "The tag for the Amplify app.
" } }, "description": { "target": "com.amazonaws.amplify#Description", "traits": { "smithy.api#documentation": "The description for the Amplify app.
", "smithy.api#required": {} } }, "repository": { "target": "com.amazonaws.amplify#Repository", "traits": { "smithy.api#documentation": "The Git repository for the Amplify app.
", "smithy.api#required": {} } }, "platform": { "target": "com.amazonaws.amplify#Platform", "traits": { "smithy.api#documentation": "The platform for the Amplify app. For a static app, set the platform type to\n WEB. For a dynamic server-side rendered (SSR) app, set the platform\n type to WEB_COMPUTE. For an app requiring Amplify Hosting's original SSR\n support only, set the platform type to WEB_DYNAMIC.
If you are deploying an SSG only app with Next.js 14 or later, you must use the\n platform type WEB_COMPUTE.
A timestamp of when Amplify created the application.
", "smithy.api#required": {} } }, "updateTime": { "target": "com.amazonaws.amplify#UpdateTime", "traits": { "smithy.api#documentation": "A timestamp of when Amplify updated the application.
", "smithy.api#required": {} } }, "computeRoleArn": { "target": "com.amazonaws.amplify#ComputeRoleArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role for an SSR app. The\n Compute role allows the Amplify Hosting compute service to securely\n access specific Amazon Web Services resources based on the role's permissions. For more\n information about the SSR Compute role, see Adding an SSR Compute\n role in the \n Amplify User Guide.
" } }, "iamServiceRoleArn": { "target": "com.amazonaws.amplify#ServiceRoleArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM service role for the Amplify app.
" } }, "environmentVariables": { "target": "com.amazonaws.amplify#EnvironmentVariables", "traits": { "smithy.api#documentation": "The environment variables for the Amplify app.
\nFor a list of the environment variables that are accessible to Amplify by default, see\n Amplify\n Environment variables in the Amplify Hosting User\n Guide.
", "smithy.api#required": {} } }, "defaultDomain": { "target": "com.amazonaws.amplify#DefaultDomain", "traits": { "smithy.api#documentation": "The default domain for the Amplify app.
", "smithy.api#required": {} } }, "enableBranchAutoBuild": { "target": "com.amazonaws.amplify#EnableBranchAutoBuild", "traits": { "smithy.api#documentation": "Enables the auto-building of branches for the Amplify app.
", "smithy.api#required": {} } }, "enableBranchAutoDeletion": { "target": "com.amazonaws.amplify#EnableBranchAutoDeletion", "traits": { "smithy.api#documentation": "Automatically disconnect a branch in the Amplify console when you delete a branch from\n your Git repository.
" } }, "enableBasicAuth": { "target": "com.amazonaws.amplify#EnableBasicAuth", "traits": { "smithy.api#documentation": "Enables basic authorization for the Amplify app's branches.
", "smithy.api#required": {} } }, "basicAuthCredentials": { "target": "com.amazonaws.amplify#BasicAuthCredentials", "traits": { "smithy.api#documentation": "The basic authorization credentials for branches for the Amplify app. You must\n base64-encode the authorization credentials and provide them in the format\n user:password.
Describes the custom redirect and rewrite rules for the Amplify app.
" } }, "productionBranch": { "target": "com.amazonaws.amplify#ProductionBranch", "traits": { "smithy.api#documentation": "Describes the information about a production branch of the Amplify app.
" } }, "buildSpec": { "target": "com.amazonaws.amplify#BuildSpec", "traits": { "smithy.api#documentation": "Describes the content of the build specification (build spec) for the Amplify app.\n
" } }, "customHeaders": { "target": "com.amazonaws.amplify#CustomHeaders", "traits": { "smithy.api#documentation": "Describes the custom HTTP headers for the Amplify app.
" } }, "enableAutoBranchCreation": { "target": "com.amazonaws.amplify#EnableAutoBranchCreation", "traits": { "smithy.api#documentation": "Enables automated branch creation for the Amplify app.
" } }, "autoBranchCreationPatterns": { "target": "com.amazonaws.amplify#AutoBranchCreationPatterns", "traits": { "smithy.api#documentation": "Describes the automated branch creation glob patterns for the Amplify app.
" } }, "autoBranchCreationConfig": { "target": "com.amazonaws.amplify#AutoBranchCreationConfig", "traits": { "smithy.api#documentation": "Describes the automated branch creation configuration for the Amplify app.
" } }, "repositoryCloneMethod": { "target": "com.amazonaws.amplify#RepositoryCloneMethod", "traits": { "smithy.api#documentation": "This is for internal use.
\nThe Amplify service uses this parameter to specify the authentication protocol to use\n to access the Git repository for an Amplify app. Amplify specifies TOKEN\n for a GitHub repository, SIGV4 for an Amazon Web Services CodeCommit\n repository, and SSH for GitLab and Bitbucket repositories.
The cache configuration for the Amplify app. If you don't specify the\n cache configuration type, Amplify uses the default\n AMPLIFY_MANAGED setting.
A timestamp of when Amplify created the webhook in your Git\n repository.
" } }, "wafConfiguration": { "target": "com.amazonaws.amplify#WafConfiguration", "traits": { "smithy.api#documentation": "Describes the Firewall configuration for the Amplify app. Firewall\n support enables you to protect your hosted applications with a direct integration with\n WAF.
" } }, "jobConfig": { "target": "com.amazonaws.amplify#JobConfig", "traits": { "smithy.api#documentation": "The configuration details that apply to the jobs for an Amplify app.
" } } }, "traits": { "smithy.api#documentation": "Represents the different branches of a repository for building, deploying, and hosting\n an Amplify app.
" } }, "com.amazonaws.amplify#AppArn": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1000 } } }, "com.amazonaws.amplify#AppId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 20 }, "smithy.api#pattern": "^d[a-z0-9]+$" } }, "com.amazonaws.amplify#Apps": { "type": "list", "member": { "target": "com.amazonaws.amplify#App" } }, "com.amazonaws.amplify#Artifact": { "type": "structure", "members": { "artifactFileName": { "target": "com.amazonaws.amplify#ArtifactFileName", "traits": { "smithy.api#documentation": "The file name for the artifact.
", "smithy.api#required": {} } }, "artifactId": { "target": "com.amazonaws.amplify#ArtifactId", "traits": { "smithy.api#documentation": "The unique ID for the artifact.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Describes an artifact.
" } }, "com.amazonaws.amplify#ArtifactFileName": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1000 } } }, "com.amazonaws.amplify#ArtifactId": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 255 }, "smithy.api#pattern": "^(?s)" } }, "com.amazonaws.amplify#ArtifactUrl": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1000 } } }, "com.amazonaws.amplify#Artifacts": { "type": "list", "member": { "target": "com.amazonaws.amplify#Artifact" } }, "com.amazonaws.amplify#ArtifactsUrl": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1000 } } }, "com.amazonaws.amplify#AssociatedResource": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2048 } } }, "com.amazonaws.amplify#AssociatedResources": { "type": "list", "member": { "target": "com.amazonaws.amplify#AssociatedResource" } }, "com.amazonaws.amplify#AutoBranchCreationConfig": { "type": "structure", "members": { "stage": { "target": "com.amazonaws.amplify#Stage", "traits": { "smithy.api#documentation": "Describes the current stage for the autocreated branch.
" } }, "framework": { "target": "com.amazonaws.amplify#Framework", "traits": { "smithy.api#documentation": "The framework for the autocreated branch.
" } }, "enableAutoBuild": { "target": "com.amazonaws.amplify#EnableAutoBuild", "traits": { "smithy.api#documentation": "Enables auto building for the autocreated branch.
" } }, "environmentVariables": { "target": "com.amazonaws.amplify#EnvironmentVariables", "traits": { "smithy.api#documentation": "The environment variables for the autocreated branch.
" } }, "basicAuthCredentials": { "target": "com.amazonaws.amplify#BasicAuthCredentials", "traits": { "smithy.api#documentation": "The basic authorization credentials for the autocreated branch. You must base64-encode\n the authorization credentials and provide them in the format\n user:password.
Enables basic authorization for the autocreated branch.
" } }, "enablePerformanceMode": { "target": "com.amazonaws.amplify#EnablePerformanceMode", "traits": { "smithy.api#documentation": "Enables performance mode for the branch.
\nPerformance mode optimizes for faster hosting performance by keeping content cached at\n the edge for a longer interval. When performance mode is enabled, hosting configuration\n or code changes can take up to 10 minutes to roll out.
" } }, "buildSpec": { "target": "com.amazonaws.amplify#BuildSpec", "traits": { "smithy.api#documentation": "The build specification (build spec) for the autocreated branch.
" } }, "enablePullRequestPreview": { "target": "com.amazonaws.amplify#EnablePullRequestPreview", "traits": { "smithy.api#documentation": "Enables pull request previews for the autocreated branch.
" } }, "pullRequestEnvironmentName": { "target": "com.amazonaws.amplify#PullRequestEnvironmentName", "traits": { "smithy.api#documentation": "The Amplify environment name for the pull request.
" } } }, "traits": { "smithy.api#documentation": "Describes the automated branch creation configuration.
" } }, "com.amazonaws.amplify#AutoBranchCreationPattern": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2048 }, "smithy.api#pattern": "^(?s).+$" } }, "com.amazonaws.amplify#AutoBranchCreationPatterns": { "type": "list", "member": { "target": "com.amazonaws.amplify#AutoBranchCreationPattern" } }, "com.amazonaws.amplify#AutoSubDomainCreationPattern": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2048 }, "smithy.api#pattern": "^(?s).+$" } }, "com.amazonaws.amplify#AutoSubDomainCreationPatterns": { "type": "list", "member": { "target": "com.amazonaws.amplify#AutoSubDomainCreationPattern" } }, "com.amazonaws.amplify#AutoSubDomainIAMRole": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1000 }, "smithy.api#pattern": "^$|^arn:aws:iam::\\d{12}:role.+$" } }, "com.amazonaws.amplify#Backend": { "type": "structure", "members": { "stackArn": { "target": "com.amazonaws.amplify#StackArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) for the CloudFormation stack.
" } } }, "traits": { "smithy.api#documentation": "Describes the backend associated with an Amplify\n Branch.
This property is available to Amplify Gen 2 apps only. When you deploy\n an application with Amplify Gen 2, you provision the app's backend infrastructure using\n Typescript code.
" } }, "com.amazonaws.amplify#BackendEnvironment": { "type": "structure", "members": { "backendEnvironmentArn": { "target": "com.amazonaws.amplify#BackendEnvironmentArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify\n app.
", "smithy.api#required": {} } }, "environmentName": { "target": "com.amazonaws.amplify#EnvironmentName", "traits": { "smithy.api#documentation": "The name for a backend environment that is part of an Amplify app.
", "smithy.api#required": {} } }, "stackName": { "target": "com.amazonaws.amplify#StackName", "traits": { "smithy.api#documentation": "The AWS CloudFormation stack name of a backend environment.
" } }, "deploymentArtifacts": { "target": "com.amazonaws.amplify#DeploymentArtifacts", "traits": { "smithy.api#documentation": "The name of deployment artifacts.
" } }, "createTime": { "target": "com.amazonaws.amplify#CreateTime", "traits": { "smithy.api#documentation": "The creation date and time for a backend environment that is part of an Amplify app.\n
", "smithy.api#required": {} } }, "updateTime": { "target": "com.amazonaws.amplify#UpdateTime", "traits": { "smithy.api#documentation": "The last updated date and time for a backend environment that is part of an Amplify\n app.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Describes the backend environment associated with a Branch of a Gen 1\n Amplify app. Amplify Gen 1 applications are created\n using Amplify Studio or the Amplify command line interface\n (CLI).
A request contains unexpected data.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.amplify#BasicAuthCredentials": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 2000 }, "smithy.api#pattern": "^(?s)", "smithy.api#sensitive": {} } }, "com.amazonaws.amplify#Branch": { "type": "structure", "members": { "branchArn": { "target": "com.amazonaws.amplify#BranchArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) for a branch that is part of an Amplify app.
", "smithy.api#required": {} } }, "branchName": { "target": "com.amazonaws.amplify#BranchName", "traits": { "smithy.api#documentation": "The name for the branch that is part of an Amplify app.
", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.amplify#Description", "traits": { "smithy.api#documentation": "The description for the branch that is part of an Amplify app.
", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.amplify#TagMap", "traits": { "smithy.api#documentation": "The tag for the branch of an Amplify app.
" } }, "stage": { "target": "com.amazonaws.amplify#Stage", "traits": { "smithy.api#documentation": "The current stage for the branch that is part of an Amplify app.
", "smithy.api#required": {} } }, "displayName": { "target": "com.amazonaws.amplify#DisplayName", "traits": { "smithy.api#documentation": "The display name for the branch. This is used as the default domain prefix.
", "smithy.api#required": {} } }, "enableNotification": { "target": "com.amazonaws.amplify#EnableNotification", "traits": { "smithy.api#documentation": "Enables notifications for a branch that is part of an Amplify app.
", "smithy.api#required": {} } }, "createTime": { "target": "com.amazonaws.amplify#CreateTime", "traits": { "smithy.api#documentation": "A timestamp of when Amplify created the branch.
", "smithy.api#required": {} } }, "updateTime": { "target": "com.amazonaws.amplify#UpdateTime", "traits": { "smithy.api#documentation": "A timestamp for the last updated time for a branch.
", "smithy.api#required": {} } }, "environmentVariables": { "target": "com.amazonaws.amplify#EnvironmentVariables", "traits": { "smithy.api#documentation": "The environment variables specific to a branch of an Amplify app.
", "smithy.api#required": {} } }, "enableAutoBuild": { "target": "com.amazonaws.amplify#EnableAutoBuild", "traits": { "smithy.api#documentation": "Enables auto-building on push for a branch of an Amplify app.
", "smithy.api#required": {} } }, "enableSkewProtection": { "target": "com.amazonaws.amplify#EnableSkewProtection", "traits": { "smithy.api#documentation": "Specifies whether the skew protection feature is enabled for the branch.
\nDeployment skew protection is available to Amplify applications to\n eliminate version skew issues between client and servers in web applications. When you\n apply skew protection to a branch, you can ensure that your clients always interact with\n the correct version of server-side assets, regardless of when a deployment occurs. For\n more information about skew protection, see Skew protection for Amplify deployments in the \n Amplify User\n Guide.
" } }, "customDomains": { "target": "com.amazonaws.amplify#CustomDomains", "traits": { "smithy.api#documentation": "The custom domains for a branch of an Amplify app.
", "smithy.api#required": {} } }, "framework": { "target": "com.amazonaws.amplify#Framework", "traits": { "smithy.api#documentation": "The framework for a branch of an Amplify app.
", "smithy.api#required": {} } }, "activeJobId": { "target": "com.amazonaws.amplify#ActiveJobId", "traits": { "smithy.api#documentation": "The ID of the active job for a branch of an Amplify app.
", "smithy.api#required": {} } }, "totalNumberOfJobs": { "target": "com.amazonaws.amplify#TotalNumberOfJobs", "traits": { "smithy.api#documentation": "The total number of jobs that are part of an Amplify app.
", "smithy.api#required": {} } }, "enableBasicAuth": { "target": "com.amazonaws.amplify#EnableBasicAuth", "traits": { "smithy.api#documentation": "Enables basic authorization for a branch of an Amplify app.
", "smithy.api#required": {} } }, "enablePerformanceMode": { "target": "com.amazonaws.amplify#EnablePerformanceMode", "traits": { "smithy.api#documentation": "Enables performance mode for the branch.
\nPerformance mode optimizes for faster hosting performance by keeping content cached at\n the edge for a longer interval. When performance mode is enabled, hosting configuration\n or code changes can take up to 10 minutes to roll out.
" } }, "thumbnailUrl": { "target": "com.amazonaws.amplify#ThumbnailUrl", "traits": { "smithy.api#documentation": "The thumbnail URL for the branch of an Amplify app.
" } }, "basicAuthCredentials": { "target": "com.amazonaws.amplify#BasicAuthCredentials", "traits": { "smithy.api#documentation": " The basic authorization credentials for a branch of an Amplify app. You must\n base64-encode the authorization credentials and provide them in the format\n user:password.
The build specification (build spec) content for the branch of an Amplify app.\n
" } }, "ttl": { "target": "com.amazonaws.amplify#TTL", "traits": { "smithy.api#documentation": "The content Time to Live (TTL) for the website in seconds.
", "smithy.api#required": {} } }, "associatedResources": { "target": "com.amazonaws.amplify#AssociatedResources", "traits": { "smithy.api#documentation": "A list of custom resources that are linked to this branch.
" } }, "enablePullRequestPreview": { "target": "com.amazonaws.amplify#EnablePullRequestPreview", "traits": { "smithy.api#documentation": "Enables pull request previews for the branch.
", "smithy.api#required": {} } }, "pullRequestEnvironmentName": { "target": "com.amazonaws.amplify#PullRequestEnvironmentName", "traits": { "smithy.api#documentation": "The Amplify environment name for the pull request.
" } }, "destinationBranch": { "target": "com.amazonaws.amplify#BranchName", "traits": { "smithy.api#documentation": "The destination branch if the branch is a pull request branch.
" } }, "sourceBranch": { "target": "com.amazonaws.amplify#BranchName", "traits": { "smithy.api#documentation": "The source branch if the branch is a pull request branch.
" } }, "backendEnvironmentArn": { "target": "com.amazonaws.amplify#BackendEnvironmentArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.
\nThis property is available to Amplify Gen 1 apps only. When you deploy\n an application with Amplify Gen 2, you provision the app's backend infrastructure using\n Typescript code.
" } }, "backend": { "target": "com.amazonaws.amplify#Backend" }, "computeRoleArn": { "target": "com.amazonaws.amplify#ComputeRoleArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role for a branch of an SSR\n app. The Compute role allows the Amplify Hosting compute service to\n securely access specific Amazon Web Services resources based on the role's permissions.\n For more information about the SSR Compute role, see Adding an SSR Compute\n role in the \n Amplify User Guide.
" } } }, "traits": { "smithy.api#documentation": "The branch for an Amplify app, which maps to a third-party repository branch.
" } }, "com.amazonaws.amplify#BranchArn": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1000 }, "smithy.api#pattern": "^(?s)" } }, "com.amazonaws.amplify#BranchName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#pattern": "^(?s).+$" } }, "com.amazonaws.amplify#Branches": { "type": "list", "member": { "target": "com.amazonaws.amplify#Branch" }, "traits": { "smithy.api#length": { "min": 0, "max": 255 } } }, "com.amazonaws.amplify#BuildComputeType": { "type": "enum", "members": { "STANDARD_8GB": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "STANDARD_8GB" } }, "LARGE_16GB": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LARGE_16GB" } }, "XLARGE_72GB": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "XLARGE_72GB" } } } }, "com.amazonaws.amplify#BuildSpec": { "type": "string", "traits": { "smithy.api#documentation": "The build specification (build spec) file for an Amplify app build.
", "smithy.api#length": { "min": 1, "max": 25000 }, "smithy.api#pattern": "^(?s).+$", "smithy.api#sensitive": {} } }, "com.amazonaws.amplify#CacheConfig": { "type": "structure", "members": { "type": { "target": "com.amazonaws.amplify#CacheConfigType", "traits": { "smithy.api#documentation": "The type of cache configuration to use for an Amplify app.
\nThe AMPLIFY_MANAGED cache configuration automatically applies an\n optimized cache configuration for your app based on its platform, routing rules, and\n rewrite rules.
The AMPLIFY_MANAGED_NO_COOKIES cache configuration type is the same as\n AMPLIFY_MANAGED, except that it excludes all cookies from the cache\n key. This is the default setting.
Describes the cache configuration for an Amplify app.
\nFor more information about how Amplify applies an optimal cache\n configuration for your app based on the type of content that is being served, see Managing cache configuration in the \n Amplify User\n guide.
" } }, "com.amazonaws.amplify#CacheConfigType": { "type": "enum", "members": { "AMPLIFY_MANAGED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AMPLIFY_MANAGED" } }, "AMPLIFY_MANAGED_NO_COOKIES": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AMPLIFY_MANAGED_NO_COOKIES" } } } }, "com.amazonaws.amplify#Certificate": { "type": "structure", "members": { "type": { "target": "com.amazonaws.amplify#CertificateType", "traits": { "smithy.api#documentation": "The type of SSL/TLS certificate that you want to use.
\nSpecify AMPLIFY_MANAGED to use the default certificate that Amplify\n provisions for you.
Specify CUSTOM to use your own certificate that you have already added to\n Certificate Manager in your Amazon Web Services account. Make sure you request (or\n import) the certificate in the US East (N. Virginia) Region (us-east-1). For more\n information about using ACM, see Importing certificates into\n Certificate Manager\n in the \n ACM User\n guide.
The Amazon resource name (ARN) for a custom certificate that you have already added to\n Certificate Manager in your Amazon Web Services account.
\nThis field is required only when the certificate type is CUSTOM.
The DNS record for certificate verification.
" } } }, "traits": { "smithy.api#documentation": "Describes the current SSL/TLS certificate that is in use for the domain. If you are\n using CreateDomainAssociation to create a new domain association,\n Certificate describes the new certificate that you are creating.
The certificate type.
\nSpecify AMPLIFY_MANAGED to use the default certificate that Amplify\n provisions for you.
Specify CUSTOM to use your own certificate that you have already added to\n Certificate Manager in your Amazon Web Services account. Make sure you request (or\n import) the certificate in the US East (N. Virginia) Region (us-east-1). For more\n information about using ACM, see Importing certificates into\n Certificate Manager\n in the \n ACM User\n guide.
The Amazon resource name (ARN) for the custom certificate that you have already added\n to Certificate Manager in your Amazon Web Services account.
\nThis field is required only when the certificate type is CUSTOM.
The type of SSL/TLS certificate to use for your custom domain. If a certificate type\n isn't specified, Amplify uses the default AMPLIFY_MANAGED\n certificate.
Creates a new Amplify app.
", "smithy.api#http": { "method": "POST", "uri": "/apps", "code": 200 } } }, "com.amazonaws.amplify#CreateAppRequest": { "type": "structure", "members": { "name": { "target": "com.amazonaws.amplify#Name", "traits": { "smithy.api#documentation": "The name of the Amplify app.
", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.amplify#Description", "traits": { "smithy.api#documentation": "The description of the Amplify app.
" } }, "repository": { "target": "com.amazonaws.amplify#Repository", "traits": { "smithy.api#documentation": "The Git repository for the Amplify app.
" } }, "platform": { "target": "com.amazonaws.amplify#Platform", "traits": { "smithy.api#documentation": "The platform for the Amplify app. For a static app, set the platform type to\n WEB. For a dynamic server-side rendered (SSR) app, set the platform\n type to WEB_COMPUTE. For an app requiring Amplify Hosting's original SSR\n support only, set the platform type to WEB_DYNAMIC.
If you are deploying an SSG only app with Next.js version 14 or later, you must set\n the platform type to WEB_COMPUTE and set the artifacts\n baseDirectory to .next in the application's build\n settings. For an example of the build specification settings, see Amplify build settings for a Next.js 14 SSG application in the\n Amplify Hosting User Guide.
The Amazon Resource Name (ARN) of the IAM role to assign to an SSR app.\n The SSR Compute role allows the Amplify Hosting compute service to\n securely access specific Amazon Web Services resources based on the role's permissions.\n For more information about the SSR Compute role, see Adding an SSR Compute\n role in the \n Amplify User Guide.
" } }, "iamServiceRoleArn": { "target": "com.amazonaws.amplify#ServiceRoleArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM service role for the Amplify app.
" } }, "oauthToken": { "target": "com.amazonaws.amplify#OauthToken", "traits": { "smithy.api#documentation": "The OAuth token for a third-party source control system for an Amplify app. The OAuth\n token is used to create a webhook and a read-only deploy key using SSH cloning. The\n OAuth token is not stored.
\nUse oauthToken for repository providers other than GitHub, such as\n Bitbucket or CodeCommit. To authorize access to GitHub as your repository provider, use\n accessToken.
You must specify either oauthToken or accessToken when you\n create a new app.
Existing Amplify apps deployed from a GitHub repository using OAuth continue to work\n with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub\n App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the\n Amplify User Guide .
" } }, "accessToken": { "target": "com.amazonaws.amplify#AccessToken", "traits": { "smithy.api#documentation": "The personal access token for a GitHub repository for an Amplify app. The personal\n access token is used to authorize access to a GitHub repository using the Amplify GitHub\n App. The token is not stored.
\nUse accessToken for GitHub repositories only. To authorize access to a\n repository provider such as Bitbucket or CodeCommit, use oauthToken.
You must specify either accessToken or oauthToken when you\n create a new app.
Existing Amplify apps deployed from a GitHub repository using OAuth continue to work\n with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub\n App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the\n Amplify User Guide .
" } }, "environmentVariables": { "target": "com.amazonaws.amplify#EnvironmentVariables", "traits": { "smithy.api#documentation": "The environment variables map for an Amplify app.
\nFor a list of the environment variables that are accessible to Amplify by default, see\n Amplify\n Environment variables in the Amplify Hosting User\n Guide.
" } }, "enableBranchAutoBuild": { "target": "com.amazonaws.amplify#EnableBranchAutoBuild", "traits": { "smithy.api#documentation": "Enables the auto building of branches for an Amplify app.
" } }, "enableBranchAutoDeletion": { "target": "com.amazonaws.amplify#EnableBranchAutoDeletion", "traits": { "smithy.api#documentation": "Automatically disconnects a branch in the Amplify console when you delete a branch\n from your Git repository.
" } }, "enableBasicAuth": { "target": "com.amazonaws.amplify#EnableBasicAuth", "traits": { "smithy.api#documentation": "Enables basic authorization for an Amplify app. This will apply to all branches that\n are part of this app.
" } }, "basicAuthCredentials": { "target": "com.amazonaws.amplify#BasicAuthCredentials", "traits": { "smithy.api#documentation": "The credentials for basic authorization for an Amplify app. You must base64-encode the\n authorization credentials and provide them in the format\n user:password.
The custom rewrite and redirect rules for an Amplify app.
" } }, "tags": { "target": "com.amazonaws.amplify#TagMap", "traits": { "smithy.api#documentation": "The tag for an Amplify app.
" } }, "buildSpec": { "target": "com.amazonaws.amplify#BuildSpec", "traits": { "smithy.api#documentation": "The build specification (build spec) for an Amplify app.
" } }, "customHeaders": { "target": "com.amazonaws.amplify#CustomHeaders", "traits": { "smithy.api#documentation": "The custom HTTP headers for an Amplify app.
" } }, "enableAutoBranchCreation": { "target": "com.amazonaws.amplify#EnableAutoBranchCreation", "traits": { "smithy.api#documentation": "Enables automated branch creation for an Amplify app.
" } }, "autoBranchCreationPatterns": { "target": "com.amazonaws.amplify#AutoBranchCreationPatterns", "traits": { "smithy.api#documentation": "The automated branch creation glob patterns for an Amplify app.
" } }, "autoBranchCreationConfig": { "target": "com.amazonaws.amplify#AutoBranchCreationConfig", "traits": { "smithy.api#documentation": "The automated branch creation configuration for an Amplify app.
" } }, "jobConfig": { "target": "com.amazonaws.amplify#JobConfig", "traits": { "smithy.api#documentation": "Describes the configuration details that apply to the jobs for an Amplify app.
" } }, "cacheConfig": { "target": "com.amazonaws.amplify#CacheConfig", "traits": { "smithy.api#documentation": "The cache configuration for the Amplify app.
" } } }, "traits": { "smithy.api#documentation": "The request structure used to create apps in Amplify.
", "smithy.api#input": {} } }, "com.amazonaws.amplify#CreateAppResult": { "type": "structure", "members": { "app": { "target": "com.amazonaws.amplify#App", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.amplify#CreateBackendEnvironment": { "type": "operation", "input": { "target": "com.amazonaws.amplify#CreateBackendEnvironmentRequest" }, "output": { "target": "com.amazonaws.amplify#CreateBackendEnvironmentResult" }, "errors": [ { "target": "com.amazonaws.amplify#BadRequestException" }, { "target": "com.amazonaws.amplify#InternalFailureException" }, { "target": "com.amazonaws.amplify#LimitExceededException" }, { "target": "com.amazonaws.amplify#NotFoundException" }, { "target": "com.amazonaws.amplify#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Creates a new backend environment for an Amplify app.
\nThis API is available only to Amplify Gen 1 applications where the\n backend is created using Amplify Studio or the Amplify\n command line interface (CLI). This API isn\u2019t available to Amplify Gen 2\n applications. When you deploy an application with Amplify Gen 2, you provision the app's\n backend infrastructure using Typescript code.
", "smithy.api#http": { "method": "POST", "uri": "/apps/{appId}/backendenvironments", "code": 200 } } }, "com.amazonaws.amplify#CreateBackendEnvironmentRequest": { "type": "structure", "members": { "appId": { "target": "com.amazonaws.amplify#AppId", "traits": { "smithy.api#documentation": "The unique ID for an Amplify app.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "environmentName": { "target": "com.amazonaws.amplify#EnvironmentName", "traits": { "smithy.api#documentation": "The name for the backend environment.
", "smithy.api#required": {} } }, "stackName": { "target": "com.amazonaws.amplify#StackName", "traits": { "smithy.api#documentation": "The AWS CloudFormation stack name of a backend environment.
" } }, "deploymentArtifacts": { "target": "com.amazonaws.amplify#DeploymentArtifacts", "traits": { "smithy.api#documentation": "The name of deployment artifacts.
" } } }, "traits": { "smithy.api#documentation": "The request structure for the backend environment create request.
", "smithy.api#input": {} } }, "com.amazonaws.amplify#CreateBackendEnvironmentResult": { "type": "structure", "members": { "backendEnvironment": { "target": "com.amazonaws.amplify#BackendEnvironment", "traits": { "smithy.api#documentation": "Describes the backend environment for an Amplify app.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The result structure for the create backend environment request.
", "smithy.api#output": {} } }, "com.amazonaws.amplify#CreateBranch": { "type": "operation", "input": { "target": "com.amazonaws.amplify#CreateBranchRequest" }, "output": { "target": "com.amazonaws.amplify#CreateBranchResult" }, "errors": [ { "target": "com.amazonaws.amplify#BadRequestException" }, { "target": "com.amazonaws.amplify#DependentServiceFailureException" }, { "target": "com.amazonaws.amplify#InternalFailureException" }, { "target": "com.amazonaws.amplify#LimitExceededException" }, { "target": "com.amazonaws.amplify#NotFoundException" }, { "target": "com.amazonaws.amplify#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Creates a new branch for an Amplify app.
", "smithy.api#http": { "method": "POST", "uri": "/apps/{appId}/branches", "code": 200 } } }, "com.amazonaws.amplify#CreateBranchRequest": { "type": "structure", "members": { "appId": { "target": "com.amazonaws.amplify#AppId", "traits": { "smithy.api#documentation": "The unique ID for an Amplify app.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "branchName": { "target": "com.amazonaws.amplify#BranchName", "traits": { "smithy.api#documentation": "The name for the branch.
", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.amplify#Description", "traits": { "smithy.api#documentation": "The description for the branch.
" } }, "stage": { "target": "com.amazonaws.amplify#Stage", "traits": { "smithy.api#documentation": "Describes the current stage for the branch.
" } }, "framework": { "target": "com.amazonaws.amplify#Framework", "traits": { "smithy.api#documentation": "The framework for the branch.
" } }, "enableNotification": { "target": "com.amazonaws.amplify#EnableNotification", "traits": { "smithy.api#documentation": "Enables notifications for the branch.
" } }, "enableAutoBuild": { "target": "com.amazonaws.amplify#EnableAutoBuild", "traits": { "smithy.api#documentation": "Enables auto building for the branch.
" } }, "enableSkewProtection": { "target": "com.amazonaws.amplify#EnableSkewProtection", "traits": { "smithy.api#documentation": "Specifies whether the skew protection feature is enabled for the branch.
\nDeployment skew protection is available to Amplify applications to\n eliminate version skew issues between client and servers in web applications. When you\n apply skew protection to a branch, you can ensure that your clients always interact with\n the correct version of server-side assets, regardless of when a deployment occurs. For\n more information about skew protection, see Skew protection for Amplify deployments in the \n Amplify User\n Guide.
" } }, "environmentVariables": { "target": "com.amazonaws.amplify#EnvironmentVariables", "traits": { "smithy.api#documentation": "The environment variables for the branch.
" } }, "basicAuthCredentials": { "target": "com.amazonaws.amplify#BasicAuthCredentials", "traits": { "smithy.api#documentation": " The basic authorization credentials for the branch. You must base64-encode the\n authorization credentials and provide them in the format\n user:password.
Enables basic authorization for the branch.
" } }, "enablePerformanceMode": { "target": "com.amazonaws.amplify#EnablePerformanceMode", "traits": { "smithy.api#documentation": "Enables performance mode for the branch.
\nPerformance mode optimizes for faster hosting performance by keeping content cached at\n the edge for a longer interval. When performance mode is enabled, hosting configuration\n or code changes can take up to 10 minutes to roll out.
" } }, "tags": { "target": "com.amazonaws.amplify#TagMap", "traits": { "smithy.api#documentation": "The tag for the branch.
" } }, "buildSpec": { "target": "com.amazonaws.amplify#BuildSpec", "traits": { "smithy.api#documentation": "The build specification (build spec) for the branch.
" } }, "ttl": { "target": "com.amazonaws.amplify#TTL", "traits": { "smithy.api#documentation": "The content Time To Live (TTL) for the website in seconds.
" } }, "displayName": { "target": "com.amazonaws.amplify#DisplayName", "traits": { "smithy.api#documentation": "The display name for a branch. This is used as the default domain prefix.
" } }, "enablePullRequestPreview": { "target": "com.amazonaws.amplify#EnablePullRequestPreview", "traits": { "smithy.api#documentation": "Enables pull request previews for this branch.
" } }, "pullRequestEnvironmentName": { "target": "com.amazonaws.amplify#PullRequestEnvironmentName", "traits": { "smithy.api#documentation": "The Amplify environment name for the pull request.
" } }, "backendEnvironmentArn": { "target": "com.amazonaws.amplify#BackendEnvironmentArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) for a backend environment that is part of a Gen 1\n Amplify app.
\nThis field is available to Amplify Gen 1 apps only where the backend is\n created using Amplify Studio or the Amplify command line\n interface (CLI).
" } }, "backend": { "target": "com.amazonaws.amplify#Backend", "traits": { "smithy.api#documentation": "The backend for a Branch of an Amplify app. Use for a\n backend created from an CloudFormation stack.
This field is available to Amplify Gen 2 apps only. When you deploy an\n application with Amplify Gen 2, you provision the app's backend infrastructure using\n Typescript code.
" } }, "computeRoleArn": { "target": "com.amazonaws.amplify#ComputeRoleArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role to assign to a branch of\n an SSR app. The SSR Compute role allows the Amplify Hosting compute\n service to securely access specific Amazon Web Services resources based on the role's\n permissions. For more information about the SSR Compute role, see Adding an SSR Compute role in the \n Amplify User\n Guide.
" } } }, "traits": { "smithy.api#documentation": "The request structure for the create branch request.
", "smithy.api#input": {} } }, "com.amazonaws.amplify#CreateBranchResult": { "type": "structure", "members": { "branch": { "target": "com.amazonaws.amplify#Branch", "traits": { "smithy.api#documentation": "Describes the branch for an Amplify app, which maps to a third-party repository\n branch.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The result structure for create branch request.
", "smithy.api#output": {} } }, "com.amazonaws.amplify#CreateDeployment": { "type": "operation", "input": { "target": "com.amazonaws.amplify#CreateDeploymentRequest" }, "output": { "target": "com.amazonaws.amplify#CreateDeploymentResult" }, "errors": [ { "target": "com.amazonaws.amplify#BadRequestException" }, { "target": "com.amazonaws.amplify#InternalFailureException" }, { "target": "com.amazonaws.amplify#LimitExceededException" }, { "target": "com.amazonaws.amplify#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Creates a deployment for a manually deployed Amplify app. Manually deployed apps are\n not connected to a Git repository.
\nThe maximum duration between the CreateDeployment call and the\n StartDeployment call cannot exceed 8 hours. If the duration exceeds 8\n hours, the StartDeployment call and the associated Job will\n fail.
The unique ID for an Amplify app.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "branchName": { "target": "com.amazonaws.amplify#BranchName", "traits": { "smithy.api#documentation": "The name of the branch to use for the job.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "fileMap": { "target": "com.amazonaws.amplify#FileMap", "traits": { "smithy.api#documentation": "An optional file map that contains the file name as the key and the file content md5\n hash as the value. If this argument is provided, the service will generate a unique\n upload URL per file. Otherwise, the service will only generate a single upload URL for\n the zipped files.
" } } }, "traits": { "smithy.api#documentation": "The request structure for the create a new deployment request.
", "smithy.api#input": {} } }, "com.amazonaws.amplify#CreateDeploymentResult": { "type": "structure", "members": { "jobId": { "target": "com.amazonaws.amplify#JobId", "traits": { "smithy.api#documentation": "The job ID for this deployment. will supply to start deployment api.
" } }, "fileUploadUrls": { "target": "com.amazonaws.amplify#FileUploadUrls", "traits": { "smithy.api#documentation": " When the fileMap argument is provided in the request,\n fileUploadUrls will contain a map of file names to upload URLs.
When the fileMap argument is not provided in the request, this\n zipUploadUrl is returned.
The result structure for the create a new deployment request.
", "smithy.api#output": {} } }, "com.amazonaws.amplify#CreateDomainAssociation": { "type": "operation", "input": { "target": "com.amazonaws.amplify#CreateDomainAssociationRequest" }, "output": { "target": "com.amazonaws.amplify#CreateDomainAssociationResult" }, "errors": [ { "target": "com.amazonaws.amplify#BadRequestException" }, { "target": "com.amazonaws.amplify#DependentServiceFailureException" }, { "target": "com.amazonaws.amplify#InternalFailureException" }, { "target": "com.amazonaws.amplify#LimitExceededException" }, { "target": "com.amazonaws.amplify#NotFoundException" }, { "target": "com.amazonaws.amplify#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Creates a new domain association for an Amplify app. This action associates a custom\n domain with the Amplify app
", "smithy.api#http": { "method": "POST", "uri": "/apps/{appId}/domains", "code": 200 } } }, "com.amazonaws.amplify#CreateDomainAssociationRequest": { "type": "structure", "members": { "appId": { "target": "com.amazonaws.amplify#AppId", "traits": { "smithy.api#documentation": "The unique ID for an Amplify app.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "domainName": { "target": "com.amazonaws.amplify#DomainName", "traits": { "smithy.api#documentation": "The domain name for the domain association.
", "smithy.api#required": {} } }, "enableAutoSubDomain": { "target": "com.amazonaws.amplify#EnableAutoSubDomain", "traits": { "smithy.api#documentation": "Enables the automated creation of subdomains for branches.
" } }, "subDomainSettings": { "target": "com.amazonaws.amplify#SubDomainSettings", "traits": { "smithy.api#documentation": "The setting for the subdomain.
", "smithy.api#required": {} } }, "autoSubDomainCreationPatterns": { "target": "com.amazonaws.amplify#AutoSubDomainCreationPatterns", "traits": { "smithy.api#documentation": "Sets the branch patterns for automatic subdomain creation.
" } }, "autoSubDomainIAMRole": { "target": "com.amazonaws.amplify#AutoSubDomainIAMRole", "traits": { "smithy.api#documentation": "The required AWS Identity and Access Management (IAM) service role for the Amazon\n Resource Name (ARN) for automatically creating subdomains.
" } }, "certificateSettings": { "target": "com.amazonaws.amplify#CertificateSettings", "traits": { "smithy.api#documentation": "The type of SSL/TLS certificate to use for your custom domain. If you don't specify a\n certificate type, Amplify uses the default certificate that it provisions and manages\n for you.
" } } }, "traits": { "smithy.api#documentation": "The request structure for the create domain association request.
", "smithy.api#input": {} } }, "com.amazonaws.amplify#CreateDomainAssociationResult": { "type": "structure", "members": { "domainAssociation": { "target": "com.amazonaws.amplify#DomainAssociation", "traits": { "smithy.api#documentation": "Describes the structure of a domain association, which associates a custom domain\n with an Amplify app.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The result structure for the create domain association request.
", "smithy.api#output": {} } }, "com.amazonaws.amplify#CreateTime": { "type": "timestamp" }, "com.amazonaws.amplify#CreateWebhook": { "type": "operation", "input": { "target": "com.amazonaws.amplify#CreateWebhookRequest" }, "output": { "target": "com.amazonaws.amplify#CreateWebhookResult" }, "errors": [ { "target": "com.amazonaws.amplify#BadRequestException" }, { "target": "com.amazonaws.amplify#DependentServiceFailureException" }, { "target": "com.amazonaws.amplify#InternalFailureException" }, { "target": "com.amazonaws.amplify#LimitExceededException" }, { "target": "com.amazonaws.amplify#NotFoundException" }, { "target": "com.amazonaws.amplify#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Creates a new webhook on an Amplify app.
", "smithy.api#http": { "method": "POST", "uri": "/apps/{appId}/webhooks", "code": 200 } } }, "com.amazonaws.amplify#CreateWebhookRequest": { "type": "structure", "members": { "appId": { "target": "com.amazonaws.amplify#AppId", "traits": { "smithy.api#documentation": "The unique ID for an Amplify app.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "branchName": { "target": "com.amazonaws.amplify#BranchName", "traits": { "smithy.api#documentation": "The name for a branch that is part of an Amplify app.
", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.amplify#Description", "traits": { "smithy.api#documentation": "The description for a webhook.
" } } }, "traits": { "smithy.api#documentation": "The request structure for the create webhook request.
", "smithy.api#input": {} } }, "com.amazonaws.amplify#CreateWebhookResult": { "type": "structure", "members": { "webhook": { "target": "com.amazonaws.amplify#Webhook", "traits": { "smithy.api#documentation": "Describes a webhook that connects repository events to an Amplify app.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The result structure for the create webhook request.
", "smithy.api#output": {} } }, "com.amazonaws.amplify#CustomDomain": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 255 } } }, "com.amazonaws.amplify#CustomDomains": { "type": "list", "member": { "target": "com.amazonaws.amplify#CustomDomain" }, "traits": { "smithy.api#length": { "min": 0, "max": 255 } } }, "com.amazonaws.amplify#CustomHeaders": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 25000 }, "smithy.api#pattern": "^(?s)" } }, "com.amazonaws.amplify#CustomRule": { "type": "structure", "members": { "source": { "target": "com.amazonaws.amplify#Source", "traits": { "smithy.api#documentation": "The source pattern for a URL rewrite or redirect rule.
", "smithy.api#required": {} } }, "target": { "target": "com.amazonaws.amplify#Target", "traits": { "smithy.api#documentation": "The target pattern for a URL rewrite or redirect rule.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.amplify#Status", "traits": { "smithy.api#documentation": "The status code for a URL rewrite or redirect rule.
\nRepresents a 200 rewrite rule.
\nRepresents a 301 (moved permanently) redirect rule. This and all future\n requests should be directed to the target URL.
\nRepresents a 302 temporary redirect rule.
\nRepresents a 404 redirect rule.
\nRepresents a 404 rewrite rule.
\nThe condition for a URL rewrite or redirect rule, such as a country code.
" } } }, "traits": { "smithy.api#documentation": "Describes a custom rewrite or redirect rule.
" } }, "com.amazonaws.amplify#CustomRules": { "type": "list", "member": { "target": "com.amazonaws.amplify#CustomRule" } }, "com.amazonaws.amplify#DNSRecord": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1000 } } }, "com.amazonaws.amplify#DefaultDomain": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1000 } } }, "com.amazonaws.amplify#DeleteApp": { "type": "operation", "input": { "target": "com.amazonaws.amplify#DeleteAppRequest" }, "output": { "target": "com.amazonaws.amplify#DeleteAppResult" }, "errors": [ { "target": "com.amazonaws.amplify#BadRequestException" }, { "target": "com.amazonaws.amplify#DependentServiceFailureException" }, { "target": "com.amazonaws.amplify#InternalFailureException" }, { "target": "com.amazonaws.amplify#NotFoundException" }, { "target": "com.amazonaws.amplify#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Deletes an existing Amplify app specified by an app ID.
", "smithy.api#http": { "method": "DELETE", "uri": "/apps/{appId}", "code": 200 } } }, "com.amazonaws.amplify#DeleteAppRequest": { "type": "structure", "members": { "appId": { "target": "com.amazonaws.amplify#AppId", "traits": { "smithy.api#documentation": "The unique ID for an Amplify app.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Describes the request structure for the delete app request.
", "smithy.api#input": {} } }, "com.amazonaws.amplify#DeleteAppResult": { "type": "structure", "members": { "app": { "target": "com.amazonaws.amplify#App", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The result structure for the delete app request.
", "smithy.api#output": {} } }, "com.amazonaws.amplify#DeleteBackendEnvironment": { "type": "operation", "input": { "target": "com.amazonaws.amplify#DeleteBackendEnvironmentRequest" }, "output": { "target": "com.amazonaws.amplify#DeleteBackendEnvironmentResult" }, "errors": [ { "target": "com.amazonaws.amplify#BadRequestException" }, { "target": "com.amazonaws.amplify#DependentServiceFailureException" }, { "target": "com.amazonaws.amplify#InternalFailureException" }, { "target": "com.amazonaws.amplify#NotFoundException" }, { "target": "com.amazonaws.amplify#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Deletes a backend environment for an Amplify app.
\nThis API is available only to Amplify Gen 1 applications where the\n backend is created using Amplify Studio or the Amplify\n command line interface (CLI). This API isn\u2019t available to Amplify Gen 2\n applications. When you deploy an application with Amplify Gen 2, you provision the app's\n backend infrastructure using Typescript code.
", "smithy.api#http": { "method": "DELETE", "uri": "/apps/{appId}/backendenvironments/{environmentName}", "code": 200 } } }, "com.amazonaws.amplify#DeleteBackendEnvironmentRequest": { "type": "structure", "members": { "appId": { "target": "com.amazonaws.amplify#AppId", "traits": { "smithy.api#documentation": "The unique ID of an Amplify app.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "environmentName": { "target": "com.amazonaws.amplify#EnvironmentName", "traits": { "smithy.api#documentation": "The name of a backend environment of an Amplify app.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The request structure for the delete backend environment request.
", "smithy.api#input": {} } }, "com.amazonaws.amplify#DeleteBackendEnvironmentResult": { "type": "structure", "members": { "backendEnvironment": { "target": "com.amazonaws.amplify#BackendEnvironment", "traits": { "smithy.api#documentation": "Describes the backend environment for an Amplify app.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The result structure of the delete backend environment result.
", "smithy.api#output": {} } }, "com.amazonaws.amplify#DeleteBranch": { "type": "operation", "input": { "target": "com.amazonaws.amplify#DeleteBranchRequest" }, "output": { "target": "com.amazonaws.amplify#DeleteBranchResult" }, "errors": [ { "target": "com.amazonaws.amplify#BadRequestException" }, { "target": "com.amazonaws.amplify#DependentServiceFailureException" }, { "target": "com.amazonaws.amplify#InternalFailureException" }, { "target": "com.amazonaws.amplify#NotFoundException" }, { "target": "com.amazonaws.amplify#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Deletes a branch for an Amplify app.
", "smithy.api#http": { "method": "DELETE", "uri": "/apps/{appId}/branches/{branchName}", "code": 200 } } }, "com.amazonaws.amplify#DeleteBranchRequest": { "type": "structure", "members": { "appId": { "target": "com.amazonaws.amplify#AppId", "traits": { "smithy.api#documentation": "The unique ID for an Amplify app.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "branchName": { "target": "com.amazonaws.amplify#BranchName", "traits": { "smithy.api#documentation": "The name of the branch.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The request structure for the delete branch request.
", "smithy.api#input": {} } }, "com.amazonaws.amplify#DeleteBranchResult": { "type": "structure", "members": { "branch": { "target": "com.amazonaws.amplify#Branch", "traits": { "smithy.api#documentation": "The branch for an Amplify app, which maps to a third-party repository branch.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The result structure for the delete branch request.
", "smithy.api#output": {} } }, "com.amazonaws.amplify#DeleteDomainAssociation": { "type": "operation", "input": { "target": "com.amazonaws.amplify#DeleteDomainAssociationRequest" }, "output": { "target": "com.amazonaws.amplify#DeleteDomainAssociationResult" }, "errors": [ { "target": "com.amazonaws.amplify#BadRequestException" }, { "target": "com.amazonaws.amplify#DependentServiceFailureException" }, { "target": "com.amazonaws.amplify#InternalFailureException" }, { "target": "com.amazonaws.amplify#NotFoundException" }, { "target": "com.amazonaws.amplify#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Deletes a domain association for an Amplify app.
", "smithy.api#http": { "method": "DELETE", "uri": "/apps/{appId}/domains/{domainName}", "code": 200 } } }, "com.amazonaws.amplify#DeleteDomainAssociationRequest": { "type": "structure", "members": { "appId": { "target": "com.amazonaws.amplify#AppId", "traits": { "smithy.api#documentation": "The unique id for an Amplify app.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "domainName": { "target": "com.amazonaws.amplify#DomainName", "traits": { "smithy.api#documentation": "The name of the domain.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The request structure for the delete domain association request.
", "smithy.api#input": {} } }, "com.amazonaws.amplify#DeleteDomainAssociationResult": { "type": "structure", "members": { "domainAssociation": { "target": "com.amazonaws.amplify#DomainAssociation", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.amplify#DeleteJob": { "type": "operation", "input": { "target": "com.amazonaws.amplify#DeleteJobRequest" }, "output": { "target": "com.amazonaws.amplify#DeleteJobResult" }, "errors": [ { "target": "com.amazonaws.amplify#BadRequestException" }, { "target": "com.amazonaws.amplify#InternalFailureException" }, { "target": "com.amazonaws.amplify#LimitExceededException" }, { "target": "com.amazonaws.amplify#NotFoundException" }, { "target": "com.amazonaws.amplify#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Deletes a job for a branch of an Amplify app.
", "smithy.api#http": { "method": "DELETE", "uri": "/apps/{appId}/branches/{branchName}/jobs/{jobId}", "code": 200 } } }, "com.amazonaws.amplify#DeleteJobRequest": { "type": "structure", "members": { "appId": { "target": "com.amazonaws.amplify#AppId", "traits": { "smithy.api#documentation": "The unique ID for an Amplify app.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "branchName": { "target": "com.amazonaws.amplify#BranchName", "traits": { "smithy.api#documentation": "The name of the branch to use for the job.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "jobId": { "target": "com.amazonaws.amplify#JobId", "traits": { "smithy.api#documentation": "The unique ID for the job.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The request structure for the delete job request.
", "smithy.api#input": {} } }, "com.amazonaws.amplify#DeleteJobResult": { "type": "structure", "members": { "jobSummary": { "target": "com.amazonaws.amplify#JobSummary", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The result structure for the delete job request.
", "smithy.api#output": {} } }, "com.amazonaws.amplify#DeleteWebhook": { "type": "operation", "input": { "target": "com.amazonaws.amplify#DeleteWebhookRequest" }, "output": { "target": "com.amazonaws.amplify#DeleteWebhookResult" }, "errors": [ { "target": "com.amazonaws.amplify#BadRequestException" }, { "target": "com.amazonaws.amplify#InternalFailureException" }, { "target": "com.amazonaws.amplify#LimitExceededException" }, { "target": "com.amazonaws.amplify#NotFoundException" }, { "target": "com.amazonaws.amplify#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Deletes a webhook.
", "smithy.api#http": { "method": "DELETE", "uri": "/webhooks/{webhookId}", "code": 200 } } }, "com.amazonaws.amplify#DeleteWebhookRequest": { "type": "structure", "members": { "webhookId": { "target": "com.amazonaws.amplify#WebhookId", "traits": { "smithy.api#documentation": "The unique ID for a webhook.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The request structure for the delete webhook request.
", "smithy.api#input": {} } }, "com.amazonaws.amplify#DeleteWebhookResult": { "type": "structure", "members": { "webhook": { "target": "com.amazonaws.amplify#Webhook", "traits": { "smithy.api#documentation": "Describes a webhook that connects repository events to an Amplify app.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The result structure for the delete webhook request.
", "smithy.api#output": {} } }, "com.amazonaws.amplify#DependentServiceFailureException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.amplify#ErrorMessage" } }, "traits": { "smithy.api#documentation": "An operation failed because a dependent service threw an exception.
", "smithy.api#error": "server", "smithy.api#httpError": 503 } }, "com.amazonaws.amplify#DeploymentArtifacts": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1000 }, "smithy.api#pattern": "^(?s).+$" } }, "com.amazonaws.amplify#Description": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1000 }, "smithy.api#pattern": "^(?s)" } }, "com.amazonaws.amplify#DisplayName": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 255 }, "smithy.api#pattern": "^(?s)" } }, "com.amazonaws.amplify#DomainAssociation": { "type": "structure", "members": { "domainAssociationArn": { "target": "com.amazonaws.amplify#DomainAssociationArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) for the domain association.
", "smithy.api#required": {} } }, "domainName": { "target": "com.amazonaws.amplify#DomainName", "traits": { "smithy.api#documentation": "The name of the domain.
", "smithy.api#required": {} } }, "enableAutoSubDomain": { "target": "com.amazonaws.amplify#EnableAutoSubDomain", "traits": { "smithy.api#documentation": "Enables the automated creation of subdomains for branches.
", "smithy.api#required": {} } }, "autoSubDomainCreationPatterns": { "target": "com.amazonaws.amplify#AutoSubDomainCreationPatterns", "traits": { "smithy.api#documentation": "Sets branch patterns for automatic subdomain creation.
" } }, "autoSubDomainIAMRole": { "target": "com.amazonaws.amplify#AutoSubDomainIAMRole", "traits": { "smithy.api#documentation": "The required AWS Identity and Access Management (IAM) service role for the Amazon\n Resource Name (ARN) for automatically creating subdomains.
" } }, "domainStatus": { "target": "com.amazonaws.amplify#DomainStatus", "traits": { "smithy.api#documentation": "The current status of the domain association.
", "smithy.api#required": {} } }, "updateStatus": { "target": "com.amazonaws.amplify#UpdateStatus", "traits": { "smithy.api#documentation": "The status of the domain update operation that is currently in progress. The following\n list describes the valid update states.
\nThe certificate is in the process of being updated.
\nIndicates that an Amplify managed certificate is in the\n process of being verified. This occurs during the creation of a custom\n domain or when a custom domain is updated to use a managed\n certificate.
\nIndicates that an Amplify custom certificate is in the\n process of being imported. This occurs during the creation of a custom\n domain or when a custom domain is updated to use a custom\n certificate.
\nIndicates that the subdomain or certificate changes are being\n propagated.
\n\n Amplify is waiting for CNAME records corresponding to\n subdomains to be propagated. If your custom domain is on Route\u00a053,\n Amplify handles this for you automatically. For more\n information about custom domains, see Setting up custom\n domains in the \n Amplify Hosting User\n Guide.
\nThe certificate has been associated with a domain.
\nThe certificate has failed to be provisioned or associated, and there is\n no existing active certificate to roll back to.
\nAdditional information that describes why the domain association is in the current\n state.
", "smithy.api#required": {} } }, "certificateVerificationDNSRecord": { "target": "com.amazonaws.amplify#CertificateVerificationDNSRecord", "traits": { "smithy.api#documentation": "The DNS record for certificate verification.
" } }, "subDomains": { "target": "com.amazonaws.amplify#SubDomains", "traits": { "smithy.api#documentation": "The subdomains for the domain association.
", "smithy.api#required": {} } }, "certificate": { "target": "com.amazonaws.amplify#Certificate", "traits": { "smithy.api#documentation": "Describes the SSL/TLS certificate for the domain association. This can be your own\n custom certificate or the default certificate that Amplify provisions for\n you.
\nIf you are updating your domain to use a different certificate,\n certificate points to the new certificate that is being created instead\n of the current active certificate. Otherwise, certificate points to the\n current active certificate.
Describes the association between a custom domain and an Amplify app.
" } }, "com.amazonaws.amplify#DomainAssociationArn": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1000 } } }, "com.amazonaws.amplify#DomainAssociations": { "type": "list", "member": { "target": "com.amazonaws.amplify#DomainAssociation" }, "traits": { "smithy.api#length": { "min": 0, "max": 255 } } }, "com.amazonaws.amplify#DomainName": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 64 }, "smithy.api#pattern": "^(((?!-)[A-Za-z0-9-]{0,62}[A-Za-z0-9])\\.)+((?!-)[A-Za-z0-9-]{1,62}[A-Za-z0-9])(\\.)?$" } }, "com.amazonaws.amplify#DomainPrefix": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 255 }, "smithy.api#pattern": "^(?s)" } }, "com.amazonaws.amplify#DomainStatus": { "type": "enum", "members": { "PENDING_VERIFICATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING_VERIFICATION" } }, "IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IN_PROGRESS" } }, "AVAILABLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AVAILABLE" } }, "IMPORTING_CUSTOM_CERTIFICATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IMPORTING_CUSTOM_CERTIFICATE" } }, "PENDING_DEPLOYMENT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING_DEPLOYMENT" } }, "AWAITING_APP_CNAME": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWAITING_APP_CNAME" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } }, "CREATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATING" } }, "REQUESTING_CERTIFICATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REQUESTING_CERTIFICATE" } }, "UPDATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UPDATING" } } } }, "com.amazonaws.amplify#EnableAutoBranchCreation": { "type": "boolean" }, "com.amazonaws.amplify#EnableAutoBuild": { "type": "boolean" }, "com.amazonaws.amplify#EnableAutoSubDomain": { "type": "boolean" }, "com.amazonaws.amplify#EnableBasicAuth": { "type": "boolean" }, "com.amazonaws.amplify#EnableBranchAutoBuild": { "type": "boolean" }, "com.amazonaws.amplify#EnableBranchAutoDeletion": { "type": "boolean" }, "com.amazonaws.amplify#EnableNotification": { "type": "boolean" }, "com.amazonaws.amplify#EnablePerformanceMode": { "type": "boolean" }, "com.amazonaws.amplify#EnablePullRequestPreview": { "type": "boolean" }, "com.amazonaws.amplify#EnableSkewProtection": { "type": "boolean" }, "com.amazonaws.amplify#EndTime": { "type": "timestamp" }, "com.amazonaws.amplify#EnvKey": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 255 }, "smithy.api#pattern": "^(?s)" } }, "com.amazonaws.amplify#EnvValue": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 5500 }, "smithy.api#pattern": "^(?s)" } }, "com.amazonaws.amplify#EnvironmentName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#pattern": "^(?s).+$" } }, "com.amazonaws.amplify#EnvironmentVariables": { "type": "map", "key": { "target": "com.amazonaws.amplify#EnvKey" }, "value": { "target": "com.amazonaws.amplify#EnvValue" } }, "com.amazonaws.amplify#ErrorMessage": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 255 } } }, "com.amazonaws.amplify#FileMap": { "type": "map", "key": { "target": "com.amazonaws.amplify#FileName" }, "value": { "target": "com.amazonaws.amplify#MD5Hash" } }, "com.amazonaws.amplify#FileName": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 255 }, "smithy.api#pattern": "^(?s)" } }, "com.amazonaws.amplify#FileUploadUrls": { "type": "map", "key": { "target": "com.amazonaws.amplify#FileName" }, "value": { "target": "com.amazonaws.amplify#UploadUrl" } }, "com.amazonaws.amplify#Framework": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 255 }, "smithy.api#pattern": "^(?s)" } }, "com.amazonaws.amplify#GenerateAccessLogs": { "type": "operation", "input": { "target": "com.amazonaws.amplify#GenerateAccessLogsRequest" }, "output": { "target": "com.amazonaws.amplify#GenerateAccessLogsResult" }, "errors": [ { "target": "com.amazonaws.amplify#BadRequestException" }, { "target": "com.amazonaws.amplify#InternalFailureException" }, { "target": "com.amazonaws.amplify#NotFoundException" }, { "target": "com.amazonaws.amplify#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Returns the website access logs for a specific time range using a presigned URL.\n
", "smithy.api#http": { "method": "POST", "uri": "/apps/{appId}/accesslogs", "code": 200 } } }, "com.amazonaws.amplify#GenerateAccessLogsRequest": { "type": "structure", "members": { "startTime": { "target": "com.amazonaws.amplify#StartTime", "traits": { "smithy.api#documentation": "The time at which the logs should start. The time range specified is inclusive of the\n start time.
" } }, "endTime": { "target": "com.amazonaws.amplify#EndTime", "traits": { "smithy.api#documentation": "The time at which the logs should end. The time range specified is inclusive of the\n end time.
" } }, "domainName": { "target": "com.amazonaws.amplify#DomainName", "traits": { "smithy.api#documentation": "The name of the domain.
", "smithy.api#required": {} } }, "appId": { "target": "com.amazonaws.amplify#AppId", "traits": { "smithy.api#documentation": "The unique ID for an Amplify app.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The request structure for the generate access logs request.
", "smithy.api#input": {} } }, "com.amazonaws.amplify#GenerateAccessLogsResult": { "type": "structure", "members": { "logUrl": { "target": "com.amazonaws.amplify#LogUrl", "traits": { "smithy.api#documentation": "The pre-signed URL for the requested access logs.
" } } }, "traits": { "smithy.api#documentation": "The result structure for the generate access logs request.
", "smithy.api#output": {} } }, "com.amazonaws.amplify#GetApp": { "type": "operation", "input": { "target": "com.amazonaws.amplify#GetAppRequest" }, "output": { "target": "com.amazonaws.amplify#GetAppResult" }, "errors": [ { "target": "com.amazonaws.amplify#BadRequestException" }, { "target": "com.amazonaws.amplify#InternalFailureException" }, { "target": "com.amazonaws.amplify#NotFoundException" }, { "target": "com.amazonaws.amplify#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Returns an existing Amplify app specified by an app ID.
", "smithy.api#http": { "method": "GET", "uri": "/apps/{appId}", "code": 200 } } }, "com.amazonaws.amplify#GetAppRequest": { "type": "structure", "members": { "appId": { "target": "com.amazonaws.amplify#AppId", "traits": { "smithy.api#documentation": "The unique ID for an Amplify app.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The request structure for the get app request.
", "smithy.api#input": {} } }, "com.amazonaws.amplify#GetAppResult": { "type": "structure", "members": { "app": { "target": "com.amazonaws.amplify#App", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.amplify#GetArtifactUrl": { "type": "operation", "input": { "target": "com.amazonaws.amplify#GetArtifactUrlRequest" }, "output": { "target": "com.amazonaws.amplify#GetArtifactUrlResult" }, "errors": [ { "target": "com.amazonaws.amplify#BadRequestException" }, { "target": "com.amazonaws.amplify#InternalFailureException" }, { "target": "com.amazonaws.amplify#LimitExceededException" }, { "target": "com.amazonaws.amplify#NotFoundException" }, { "target": "com.amazonaws.amplify#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Returns the artifact info that corresponds to an artifact id.
", "smithy.api#http": { "method": "GET", "uri": "/artifacts/{artifactId}", "code": 200 } } }, "com.amazonaws.amplify#GetArtifactUrlRequest": { "type": "structure", "members": { "artifactId": { "target": "com.amazonaws.amplify#ArtifactId", "traits": { "smithy.api#documentation": "The unique ID for an artifact.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Returns the request structure for the get artifact request.
", "smithy.api#input": {} } }, "com.amazonaws.amplify#GetArtifactUrlResult": { "type": "structure", "members": { "artifactId": { "target": "com.amazonaws.amplify#ArtifactId", "traits": { "smithy.api#documentation": "The unique ID for an artifact.
", "smithy.api#required": {} } }, "artifactUrl": { "target": "com.amazonaws.amplify#ArtifactUrl", "traits": { "smithy.api#documentation": "The presigned URL for the artifact.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Returns the result structure for the get artifact request.
", "smithy.api#output": {} } }, "com.amazonaws.amplify#GetBackendEnvironment": { "type": "operation", "input": { "target": "com.amazonaws.amplify#GetBackendEnvironmentRequest" }, "output": { "target": "com.amazonaws.amplify#GetBackendEnvironmentResult" }, "errors": [ { "target": "com.amazonaws.amplify#BadRequestException" }, { "target": "com.amazonaws.amplify#InternalFailureException" }, { "target": "com.amazonaws.amplify#NotFoundException" }, { "target": "com.amazonaws.amplify#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Returns a backend environment for an Amplify app.
\nThis API is available only to Amplify Gen 1 applications where the\n backend is created using Amplify Studio or the Amplify\n command line interface (CLI). This API isn\u2019t available to Amplify Gen 2\n applications. When you deploy an application with Amplify Gen 2, you provision the app's\n backend infrastructure using Typescript code.
", "smithy.api#http": { "method": "GET", "uri": "/apps/{appId}/backendenvironments/{environmentName}", "code": 200 } } }, "com.amazonaws.amplify#GetBackendEnvironmentRequest": { "type": "structure", "members": { "appId": { "target": "com.amazonaws.amplify#AppId", "traits": { "smithy.api#documentation": "The unique id for an Amplify app.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "environmentName": { "target": "com.amazonaws.amplify#EnvironmentName", "traits": { "smithy.api#documentation": "The name for the backend environment.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The request structure for the get backend environment request.
", "smithy.api#input": {} } }, "com.amazonaws.amplify#GetBackendEnvironmentResult": { "type": "structure", "members": { "backendEnvironment": { "target": "com.amazonaws.amplify#BackendEnvironment", "traits": { "smithy.api#documentation": "Describes the backend environment for an Amplify app.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The result structure for the get backend environment result.
", "smithy.api#output": {} } }, "com.amazonaws.amplify#GetBranch": { "type": "operation", "input": { "target": "com.amazonaws.amplify#GetBranchRequest" }, "output": { "target": "com.amazonaws.amplify#GetBranchResult" }, "errors": [ { "target": "com.amazonaws.amplify#BadRequestException" }, { "target": "com.amazonaws.amplify#InternalFailureException" }, { "target": "com.amazonaws.amplify#NotFoundException" }, { "target": "com.amazonaws.amplify#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Returns a branch for an Amplify app.
", "smithy.api#http": { "method": "GET", "uri": "/apps/{appId}/branches/{branchName}", "code": 200 } } }, "com.amazonaws.amplify#GetBranchRequest": { "type": "structure", "members": { "appId": { "target": "com.amazonaws.amplify#AppId", "traits": { "smithy.api#documentation": "The unique ID for an Amplify app.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "branchName": { "target": "com.amazonaws.amplify#BranchName", "traits": { "smithy.api#documentation": "The name of the branch.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The request structure for the get branch request.
", "smithy.api#input": {} } }, "com.amazonaws.amplify#GetBranchResult": { "type": "structure", "members": { "branch": { "target": "com.amazonaws.amplify#Branch", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.amplify#GetDomainAssociation": { "type": "operation", "input": { "target": "com.amazonaws.amplify#GetDomainAssociationRequest" }, "output": { "target": "com.amazonaws.amplify#GetDomainAssociationResult" }, "errors": [ { "target": "com.amazonaws.amplify#BadRequestException" }, { "target": "com.amazonaws.amplify#InternalFailureException" }, { "target": "com.amazonaws.amplify#NotFoundException" }, { "target": "com.amazonaws.amplify#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Returns the domain information for an Amplify app.
", "smithy.api#http": { "method": "GET", "uri": "/apps/{appId}/domains/{domainName}", "code": 200 } } }, "com.amazonaws.amplify#GetDomainAssociationRequest": { "type": "structure", "members": { "appId": { "target": "com.amazonaws.amplify#AppId", "traits": { "smithy.api#documentation": "The unique id for an Amplify app.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "domainName": { "target": "com.amazonaws.amplify#DomainName", "traits": { "smithy.api#documentation": "The name of the domain.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The request structure for the get domain association request.
", "smithy.api#input": {} } }, "com.amazonaws.amplify#GetDomainAssociationResult": { "type": "structure", "members": { "domainAssociation": { "target": "com.amazonaws.amplify#DomainAssociation", "traits": { "smithy.api#documentation": "Describes the structure of a domain association, which associates a custom domain\n with an Amplify app.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The result structure for the get domain association request.
", "smithy.api#output": {} } }, "com.amazonaws.amplify#GetJob": { "type": "operation", "input": { "target": "com.amazonaws.amplify#GetJobRequest" }, "output": { "target": "com.amazonaws.amplify#GetJobResult" }, "errors": [ { "target": "com.amazonaws.amplify#BadRequestException" }, { "target": "com.amazonaws.amplify#InternalFailureException" }, { "target": "com.amazonaws.amplify#LimitExceededException" }, { "target": "com.amazonaws.amplify#NotFoundException" }, { "target": "com.amazonaws.amplify#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Returns a job for a branch of an Amplify app.
", "smithy.api#http": { "method": "GET", "uri": "/apps/{appId}/branches/{branchName}/jobs/{jobId}", "code": 200 } } }, "com.amazonaws.amplify#GetJobRequest": { "type": "structure", "members": { "appId": { "target": "com.amazonaws.amplify#AppId", "traits": { "smithy.api#documentation": "The unique ID for an Amplify app.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "branchName": { "target": "com.amazonaws.amplify#BranchName", "traits": { "smithy.api#documentation": "The name of the branch to use for the job.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "jobId": { "target": "com.amazonaws.amplify#JobId", "traits": { "smithy.api#documentation": "The unique ID for the job.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The request structure for the get job request.
", "smithy.api#input": {} } }, "com.amazonaws.amplify#GetJobResult": { "type": "structure", "members": { "job": { "target": "com.amazonaws.amplify#Job", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.amplify#GetWebhook": { "type": "operation", "input": { "target": "com.amazonaws.amplify#GetWebhookRequest" }, "output": { "target": "com.amazonaws.amplify#GetWebhookResult" }, "errors": [ { "target": "com.amazonaws.amplify#BadRequestException" }, { "target": "com.amazonaws.amplify#InternalFailureException" }, { "target": "com.amazonaws.amplify#LimitExceededException" }, { "target": "com.amazonaws.amplify#NotFoundException" }, { "target": "com.amazonaws.amplify#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Returns the webhook information that corresponds to a specified webhook ID.
", "smithy.api#http": { "method": "GET", "uri": "/webhooks/{webhookId}", "code": 200 } } }, "com.amazonaws.amplify#GetWebhookRequest": { "type": "structure", "members": { "webhookId": { "target": "com.amazonaws.amplify#WebhookId", "traits": { "smithy.api#documentation": "The unique ID for a webhook.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The request structure for the get webhook request.
", "smithy.api#input": {} } }, "com.amazonaws.amplify#GetWebhookResult": { "type": "structure", "members": { "webhook": { "target": "com.amazonaws.amplify#Webhook", "traits": { "smithy.api#documentation": "Describes the structure of a webhook.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The result structure for the get webhook request.
", "smithy.api#output": {} } }, "com.amazonaws.amplify#InternalFailureException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.amplify#ErrorMessage" } }, "traits": { "smithy.api#documentation": "The service failed to perform an operation due to an internal issue.
", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.amplify#Job": { "type": "structure", "members": { "summary": { "target": "com.amazonaws.amplify#JobSummary", "traits": { "smithy.api#documentation": "Describes the summary for an execution job for an Amplify app.
", "smithy.api#required": {} } }, "steps": { "target": "com.amazonaws.amplify#Steps", "traits": { "smithy.api#documentation": "The execution steps for an execution job, for an Amplify app.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Describes an execution job for an Amplify app.
" } }, "com.amazonaws.amplify#JobArn": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1000 } } }, "com.amazonaws.amplify#JobConfig": { "type": "structure", "members": { "buildComputeType": { "target": "com.amazonaws.amplify#BuildComputeType", "traits": { "smithy.api#documentation": "Specifies the size of the build instance. Amplify supports three\n instance sizes: STANDARD_8GB, LARGE_16GB, and\n XLARGE_72GB. If you don't specify a value, Amplify uses\n the STANDARD_8GB default.
The following list describes the CPU, memory, and storage capacity for each build\n instance type:
\nvCPUs: 4
\nMemory: 8 GiB
\nDisk space: 128 GB
\nvCPUs: 8
\nMemory: 16 GiB
\nDisk space: 128 GB
\nvCPUs: 36
\nMemory: 72 GiB
\nDisk space: 256 GB
\nDescribes the configuration details that apply to the jobs for an Amplify app.
\nUse JobConfig to apply configuration to jobs, such as customizing the build instance size when you create or\n update an Amplify app. For more information about customizable build\n instances, see Custom build instances in the \n Amplify User Guide.
The Amazon Resource Name (ARN) for the job.
", "smithy.api#required": {} } }, "jobId": { "target": "com.amazonaws.amplify#JobId", "traits": { "smithy.api#documentation": "The unique ID for the job.
", "smithy.api#required": {} } }, "commitId": { "target": "com.amazonaws.amplify#CommitId", "traits": { "smithy.api#documentation": "The commit ID from a third-party repository provider for the job.
", "smithy.api#required": {} } }, "commitMessage": { "target": "com.amazonaws.amplify#CommitMessage", "traits": { "smithy.api#documentation": "The commit message from a third-party repository provider for the job.
", "smithy.api#required": {} } }, "commitTime": { "target": "com.amazonaws.amplify#CommitTime", "traits": { "smithy.api#documentation": "The commit date and time for the job.
", "smithy.api#required": {} } }, "startTime": { "target": "com.amazonaws.amplify#StartTime", "traits": { "smithy.api#documentation": "The start date and time for the job.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.amplify#JobStatus", "traits": { "smithy.api#documentation": "The current status for the job.
", "smithy.api#required": {} } }, "endTime": { "target": "com.amazonaws.amplify#EndTime", "traits": { "smithy.api#documentation": "The end date and time for the job.
" } }, "jobType": { "target": "com.amazonaws.amplify#JobType", "traits": { "smithy.api#documentation": " The type for the job. If the value is RELEASE, the job was manually\n released from its source by using the StartJob API. This value is available\n only for apps that are connected to a repository.
If the value is RETRY, the job was manually retried using the\n StartJob API. If the value is WEB_HOOK, the job was\n automatically triggered by webhooks. If the value is MANUAL, the job is for\n a manually deployed app. Manually deployed apps are not connected to a Git\n repository.
The source URL for the files to deploy. The source URL can be either an HTTP GET URL\n that is publicly accessible and downloads a single .zip file, or an Amazon S3\n bucket and prefix.
" } }, "sourceUrlType": { "target": "com.amazonaws.amplify#SourceUrlType", "traits": { "smithy.api#documentation": "The type of source specified by the sourceURL. If the value is\n ZIP, the source is a .zip file. If the value is\n BUCKET_PREFIX, the source is an Amazon S3 bucket and prefix. If\n no value is specified, the default is ZIP.
Describes the summary for an execution job for an Amplify app.
" } }, "com.amazonaws.amplify#JobType": { "type": "enum", "members": { "RELEASE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RELEASE" } }, "RETRY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RETRY" } }, "MANUAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MANUAL" } }, "WEB_HOOK": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "WEB_HOOK" } } }, "traits": { "smithy.api#length": { "min": 0, "max": 10 } } }, "com.amazonaws.amplify#LastDeployTime": { "type": "timestamp" }, "com.amazonaws.amplify#LimitExceededException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.amplify#ErrorMessage" } }, "traits": { "smithy.api#documentation": "A resource could not be created because service quotas were exceeded.
", "smithy.api#error": "client", "smithy.api#httpError": 429 } }, "com.amazonaws.amplify#ListApps": { "type": "operation", "input": { "target": "com.amazonaws.amplify#ListAppsRequest" }, "output": { "target": "com.amazonaws.amplify#ListAppsResult" }, "errors": [ { "target": "com.amazonaws.amplify#BadRequestException" }, { "target": "com.amazonaws.amplify#InternalFailureException" }, { "target": "com.amazonaws.amplify#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Returns a list of the existing Amplify apps.
", "smithy.api#http": { "method": "GET", "uri": "/apps", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "apps", "pageSize": "maxResults" } } }, "com.amazonaws.amplify#ListAppsRequest": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.amplify#NextToken", "traits": { "smithy.api#documentation": "A pagination token. If non-null, the pagination token is returned in a result. Pass\n its value in another request to retrieve more entries.
", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.amplify#MaxResultsForListApps", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "The maximum number of records to list in a single response.
", "smithy.api#httpQuery": "maxResults" } } }, "traits": { "smithy.api#documentation": "The request structure for the list apps request.
", "smithy.api#input": {} } }, "com.amazonaws.amplify#ListAppsResult": { "type": "structure", "members": { "apps": { "target": "com.amazonaws.amplify#Apps", "traits": { "smithy.api#documentation": "A list of Amplify apps.
", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.amplify#NextToken", "traits": { "smithy.api#documentation": "A pagination token. Set to null to start listing apps from start. If non-null, the\n pagination token is returned in a result. Pass its value in here to list more projects.\n
" } } }, "traits": { "smithy.api#documentation": "The result structure for an Amplify app list request.
", "smithy.api#output": {} } }, "com.amazonaws.amplify#ListArtifacts": { "type": "operation", "input": { "target": "com.amazonaws.amplify#ListArtifactsRequest" }, "output": { "target": "com.amazonaws.amplify#ListArtifactsResult" }, "errors": [ { "target": "com.amazonaws.amplify#BadRequestException" }, { "target": "com.amazonaws.amplify#InternalFailureException" }, { "target": "com.amazonaws.amplify#LimitExceededException" }, { "target": "com.amazonaws.amplify#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Returns a list of end-to-end testing artifacts for a specified app, branch, and\n job.
\nTo return the build artifacts, use the GetJob API.
\nFor more information about Amplify testing support, see Setting up\n end-to-end Cypress tests for your Amplify application in the\n \n Amplify Hosting User Guide.
", "smithy.api#http": { "method": "GET", "uri": "/apps/{appId}/branches/{branchName}/jobs/{jobId}/artifacts", "code": 200 } } }, "com.amazonaws.amplify#ListArtifactsRequest": { "type": "structure", "members": { "appId": { "target": "com.amazonaws.amplify#AppId", "traits": { "smithy.api#documentation": "The unique ID for an Amplify app.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "branchName": { "target": "com.amazonaws.amplify#BranchName", "traits": { "smithy.api#documentation": "The name of a branch that is part of an Amplify app.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "jobId": { "target": "com.amazonaws.amplify#JobId", "traits": { "smithy.api#documentation": "The unique ID for a job.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.amplify#NextToken", "traits": { "smithy.api#documentation": "A pagination token. Set to null to start listing artifacts from start. If a non-null\n pagination token is returned in a result, pass its value in here to list more artifacts.\n
", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.amplify#MaxResults", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "The maximum number of records to list in a single response.
", "smithy.api#httpQuery": "maxResults" } } }, "traits": { "smithy.api#documentation": "Describes the request structure for the list artifacts request.
", "smithy.api#input": {} } }, "com.amazonaws.amplify#ListArtifactsResult": { "type": "structure", "members": { "artifacts": { "target": "com.amazonaws.amplify#Artifacts", "traits": { "smithy.api#documentation": "A list of artifacts.
", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.amplify#NextToken", "traits": { "smithy.api#documentation": "A pagination token. If a non-null pagination token is returned in a result, pass its\n value in another request to retrieve more entries.
" } } }, "traits": { "smithy.api#documentation": "The result structure for the list artifacts request.
", "smithy.api#output": {} } }, "com.amazonaws.amplify#ListBackendEnvironments": { "type": "operation", "input": { "target": "com.amazonaws.amplify#ListBackendEnvironmentsRequest" }, "output": { "target": "com.amazonaws.amplify#ListBackendEnvironmentsResult" }, "errors": [ { "target": "com.amazonaws.amplify#BadRequestException" }, { "target": "com.amazonaws.amplify#InternalFailureException" }, { "target": "com.amazonaws.amplify#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Lists the backend environments for an Amplify app.
\nThis API is available only to Amplify Gen 1 applications where the\n backend is created using Amplify Studio or the Amplify\n command line interface (CLI). This API isn\u2019t available to Amplify Gen 2\n applications. When you deploy an application with Amplify Gen 2, you provision the app's\n backend infrastructure using Typescript code.
", "smithy.api#http": { "method": "GET", "uri": "/apps/{appId}/backendenvironments", "code": 200 } } }, "com.amazonaws.amplify#ListBackendEnvironmentsRequest": { "type": "structure", "members": { "appId": { "target": "com.amazonaws.amplify#AppId", "traits": { "smithy.api#documentation": "The unique ID for an Amplify app.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "environmentName": { "target": "com.amazonaws.amplify#EnvironmentName", "traits": { "smithy.api#documentation": "The name of the backend environment
", "smithy.api#httpQuery": "environmentName" } }, "nextToken": { "target": "com.amazonaws.amplify#NextToken", "traits": { "smithy.api#documentation": "A pagination token. Set to null to start listing backend environments from the start.\n If a non-null pagination token is returned in a result, pass its value in here to list\n more backend environments.
", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.amplify#MaxResults", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "The maximum number of records to list in a single response.
", "smithy.api#httpQuery": "maxResults" } } }, "traits": { "smithy.api#documentation": "The request structure for the list backend environments request.
", "smithy.api#input": {} } }, "com.amazonaws.amplify#ListBackendEnvironmentsResult": { "type": "structure", "members": { "backendEnvironments": { "target": "com.amazonaws.amplify#BackendEnvironments", "traits": { "smithy.api#documentation": "The list of backend environments for an Amplify app.
", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.amplify#NextToken", "traits": { "smithy.api#documentation": "A pagination token. If a non-null pagination token is returned in a result, pass its\n value in another request to retrieve more entries.
" } } }, "traits": { "smithy.api#documentation": "The result structure for the list backend environments result.
", "smithy.api#output": {} } }, "com.amazonaws.amplify#ListBranches": { "type": "operation", "input": { "target": "com.amazonaws.amplify#ListBranchesRequest" }, "output": { "target": "com.amazonaws.amplify#ListBranchesResult" }, "errors": [ { "target": "com.amazonaws.amplify#BadRequestException" }, { "target": "com.amazonaws.amplify#InternalFailureException" }, { "target": "com.amazonaws.amplify#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Lists the branches of an Amplify app.
", "smithy.api#http": { "method": "GET", "uri": "/apps/{appId}/branches", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "branches", "pageSize": "maxResults" } } }, "com.amazonaws.amplify#ListBranchesRequest": { "type": "structure", "members": { "appId": { "target": "com.amazonaws.amplify#AppId", "traits": { "smithy.api#documentation": "The unique ID for an Amplify app.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.amplify#NextToken", "traits": { "smithy.api#documentation": "A pagination token. Set to null to start listing branches from the start. If a\n non-null pagination token is returned in a result, pass its value in here to list more\n branches.
", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.amplify#MaxResults", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "The maximum number of records to list in a single response.
", "smithy.api#httpQuery": "maxResults" } } }, "traits": { "smithy.api#documentation": "The request structure for the list branches request.
", "smithy.api#input": {} } }, "com.amazonaws.amplify#ListBranchesResult": { "type": "structure", "members": { "branches": { "target": "com.amazonaws.amplify#Branches", "traits": { "smithy.api#documentation": "A list of branches for an Amplify app.
", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.amplify#NextToken", "traits": { "smithy.api#documentation": "A pagination token. If a non-null pagination token is returned in a result, pass its\n value in another request to retrieve more entries.
" } } }, "traits": { "smithy.api#documentation": "The result structure for the list branches request.
", "smithy.api#output": {} } }, "com.amazonaws.amplify#ListDomainAssociations": { "type": "operation", "input": { "target": "com.amazonaws.amplify#ListDomainAssociationsRequest" }, "output": { "target": "com.amazonaws.amplify#ListDomainAssociationsResult" }, "errors": [ { "target": "com.amazonaws.amplify#BadRequestException" }, { "target": "com.amazonaws.amplify#InternalFailureException" }, { "target": "com.amazonaws.amplify#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Returns the domain associations for an Amplify app.
", "smithy.api#http": { "method": "GET", "uri": "/apps/{appId}/domains", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "domainAssociations", "pageSize": "maxResults" } } }, "com.amazonaws.amplify#ListDomainAssociationsRequest": { "type": "structure", "members": { "appId": { "target": "com.amazonaws.amplify#AppId", "traits": { "smithy.api#documentation": "The unique ID for an Amplify app.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.amplify#NextToken", "traits": { "smithy.api#documentation": "A pagination token. Set to null to start listing apps from the start. If non-null, a\n pagination token is returned in a result. Pass its value in here to list more projects.\n
", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.amplify#MaxResults", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "The maximum number of records to list in a single response.
", "smithy.api#httpQuery": "maxResults" } } }, "traits": { "smithy.api#documentation": "The request structure for the list domain associations request.
", "smithy.api#input": {} } }, "com.amazonaws.amplify#ListDomainAssociationsResult": { "type": "structure", "members": { "domainAssociations": { "target": "com.amazonaws.amplify#DomainAssociations", "traits": { "smithy.api#documentation": "A list of domain associations.
", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.amplify#NextToken", "traits": { "smithy.api#documentation": "A pagination token. If non-null, a pagination token is returned in a result. Pass its\n value in another request to retrieve more entries.
" } } }, "traits": { "smithy.api#documentation": "The result structure for the list domain association request.
", "smithy.api#output": {} } }, "com.amazonaws.amplify#ListJobs": { "type": "operation", "input": { "target": "com.amazonaws.amplify#ListJobsRequest" }, "output": { "target": "com.amazonaws.amplify#ListJobsResult" }, "errors": [ { "target": "com.amazonaws.amplify#BadRequestException" }, { "target": "com.amazonaws.amplify#InternalFailureException" }, { "target": "com.amazonaws.amplify#LimitExceededException" }, { "target": "com.amazonaws.amplify#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Lists the jobs for a branch of an Amplify app.
", "smithy.api#http": { "method": "GET", "uri": "/apps/{appId}/branches/{branchName}/jobs", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "jobSummaries", "pageSize": "maxResults" } } }, "com.amazonaws.amplify#ListJobsRequest": { "type": "structure", "members": { "appId": { "target": "com.amazonaws.amplify#AppId", "traits": { "smithy.api#documentation": "The unique ID for an Amplify app.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "branchName": { "target": "com.amazonaws.amplify#BranchName", "traits": { "smithy.api#documentation": "The name of the branch to use for the request.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.amplify#NextToken", "traits": { "smithy.api#documentation": "A pagination token. Set to null to start listing steps from the start. If a non-null\n pagination token is returned in a result, pass its value in here to list more steps.\n
", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.amplify#MaxResults", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "The maximum number of records to list in a single response.
", "smithy.api#httpQuery": "maxResults" } } }, "traits": { "smithy.api#documentation": "The request structure for the list jobs request.
", "smithy.api#input": {} } }, "com.amazonaws.amplify#ListJobsResult": { "type": "structure", "members": { "jobSummaries": { "target": "com.amazonaws.amplify#JobSummaries", "traits": { "smithy.api#documentation": "The result structure for the list job result request.
", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.amplify#NextToken", "traits": { "smithy.api#documentation": "A pagination token. If non-null the pagination token is returned in a result. Pass its\n value in another request to retrieve more entries.
" } } }, "traits": { "smithy.api#documentation": "The maximum number of records to list in a single response.
", "smithy.api#output": {} } }, "com.amazonaws.amplify#ListTagsForResource": { "type": "operation", "input": { "target": "com.amazonaws.amplify#ListTagsForResourceRequest" }, "output": { "target": "com.amazonaws.amplify#ListTagsForResourceResponse" }, "errors": [ { "target": "com.amazonaws.amplify#BadRequestException" }, { "target": "com.amazonaws.amplify#InternalFailureException" }, { "target": "com.amazonaws.amplify#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "Returns a list of tags for a specified Amazon Resource Name (ARN).
", "smithy.api#http": { "method": "GET", "uri": "/tags/{resourceArn}", "code": 200 } } }, "com.amazonaws.amplify#ListTagsForResourceRequest": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.amplify#ResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) to use to list tags.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The request structure to use to list tags for a resource.
", "smithy.api#input": {} } }, "com.amazonaws.amplify#ListTagsForResourceResponse": { "type": "structure", "members": { "tags": { "target": "com.amazonaws.amplify#TagMap", "traits": { "smithy.api#documentation": "A list of tags for the specified The Amazon Resource Name (ARN).
" } } }, "traits": { "smithy.api#documentation": "The response for the list tags for resource request.
", "smithy.api#output": {} } }, "com.amazonaws.amplify#ListWebhooks": { "type": "operation", "input": { "target": "com.amazonaws.amplify#ListWebhooksRequest" }, "output": { "target": "com.amazonaws.amplify#ListWebhooksResult" }, "errors": [ { "target": "com.amazonaws.amplify#BadRequestException" }, { "target": "com.amazonaws.amplify#InternalFailureException" }, { "target": "com.amazonaws.amplify#LimitExceededException" }, { "target": "com.amazonaws.amplify#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Returns a list of webhooks for an Amplify app.
", "smithy.api#http": { "method": "GET", "uri": "/apps/{appId}/webhooks", "code": 200 } } }, "com.amazonaws.amplify#ListWebhooksRequest": { "type": "structure", "members": { "appId": { "target": "com.amazonaws.amplify#AppId", "traits": { "smithy.api#documentation": "The unique ID for an Amplify app.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.amplify#NextToken", "traits": { "smithy.api#documentation": "A pagination token. Set to null to start listing webhooks from the start. If\n non-null,the pagination token is returned in a result. Pass its value in here to list\n more webhooks.
", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.amplify#MaxResults", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "The maximum number of records to list in a single response.
", "smithy.api#httpQuery": "maxResults" } } }, "traits": { "smithy.api#documentation": "The request structure for the list webhooks request.
", "smithy.api#input": {} } }, "com.amazonaws.amplify#ListWebhooksResult": { "type": "structure", "members": { "webhooks": { "target": "com.amazonaws.amplify#Webhooks", "traits": { "smithy.api#documentation": "A list of webhooks.
", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.amplify#NextToken", "traits": { "smithy.api#documentation": "A pagination token. If non-null, the pagination token is returned in a result. Pass\n its value in another request to retrieve more entries.
" } } }, "traits": { "smithy.api#documentation": "The result structure for the list webhooks request.
", "smithy.api#output": {} } }, "com.amazonaws.amplify#LogUrl": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1000 } } }, "com.amazonaws.amplify#MD5Hash": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 32 }, "smithy.api#pattern": "^(?s)" } }, "com.amazonaws.amplify#MaxResults": { "type": "integer", "traits": { "smithy.api#default": 0, "smithy.api#range": { "min": 0, "max": 50 } } }, "com.amazonaws.amplify#MaxResultsForListApps": { "type": "integer", "traits": { "smithy.api#default": 0, "smithy.api#range": { "min": 0, "max": 100 } } }, "com.amazonaws.amplify#Name": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#pattern": "^(?s).+$" } }, "com.amazonaws.amplify#NextToken": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 2000 }, "smithy.api#pattern": "^(?s)" } }, "com.amazonaws.amplify#NotFoundException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.amplify#ErrorMessage" } }, "traits": { "smithy.api#documentation": "An entity was not found during an operation.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.amplify#OauthToken": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 4096 }, "smithy.api#pattern": "^(?s)", "smithy.api#sensitive": {} } }, "com.amazonaws.amplify#Platform": { "type": "enum", "members": { "WEB": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "WEB" } }, "WEB_DYNAMIC": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "WEB_DYNAMIC" } }, "WEB_COMPUTE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "WEB_COMPUTE" } } } }, "com.amazonaws.amplify#ProductionBranch": { "type": "structure", "members": { "lastDeployTime": { "target": "com.amazonaws.amplify#LastDeployTime", "traits": { "smithy.api#documentation": "The last deploy time of the production branch.
" } }, "status": { "target": "com.amazonaws.amplify#Status", "traits": { "smithy.api#documentation": "The status of the production branch.
" } }, "thumbnailUrl": { "target": "com.amazonaws.amplify#ThumbnailUrl", "traits": { "smithy.api#documentation": "The thumbnail URL for the production branch.
" } }, "branchName": { "target": "com.amazonaws.amplify#BranchName", "traits": { "smithy.api#documentation": "The branch name for the production branch.
" } } }, "traits": { "smithy.api#documentation": "Describes the information about a production branch for an Amplify app.
" } }, "com.amazonaws.amplify#PullRequestEnvironmentName": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 20 }, "smithy.api#pattern": "^(?s)" } }, "com.amazonaws.amplify#Repository": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1000 }, "smithy.api#pattern": "^(?s)" } }, "com.amazonaws.amplify#RepositoryCloneMethod": { "type": "enum", "members": { "SSH": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SSH" } }, "TOKEN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TOKEN" } }, "SIGV4": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SIGV4" } } } }, "com.amazonaws.amplify#ResourceArn": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 2048 }, "smithy.api#pattern": "^arn:aws:amplify:" } }, "com.amazonaws.amplify#ResourceNotFoundException": { "type": "structure", "members": { "code": { "target": "com.amazonaws.amplify#Code", "traits": { "smithy.api#required": {} } }, "message": { "target": "com.amazonaws.amplify#ErrorMessage", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "An operation failed due to a non-existent resource.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.amplify#Screenshots": { "type": "map", "key": { "target": "com.amazonaws.amplify#ThumbnailName" }, "value": { "target": "com.amazonaws.amplify#ThumbnailUrl" } }, "com.amazonaws.amplify#ServiceRoleArn": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1000 }, "smithy.api#pattern": "^(?s)" } }, "com.amazonaws.amplify#Source": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2048 }, "smithy.api#pattern": "^(?s).+$" } }, "com.amazonaws.amplify#SourceUrl": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 3000 }, "smithy.api#pattern": "^(s3|https|http)://" } }, "com.amazonaws.amplify#SourceUrlType": { "type": "enum", "members": { "ZIP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ZIP" } }, "BUCKET_PREFIX": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BUCKET_PREFIX" } } } }, "com.amazonaws.amplify#StackArn": { "type": "string", "traits": { "smithy.api#length": { "min": 20, "max": 2048 }, "smithy.api#pattern": "^arn:aws:cloudformation:[a-z0-9-]+:\\d{12}:stack/.+/.+$" } }, "com.amazonaws.amplify#StackName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#pattern": "^(?s).+$" } }, "com.amazonaws.amplify#Stage": { "type": "enum", "members": { "PRODUCTION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PRODUCTION" } }, "BETA": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BETA" } }, "DEVELOPMENT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DEVELOPMENT" } }, "EXPERIMENTAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EXPERIMENTAL" } }, "PULL_REQUEST": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PULL_REQUEST" } } } }, "com.amazonaws.amplify#StartDeployment": { "type": "operation", "input": { "target": "com.amazonaws.amplify#StartDeploymentRequest" }, "output": { "target": "com.amazonaws.amplify#StartDeploymentResult" }, "errors": [ { "target": "com.amazonaws.amplify#BadRequestException" }, { "target": "com.amazonaws.amplify#InternalFailureException" }, { "target": "com.amazonaws.amplify#LimitExceededException" }, { "target": "com.amazonaws.amplify#NotFoundException" }, { "target": "com.amazonaws.amplify#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Starts a deployment for a manually deployed app. Manually deployed apps are not\n connected to a Git repository.
\nThe maximum duration between the CreateDeployment call and the\n StartDeployment call cannot exceed 8 hours. If the duration exceeds 8\n hours, the StartDeployment call and the associated Job will\n fail.
The unique ID for an Amplify app.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "branchName": { "target": "com.amazonaws.amplify#BranchName", "traits": { "smithy.api#documentation": "The name of the branch to use for the deployment job.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "jobId": { "target": "com.amazonaws.amplify#JobId", "traits": { "smithy.api#documentation": "The job ID for this deployment that is generated by the CreateDeployment\n request.
The source URL for the deployment that is used when calling\n StartDeployment without CreateDeployment. The source URL\n can be either an HTTP GET URL that is publicly accessible and downloads a single .zip\n file, or an Amazon S3 bucket and prefix.
The type of source specified by the sourceURL. If the value is\n ZIP, the source is a .zip file. If the value is\n BUCKET_PREFIX, the source is an Amazon S3 bucket and prefix. If\n no value is specified, the default is ZIP.
The request structure for the start a deployment request.
", "smithy.api#input": {} } }, "com.amazonaws.amplify#StartDeploymentResult": { "type": "structure", "members": { "jobSummary": { "target": "com.amazonaws.amplify#JobSummary", "traits": { "smithy.api#documentation": "The summary for the job.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The result structure for the start a deployment request.
", "smithy.api#output": {} } }, "com.amazonaws.amplify#StartJob": { "type": "operation", "input": { "target": "com.amazonaws.amplify#StartJobRequest" }, "output": { "target": "com.amazonaws.amplify#StartJobResult" }, "errors": [ { "target": "com.amazonaws.amplify#BadRequestException" }, { "target": "com.amazonaws.amplify#InternalFailureException" }, { "target": "com.amazonaws.amplify#LimitExceededException" }, { "target": "com.amazonaws.amplify#NotFoundException" }, { "target": "com.amazonaws.amplify#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Starts a new job for a branch of an Amplify app.
", "smithy.api#http": { "method": "POST", "uri": "/apps/{appId}/branches/{branchName}/jobs", "code": 200 } } }, "com.amazonaws.amplify#StartJobRequest": { "type": "structure", "members": { "appId": { "target": "com.amazonaws.amplify#AppId", "traits": { "smithy.api#documentation": "The unique ID for an Amplify app.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "branchName": { "target": "com.amazonaws.amplify#BranchName", "traits": { "smithy.api#documentation": "The name of the branch to use for the job.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "jobId": { "target": "com.amazonaws.amplify#JobId", "traits": { "smithy.api#documentation": "The unique ID for an existing job. This is required if the value of\n jobType is RETRY.
Describes the type for the job. The job type RELEASE starts a new job\n with the latest change from the specified branch. This value is available only for apps\n that are connected to a repository.
The job type RETRY retries an existing job. If the job type value is\n RETRY, the jobId is also required.
A descriptive reason for starting the job.
" } }, "commitId": { "target": "com.amazonaws.amplify#CommitId", "traits": { "smithy.api#documentation": "The commit ID from a third-party repository provider for the job.
" } }, "commitMessage": { "target": "com.amazonaws.amplify#CommitMessage", "traits": { "smithy.api#documentation": "The commit message from a third-party repository provider for the job.
" } }, "commitTime": { "target": "com.amazonaws.amplify#CommitTime", "traits": { "smithy.api#documentation": "The commit date and time for the job.
" } } }, "traits": { "smithy.api#documentation": "The request structure for the start job request.
", "smithy.api#input": {} } }, "com.amazonaws.amplify#StartJobResult": { "type": "structure", "members": { "jobSummary": { "target": "com.amazonaws.amplify#JobSummary", "traits": { "smithy.api#documentation": "The summary for the job.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The result structure for the run job request.
", "smithy.api#output": {} } }, "com.amazonaws.amplify#StartTime": { "type": "timestamp" }, "com.amazonaws.amplify#Status": { "type": "string", "traits": { "smithy.api#length": { "min": 3, "max": 7 }, "smithy.api#pattern": "^.{3,7}$" } }, "com.amazonaws.amplify#StatusReason": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1000 } } }, "com.amazonaws.amplify#Step": { "type": "structure", "members": { "stepName": { "target": "com.amazonaws.amplify#StepName", "traits": { "smithy.api#documentation": "The name of the execution step.
", "smithy.api#required": {} } }, "startTime": { "target": "com.amazonaws.amplify#StartTime", "traits": { "smithy.api#documentation": "The start date and time of the execution step.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.amplify#JobStatus", "traits": { "smithy.api#documentation": "The status of the execution step.
", "smithy.api#required": {} } }, "endTime": { "target": "com.amazonaws.amplify#EndTime", "traits": { "smithy.api#documentation": "The end date and time of the execution step.
", "smithy.api#required": {} } }, "logUrl": { "target": "com.amazonaws.amplify#LogUrl", "traits": { "smithy.api#documentation": "The URL to the logs for the execution step.
" } }, "artifactsUrl": { "target": "com.amazonaws.amplify#ArtifactsUrl", "traits": { "smithy.api#documentation": "The URL to the build artifact for the execution step.
" } }, "testArtifactsUrl": { "target": "com.amazonaws.amplify#TestArtifactsUrl", "traits": { "smithy.api#documentation": "The URL to the test artifact for the execution step.
" } }, "testConfigUrl": { "target": "com.amazonaws.amplify#TestConfigUrl", "traits": { "smithy.api#documentation": "The URL to the test configuration for the execution step.
" } }, "screenshots": { "target": "com.amazonaws.amplify#Screenshots", "traits": { "smithy.api#documentation": "The list of screenshot URLs for the execution step, if relevant.
" } }, "statusReason": { "target": "com.amazonaws.amplify#StatusReason", "traits": { "smithy.api#documentation": "The reason for the current step status.
" } }, "context": { "target": "com.amazonaws.amplify#Context", "traits": { "smithy.api#documentation": "The context for the current step. Includes a build image if the step is build.\n
" } } }, "traits": { "smithy.api#documentation": "Describes an execution step, for an execution job, for an Amplify app.
" } }, "com.amazonaws.amplify#StepName": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 255 } } }, "com.amazonaws.amplify#Steps": { "type": "list", "member": { "target": "com.amazonaws.amplify#Step" } }, "com.amazonaws.amplify#StopJob": { "type": "operation", "input": { "target": "com.amazonaws.amplify#StopJobRequest" }, "output": { "target": "com.amazonaws.amplify#StopJobResult" }, "errors": [ { "target": "com.amazonaws.amplify#BadRequestException" }, { "target": "com.amazonaws.amplify#InternalFailureException" }, { "target": "com.amazonaws.amplify#LimitExceededException" }, { "target": "com.amazonaws.amplify#NotFoundException" }, { "target": "com.amazonaws.amplify#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Stops a job that is in progress for a branch of an Amplify app.
", "smithy.api#http": { "method": "DELETE", "uri": "/apps/{appId}/branches/{branchName}/jobs/{jobId}/stop", "code": 200 } } }, "com.amazonaws.amplify#StopJobRequest": { "type": "structure", "members": { "appId": { "target": "com.amazonaws.amplify#AppId", "traits": { "smithy.api#documentation": "The unique ID for an Amplify app.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "branchName": { "target": "com.amazonaws.amplify#BranchName", "traits": { "smithy.api#documentation": "The name of the branch to use for the stop job request.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "jobId": { "target": "com.amazonaws.amplify#JobId", "traits": { "smithy.api#documentation": "The unique id for the job.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The request structure for the stop job request.
", "smithy.api#input": {} } }, "com.amazonaws.amplify#StopJobResult": { "type": "structure", "members": { "jobSummary": { "target": "com.amazonaws.amplify#JobSummary", "traits": { "smithy.api#documentation": "The summary for the job.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The result structure for the stop job request.
", "smithy.api#output": {} } }, "com.amazonaws.amplify#SubDomain": { "type": "structure", "members": { "subDomainSetting": { "target": "com.amazonaws.amplify#SubDomainSetting", "traits": { "smithy.api#documentation": "Describes the settings for the subdomain.
", "smithy.api#required": {} } }, "verified": { "target": "com.amazonaws.amplify#Verified", "traits": { "smithy.api#documentation": "The verified status of the subdomain
", "smithy.api#required": {} } }, "dnsRecord": { "target": "com.amazonaws.amplify#DNSRecord", "traits": { "smithy.api#documentation": "The DNS record for the subdomain.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The subdomain for the domain association.
" } }, "com.amazonaws.amplify#SubDomainSetting": { "type": "structure", "members": { "prefix": { "target": "com.amazonaws.amplify#DomainPrefix", "traits": { "smithy.api#documentation": "The prefix setting for the subdomain.
", "smithy.api#required": {} } }, "branchName": { "target": "com.amazonaws.amplify#BranchName", "traits": { "smithy.api#documentation": "The branch name setting for the subdomain.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Describes the settings for the subdomain.
" } }, "com.amazonaws.amplify#SubDomainSettings": { "type": "list", "member": { "target": "com.amazonaws.amplify#SubDomainSetting" }, "traits": { "smithy.api#length": { "min": 0, "max": 500 } } }, "com.amazonaws.amplify#SubDomains": { "type": "list", "member": { "target": "com.amazonaws.amplify#SubDomain" }, "traits": { "smithy.api#length": { "min": 0, "max": 500 } } }, "com.amazonaws.amplify#TTL": { "type": "string", "traits": { "smithy.api#documentation": "The content Time to Live (TTL) for the website in seconds.
", "smithy.api#length": { "min": 0, "max": 32 }, "smithy.api#pattern": "^\\d*$" } }, "com.amazonaws.amplify#TagKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$" } }, "com.amazonaws.amplify#TagKeyList": { "type": "list", "member": { "target": "com.amazonaws.amplify#TagKey" }, "traits": { "smithy.api#length": { "min": 1, "max": 50 } } }, "com.amazonaws.amplify#TagMap": { "type": "map", "key": { "target": "com.amazonaws.amplify#TagKey" }, "value": { "target": "com.amazonaws.amplify#TagValue" }, "traits": { "smithy.api#length": { "min": 0, "max": 50 } } }, "com.amazonaws.amplify#TagResource": { "type": "operation", "input": { "target": "com.amazonaws.amplify#TagResourceRequest" }, "output": { "target": "com.amazonaws.amplify#TagResourceResponse" }, "errors": [ { "target": "com.amazonaws.amplify#BadRequestException" }, { "target": "com.amazonaws.amplify#InternalFailureException" }, { "target": "com.amazonaws.amplify#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "Tags the resource with a tag key and value.
", "smithy.api#http": { "method": "POST", "uri": "/tags/{resourceArn}", "code": 200 } } }, "com.amazonaws.amplify#TagResourceRequest": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.amplify#ResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) to use to tag a resource.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.amplify#TagMap", "traits": { "smithy.api#documentation": "The tags used to tag the resource.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The request structure to tag a resource with a tag key and value.
", "smithy.api#input": {} } }, "com.amazonaws.amplify#TagResourceResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "The response for the tag resource request.
", "smithy.api#output": {} } }, "com.amazonaws.amplify#TagValue": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 }, "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" } }, "com.amazonaws.amplify#Target": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2048 }, "smithy.api#pattern": "^(?s).+$" } }, "com.amazonaws.amplify#TestArtifactsUrl": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1000 } } }, "com.amazonaws.amplify#TestConfigUrl": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1000 } } }, "com.amazonaws.amplify#ThumbnailName": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 } } }, "com.amazonaws.amplify#ThumbnailUrl": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2000 } } }, "com.amazonaws.amplify#TotalNumberOfJobs": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1000 } } }, "com.amazonaws.amplify#UnauthorizedException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.amplify#ErrorMessage" } }, "traits": { "smithy.api#documentation": "An operation failed due to a lack of access.
", "smithy.api#error": "client", "smithy.api#httpError": 401 } }, "com.amazonaws.amplify#UntagResource": { "type": "operation", "input": { "target": "com.amazonaws.amplify#UntagResourceRequest" }, "output": { "target": "com.amazonaws.amplify#UntagResourceResponse" }, "errors": [ { "target": "com.amazonaws.amplify#BadRequestException" }, { "target": "com.amazonaws.amplify#InternalFailureException" }, { "target": "com.amazonaws.amplify#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "Untags a resource with a specified Amazon Resource Name (ARN).
", "smithy.api#http": { "method": "DELETE", "uri": "/tags/{resourceArn}", "code": 200 } } }, "com.amazonaws.amplify#UntagResourceRequest": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.amplify#ResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) to use to untag a resource.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "tagKeys": { "target": "com.amazonaws.amplify#TagKeyList", "traits": { "smithy.api#documentation": "The tag keys to use to untag a resource.
", "smithy.api#httpQuery": "tagKeys", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The request structure for the untag resource request.
", "smithy.api#input": {} } }, "com.amazonaws.amplify#UntagResourceResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "The response for the untag resource request.
", "smithy.api#output": {} } }, "com.amazonaws.amplify#UpdateApp": { "type": "operation", "input": { "target": "com.amazonaws.amplify#UpdateAppRequest" }, "output": { "target": "com.amazonaws.amplify#UpdateAppResult" }, "errors": [ { "target": "com.amazonaws.amplify#BadRequestException" }, { "target": "com.amazonaws.amplify#InternalFailureException" }, { "target": "com.amazonaws.amplify#NotFoundException" }, { "target": "com.amazonaws.amplify#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Updates an existing Amplify app.
", "smithy.api#http": { "method": "POST", "uri": "/apps/{appId}", "code": 200 } } }, "com.amazonaws.amplify#UpdateAppRequest": { "type": "structure", "members": { "appId": { "target": "com.amazonaws.amplify#AppId", "traits": { "smithy.api#documentation": "The unique ID for an Amplify app.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.amplify#Name", "traits": { "smithy.api#documentation": "The name for an Amplify app.
" } }, "description": { "target": "com.amazonaws.amplify#Description", "traits": { "smithy.api#documentation": "The description for an Amplify app.
" } }, "platform": { "target": "com.amazonaws.amplify#Platform", "traits": { "smithy.api#documentation": "The platform for the Amplify app. For a static app, set the platform type to\n WEB. For a dynamic server-side rendered (SSR) app, set the platform\n type to WEB_COMPUTE. For an app requiring Amplify Hosting's original SSR\n support only, set the platform type to WEB_DYNAMIC.
If you are deploying an SSG only app with Next.js version 14 or later, you must set\n the platform type to WEB_COMPUTE.
The Amazon Resource Name (ARN) of the IAM role to assign to an SSR app.\n The SSR Compute role allows the Amplify Hosting compute service to\n securely access specific Amazon Web Services resources based on the role's permissions.\n For more information about the SSR Compute role, see Adding an SSR Compute\n role in the \n Amplify User Guide.
" } }, "iamServiceRoleArn": { "target": "com.amazonaws.amplify#ServiceRoleArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM service role for the Amplify app.
" } }, "environmentVariables": { "target": "com.amazonaws.amplify#EnvironmentVariables", "traits": { "smithy.api#documentation": "The environment variables for an Amplify app.
" } }, "enableBranchAutoBuild": { "target": "com.amazonaws.amplify#EnableAutoBuild", "traits": { "smithy.api#documentation": "Enables branch auto-building for an Amplify app.
" } }, "enableBranchAutoDeletion": { "target": "com.amazonaws.amplify#EnableBranchAutoDeletion", "traits": { "smithy.api#documentation": "Automatically disconnects a branch in the Amplify console when you delete a branch\n from your Git repository.
" } }, "enableBasicAuth": { "target": "com.amazonaws.amplify#EnableBasicAuth", "traits": { "smithy.api#documentation": "Enables basic authorization for an Amplify app.
" } }, "basicAuthCredentials": { "target": "com.amazonaws.amplify#BasicAuthCredentials", "traits": { "smithy.api#documentation": "The basic authorization credentials for an Amplify app. You must base64-encode the\n authorization credentials and provide them in the format\n user:password.
The custom redirect and rewrite rules for an Amplify app.
" } }, "buildSpec": { "target": "com.amazonaws.amplify#BuildSpec", "traits": { "smithy.api#documentation": "The build specification (build spec) for an Amplify app.
" } }, "customHeaders": { "target": "com.amazonaws.amplify#CustomHeaders", "traits": { "smithy.api#documentation": "The custom HTTP headers for an Amplify app.
" } }, "enableAutoBranchCreation": { "target": "com.amazonaws.amplify#EnableAutoBranchCreation", "traits": { "smithy.api#documentation": "Enables automated branch creation for an Amplify app.
" } }, "autoBranchCreationPatterns": { "target": "com.amazonaws.amplify#AutoBranchCreationPatterns", "traits": { "smithy.api#documentation": "Describes the automated branch creation glob patterns for an Amplify app.
" } }, "autoBranchCreationConfig": { "target": "com.amazonaws.amplify#AutoBranchCreationConfig", "traits": { "smithy.api#documentation": "The automated branch creation configuration for an Amplify app.
" } }, "repository": { "target": "com.amazonaws.amplify#Repository", "traits": { "smithy.api#documentation": "The name of the Git repository for an Amplify app.
" } }, "oauthToken": { "target": "com.amazonaws.amplify#OauthToken", "traits": { "smithy.api#documentation": "The OAuth token for a third-party source control system for an Amplify app. The OAuth\n token is used to create a webhook and a read-only deploy key using SSH cloning. The\n OAuth token is not stored.
\nUse oauthToken for repository providers other than GitHub, such as\n Bitbucket or CodeCommit.
To authorize access to GitHub as your repository provider, use\n accessToken.
You must specify either oauthToken or accessToken when you\n update an app.
Existing Amplify apps deployed from a GitHub repository using OAuth continue to work\n with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub\n App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the\n Amplify User Guide .
" } }, "accessToken": { "target": "com.amazonaws.amplify#AccessToken", "traits": { "smithy.api#documentation": "The personal access token for a GitHub repository for an Amplify app. The personal\n access token is used to authorize access to a GitHub repository using the Amplify GitHub\n App. The token is not stored.
\nUse accessToken for GitHub repositories only. To authorize access to a\n repository provider such as Bitbucket or CodeCommit, use oauthToken.
You must specify either accessToken or oauthToken when you\n update an app.
Existing Amplify apps deployed from a GitHub repository using OAuth continue to work\n with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub\n App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the\n Amplify User Guide .
" } }, "jobConfig": { "target": "com.amazonaws.amplify#JobConfig", "traits": { "smithy.api#documentation": "Describes the configuration details that apply to the jobs for an Amplify app.
" } }, "cacheConfig": { "target": "com.amazonaws.amplify#CacheConfig", "traits": { "smithy.api#documentation": "The cache configuration for the Amplify app.
" } } }, "traits": { "smithy.api#documentation": "The request structure for the update app request.
", "smithy.api#input": {} } }, "com.amazonaws.amplify#UpdateAppResult": { "type": "structure", "members": { "app": { "target": "com.amazonaws.amplify#App", "traits": { "smithy.api#documentation": "Represents the updated Amplify app.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The result structure for an Amplify app update request.
", "smithy.api#output": {} } }, "com.amazonaws.amplify#UpdateBranch": { "type": "operation", "input": { "target": "com.amazonaws.amplify#UpdateBranchRequest" }, "output": { "target": "com.amazonaws.amplify#UpdateBranchResult" }, "errors": [ { "target": "com.amazonaws.amplify#BadRequestException" }, { "target": "com.amazonaws.amplify#DependentServiceFailureException" }, { "target": "com.amazonaws.amplify#InternalFailureException" }, { "target": "com.amazonaws.amplify#NotFoundException" }, { "target": "com.amazonaws.amplify#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Updates a branch for an Amplify app.
", "smithy.api#http": { "method": "POST", "uri": "/apps/{appId}/branches/{branchName}", "code": 200 } } }, "com.amazonaws.amplify#UpdateBranchRequest": { "type": "structure", "members": { "appId": { "target": "com.amazonaws.amplify#AppId", "traits": { "smithy.api#documentation": "The unique ID for an Amplify app.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "branchName": { "target": "com.amazonaws.amplify#BranchName", "traits": { "smithy.api#documentation": "The name of the branch.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.amplify#Description", "traits": { "smithy.api#documentation": "The description for the branch.
" } }, "framework": { "target": "com.amazonaws.amplify#Framework", "traits": { "smithy.api#documentation": "The framework for the branch.
" } }, "stage": { "target": "com.amazonaws.amplify#Stage", "traits": { "smithy.api#documentation": "Describes the current stage for the branch.
" } }, "enableNotification": { "target": "com.amazonaws.amplify#EnableNotification", "traits": { "smithy.api#documentation": "Enables notifications for the branch.
" } }, "enableAutoBuild": { "target": "com.amazonaws.amplify#EnableAutoBuild", "traits": { "smithy.api#documentation": "Enables auto building for the branch.
" } }, "enableSkewProtection": { "target": "com.amazonaws.amplify#EnableSkewProtection", "traits": { "smithy.api#documentation": "Specifies whether the skew protection feature is enabled for the branch.
\nDeployment skew protection is available to Amplify applications to\n eliminate version skew issues between client and servers in web applications. When you\n apply skew protection to a branch, you can ensure that your clients always interact with\n the correct version of server-side assets, regardless of when a deployment occurs. For\n more information about skew protection, see Skew protection for Amplify deployments in the \n Amplify User\n Guide.
" } }, "environmentVariables": { "target": "com.amazonaws.amplify#EnvironmentVariables", "traits": { "smithy.api#documentation": "The environment variables for the branch.
" } }, "basicAuthCredentials": { "target": "com.amazonaws.amplify#BasicAuthCredentials", "traits": { "smithy.api#documentation": " The basic authorization credentials for the branch. You must base64-encode the\n authorization credentials and provide them in the format\n user:password.
Enables basic authorization for the branch.
" } }, "enablePerformanceMode": { "target": "com.amazonaws.amplify#EnablePerformanceMode", "traits": { "smithy.api#documentation": "Enables performance mode for the branch.
\nPerformance mode optimizes for faster hosting performance by keeping content cached at\n the edge for a longer interval. When performance mode is enabled, hosting configuration\n or code changes can take up to 10 minutes to roll out.
" } }, "buildSpec": { "target": "com.amazonaws.amplify#BuildSpec", "traits": { "smithy.api#documentation": "The build specification (build spec) for the branch.
" } }, "ttl": { "target": "com.amazonaws.amplify#TTL", "traits": { "smithy.api#documentation": "The content Time to Live (TTL) for the website in seconds.
" } }, "displayName": { "target": "com.amazonaws.amplify#DisplayName", "traits": { "smithy.api#documentation": "The display name for a branch. This is used as the default domain prefix.
" } }, "enablePullRequestPreview": { "target": "com.amazonaws.amplify#EnablePullRequestPreview", "traits": { "smithy.api#documentation": "Enables pull request previews for this branch.
" } }, "pullRequestEnvironmentName": { "target": "com.amazonaws.amplify#PullRequestEnvironmentName", "traits": { "smithy.api#documentation": "The Amplify environment name for the pull request.
" } }, "backendEnvironmentArn": { "target": "com.amazonaws.amplify#BackendEnvironmentArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) for a backend environment that is part of a Gen 1\n Amplify app.
\nThis field is available to Amplify Gen 1 apps only where the backend is\n created using Amplify Studio or the Amplify command line\n interface (CLI).
" } }, "backend": { "target": "com.amazonaws.amplify#Backend", "traits": { "smithy.api#documentation": "The backend for a Branch of an Amplify app. Use for a\n backend created from an CloudFormation stack.
This field is available to Amplify Gen 2 apps only. When you deploy an\n application with Amplify Gen 2, you provision the app's backend infrastructure using\n Typescript code.
" } }, "computeRoleArn": { "target": "com.amazonaws.amplify#ComputeRoleArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role to assign to a branch of\n an SSR app. The SSR Compute role allows the Amplify Hosting compute\n service to securely access specific Amazon Web Services resources based on the role's\n permissions. For more information about the SSR Compute role, see Adding an SSR Compute role in the \n Amplify User\n Guide.
" } } }, "traits": { "smithy.api#documentation": "The request structure for the update branch request.
", "smithy.api#input": {} } }, "com.amazonaws.amplify#UpdateBranchResult": { "type": "structure", "members": { "branch": { "target": "com.amazonaws.amplify#Branch", "traits": { "smithy.api#documentation": "The branch for an Amplify app, which maps to a third-party repository branch.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The result structure for the update branch request.
", "smithy.api#output": {} } }, "com.amazonaws.amplify#UpdateDomainAssociation": { "type": "operation", "input": { "target": "com.amazonaws.amplify#UpdateDomainAssociationRequest" }, "output": { "target": "com.amazonaws.amplify#UpdateDomainAssociationResult" }, "errors": [ { "target": "com.amazonaws.amplify#BadRequestException" }, { "target": "com.amazonaws.amplify#DependentServiceFailureException" }, { "target": "com.amazonaws.amplify#InternalFailureException" }, { "target": "com.amazonaws.amplify#NotFoundException" }, { "target": "com.amazonaws.amplify#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Creates a new domain association for an Amplify app.
", "smithy.api#http": { "method": "POST", "uri": "/apps/{appId}/domains/{domainName}", "code": 200 } } }, "com.amazonaws.amplify#UpdateDomainAssociationRequest": { "type": "structure", "members": { "appId": { "target": "com.amazonaws.amplify#AppId", "traits": { "smithy.api#documentation": "The unique ID for an Amplify app.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "domainName": { "target": "com.amazonaws.amplify#DomainName", "traits": { "smithy.api#documentation": "The name of the domain.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "enableAutoSubDomain": { "target": "com.amazonaws.amplify#EnableAutoSubDomain", "traits": { "smithy.api#documentation": "Enables the automated creation of subdomains for branches.
" } }, "subDomainSettings": { "target": "com.amazonaws.amplify#SubDomainSettings", "traits": { "smithy.api#documentation": "Describes the settings for the subdomain.
" } }, "autoSubDomainCreationPatterns": { "target": "com.amazonaws.amplify#AutoSubDomainCreationPatterns", "traits": { "smithy.api#documentation": "Sets the branch patterns for automatic subdomain creation.
" } }, "autoSubDomainIAMRole": { "target": "com.amazonaws.amplify#AutoSubDomainIAMRole", "traits": { "smithy.api#documentation": "The required AWS Identity and Access Management (IAM) service role for the Amazon\n Resource Name (ARN) for automatically creating subdomains.
" } }, "certificateSettings": { "target": "com.amazonaws.amplify#CertificateSettings", "traits": { "smithy.api#documentation": "The type of SSL/TLS certificate to use for your custom domain.
" } } }, "traits": { "smithy.api#documentation": "The request structure for the update domain association request.
", "smithy.api#input": {} } }, "com.amazonaws.amplify#UpdateDomainAssociationResult": { "type": "structure", "members": { "domainAssociation": { "target": "com.amazonaws.amplify#DomainAssociation", "traits": { "smithy.api#documentation": "Describes a domain association, which associates a custom domain with an Amplify app.\n
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The result structure for the update domain association request.
", "smithy.api#output": {} } }, "com.amazonaws.amplify#UpdateStatus": { "type": "enum", "members": { "REQUESTING_CERTIFICATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REQUESTING_CERTIFICATE" } }, "PENDING_VERIFICATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING_VERIFICATION" } }, "IMPORTING_CUSTOM_CERTIFICATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IMPORTING_CUSTOM_CERTIFICATE" } }, "PENDING_DEPLOYMENT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING_DEPLOYMENT" } }, "AWAITING_APP_CNAME": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWAITING_APP_CNAME" } }, "UPDATE_COMPLETE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UPDATE_COMPLETE" } }, "UPDATE_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UPDATE_FAILED" } } } }, "com.amazonaws.amplify#UpdateTime": { "type": "timestamp" }, "com.amazonaws.amplify#UpdateWebhook": { "type": "operation", "input": { "target": "com.amazonaws.amplify#UpdateWebhookRequest" }, "output": { "target": "com.amazonaws.amplify#UpdateWebhookResult" }, "errors": [ { "target": "com.amazonaws.amplify#BadRequestException" }, { "target": "com.amazonaws.amplify#DependentServiceFailureException" }, { "target": "com.amazonaws.amplify#InternalFailureException" }, { "target": "com.amazonaws.amplify#NotFoundException" }, { "target": "com.amazonaws.amplify#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "Updates a webhook.
", "smithy.api#http": { "method": "POST", "uri": "/webhooks/{webhookId}", "code": 200 } } }, "com.amazonaws.amplify#UpdateWebhookRequest": { "type": "structure", "members": { "webhookId": { "target": "com.amazonaws.amplify#WebhookId", "traits": { "smithy.api#documentation": "The unique ID for a webhook.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "branchName": { "target": "com.amazonaws.amplify#BranchName", "traits": { "smithy.api#documentation": "The name for a branch that is part of an Amplify app.
" } }, "description": { "target": "com.amazonaws.amplify#Description", "traits": { "smithy.api#documentation": "The description for a webhook.
" } } }, "traits": { "smithy.api#documentation": "The request structure for the update webhook request.
", "smithy.api#input": {} } }, "com.amazonaws.amplify#UpdateWebhookResult": { "type": "structure", "members": { "webhook": { "target": "com.amazonaws.amplify#Webhook", "traits": { "smithy.api#documentation": "Describes a webhook that connects repository events to an Amplify app.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The result structure for the update webhook request.
", "smithy.api#output": {} } }, "com.amazonaws.amplify#UploadUrl": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1000 } } }, "com.amazonaws.amplify#Verified": { "type": "boolean" }, "com.amazonaws.amplify#WafConfiguration": { "type": "structure", "members": { "webAclArn": { "target": "com.amazonaws.amplify#WebAclArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) for the web ACL associated with an Amplify app.
" } }, "wafStatus": { "target": "com.amazonaws.amplify#WafStatus", "traits": { "smithy.api#documentation": "The status of the process to associate or disassociate a web ACL to an Amplify app.
" } }, "statusReason": { "target": "com.amazonaws.amplify#StatusReason", "traits": { "smithy.api#documentation": "The reason for the current status of the Firewall configuration.
" } } }, "traits": { "smithy.api#documentation": "Describes the Firewall configuration for a hosted Amplify application.\n Firewall support enables you to protect your web applications with a direct integration\n with WAF. For more information about using WAF protections\n for an Amplify application, see Firewall support for hosted\n sites in the \n Amplify User Guide.
" } }, "com.amazonaws.amplify#WafStatus": { "type": "enum", "members": { "ASSOCIATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ASSOCIATING" } }, "ASSOCIATION_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ASSOCIATION_FAILED" } }, "ASSOCIATION_SUCCESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ASSOCIATION_SUCCESS" } }, "DISASSOCIATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DISASSOCIATING" } }, "DISASSOCIATION_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DISASSOCIATION_FAILED" } } } }, "com.amazonaws.amplify#WebAclArn": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 512 }, "smithy.api#pattern": "^arn:aws:wafv2:" } }, "com.amazonaws.amplify#Webhook": { "type": "structure", "members": { "webhookArn": { "target": "com.amazonaws.amplify#WebhookArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) for the webhook.
", "smithy.api#required": {} } }, "webhookId": { "target": "com.amazonaws.amplify#WebhookId", "traits": { "smithy.api#documentation": "The ID of the webhook.
", "smithy.api#required": {} } }, "webhookUrl": { "target": "com.amazonaws.amplify#WebhookUrl", "traits": { "smithy.api#documentation": "The URL of the webhook.
", "smithy.api#required": {} } }, "appId": { "target": "com.amazonaws.amplify#AppId", "traits": { "smithy.api#documentation": "The unique ID of an Amplify app.
" } }, "branchName": { "target": "com.amazonaws.amplify#BranchName", "traits": { "smithy.api#documentation": "The name for a branch that is part of an Amplify app.
", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.amplify#Description", "traits": { "smithy.api#documentation": "The description for a webhook.
", "smithy.api#required": {} } }, "createTime": { "target": "com.amazonaws.amplify#CreateTime", "traits": { "smithy.api#documentation": "A timestamp of when Amplify created the webhook in your Git\n repository.
", "smithy.api#required": {} } }, "updateTime": { "target": "com.amazonaws.amplify#UpdateTime", "traits": { "smithy.api#documentation": "A timestamp of when Amplify updated the webhook in your Git\n repository.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Describes a webhook that connects repository events to an Amplify app.
" } }, "com.amazonaws.amplify#WebhookArn": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1000 } } }, "com.amazonaws.amplify#WebhookId": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 255 }, "smithy.api#pattern": "^(?s)" } }, "com.amazonaws.amplify#WebhookUrl": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1000 } } }, "com.amazonaws.amplify#Webhooks": { "type": "list", "member": { "target": "com.amazonaws.amplify#Webhook" } }, "com.amazonaws.amplify#webhookCreateTime": { "type": "timestamp" } } }