{ "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.amplifybackend#AdditionalConstraintsElement": { "type": "enum", "members": { "REQUIRE_DIGIT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REQUIRE_DIGIT" } }, "REQUIRE_LOWERCASE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REQUIRE_LOWERCASE" } }, "REQUIRE_SYMBOL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REQUIRE_SYMBOL" } }, "REQUIRE_UPPERCASE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REQUIRE_UPPERCASE" } } } }, "com.amazonaws.amplifybackend#AmplifyBackend": { "type": "service", "version": "2020-08-11", "operations": [ { "target": "com.amazonaws.amplifybackend#CloneBackend" }, { "target": "com.amazonaws.amplifybackend#CreateBackend" }, { "target": "com.amazonaws.amplifybackend#CreateBackendAPI" }, { "target": "com.amazonaws.amplifybackend#CreateBackendAuth" }, { "target": "com.amazonaws.amplifybackend#CreateBackendConfig" }, { "target": "com.amazonaws.amplifybackend#CreateBackendStorage" }, { "target": "com.amazonaws.amplifybackend#CreateToken" }, { "target": "com.amazonaws.amplifybackend#DeleteBackend" }, { "target": "com.amazonaws.amplifybackend#DeleteBackendAPI" }, { "target": "com.amazonaws.amplifybackend#DeleteBackendAuth" }, { "target": "com.amazonaws.amplifybackend#DeleteBackendStorage" }, { "target": "com.amazonaws.amplifybackend#DeleteToken" }, { "target": "com.amazonaws.amplifybackend#GenerateBackendAPIModels" }, { "target": "com.amazonaws.amplifybackend#GetBackend" }, { "target": "com.amazonaws.amplifybackend#GetBackendAPI" }, { "target": "com.amazonaws.amplifybackend#GetBackendAPIModels" }, { "target": "com.amazonaws.amplifybackend#GetBackendAuth" }, { "target": "com.amazonaws.amplifybackend#GetBackendJob" }, { "target": "com.amazonaws.amplifybackend#GetBackendStorage" }, { "target": "com.amazonaws.amplifybackend#GetToken" }, { "target": "com.amazonaws.amplifybackend#ImportBackendAuth" }, { "target": "com.amazonaws.amplifybackend#ImportBackendStorage" }, { "target": "com.amazonaws.amplifybackend#ListBackendJobs" }, { "target": "com.amazonaws.amplifybackend#ListS3Buckets" }, { "target": "com.amazonaws.amplifybackend#RemoveAllBackends" }, { "target": "com.amazonaws.amplifybackend#RemoveBackendConfig" }, { "target": "com.amazonaws.amplifybackend#UpdateBackendAPI" }, { "target": "com.amazonaws.amplifybackend#UpdateBackendAuth" }, { "target": "com.amazonaws.amplifybackend#UpdateBackendConfig" }, { "target": "com.amazonaws.amplifybackend#UpdateBackendJob" }, { "target": "com.amazonaws.amplifybackend#UpdateBackendStorage" } ], "traits": { "aws.api#service": { "sdkId": "AmplifyBackend", "arnNamespace": "amplifybackend", "cloudFormationName": "AmplifyBackend", "cloudTrailEventSource": "amplifybackend.amazonaws.com", "endpointPrefix": "amplifybackend" }, "aws.auth#sigv4": { "name": "amplifybackend" }, "aws.protocols#restJson1": {}, "smithy.api#documentation": "

AWS Amplify Admin API

", "smithy.api#title": "AmplifyBackend", "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://amplifybackend-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://amplifybackend-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://amplifybackend.{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://amplifybackend.{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://amplifybackend-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://amplifybackend-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://amplifybackend.{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://amplifybackend.{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-northeast-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://amplifybackend.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://amplifybackend.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://amplifybackend.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://amplifybackend.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://amplifybackend.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://amplifybackend.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://amplifybackend.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://amplifybackend.eu-north-1.amazonaws.com" } }, "params": { "Region": "eu-north-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://amplifybackend.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://amplifybackend.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://amplifybackend.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://amplifybackend.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://amplifybackend.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://amplifybackend.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://amplifybackend.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://amplifybackend.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://amplifybackend.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://amplifybackend-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://amplifybackend-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://amplifybackend.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://amplifybackend-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://amplifybackend-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://amplifybackend.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://amplifybackend.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://amplifybackend-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://amplifybackend-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://amplifybackend.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://amplifybackend.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://amplifybackend-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://amplifybackend.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://amplifybackend-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://amplifybackend.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.amplifybackend#AuthResources": { "type": "enum", "members": { "USER_POOL_ONLY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "USER_POOL_ONLY" } }, "IDENTITY_POOL_AND_USER_POOL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IDENTITY_POOL_AND_USER_POOL" } } } }, "com.amazonaws.amplifybackend#AuthenticatedElement": { "type": "enum", "members": { "READ": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "READ" } }, "CREATE_AND_UPDATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATE_AND_UPDATE" } }, "DELETE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETE" } } } }, "com.amazonaws.amplifybackend#BackendAPIAppSyncAuthSettings": { "type": "structure", "members": { "CognitoUserPoolId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The Amazon Cognito user pool ID, if Amazon Cognito was used as an authentication setting to access your data models.

", "smithy.api#jsonName": "cognitoUserPoolId" } }, "Description": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The API key description for API_KEY, if it was used as an authentication mechanism to access your data models.

", "smithy.api#jsonName": "description" } }, "ExpirationTime": { "target": "com.amazonaws.amplifybackend#__double", "traits": { "smithy.api#documentation": "

The API key expiration time for API_KEY, if it was used as an authentication mechanism to access your data models.

", "smithy.api#jsonName": "expirationTime" } }, "OpenIDAuthTTL": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The expiry time for the OpenID authentication mechanism.

", "smithy.api#jsonName": "openIDAuthTTL" } }, "OpenIDClientId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The clientID for openID, if openID was used as an authentication setting to access your data models.

", "smithy.api#jsonName": "openIDClientId" } }, "OpenIDIatTTL": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The expiry time for the OpenID authentication mechanism.

", "smithy.api#jsonName": "openIDIatTTL" } }, "OpenIDIssueURL": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The openID issuer URL, if openID was used as an authentication setting to access your data models.

", "smithy.api#jsonName": "openIDIssueURL" } }, "OpenIDProviderName": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The OpenID provider name, if OpenID was used as an authentication mechanism to access your data models.

", "smithy.api#jsonName": "openIDProviderName" } } }, "traits": { "smithy.api#documentation": "

The authentication settings for accessing provisioned data models in your Amplify project.

" } }, "com.amazonaws.amplifybackend#BackendAPIAuthType": { "type": "structure", "members": { "Mode": { "target": "com.amazonaws.amplifybackend#Mode", "traits": { "smithy.api#documentation": "

Describes the authentication mode.

", "smithy.api#jsonName": "mode" } }, "Settings": { "target": "com.amazonaws.amplifybackend#BackendAPIAppSyncAuthSettings", "traits": { "smithy.api#documentation": "

Describes settings for the authentication mode.

", "smithy.api#jsonName": "settings" } } }, "traits": { "smithy.api#documentation": "

Describes the auth types for your configured data models.

" } }, "com.amazonaws.amplifybackend#BackendAPIConflictResolution": { "type": "structure", "members": { "ResolutionStrategy": { "target": "com.amazonaws.amplifybackend#ResolutionStrategy", "traits": { "smithy.api#documentation": "

The strategy for conflict resolution.

", "smithy.api#jsonName": "resolutionStrategy" } } }, "traits": { "smithy.api#documentation": "

Describes the conflict resolution configuration for your data model configured in your Amplify project.

" } }, "com.amazonaws.amplifybackend#BackendAPIResourceConfig": { "type": "structure", "members": { "AdditionalAuthTypes": { "target": "com.amazonaws.amplifybackend#ListOfBackendAPIAuthType", "traits": { "smithy.api#documentation": "

Additional authentication methods used to interact with your data models.

", "smithy.api#jsonName": "additionalAuthTypes" } }, "ApiName": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The API name used to interact with the data model, configured as a part of your Amplify project.

", "smithy.api#jsonName": "apiName" } }, "ConflictResolution": { "target": "com.amazonaws.amplifybackend#BackendAPIConflictResolution", "traits": { "smithy.api#documentation": "

The conflict resolution strategy for your data stored in the data models.

", "smithy.api#jsonName": "conflictResolution" } }, "DefaultAuthType": { "target": "com.amazonaws.amplifybackend#BackendAPIAuthType", "traits": { "smithy.api#documentation": "

The default authentication type for interacting with the configured data models in your Amplify project.

", "smithy.api#jsonName": "defaultAuthType" } }, "Service": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The service used to provision and interact with the data model.

", "smithy.api#jsonName": "service" } }, "TransformSchema": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The definition of the data model in the annotated transform of the GraphQL schema.

", "smithy.api#jsonName": "transformSchema" } } }, "traits": { "smithy.api#documentation": "

The resource config for the data model, configured as a part of the Amplify project.

" } }, "com.amazonaws.amplifybackend#BackendAuthAppleProviderConfig": { "type": "structure", "members": { "ClientId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

Describes the client_id (also called Services ID) that comes from Apple.

", "smithy.api#jsonName": "client_id" } }, "KeyId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

Describes the key_id that comes from Apple.

", "smithy.api#jsonName": "key_id" } }, "PrivateKey": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

Describes the private_key that comes from Apple.

", "smithy.api#jsonName": "private_key" } }, "TeamId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

Describes the team_id that comes from Apple.

", "smithy.api#jsonName": "team_id" } } }, "traits": { "smithy.api#documentation": "

Describes Apple social federation configurations for allowing your app users to sign in using OAuth.

", "smithy.api#sensitive": {} } }, "com.amazonaws.amplifybackend#BackendAuthSocialProviderConfig": { "type": "structure", "members": { "ClientId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

Describes the client_id, which can be obtained from the third-party social federation provider.

", "smithy.api#jsonName": "client_id" } }, "ClientSecret": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

Describes the client_secret, which can be obtained from third-party social federation providers.

", "smithy.api#jsonName": "client_secret" } } }, "traits": { "smithy.api#documentation": "

Describes third-party social federation configurations for allowing your app users to sign in using OAuth.

", "smithy.api#sensitive": {} } }, "com.amazonaws.amplifybackend#BackendJobRespObj": { "type": "structure", "members": { "AppId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The app ID.

", "smithy.api#jsonName": "appId", "smithy.api#required": {} } }, "BackendEnvironmentName": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The name of the backend environment.

", "smithy.api#jsonName": "backendEnvironmentName", "smithy.api#required": {} } }, "CreateTime": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The time when the job was created.

", "smithy.api#jsonName": "createTime" } }, "Error": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

If the request fails, this error is returned.

", "smithy.api#jsonName": "error" } }, "JobId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The ID for the job.

", "smithy.api#jsonName": "jobId" } }, "Operation": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The name of the operation.

", "smithy.api#jsonName": "operation" } }, "Status": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The current status of the request.

", "smithy.api#jsonName": "status" } }, "UpdateTime": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The time when the job was last updated.

", "smithy.api#jsonName": "updateTime" } } }, "traits": { "smithy.api#documentation": "

The response object for this operation.

" } }, "com.amazonaws.amplifybackend#BackendStoragePermissions": { "type": "structure", "members": { "Authenticated": { "target": "com.amazonaws.amplifybackend#ListOfAuthenticatedElement", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

Lists all authenticated user read, write, and delete permissions for your S3 bucket.

", "smithy.api#jsonName": "authenticated", "smithy.api#required": {} } }, "UnAuthenticated": { "target": "com.amazonaws.amplifybackend#ListOfUnAuthenticatedElement", "traits": { "smithy.api#documentation": "

Lists all unauthenticated user read, write, and delete permissions for your S3 bucket.

", "smithy.api#jsonName": "unAuthenticated" } } }, "traits": { "smithy.api#documentation": "

Describes the read, write, and delete permissions users have against your storage S3 bucket.

" } }, "com.amazonaws.amplifybackend#BadRequestException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

An error message to inform that the request failed.

", "smithy.api#jsonName": "message" } } }, "traits": { "smithy.api#documentation": "

An error returned if a request is not formed properly.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.amplifybackend#CloneBackend": { "type": "operation", "input": { "target": "com.amazonaws.amplifybackend#CloneBackendRequest" }, "output": { "target": "com.amazonaws.amplifybackend#CloneBackendResponse" }, "errors": [ { "target": "com.amazonaws.amplifybackend#BadRequestException" }, { "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" }, { "target": "com.amazonaws.amplifybackend#NotFoundException" }, { "target": "com.amazonaws.amplifybackend#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "

This operation clones an existing backend.

", "smithy.api#http": { "method": "POST", "uri": "/backend/{AppId}/environments/{BackendEnvironmentName}/clone", "code": 200 } } }, "com.amazonaws.amplifybackend#CloneBackendRequest": { "type": "structure", "members": { "AppId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The app ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "BackendEnvironmentName": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The name of the backend environment.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "TargetEnvironmentName": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The name of the destination backend environment to be created.

", "smithy.api#jsonName": "targetEnvironmentName", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The request body for CloneBackend.

", "smithy.api#input": {} } }, "com.amazonaws.amplifybackend#CloneBackendResponse": { "type": "structure", "members": { "AppId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The app ID.

", "smithy.api#jsonName": "appId" } }, "BackendEnvironmentName": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The name of the backend environment.

", "smithy.api#jsonName": "backendEnvironmentName" } }, "Error": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

If the request fails, this error is returned.

", "smithy.api#jsonName": "error" } }, "JobId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The ID for the job.

", "smithy.api#jsonName": "jobId" } }, "Operation": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The name of the operation.

", "smithy.api#jsonName": "operation" } }, "Status": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The current status of the request.

", "smithy.api#jsonName": "status" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.amplifybackend#CreateBackend": { "type": "operation", "input": { "target": "com.amazonaws.amplifybackend#CreateBackendRequest" }, "output": { "target": "com.amazonaws.amplifybackend#CreateBackendResponse" }, "errors": [ { "target": "com.amazonaws.amplifybackend#BadRequestException" }, { "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" }, { "target": "com.amazonaws.amplifybackend#NotFoundException" }, { "target": "com.amazonaws.amplifybackend#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "

This operation creates a backend for an Amplify app. Backends are automatically created at the time of app creation.

", "smithy.api#http": { "method": "POST", "uri": "/backend", "code": 200 } } }, "com.amazonaws.amplifybackend#CreateBackendAPI": { "type": "operation", "input": { "target": "com.amazonaws.amplifybackend#CreateBackendAPIRequest" }, "output": { "target": "com.amazonaws.amplifybackend#CreateBackendAPIResponse" }, "errors": [ { "target": "com.amazonaws.amplifybackend#BadRequestException" }, { "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" }, { "target": "com.amazonaws.amplifybackend#NotFoundException" }, { "target": "com.amazonaws.amplifybackend#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "

Creates a new backend API resource.

", "smithy.api#http": { "method": "POST", "uri": "/backend/{AppId}/api", "code": 200 } } }, "com.amazonaws.amplifybackend#CreateBackendAPIRequest": { "type": "structure", "members": { "AppId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The app ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "BackendEnvironmentName": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The name of the backend environment.

", "smithy.api#jsonName": "backendEnvironmentName", "smithy.api#required": {} } }, "ResourceConfig": { "target": "com.amazonaws.amplifybackend#BackendAPIResourceConfig", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The resource configuration for this request.

", "smithy.api#jsonName": "resourceConfig", "smithy.api#required": {} } }, "ResourceName": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The name of this resource.

", "smithy.api#jsonName": "resourceName", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The request body for CreateBackendAPI.

", "smithy.api#input": {} } }, "com.amazonaws.amplifybackend#CreateBackendAPIResponse": { "type": "structure", "members": { "AppId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The app ID.

", "smithy.api#jsonName": "appId" } }, "BackendEnvironmentName": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The name of the backend environment.

", "smithy.api#jsonName": "backendEnvironmentName" } }, "Error": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

If the request fails, this error is returned.

", "smithy.api#jsonName": "error" } }, "JobId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The ID for the job.

", "smithy.api#jsonName": "jobId" } }, "Operation": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The name of the operation.

", "smithy.api#jsonName": "operation" } }, "Status": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The current status of the request.

", "smithy.api#jsonName": "status" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.amplifybackend#CreateBackendAuth": { "type": "operation", "input": { "target": "com.amazonaws.amplifybackend#CreateBackendAuthRequest" }, "output": { "target": "com.amazonaws.amplifybackend#CreateBackendAuthResponse" }, "errors": [ { "target": "com.amazonaws.amplifybackend#BadRequestException" }, { "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" }, { "target": "com.amazonaws.amplifybackend#NotFoundException" }, { "target": "com.amazonaws.amplifybackend#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "

Creates a new backend authentication resource.

", "smithy.api#http": { "method": "POST", "uri": "/backend/{AppId}/auth", "code": 200 } } }, "com.amazonaws.amplifybackend#CreateBackendAuthForgotPasswordConfig": { "type": "structure", "members": { "DeliveryMethod": { "target": "com.amazonaws.amplifybackend#DeliveryMethod", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

(DEPRECATED) Describes which mode to use (either SMS or email) to deliver messages to app users who want to recover their password.

", "smithy.api#jsonName": "deliveryMethod", "smithy.api#required": {} } }, "EmailSettings": { "target": "com.amazonaws.amplifybackend#EmailSettings", "traits": { "smithy.api#documentation": "

(DEPRECATED) The configuration for the email sent when an app user forgets their password.

", "smithy.api#jsonName": "emailSettings" } }, "SmsSettings": { "target": "com.amazonaws.amplifybackend#SmsSettings", "traits": { "smithy.api#documentation": "

(DEPRECATED) The configuration for the SMS message sent when an app user forgets their password.

", "smithy.api#jsonName": "smsSettings" } } }, "traits": { "smithy.api#documentation": "

(DEPRECATED) Describes the forgot password policy for authenticating into the Amplify app.

" } }, "com.amazonaws.amplifybackend#CreateBackendAuthIdentityPoolConfig": { "type": "structure", "members": { "IdentityPoolName": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

Name of the Amazon Cognito identity pool used for authorization.

", "smithy.api#jsonName": "identityPoolName", "smithy.api#required": {} } }, "UnauthenticatedLogin": { "target": "com.amazonaws.amplifybackend#__boolean", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

Set to true or false based on whether you want to enable guest authorization to your Amplify app.

", "smithy.api#jsonName": "unauthenticatedLogin", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Describes authorization configurations for the auth resources, configured as a part of your Amplify project.

" } }, "com.amazonaws.amplifybackend#CreateBackendAuthMFAConfig": { "type": "structure", "members": { "MFAMode": { "target": "com.amazonaws.amplifybackend#MFAMode", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

Describes whether MFA should be [ON, OFF, or OPTIONAL] for authentication in your Amplify project.

", "smithy.api#required": {} } }, "Settings": { "target": "com.amazonaws.amplifybackend#Settings", "traits": { "smithy.api#documentation": "

Describes the configuration settings and methods for your Amplify app users to use MFA.

", "smithy.api#jsonName": "settings" } } }, "traits": { "smithy.api#documentation": "

Describes whether to apply multi-factor authentication policies for your Amazon Cognito user pool configured as a part of your Amplify project.

" } }, "com.amazonaws.amplifybackend#CreateBackendAuthOAuthConfig": { "type": "structure", "members": { "DomainPrefix": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The domain prefix for your Amplify app.

", "smithy.api#jsonName": "domainPrefix" } }, "OAuthGrantType": { "target": "com.amazonaws.amplifybackend#OAuthGrantType", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The OAuth grant type that you use to allow app users to authenticate from your Amplify app.

", "smithy.api#jsonName": "oAuthGrantType", "smithy.api#required": {} } }, "OAuthScopes": { "target": "com.amazonaws.amplifybackend#ListOfOAuthScopesElement", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

List of OAuth-related flows used to allow your app users to authenticate from your Amplify app.

", "smithy.api#jsonName": "oAuthScopes", "smithy.api#required": {} } }, "RedirectSignInURIs": { "target": "com.amazonaws.amplifybackend#ListOf__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The redirected URI for signing in to your Amplify app.

", "smithy.api#jsonName": "redirectSignInURIs", "smithy.api#required": {} } }, "RedirectSignOutURIs": { "target": "com.amazonaws.amplifybackend#ListOf__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

Redirect URLs that OAuth uses when a user signs out of an Amplify app.

", "smithy.api#jsonName": "redirectSignOutURIs", "smithy.api#required": {} } }, "SocialProviderSettings": { "target": "com.amazonaws.amplifybackend#SocialProviderSettings", "traits": { "smithy.api#documentation": "

The settings for using social providers to access your Amplify app.

", "smithy.api#jsonName": "socialProviderSettings" } } }, "traits": { "smithy.api#documentation": "

Creates the OAuth configuration for your Amplify project.

" } }, "com.amazonaws.amplifybackend#CreateBackendAuthPasswordPolicyConfig": { "type": "structure", "members": { "AdditionalConstraints": { "target": "com.amazonaws.amplifybackend#ListOfAdditionalConstraintsElement", "traits": { "smithy.api#documentation": "

Additional constraints for the password used to access the backend of your Amplify project.

", "smithy.api#jsonName": "additionalConstraints" } }, "MinimumLength": { "target": "com.amazonaws.amplifybackend#__double", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The minimum length of the password used to access the backend of your Amplify project.

", "smithy.api#jsonName": "minimumLength", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The password policy configuration for the backend to your Amplify project.

" } }, "com.amazonaws.amplifybackend#CreateBackendAuthRequest": { "type": "structure", "members": { "AppId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The app ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "BackendEnvironmentName": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The name of the backend environment.

", "smithy.api#jsonName": "backendEnvironmentName", "smithy.api#required": {} } }, "ResourceConfig": { "target": "com.amazonaws.amplifybackend#CreateBackendAuthResourceConfig", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The resource configuration for this request object.

", "smithy.api#jsonName": "resourceConfig", "smithy.api#required": {} } }, "ResourceName": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The name of this resource.

", "smithy.api#jsonName": "resourceName", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The request body for CreateBackendAuth.

", "smithy.api#input": {} } }, "com.amazonaws.amplifybackend#CreateBackendAuthResourceConfig": { "type": "structure", "members": { "AuthResources": { "target": "com.amazonaws.amplifybackend#AuthResources", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

Defines whether you want to configure only authentication or both authentication and authorization settings.

", "smithy.api#jsonName": "authResources", "smithy.api#required": {} } }, "IdentityPoolConfigs": { "target": "com.amazonaws.amplifybackend#CreateBackendAuthIdentityPoolConfig", "traits": { "smithy.api#documentation": "

Describes the authorization configuration for the Amazon Cognito identity pool, provisioned as a part of your auth resource in the Amplify project.

", "smithy.api#jsonName": "identityPoolConfigs" } }, "Service": { "target": "com.amazonaws.amplifybackend#Service", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

Defines the service name to use when configuring an authentication resource in your Amplify project.

", "smithy.api#jsonName": "service", "smithy.api#required": {} } }, "UserPoolConfigs": { "target": "com.amazonaws.amplifybackend#CreateBackendAuthUserPoolConfig", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

Describes authentication configuration for the Amazon Cognito user pool, provisioned as a part of your auth resource in the Amplify project.

", "smithy.api#jsonName": "userPoolConfigs", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Defines the resource configuration when creating an auth resource in your Amplify project.

" } }, "com.amazonaws.amplifybackend#CreateBackendAuthResponse": { "type": "structure", "members": { "AppId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The app ID.

", "smithy.api#jsonName": "appId" } }, "BackendEnvironmentName": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The name of the backend environment.

", "smithy.api#jsonName": "backendEnvironmentName" } }, "Error": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

If the request fails, this error is returned.

", "smithy.api#jsonName": "error" } }, "JobId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The ID for the job.

", "smithy.api#jsonName": "jobId" } }, "Operation": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The name of the operation.

", "smithy.api#jsonName": "operation" } }, "Status": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The current status of the request.

", "smithy.api#jsonName": "status" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.amplifybackend#CreateBackendAuthUserPoolConfig": { "type": "structure", "members": { "ForgotPassword": { "target": "com.amazonaws.amplifybackend#CreateBackendAuthForgotPasswordConfig", "traits": { "smithy.api#documentation": "

(DEPRECATED) Describes the forgotten password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.

", "smithy.api#jsonName": "forgotPassword" } }, "Mfa": { "target": "com.amazonaws.amplifybackend#CreateBackendAuthMFAConfig", "traits": { "smithy.api#documentation": "

Describes whether to apply multi-factor authentication policies for your Amazon Cognito user pool configured as a part of your Amplify project.

", "smithy.api#jsonName": "mfa" } }, "OAuth": { "target": "com.amazonaws.amplifybackend#CreateBackendAuthOAuthConfig", "traits": { "smithy.api#documentation": "

Describes the OAuth policy and rules for your Amazon Cognito user pool, configured as a part of your Amplify project.

", "smithy.api#jsonName": "oAuth" } }, "PasswordPolicy": { "target": "com.amazonaws.amplifybackend#CreateBackendAuthPasswordPolicyConfig", "traits": { "smithy.api#documentation": "

Describes the password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.

", "smithy.api#jsonName": "passwordPolicy" } }, "RequiredSignUpAttributes": { "target": "com.amazonaws.amplifybackend#ListOfRequiredSignUpAttributesElement", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The required attributes to sign up new users in the user pool.

", "smithy.api#jsonName": "requiredSignUpAttributes", "smithy.api#required": {} } }, "SignInMethod": { "target": "com.amazonaws.amplifybackend#SignInMethod", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

Describes the sign-in methods that your Amplify app users use to log in using the Amazon Cognito user pool, configured as a part of your Amplify project.

", "smithy.api#jsonName": "signInMethod", "smithy.api#required": {} } }, "UserPoolName": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The Amazon Cognito user pool name.

", "smithy.api#jsonName": "userPoolName", "smithy.api#required": {} } }, "VerificationMessage": { "target": "com.amazonaws.amplifybackend#CreateBackendAuthVerificationMessageConfig", "traits": { "smithy.api#documentation": "

Describes the email or SMS verification message for your Amazon Cognito user pool, configured as a part of your Amplify project.

", "smithy.api#jsonName": "verificationMessage" } } }, "traits": { "smithy.api#documentation": "

Describes the Amazon Cognito user pool configuration for the auth resource to be configured for your Amplify project.

" } }, "com.amazonaws.amplifybackend#CreateBackendAuthVerificationMessageConfig": { "type": "structure", "members": { "DeliveryMethod": { "target": "com.amazonaws.amplifybackend#DeliveryMethod", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The type of verification message to send.

", "smithy.api#jsonName": "deliveryMethod", "smithy.api#required": {} } }, "EmailSettings": { "target": "com.amazonaws.amplifybackend#EmailSettings", "traits": { "smithy.api#documentation": "

The settings for the email message.

", "smithy.api#jsonName": "emailSettings" } }, "SmsSettings": { "target": "com.amazonaws.amplifybackend#SmsSettings", "traits": { "smithy.api#documentation": "

The settings for the SMS message.

", "smithy.api#jsonName": "smsSettings" } } }, "traits": { "smithy.api#documentation": "

Creates an email or SMS verification message for the auth resource configured for your Amplify project.

" } }, "com.amazonaws.amplifybackend#CreateBackendConfig": { "type": "operation", "input": { "target": "com.amazonaws.amplifybackend#CreateBackendConfigRequest" }, "output": { "target": "com.amazonaws.amplifybackend#CreateBackendConfigResponse" }, "errors": [ { "target": "com.amazonaws.amplifybackend#BadRequestException" }, { "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" }, { "target": "com.amazonaws.amplifybackend#NotFoundException" }, { "target": "com.amazonaws.amplifybackend#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "

Creates a config object for a backend.

", "smithy.api#http": { "method": "POST", "uri": "/backend/{AppId}/config", "code": 200 } } }, "com.amazonaws.amplifybackend#CreateBackendConfigRequest": { "type": "structure", "members": { "AppId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The app ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "BackendManagerAppId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The app ID for the backend manager.

", "smithy.api#jsonName": "backendManagerAppId" } } }, "traits": { "smithy.api#documentation": "

The request body for CreateBackendConfig.

", "smithy.api#input": {} } }, "com.amazonaws.amplifybackend#CreateBackendConfigResponse": { "type": "structure", "members": { "AppId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The app ID.

", "smithy.api#jsonName": "appId" } }, "BackendEnvironmentName": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The name of the backend environment.

", "smithy.api#jsonName": "backendEnvironmentName" } }, "JobId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The ID for the job.

", "smithy.api#jsonName": "jobId" } }, "Status": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The current status of the request.

", "smithy.api#jsonName": "status" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.amplifybackend#CreateBackendRequest": { "type": "structure", "members": { "AppId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The app ID.

", "smithy.api#jsonName": "appId", "smithy.api#required": {} } }, "AppName": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The name of the app.

", "smithy.api#jsonName": "appName", "smithy.api#required": {} } }, "BackendEnvironmentName": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The name of the backend environment.

", "smithy.api#jsonName": "backendEnvironmentName", "smithy.api#required": {} } }, "ResourceConfig": { "target": "com.amazonaws.amplifybackend#ResourceConfig", "traits": { "smithy.api#documentation": "

The resource configuration for creating a backend.

", "smithy.api#jsonName": "resourceConfig" } }, "ResourceName": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The name of the resource.

", "smithy.api#jsonName": "resourceName" } } }, "traits": { "smithy.api#documentation": "

The request body for CreateBackend.

", "smithy.api#input": {} } }, "com.amazonaws.amplifybackend#CreateBackendResponse": { "type": "structure", "members": { "AppId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The app ID.

", "smithy.api#jsonName": "appId" } }, "BackendEnvironmentName": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The name of the backend environment.

", "smithy.api#jsonName": "backendEnvironmentName" } }, "Error": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

If the request fails, this error is returned.

", "smithy.api#jsonName": "error" } }, "JobId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The ID for the job.

", "smithy.api#jsonName": "jobId" } }, "Operation": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The name of the operation.

", "smithy.api#jsonName": "operation" } }, "Status": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The current status of the request.

", "smithy.api#jsonName": "status" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.amplifybackend#CreateBackendStorage": { "type": "operation", "input": { "target": "com.amazonaws.amplifybackend#CreateBackendStorageRequest" }, "output": { "target": "com.amazonaws.amplifybackend#CreateBackendStorageResponse" }, "errors": [ { "target": "com.amazonaws.amplifybackend#BadRequestException" }, { "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" }, { "target": "com.amazonaws.amplifybackend#NotFoundException" }, { "target": "com.amazonaws.amplifybackend#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "

Creates a backend storage resource.

", "smithy.api#http": { "method": "POST", "uri": "/backend/{AppId}/storage", "code": 200 } } }, "com.amazonaws.amplifybackend#CreateBackendStorageRequest": { "type": "structure", "members": { "AppId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The app ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "BackendEnvironmentName": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The name of the backend environment.

", "smithy.api#jsonName": "backendEnvironmentName", "smithy.api#required": {} } }, "ResourceConfig": { "target": "com.amazonaws.amplifybackend#CreateBackendStorageResourceConfig", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The resource configuration for creating backend storage.

", "smithy.api#jsonName": "resourceConfig", "smithy.api#required": {} } }, "ResourceName": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The name of the storage resource.

", "smithy.api#jsonName": "resourceName", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The request body for CreateBackendStorage.

", "smithy.api#input": {} } }, "com.amazonaws.amplifybackend#CreateBackendStorageResourceConfig": { "type": "structure", "members": { "BucketName": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The name of the S3 bucket.

", "smithy.api#jsonName": "bucketName" } }, "Permissions": { "target": "com.amazonaws.amplifybackend#BackendStoragePermissions", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The authorization configuration for the storage S3 bucket.

", "smithy.api#jsonName": "permissions", "smithy.api#required": {} } }, "ServiceName": { "target": "com.amazonaws.amplifybackend#ServiceName", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The name of the storage service.

", "smithy.api#jsonName": "serviceName", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The resource configuration for creating backend storage.

" } }, "com.amazonaws.amplifybackend#CreateBackendStorageResponse": { "type": "structure", "members": { "AppId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The app ID.

", "smithy.api#jsonName": "appId" } }, "BackendEnvironmentName": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The name of the backend environment.

", "smithy.api#jsonName": "backendEnvironmentName" } }, "JobId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The ID for the job.

", "smithy.api#jsonName": "jobId" } }, "Status": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The current status of the request.

", "smithy.api#jsonName": "status" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.amplifybackend#CreateToken": { "type": "operation", "input": { "target": "com.amazonaws.amplifybackend#CreateTokenRequest" }, "output": { "target": "com.amazonaws.amplifybackend#CreateTokenResponse" }, "errors": [ { "target": "com.amazonaws.amplifybackend#BadRequestException" }, { "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" }, { "target": "com.amazonaws.amplifybackend#NotFoundException" }, { "target": "com.amazonaws.amplifybackend#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "

Generates a one-time challenge code to authenticate a user into your Amplify Admin UI.

", "smithy.api#http": { "method": "POST", "uri": "/backend/{AppId}/challenge", "code": 200 } } }, "com.amazonaws.amplifybackend#CreateTokenRequest": { "type": "structure", "members": { "AppId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The app ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.amplifybackend#CreateTokenResponse": { "type": "structure", "members": { "AppId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The app ID.

", "smithy.api#jsonName": "appId" } }, "ChallengeCode": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

One-time challenge code for authenticating into the Amplify Admin UI.

", "smithy.api#jsonName": "challengeCode" } }, "SessionId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

A unique ID provided when creating a new challenge token.

", "smithy.api#jsonName": "sessionId" } }, "Ttl": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The expiry time for the one-time generated token code.

", "smithy.api#jsonName": "ttl" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.amplifybackend#DeleteBackend": { "type": "operation", "input": { "target": "com.amazonaws.amplifybackend#DeleteBackendRequest" }, "output": { "target": "com.amazonaws.amplifybackend#DeleteBackendResponse" }, "errors": [ { "target": "com.amazonaws.amplifybackend#BadRequestException" }, { "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" }, { "target": "com.amazonaws.amplifybackend#NotFoundException" }, { "target": "com.amazonaws.amplifybackend#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "

Removes an existing environment from your Amplify project.

", "smithy.api#http": { "method": "POST", "uri": "/backend/{AppId}/environments/{BackendEnvironmentName}/remove", "code": 200 } } }, "com.amazonaws.amplifybackend#DeleteBackendAPI": { "type": "operation", "input": { "target": "com.amazonaws.amplifybackend#DeleteBackendAPIRequest" }, "output": { "target": "com.amazonaws.amplifybackend#DeleteBackendAPIResponse" }, "errors": [ { "target": "com.amazonaws.amplifybackend#BadRequestException" }, { "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" }, { "target": "com.amazonaws.amplifybackend#NotFoundException" }, { "target": "com.amazonaws.amplifybackend#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "

Deletes an existing backend API resource.

", "smithy.api#http": { "method": "POST", "uri": "/backend/{AppId}/api/{BackendEnvironmentName}/remove", "code": 200 } } }, "com.amazonaws.amplifybackend#DeleteBackendAPIRequest": { "type": "structure", "members": { "AppId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The app ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "BackendEnvironmentName": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The name of the backend environment.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ResourceConfig": { "target": "com.amazonaws.amplifybackend#BackendAPIResourceConfig", "traits": { "smithy.api#documentation": "

Defines the resource configuration for the data model in your Amplify project.

", "smithy.api#jsonName": "resourceConfig" } }, "ResourceName": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The name of this resource.

", "smithy.api#jsonName": "resourceName", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The request body for DeleteBackendAPI.

", "smithy.api#input": {} } }, "com.amazonaws.amplifybackend#DeleteBackendAPIResponse": { "type": "structure", "members": { "AppId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The app ID.

", "smithy.api#jsonName": "appId" } }, "BackendEnvironmentName": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The name of the backend environment.

", "smithy.api#jsonName": "backendEnvironmentName" } }, "Error": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

If the request fails, this error is returned.

", "smithy.api#jsonName": "error" } }, "JobId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The ID for the job.

", "smithy.api#jsonName": "jobId" } }, "Operation": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The name of the operation.

", "smithy.api#jsonName": "operation" } }, "Status": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The current status of the request.

", "smithy.api#jsonName": "status" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.amplifybackend#DeleteBackendAuth": { "type": "operation", "input": { "target": "com.amazonaws.amplifybackend#DeleteBackendAuthRequest" }, "output": { "target": "com.amazonaws.amplifybackend#DeleteBackendAuthResponse" }, "errors": [ { "target": "com.amazonaws.amplifybackend#BadRequestException" }, { "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" }, { "target": "com.amazonaws.amplifybackend#NotFoundException" }, { "target": "com.amazonaws.amplifybackend#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "

Deletes an existing backend authentication resource.

", "smithy.api#http": { "method": "POST", "uri": "/backend/{AppId}/auth/{BackendEnvironmentName}/remove", "code": 200 } } }, "com.amazonaws.amplifybackend#DeleteBackendAuthRequest": { "type": "structure", "members": { "AppId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The app ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "BackendEnvironmentName": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The name of the backend environment.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ResourceName": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The name of this resource.

", "smithy.api#jsonName": "resourceName", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The request body for DeleteBackendAuth.

", "smithy.api#input": {} } }, "com.amazonaws.amplifybackend#DeleteBackendAuthResponse": { "type": "structure", "members": { "AppId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The app ID.

", "smithy.api#jsonName": "appId" } }, "BackendEnvironmentName": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The name of the backend environment.

", "smithy.api#jsonName": "backendEnvironmentName" } }, "Error": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

If the request fails, this error is returned.

", "smithy.api#jsonName": "error" } }, "JobId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The ID for the job.

", "smithy.api#jsonName": "jobId" } }, "Operation": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The name of the operation.

", "smithy.api#jsonName": "operation" } }, "Status": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The current status of the request.

", "smithy.api#jsonName": "status" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.amplifybackend#DeleteBackendRequest": { "type": "structure", "members": { "AppId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The app ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "BackendEnvironmentName": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The name of the backend environment.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.amplifybackend#DeleteBackendResponse": { "type": "structure", "members": { "AppId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The app ID.

", "smithy.api#jsonName": "appId" } }, "BackendEnvironmentName": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The name of the backend environment.

", "smithy.api#jsonName": "backendEnvironmentName" } }, "Error": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

If the request fails, this error is returned.

", "smithy.api#jsonName": "error" } }, "JobId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The ID for the job.

", "smithy.api#jsonName": "jobId" } }, "Operation": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The name of the operation.

", "smithy.api#jsonName": "operation" } }, "Status": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The current status of the request.

", "smithy.api#jsonName": "status" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.amplifybackend#DeleteBackendStorage": { "type": "operation", "input": { "target": "com.amazonaws.amplifybackend#DeleteBackendStorageRequest" }, "output": { "target": "com.amazonaws.amplifybackend#DeleteBackendStorageResponse" }, "errors": [ { "target": "com.amazonaws.amplifybackend#BadRequestException" }, { "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" }, { "target": "com.amazonaws.amplifybackend#NotFoundException" }, { "target": "com.amazonaws.amplifybackend#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "

Removes the specified backend storage resource.

", "smithy.api#http": { "method": "POST", "uri": "/backend/{AppId}/storage/{BackendEnvironmentName}/remove", "code": 200 } } }, "com.amazonaws.amplifybackend#DeleteBackendStorageRequest": { "type": "structure", "members": { "AppId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The app ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "BackendEnvironmentName": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The name of the backend environment.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ResourceName": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The name of the storage resource.

", "smithy.api#jsonName": "resourceName", "smithy.api#required": {} } }, "ServiceName": { "target": "com.amazonaws.amplifybackend#ServiceName", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The name of the storage service.

", "smithy.api#jsonName": "serviceName", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The request body for DeleteBackendStorage.

", "smithy.api#input": {} } }, "com.amazonaws.amplifybackend#DeleteBackendStorageResponse": { "type": "structure", "members": { "AppId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The app ID.

", "smithy.api#jsonName": "appId" } }, "BackendEnvironmentName": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The name of the backend environment.

", "smithy.api#jsonName": "backendEnvironmentName" } }, "JobId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The ID for the job.

", "smithy.api#jsonName": "jobId" } }, "Status": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The current status of the request.

", "smithy.api#jsonName": "status" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.amplifybackend#DeleteToken": { "type": "operation", "input": { "target": "com.amazonaws.amplifybackend#DeleteTokenRequest" }, "output": { "target": "com.amazonaws.amplifybackend#DeleteTokenResponse" }, "errors": [ { "target": "com.amazonaws.amplifybackend#BadRequestException" }, { "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" }, { "target": "com.amazonaws.amplifybackend#NotFoundException" }, { "target": "com.amazonaws.amplifybackend#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "

Deletes the challenge token based on the given appId and sessionId.

", "smithy.api#http": { "method": "POST", "uri": "/backend/{AppId}/challenge/{SessionId}/remove", "code": 200 } } }, "com.amazonaws.amplifybackend#DeleteTokenRequest": { "type": "structure", "members": { "AppId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The app ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "SessionId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The session ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.amplifybackend#DeleteTokenResponse": { "type": "structure", "members": { "IsSuccess": { "target": "com.amazonaws.amplifybackend#__boolean", "traits": { "smithy.api#documentation": "

Indicates whether the request succeeded or failed.

", "smithy.api#jsonName": "isSuccess" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.amplifybackend#DeliveryMethod": { "type": "enum", "members": { "EMAIL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EMAIL" } }, "SMS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SMS" } } }, "traits": { "smithy.api#documentation": "

The type of verification message to send.

" } }, "com.amazonaws.amplifybackend#EmailSettings": { "type": "structure", "members": { "EmailMessage": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The contents of the email message.

", "smithy.api#jsonName": "emailMessage" } }, "EmailSubject": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The contents of the subject line of the email message.

", "smithy.api#jsonName": "emailSubject" } } }, "traits": { "smithy.api#documentation": "

The configuration for the email sent when an app user forgets their password.

", "smithy.api#sensitive": {} } }, "com.amazonaws.amplifybackend#GatewayTimeoutException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

An error message to inform that the request failed.

", "smithy.api#jsonName": "message" } } }, "traits": { "smithy.api#documentation": "

An error returned if there's a temporary issue with the service.

", "smithy.api#error": "server", "smithy.api#httpError": 504 } }, "com.amazonaws.amplifybackend#GenerateBackendAPIModels": { "type": "operation", "input": { "target": "com.amazonaws.amplifybackend#GenerateBackendAPIModelsRequest" }, "output": { "target": "com.amazonaws.amplifybackend#GenerateBackendAPIModelsResponse" }, "errors": [ { "target": "com.amazonaws.amplifybackend#BadRequestException" }, { "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" }, { "target": "com.amazonaws.amplifybackend#NotFoundException" }, { "target": "com.amazonaws.amplifybackend#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "

Generates a model schema for an existing backend API resource.

", "smithy.api#http": { "method": "POST", "uri": "/backend/{AppId}/api/{BackendEnvironmentName}/generateModels", "code": 200 } } }, "com.amazonaws.amplifybackend#GenerateBackendAPIModelsRequest": { "type": "structure", "members": { "AppId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The app ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "BackendEnvironmentName": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The name of the backend environment.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ResourceName": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The name of this resource.

", "smithy.api#jsonName": "resourceName", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The request body for GenerateBackendAPIModels.

", "smithy.api#input": {} } }, "com.amazonaws.amplifybackend#GenerateBackendAPIModelsResponse": { "type": "structure", "members": { "AppId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The app ID.

", "smithy.api#jsonName": "appId" } }, "BackendEnvironmentName": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The name of the backend environment.

", "smithy.api#jsonName": "backendEnvironmentName" } }, "Error": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

If the request fails, this error is returned.

", "smithy.api#jsonName": "error" } }, "JobId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The ID for the job.

", "smithy.api#jsonName": "jobId" } }, "Operation": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The name of the operation.

", "smithy.api#jsonName": "operation" } }, "Status": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The current status of the request.

", "smithy.api#jsonName": "status" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.amplifybackend#GetBackend": { "type": "operation", "input": { "target": "com.amazonaws.amplifybackend#GetBackendRequest" }, "output": { "target": "com.amazonaws.amplifybackend#GetBackendResponse" }, "errors": [ { "target": "com.amazonaws.amplifybackend#BadRequestException" }, { "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" }, { "target": "com.amazonaws.amplifybackend#NotFoundException" }, { "target": "com.amazonaws.amplifybackend#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "

Provides project-level details for your Amplify UI project.

", "smithy.api#http": { "method": "POST", "uri": "/backend/{AppId}/details", "code": 200 } } }, "com.amazonaws.amplifybackend#GetBackendAPI": { "type": "operation", "input": { "target": "com.amazonaws.amplifybackend#GetBackendAPIRequest" }, "output": { "target": "com.amazonaws.amplifybackend#GetBackendAPIResponse" }, "errors": [ { "target": "com.amazonaws.amplifybackend#BadRequestException" }, { "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" }, { "target": "com.amazonaws.amplifybackend#NotFoundException" }, { "target": "com.amazonaws.amplifybackend#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "

Gets the details for a backend API.

", "smithy.api#http": { "method": "POST", "uri": "/backend/{AppId}/api/{BackendEnvironmentName}/details", "code": 200 } } }, "com.amazonaws.amplifybackend#GetBackendAPIModels": { "type": "operation", "input": { "target": "com.amazonaws.amplifybackend#GetBackendAPIModelsRequest" }, "output": { "target": "com.amazonaws.amplifybackend#GetBackendAPIModelsResponse" }, "errors": [ { "target": "com.amazonaws.amplifybackend#BadRequestException" }, { "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" }, { "target": "com.amazonaws.amplifybackend#NotFoundException" }, { "target": "com.amazonaws.amplifybackend#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "

Gets a model introspection schema for an existing backend API resource.

", "smithy.api#http": { "method": "POST", "uri": "/backend/{AppId}/api/{BackendEnvironmentName}/getModels", "code": 200 } } }, "com.amazonaws.amplifybackend#GetBackendAPIModelsRequest": { "type": "structure", "members": { "AppId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The app ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "BackendEnvironmentName": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The name of the backend environment.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ResourceName": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The name of this resource.

", "smithy.api#jsonName": "resourceName", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The request body for GetBackendAPIModels.

", "smithy.api#input": {} } }, "com.amazonaws.amplifybackend#GetBackendAPIModelsResponse": { "type": "structure", "members": { "Models": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

Stringified JSON of the datastore model.

", "smithy.api#jsonName": "models" } }, "Status": { "target": "com.amazonaws.amplifybackend#Status", "traits": { "smithy.api#documentation": "

The current status of the request.

", "smithy.api#jsonName": "status" } }, "ModelIntrospectionSchema": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

Stringified JSON of the model introspection schema for an existing backend API resource.

", "smithy.api#jsonName": "modelIntrospectionSchema" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.amplifybackend#GetBackendAPIRequest": { "type": "structure", "members": { "AppId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The app ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "BackendEnvironmentName": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The name of the backend environment.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ResourceConfig": { "target": "com.amazonaws.amplifybackend#BackendAPIResourceConfig", "traits": { "smithy.api#documentation": "

Defines the resource configuration for the data model in your Amplify project.

", "smithy.api#jsonName": "resourceConfig" } }, "ResourceName": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The name of this resource.

", "smithy.api#jsonName": "resourceName", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The request body for GetBackendAPI.

", "smithy.api#input": {} } }, "com.amazonaws.amplifybackend#GetBackendAPIResponse": { "type": "structure", "members": { "AppId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The app ID.

", "smithy.api#jsonName": "appId" } }, "BackendEnvironmentName": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The name of the backend environment.

", "smithy.api#jsonName": "backendEnvironmentName" } }, "Error": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

If the request fails, this error is returned.

", "smithy.api#jsonName": "error" } }, "ResourceConfig": { "target": "com.amazonaws.amplifybackend#BackendAPIResourceConfig", "traits": { "smithy.api#documentation": "

The resource configuration for this response object.

", "smithy.api#jsonName": "resourceConfig" } }, "ResourceName": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The name of this resource.

", "smithy.api#jsonName": "resourceName" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.amplifybackend#GetBackendAuth": { "type": "operation", "input": { "target": "com.amazonaws.amplifybackend#GetBackendAuthRequest" }, "output": { "target": "com.amazonaws.amplifybackend#GetBackendAuthResponse" }, "errors": [ { "target": "com.amazonaws.amplifybackend#BadRequestException" }, { "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" }, { "target": "com.amazonaws.amplifybackend#NotFoundException" }, { "target": "com.amazonaws.amplifybackend#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "

Gets a backend auth details.

", "smithy.api#http": { "method": "POST", "uri": "/backend/{AppId}/auth/{BackendEnvironmentName}/details", "code": 200 } } }, "com.amazonaws.amplifybackend#GetBackendAuthRequest": { "type": "structure", "members": { "AppId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The app ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "BackendEnvironmentName": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The name of the backend environment.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ResourceName": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The name of this resource.

", "smithy.api#jsonName": "resourceName", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The request body for GetBackendAuth.

", "smithy.api#input": {} } }, "com.amazonaws.amplifybackend#GetBackendAuthResponse": { "type": "structure", "members": { "AppId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The app ID.

", "smithy.api#jsonName": "appId" } }, "BackendEnvironmentName": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The name of the backend environment.

", "smithy.api#jsonName": "backendEnvironmentName" } }, "Error": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

If the request fails, this error is returned.

", "smithy.api#jsonName": "error" } }, "ResourceConfig": { "target": "com.amazonaws.amplifybackend#CreateBackendAuthResourceConfig", "traits": { "smithy.api#documentation": "

The resource configuration for authorization requests to the backend of your Amplify project.

", "smithy.api#jsonName": "resourceConfig" } }, "ResourceName": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The name of this resource.

", "smithy.api#jsonName": "resourceName" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.amplifybackend#GetBackendJob": { "type": "operation", "input": { "target": "com.amazonaws.amplifybackend#GetBackendJobRequest" }, "output": { "target": "com.amazonaws.amplifybackend#GetBackendJobResponse" }, "errors": [ { "target": "com.amazonaws.amplifybackend#BadRequestException" }, { "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" }, { "target": "com.amazonaws.amplifybackend#NotFoundException" }, { "target": "com.amazonaws.amplifybackend#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "

Returns information about a specific job.

", "smithy.api#http": { "method": "GET", "uri": "/backend/{AppId}/job/{BackendEnvironmentName}/{JobId}", "code": 200 } } }, "com.amazonaws.amplifybackend#GetBackendJobRequest": { "type": "structure", "members": { "AppId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The app ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "BackendEnvironmentName": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The name of the backend environment.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "JobId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The ID for the job.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.amplifybackend#GetBackendJobResponse": { "type": "structure", "members": { "AppId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The app ID.

", "smithy.api#jsonName": "appId" } }, "BackendEnvironmentName": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The name of the backend environment.

", "smithy.api#jsonName": "backendEnvironmentName" } }, "CreateTime": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The time when the job was created.

", "smithy.api#jsonName": "createTime" } }, "Error": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

If the request fails, this error is returned.

", "smithy.api#jsonName": "error" } }, "JobId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The ID for the job.

", "smithy.api#jsonName": "jobId" } }, "Operation": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The name of the operation.

", "smithy.api#jsonName": "operation" } }, "Status": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The current status of the request.

", "smithy.api#jsonName": "status" } }, "UpdateTime": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The time when the job was last updated.

", "smithy.api#jsonName": "updateTime" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.amplifybackend#GetBackendRequest": { "type": "structure", "members": { "AppId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The app ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "BackendEnvironmentName": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The name of the backend environment.

", "smithy.api#jsonName": "backendEnvironmentName" } } }, "traits": { "smithy.api#documentation": "

The request body for GetBackend.

", "smithy.api#input": {} } }, "com.amazonaws.amplifybackend#GetBackendResponse": { "type": "structure", "members": { "AmplifyFeatureFlags": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

A stringified version of the cli.json file for your Amplify project.

", "smithy.api#jsonName": "amplifyFeatureFlags" } }, "AmplifyMetaConfig": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

A stringified version of the current configs for your Amplify project.

", "smithy.api#jsonName": "amplifyMetaConfig" } }, "AppId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The app ID.

", "smithy.api#jsonName": "appId" } }, "AppName": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The name of the app.

", "smithy.api#jsonName": "appName" } }, "BackendEnvironmentList": { "target": "com.amazonaws.amplifybackend#ListOf__string", "traits": { "smithy.api#documentation": "

A list of backend environments in an array.

", "smithy.api#jsonName": "backendEnvironmentList" } }, "BackendEnvironmentName": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The name of the backend environment.

", "smithy.api#jsonName": "backendEnvironmentName" } }, "Error": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

If the request failed, this is the returned error.

", "smithy.api#jsonName": "error" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.amplifybackend#GetBackendStorage": { "type": "operation", "input": { "target": "com.amazonaws.amplifybackend#GetBackendStorageRequest" }, "output": { "target": "com.amazonaws.amplifybackend#GetBackendStorageResponse" }, "errors": [ { "target": "com.amazonaws.amplifybackend#BadRequestException" }, { "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" }, { "target": "com.amazonaws.amplifybackend#NotFoundException" }, { "target": "com.amazonaws.amplifybackend#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "

Gets details for a backend storage resource.

", "smithy.api#http": { "method": "POST", "uri": "/backend/{AppId}/storage/{BackendEnvironmentName}/details", "code": 200 } } }, "com.amazonaws.amplifybackend#GetBackendStorageRequest": { "type": "structure", "members": { "AppId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The app ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "BackendEnvironmentName": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The name of the backend environment.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ResourceName": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The name of the storage resource.

", "smithy.api#jsonName": "resourceName", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The request body for GetBackendStorage.

", "smithy.api#input": {} } }, "com.amazonaws.amplifybackend#GetBackendStorageResourceConfig": { "type": "structure", "members": { "BucketName": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The name of the S3 bucket.

", "smithy.api#jsonName": "bucketName" } }, "Imported": { "target": "com.amazonaws.amplifybackend#__boolean", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

Returns True if the storage resource has been imported.

", "smithy.api#jsonName": "imported", "smithy.api#required": {} } }, "Permissions": { "target": "com.amazonaws.amplifybackend#BackendStoragePermissions", "traits": { "smithy.api#documentation": "

The authorization configuration for the storage S3 bucket.

", "smithy.api#jsonName": "permissions" } }, "ServiceName": { "target": "com.amazonaws.amplifybackend#ServiceName", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The name of the storage service.

", "smithy.api#jsonName": "serviceName", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The details for a backend storage resource.

" } }, "com.amazonaws.amplifybackend#GetBackendStorageResponse": { "type": "structure", "members": { "AppId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The app ID.

", "smithy.api#jsonName": "appId" } }, "BackendEnvironmentName": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The name of the backend environment.

", "smithy.api#jsonName": "backendEnvironmentName" } }, "ResourceConfig": { "target": "com.amazonaws.amplifybackend#GetBackendStorageResourceConfig", "traits": { "smithy.api#documentation": "

The resource configuration for the backend storage resource.

", "smithy.api#jsonName": "resourceConfig" } }, "ResourceName": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The name of the storage resource.

", "smithy.api#jsonName": "resourceName" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.amplifybackend#GetToken": { "type": "operation", "input": { "target": "com.amazonaws.amplifybackend#GetTokenRequest" }, "output": { "target": "com.amazonaws.amplifybackend#GetTokenResponse" }, "errors": [ { "target": "com.amazonaws.amplifybackend#BadRequestException" }, { "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" }, { "target": "com.amazonaws.amplifybackend#NotFoundException" }, { "target": "com.amazonaws.amplifybackend#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "

Gets the challenge token based on the given appId and sessionId.

", "smithy.api#http": { "method": "GET", "uri": "/backend/{AppId}/challenge/{SessionId}", "code": 200 } } }, "com.amazonaws.amplifybackend#GetTokenRequest": { "type": "structure", "members": { "AppId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The app ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "SessionId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The session ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.amplifybackend#GetTokenResponse": { "type": "structure", "members": { "AppId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The app ID.

", "smithy.api#jsonName": "appId" } }, "ChallengeCode": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The one-time challenge code for authenticating into the Amplify Admin UI.

", "smithy.api#jsonName": "challengeCode" } }, "SessionId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

A unique ID provided when creating a new challenge token.

", "smithy.api#jsonName": "sessionId" } }, "Ttl": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The expiry time for the one-time generated token code.

", "smithy.api#jsonName": "ttl" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.amplifybackend#ImportBackendAuth": { "type": "operation", "input": { "target": "com.amazonaws.amplifybackend#ImportBackendAuthRequest" }, "output": { "target": "com.amazonaws.amplifybackend#ImportBackendAuthResponse" }, "errors": [ { "target": "com.amazonaws.amplifybackend#BadRequestException" }, { "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" }, { "target": "com.amazonaws.amplifybackend#NotFoundException" }, { "target": "com.amazonaws.amplifybackend#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "

Imports an existing backend authentication resource.

", "smithy.api#http": { "method": "POST", "uri": "/backend/{AppId}/auth/{BackendEnvironmentName}/import", "code": 200 } } }, "com.amazonaws.amplifybackend#ImportBackendAuthRequest": { "type": "structure", "members": { "AppId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The app ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "BackendEnvironmentName": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The name of the backend environment.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "IdentityPoolId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The ID of the Amazon Cognito identity pool.

", "smithy.api#jsonName": "identityPoolId" } }, "NativeClientId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The ID of the Amazon Cognito native client.

", "smithy.api#jsonName": "nativeClientId", "smithy.api#required": {} } }, "UserPoolId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The ID of the Amazon Cognito user pool.

", "smithy.api#jsonName": "userPoolId", "smithy.api#required": {} } }, "WebClientId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The ID of the Amazon Cognito web client.

", "smithy.api#jsonName": "webClientId", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The request body for ImportBackendAuth.

", "smithy.api#input": {} } }, "com.amazonaws.amplifybackend#ImportBackendAuthResponse": { "type": "structure", "members": { "AppId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The app ID.

", "smithy.api#jsonName": "appId" } }, "BackendEnvironmentName": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The name of the backend environment.

", "smithy.api#jsonName": "backendEnvironmentName" } }, "Error": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

If the request fails, this error is returned.

", "smithy.api#jsonName": "error" } }, "JobId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The ID for the job.

", "smithy.api#jsonName": "jobId" } }, "Operation": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The name of the operation.

", "smithy.api#jsonName": "operation" } }, "Status": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The current status of the request.

", "smithy.api#jsonName": "status" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.amplifybackend#ImportBackendStorage": { "type": "operation", "input": { "target": "com.amazonaws.amplifybackend#ImportBackendStorageRequest" }, "output": { "target": "com.amazonaws.amplifybackend#ImportBackendStorageResponse" }, "errors": [ { "target": "com.amazonaws.amplifybackend#BadRequestException" }, { "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" }, { "target": "com.amazonaws.amplifybackend#NotFoundException" }, { "target": "com.amazonaws.amplifybackend#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "

Imports an existing backend storage resource.

", "smithy.api#http": { "method": "POST", "uri": "/backend/{AppId}/storage/{BackendEnvironmentName}/import", "code": 200 } } }, "com.amazonaws.amplifybackend#ImportBackendStorageRequest": { "type": "structure", "members": { "AppId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The app ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "BackendEnvironmentName": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The name of the backend environment.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "BucketName": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The name of the S3 bucket.

", "smithy.api#jsonName": "bucketName" } }, "ServiceName": { "target": "com.amazonaws.amplifybackend#ServiceName", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The name of the storage service.

", "smithy.api#jsonName": "serviceName", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The request body for ImportBackendStorage.

", "smithy.api#input": {} } }, "com.amazonaws.amplifybackend#ImportBackendStorageResponse": { "type": "structure", "members": { "AppId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The app ID.

", "smithy.api#jsonName": "appId" } }, "BackendEnvironmentName": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The name of the backend environment.

", "smithy.api#jsonName": "backendEnvironmentName" } }, "JobId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The ID for the job.

", "smithy.api#jsonName": "jobId" } }, "Status": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The current status of the request.

", "smithy.api#jsonName": "status" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.amplifybackend#ListBackendJobs": { "type": "operation", "input": { "target": "com.amazonaws.amplifybackend#ListBackendJobsRequest" }, "output": { "target": "com.amazonaws.amplifybackend#ListBackendJobsResponse" }, "errors": [ { "target": "com.amazonaws.amplifybackend#BadRequestException" }, { "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" }, { "target": "com.amazonaws.amplifybackend#NotFoundException" }, { "target": "com.amazonaws.amplifybackend#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "

Lists the jobs for the backend of an Amplify app.

", "smithy.api#http": { "method": "POST", "uri": "/backend/{AppId}/job/{BackendEnvironmentName}", "code": 200 } } }, "com.amazonaws.amplifybackend#ListBackendJobsRequest": { "type": "structure", "members": { "AppId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The app ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "BackendEnvironmentName": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The name of the backend environment.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "JobId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The ID for the job.

", "smithy.api#jsonName": "jobId" } }, "MaxResults": { "target": "com.amazonaws.amplifybackend#__integerMin1Max25", "traits": { "smithy.api#documentation": "

The maximum number of results that you want in the response.

", "smithy.api#jsonName": "maxResults" } }, "NextToken": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The token for the next set of results.

", "smithy.api#jsonName": "nextToken" } }, "Operation": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

Filters the list of response objects to include only those with the specified operation name.

", "smithy.api#jsonName": "operation" } }, "Status": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

Filters the list of response objects to include only those with the specified status.

", "smithy.api#jsonName": "status" } } }, "traits": { "smithy.api#documentation": "

The request body for ListBackendJobs.

", "smithy.api#input": {} } }, "com.amazonaws.amplifybackend#ListBackendJobsResponse": { "type": "structure", "members": { "Jobs": { "target": "com.amazonaws.amplifybackend#ListOfBackendJobRespObj", "traits": { "smithy.api#documentation": "

An array of jobs and their properties.

", "smithy.api#jsonName": "jobs" } }, "NextToken": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The token for the next set of results.

", "smithy.api#jsonName": "nextToken" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.amplifybackend#ListOfAdditionalConstraintsElement": { "type": "list", "member": { "target": "com.amazonaws.amplifybackend#AdditionalConstraintsElement" } }, "com.amazonaws.amplifybackend#ListOfAuthenticatedElement": { "type": "list", "member": { "target": "com.amazonaws.amplifybackend#AuthenticatedElement" } }, "com.amazonaws.amplifybackend#ListOfBackendAPIAuthType": { "type": "list", "member": { "target": "com.amazonaws.amplifybackend#BackendAPIAuthType" } }, "com.amazonaws.amplifybackend#ListOfBackendJobRespObj": { "type": "list", "member": { "target": "com.amazonaws.amplifybackend#BackendJobRespObj" } }, "com.amazonaws.amplifybackend#ListOfMfaTypesElement": { "type": "list", "member": { "target": "com.amazonaws.amplifybackend#MfaTypesElement" } }, "com.amazonaws.amplifybackend#ListOfOAuthScopesElement": { "type": "list", "member": { "target": "com.amazonaws.amplifybackend#OAuthScopesElement" } }, "com.amazonaws.amplifybackend#ListOfRequiredSignUpAttributesElement": { "type": "list", "member": { "target": "com.amazonaws.amplifybackend#RequiredSignUpAttributesElement" } }, "com.amazonaws.amplifybackend#ListOfS3BucketInfo": { "type": "list", "member": { "target": "com.amazonaws.amplifybackend#S3BucketInfo" } }, "com.amazonaws.amplifybackend#ListOfUnAuthenticatedElement": { "type": "list", "member": { "target": "com.amazonaws.amplifybackend#UnAuthenticatedElement" } }, "com.amazonaws.amplifybackend#ListOf__string": { "type": "list", "member": { "target": "com.amazonaws.amplifybackend#__string" } }, "com.amazonaws.amplifybackend#ListS3Buckets": { "type": "operation", "input": { "target": "com.amazonaws.amplifybackend#ListS3BucketsRequest" }, "output": { "target": "com.amazonaws.amplifybackend#ListS3BucketsResponse" }, "errors": [ { "target": "com.amazonaws.amplifybackend#BadRequestException" }, { "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" }, { "target": "com.amazonaws.amplifybackend#NotFoundException" }, { "target": "com.amazonaws.amplifybackend#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "

The list of S3 buckets in your account.

", "smithy.api#http": { "method": "POST", "uri": "/s3Buckets", "code": 200 } } }, "com.amazonaws.amplifybackend#ListS3BucketsRequest": { "type": "structure", "members": { "NextToken": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

Reserved for future use.

", "smithy.api#jsonName": "nextToken" } } }, "traits": { "smithy.api#documentation": "

The request body for S3Buckets.

", "smithy.api#input": {} } }, "com.amazonaws.amplifybackend#ListS3BucketsResponse": { "type": "structure", "members": { "Buckets": { "target": "com.amazonaws.amplifybackend#ListOfS3BucketInfo", "traits": { "smithy.api#documentation": "

The list of S3 buckets.

", "smithy.api#jsonName": "buckets" } }, "NextToken": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

Reserved for future use.

", "smithy.api#jsonName": "nextToken" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.amplifybackend#LoginAuthConfigReqObj": { "type": "structure", "members": { "AwsCognitoIdentityPoolId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The Amazon Cognito identity pool ID used for the Amplify Admin UI login authorization.

", "smithy.api#jsonName": "aws_cognito_identity_pool_id" } }, "AwsCognitoRegion": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The AWS Region for the Amplify Admin UI login.

", "smithy.api#jsonName": "aws_cognito_region" } }, "AwsUserPoolsId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The Amazon Cognito user pool ID used for Amplify Admin UI login authentication.

", "smithy.api#jsonName": "aws_user_pools_id" } }, "AwsUserPoolsWebClientId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The web client ID for the Amazon Cognito user pools.

", "smithy.api#jsonName": "aws_user_pools_web_client_id" } } }, "traits": { "smithy.api#documentation": "

The request object for this operation.

" } }, "com.amazonaws.amplifybackend#MFAMode": { "type": "enum", "members": { "ON": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ON" } }, "OFF": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OFF" } }, "OPTIONAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OPTIONAL" } } } }, "com.amazonaws.amplifybackend#MfaTypesElement": { "type": "enum", "members": { "SMS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SMS" } }, "TOTP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TOTP" } } } }, "com.amazonaws.amplifybackend#Mode": { "type": "enum", "members": { "API_KEY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "API_KEY" } }, "AWS_IAM": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWS_IAM" } }, "AMAZON_COGNITO_USER_POOLS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AMAZON_COGNITO_USER_POOLS" } }, "OPENID_CONNECT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OPENID_CONNECT" } } } }, "com.amazonaws.amplifybackend#NotFoundException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

An error message to inform that the request has failed.

", "smithy.api#jsonName": "message" } }, "ResourceType": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The type of resource that is not found.

", "smithy.api#jsonName": "resourceType" } } }, "traits": { "smithy.api#documentation": "

An error returned when a specific resource type is not found.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.amplifybackend#OAuthGrantType": { "type": "enum", "members": { "CODE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CODE" } }, "IMPLICIT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IMPLICIT" } } } }, "com.amazonaws.amplifybackend#OAuthScopesElement": { "type": "enum", "members": { "PHONE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PHONE" } }, "EMAIL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EMAIL" } }, "OPENID": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OPENID" } }, "PROFILE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PROFILE" } }, "AWS_COGNITO_SIGNIN_USER_ADMIN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWS_COGNITO_SIGNIN_USER_ADMIN" } } } }, "com.amazonaws.amplifybackend#RemoveAllBackends": { "type": "operation", "input": { "target": "com.amazonaws.amplifybackend#RemoveAllBackendsRequest" }, "output": { "target": "com.amazonaws.amplifybackend#RemoveAllBackendsResponse" }, "errors": [ { "target": "com.amazonaws.amplifybackend#BadRequestException" }, { "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" }, { "target": "com.amazonaws.amplifybackend#NotFoundException" }, { "target": "com.amazonaws.amplifybackend#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "

Removes all backend environments from your Amplify project.

", "smithy.api#http": { "method": "POST", "uri": "/backend/{AppId}/remove", "code": 200 } } }, "com.amazonaws.amplifybackend#RemoveAllBackendsRequest": { "type": "structure", "members": { "AppId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The app ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "CleanAmplifyApp": { "target": "com.amazonaws.amplifybackend#__boolean", "traits": { "smithy.api#documentation": "

Cleans up the Amplify Console app if this value is set to true.

", "smithy.api#jsonName": "cleanAmplifyApp" } } }, "traits": { "smithy.api#documentation": "

The request body for RemoveAllBackends.

", "smithy.api#input": {} } }, "com.amazonaws.amplifybackend#RemoveAllBackendsResponse": { "type": "structure", "members": { "AppId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The app ID.

", "smithy.api#jsonName": "appId" } }, "Error": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

If the request fails, this error is returned.

", "smithy.api#jsonName": "error" } }, "JobId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The ID for the job.

", "smithy.api#jsonName": "jobId" } }, "Operation": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The name of the operation.

", "smithy.api#jsonName": "operation" } }, "Status": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The current status of the request.

", "smithy.api#jsonName": "status" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.amplifybackend#RemoveBackendConfig": { "type": "operation", "input": { "target": "com.amazonaws.amplifybackend#RemoveBackendConfigRequest" }, "output": { "target": "com.amazonaws.amplifybackend#RemoveBackendConfigResponse" }, "errors": [ { "target": "com.amazonaws.amplifybackend#BadRequestException" }, { "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" }, { "target": "com.amazonaws.amplifybackend#NotFoundException" }, { "target": "com.amazonaws.amplifybackend#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "

Removes the AWS resources required to access the Amplify Admin UI.

", "smithy.api#http": { "method": "POST", "uri": "/backend/{AppId}/config/remove", "code": 200 } } }, "com.amazonaws.amplifybackend#RemoveBackendConfigRequest": { "type": "structure", "members": { "AppId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The app ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.amplifybackend#RemoveBackendConfigResponse": { "type": "structure", "members": { "Error": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

If the request fails, this error is returned.

", "smithy.api#jsonName": "error" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.amplifybackend#RequiredSignUpAttributesElement": { "type": "enum", "members": { "ADDRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ADDRESS" } }, "BIRTHDATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BIRTHDATE" } }, "EMAIL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EMAIL" } }, "FAMILY_NAME": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAMILY_NAME" } }, "GENDER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "GENDER" } }, "GIVEN_NAME": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "GIVEN_NAME" } }, "LOCALE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LOCALE" } }, "MIDDLE_NAME": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MIDDLE_NAME" } }, "NAME": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NAME" } }, "NICKNAME": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NICKNAME" } }, "PHONE_NUMBER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PHONE_NUMBER" } }, "PICTURE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PICTURE" } }, "PREFERRED_USERNAME": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PREFERRED_USERNAME" } }, "PROFILE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PROFILE" } }, "UPDATED_AT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UPDATED_AT" } }, "WEBSITE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "WEBSITE" } }, "ZONE_INFO": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ZONE_INFO" } } } }, "com.amazonaws.amplifybackend#ResolutionStrategy": { "type": "enum", "members": { "OPTIMISTIC_CONCURRENCY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OPTIMISTIC_CONCURRENCY" } }, "LAMBDA": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LAMBDA" } }, "AUTOMERGE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AUTOMERGE" } }, "NONE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NONE" } } } }, "com.amazonaws.amplifybackend#ResourceConfig": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "

Defines the resource configuration for the data model in your Amplify project.

" } }, "com.amazonaws.amplifybackend#S3BucketInfo": { "type": "structure", "members": { "CreationDate": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The creation date of the S3 bucket.

", "smithy.api#jsonName": "creationDate" } }, "Name": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The name of the S3 bucket.

", "smithy.api#jsonName": "name" } } }, "traits": { "smithy.api#documentation": "

Describes the metadata of the S3 bucket.

" } }, "com.amazonaws.amplifybackend#Service": { "type": "enum", "members": { "COGNITO": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COGNITO" } } } }, "com.amazonaws.amplifybackend#ServiceName": { "type": "enum", "members": { "S3": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "S3" } } } }, "com.amazonaws.amplifybackend#Settings": { "type": "structure", "members": { "MfaTypes": { "target": "com.amazonaws.amplifybackend#ListOfMfaTypesElement", "traits": { "smithy.api#documentation": "

The supported MFA types.

", "smithy.api#jsonName": "mfaTypes" } }, "SmsMessage": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The body of the SMS message.

", "smithy.api#jsonName": "smsMessage" } } }, "traits": { "smithy.api#documentation": "

The settings of your MFA configuration for the backend of your Amplify project.

" } }, "com.amazonaws.amplifybackend#SignInMethod": { "type": "enum", "members": { "EMAIL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EMAIL" } }, "EMAIL_AND_PHONE_NUMBER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EMAIL_AND_PHONE_NUMBER" } }, "PHONE_NUMBER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PHONE_NUMBER" } }, "USERNAME": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "USERNAME" } } } }, "com.amazonaws.amplifybackend#SmsSettings": { "type": "structure", "members": { "SmsMessage": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The contents of the SMS message.

", "smithy.api#jsonName": "smsMessage" } } }, "traits": { "smithy.api#documentation": "

SMS settings for authentication.

", "smithy.api#sensitive": {} } }, "com.amazonaws.amplifybackend#SocialProviderSettings": { "type": "structure", "members": { "Facebook": { "target": "com.amazonaws.amplifybackend#BackendAuthSocialProviderConfig" }, "Google": { "target": "com.amazonaws.amplifybackend#BackendAuthSocialProviderConfig" }, "LoginWithAmazon": { "target": "com.amazonaws.amplifybackend#BackendAuthSocialProviderConfig" }, "SignInWithApple": { "target": "com.amazonaws.amplifybackend#BackendAuthAppleProviderConfig" } }, "traits": { "smithy.api#documentation": "

The settings for using the social identity providers for access to your Amplify app.

" } }, "com.amazonaws.amplifybackend#Status": { "type": "enum", "members": { "LATEST": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LATEST" } }, "STALE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "STALE" } } } }, "com.amazonaws.amplifybackend#TooManyRequestsException": { "type": "structure", "members": { "LimitType": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The type of limit that was exceeded.

", "smithy.api#jsonName": "limitType" } }, "Message": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

An error message to inform that the request has failed.

", "smithy.api#jsonName": "message" } } }, "traits": { "smithy.api#documentation": "

An error that is returned when a limit of a specific type has been exceeded.

", "smithy.api#error": "client", "smithy.api#httpError": 429 } }, "com.amazonaws.amplifybackend#UnAuthenticatedElement": { "type": "enum", "members": { "READ": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "READ" } }, "CREATE_AND_UPDATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATE_AND_UPDATE" } }, "DELETE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETE" } } } }, "com.amazonaws.amplifybackend#UpdateBackendAPI": { "type": "operation", "input": { "target": "com.amazonaws.amplifybackend#UpdateBackendAPIRequest" }, "output": { "target": "com.amazonaws.amplifybackend#UpdateBackendAPIResponse" }, "errors": [ { "target": "com.amazonaws.amplifybackend#BadRequestException" }, { "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" }, { "target": "com.amazonaws.amplifybackend#NotFoundException" }, { "target": "com.amazonaws.amplifybackend#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "

Updates an existing backend API resource.

", "smithy.api#http": { "method": "POST", "uri": "/backend/{AppId}/api/{BackendEnvironmentName}", "code": 200 } } }, "com.amazonaws.amplifybackend#UpdateBackendAPIRequest": { "type": "structure", "members": { "AppId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The app ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "BackendEnvironmentName": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The name of the backend environment.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ResourceConfig": { "target": "com.amazonaws.amplifybackend#BackendAPIResourceConfig", "traits": { "smithy.api#documentation": "

Defines the resource configuration for the data model in your Amplify project.

", "smithy.api#jsonName": "resourceConfig" } }, "ResourceName": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The name of this resource.

", "smithy.api#jsonName": "resourceName", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The request body for UpdateBackendAPI.

", "smithy.api#input": {} } }, "com.amazonaws.amplifybackend#UpdateBackendAPIResponse": { "type": "structure", "members": { "AppId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The app ID.

", "smithy.api#jsonName": "appId" } }, "BackendEnvironmentName": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The name of the backend environment.

", "smithy.api#jsonName": "backendEnvironmentName" } }, "Error": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

If the request fails, this error is returned.

", "smithy.api#jsonName": "error" } }, "JobId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The ID for the job.

", "smithy.api#jsonName": "jobId" } }, "Operation": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The name of the operation.

", "smithy.api#jsonName": "operation" } }, "Status": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The current status of the request.

", "smithy.api#jsonName": "status" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.amplifybackend#UpdateBackendAuth": { "type": "operation", "input": { "target": "com.amazonaws.amplifybackend#UpdateBackendAuthRequest" }, "output": { "target": "com.amazonaws.amplifybackend#UpdateBackendAuthResponse" }, "errors": [ { "target": "com.amazonaws.amplifybackend#BadRequestException" }, { "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" }, { "target": "com.amazonaws.amplifybackend#NotFoundException" }, { "target": "com.amazonaws.amplifybackend#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "

Updates an existing backend authentication resource.

", "smithy.api#http": { "method": "POST", "uri": "/backend/{AppId}/auth/{BackendEnvironmentName}", "code": 200 } } }, "com.amazonaws.amplifybackend#UpdateBackendAuthForgotPasswordConfig": { "type": "structure", "members": { "DeliveryMethod": { "target": "com.amazonaws.amplifybackend#DeliveryMethod", "traits": { "smithy.api#documentation": "

(DEPRECATED) Describes which mode to use (either SMS or email) to deliver messages to app users that want to recover their password.

", "smithy.api#jsonName": "deliveryMethod" } }, "EmailSettings": { "target": "com.amazonaws.amplifybackend#EmailSettings", "traits": { "smithy.api#documentation": "

(DEPRECATED) The configuration for the email sent when an app user forgets their password.

", "smithy.api#jsonName": "emailSettings" } }, "SmsSettings": { "target": "com.amazonaws.amplifybackend#SmsSettings", "traits": { "smithy.api#documentation": "

(DEPRECATED) The configuration for the SMS message sent when an Amplify app user forgets their password.

", "smithy.api#jsonName": "smsSettings" } } }, "traits": { "smithy.api#documentation": "

(DEPRECATED) Describes the forgot password policy for authenticating into the Amplify app.

" } }, "com.amazonaws.amplifybackend#UpdateBackendAuthIdentityPoolConfig": { "type": "structure", "members": { "UnauthenticatedLogin": { "target": "com.amazonaws.amplifybackend#__boolean", "traits": { "smithy.api#documentation": "

A boolean value that can be set to allow or disallow guest-level authorization into your Amplify app.

", "smithy.api#jsonName": "unauthenticatedLogin" } } }, "traits": { "smithy.api#documentation": "

Describes the authorization configuration for the Amazon Cognito identity pool, provisioned as a part of your auth resource in the Amplify project.

" } }, "com.amazonaws.amplifybackend#UpdateBackendAuthMFAConfig": { "type": "structure", "members": { "MFAMode": { "target": "com.amazonaws.amplifybackend#MFAMode", "traits": { "smithy.api#documentation": "

The MFA mode for the backend of your Amplify project.

" } }, "Settings": { "target": "com.amazonaws.amplifybackend#Settings", "traits": { "smithy.api#documentation": "

The settings of your MFA configuration for the backend of your Amplify project.

", "smithy.api#jsonName": "settings" } } }, "traits": { "smithy.api#documentation": "

Updates the multi-factor authentication (MFA) configuration for the backend of your Amplify project.

" } }, "com.amazonaws.amplifybackend#UpdateBackendAuthOAuthConfig": { "type": "structure", "members": { "DomainPrefix": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The Amazon Cognito domain prefix used to create a hosted UI for authentication.

", "smithy.api#jsonName": "domainPrefix" } }, "OAuthGrantType": { "target": "com.amazonaws.amplifybackend#OAuthGrantType", "traits": { "smithy.api#documentation": "

The OAuth grant type to allow app users to authenticate from your Amplify app.

", "smithy.api#jsonName": "oAuthGrantType" } }, "OAuthScopes": { "target": "com.amazonaws.amplifybackend#ListOfOAuthScopesElement", "traits": { "smithy.api#documentation": "

The list of OAuth-related flows that can allow users to authenticate from your Amplify app.

", "smithy.api#jsonName": "oAuthScopes" } }, "RedirectSignInURIs": { "target": "com.amazonaws.amplifybackend#ListOf__string", "traits": { "smithy.api#documentation": "

Redirect URLs that OAuth uses when a user signs in to an Amplify app.

", "smithy.api#jsonName": "redirectSignInURIs" } }, "RedirectSignOutURIs": { "target": "com.amazonaws.amplifybackend#ListOf__string", "traits": { "smithy.api#documentation": "

Redirect URLs that OAuth uses when a user signs out of an Amplify app.

", "smithy.api#jsonName": "redirectSignOutURIs" } }, "SocialProviderSettings": { "target": "com.amazonaws.amplifybackend#SocialProviderSettings", "traits": { "smithy.api#documentation": "

Describes third-party social federation configurations for allowing your users to sign in with OAuth.

", "smithy.api#jsonName": "socialProviderSettings" } } }, "traits": { "smithy.api#documentation": "

The OAuth configurations for authenticating users into your Amplify app.

" } }, "com.amazonaws.amplifybackend#UpdateBackendAuthPasswordPolicyConfig": { "type": "structure", "members": { "AdditionalConstraints": { "target": "com.amazonaws.amplifybackend#ListOfAdditionalConstraintsElement", "traits": { "smithy.api#documentation": "

Describes additional constraints on password requirements to sign in to the auth resource, configured as a part of your Amplify project.

", "smithy.api#jsonName": "additionalConstraints" } }, "MinimumLength": { "target": "com.amazonaws.amplifybackend#__double", "traits": { "smithy.api#documentation": "

Describes the minimum length of the password required to sign in to the auth resource, configured as a part of your Amplify project.

", "smithy.api#jsonName": "minimumLength" } } }, "traits": { "smithy.api#documentation": "

Describes the password policy for your Amazon Cognito user pool configured as a part of your Amplify project.

" } }, "com.amazonaws.amplifybackend#UpdateBackendAuthRequest": { "type": "structure", "members": { "AppId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The app ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "BackendEnvironmentName": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The name of the backend environment.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ResourceConfig": { "target": "com.amazonaws.amplifybackend#UpdateBackendAuthResourceConfig", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The resource configuration for this request object.

", "smithy.api#jsonName": "resourceConfig", "smithy.api#required": {} } }, "ResourceName": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The name of this resource.

", "smithy.api#jsonName": "resourceName", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The request body for UpdateBackendAuth.

", "smithy.api#input": {} } }, "com.amazonaws.amplifybackend#UpdateBackendAuthResourceConfig": { "type": "structure", "members": { "AuthResources": { "target": "com.amazonaws.amplifybackend#AuthResources", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

Defines the service name to use when configuring an authentication resource in your Amplify project.

", "smithy.api#jsonName": "authResources", "smithy.api#required": {} } }, "IdentityPoolConfigs": { "target": "com.amazonaws.amplifybackend#UpdateBackendAuthIdentityPoolConfig", "traits": { "smithy.api#documentation": "

Describes the authorization configuration for the Amazon Cognito identity pool, provisioned as a part of your auth resource in the Amplify project.

", "smithy.api#jsonName": "identityPoolConfigs" } }, "Service": { "target": "com.amazonaws.amplifybackend#Service", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

Defines the service name to use when configuring an authentication resource in your Amplify project.

", "smithy.api#jsonName": "service", "smithy.api#required": {} } }, "UserPoolConfigs": { "target": "com.amazonaws.amplifybackend#UpdateBackendAuthUserPoolConfig", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

Describes the authentication configuration for the Amazon Cognito user pool, provisioned as a part of your auth resource in the Amplify project.

", "smithy.api#jsonName": "userPoolConfigs", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Defines the resource configuration when updating an authentication resource in your Amplify project.

" } }, "com.amazonaws.amplifybackend#UpdateBackendAuthResponse": { "type": "structure", "members": { "AppId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The app ID.

", "smithy.api#jsonName": "appId" } }, "BackendEnvironmentName": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The name of the backend environment.

", "smithy.api#jsonName": "backendEnvironmentName" } }, "Error": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

If the request fails, this error is returned.

", "smithy.api#jsonName": "error" } }, "JobId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The ID for the job.

", "smithy.api#jsonName": "jobId" } }, "Operation": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The name of the operation.

", "smithy.api#jsonName": "operation" } }, "Status": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The current status of the request.

", "smithy.api#jsonName": "status" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.amplifybackend#UpdateBackendAuthUserPoolConfig": { "type": "structure", "members": { "ForgotPassword": { "target": "com.amazonaws.amplifybackend#UpdateBackendAuthForgotPasswordConfig", "traits": { "smithy.api#documentation": "

(DEPRECATED) Describes the forgot password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.

", "smithy.api#jsonName": "forgotPassword" } }, "Mfa": { "target": "com.amazonaws.amplifybackend#UpdateBackendAuthMFAConfig", "traits": { "smithy.api#documentation": "

Describes whether to apply multi-factor authentication policies for your Amazon Cognito user pool configured as a part of your Amplify project.

", "smithy.api#jsonName": "mfa" } }, "OAuth": { "target": "com.amazonaws.amplifybackend#UpdateBackendAuthOAuthConfig", "traits": { "smithy.api#documentation": "

Describes the OAuth policy and rules for your Amazon Cognito user pool, configured as a part of your Amplify project.

", "smithy.api#jsonName": "oAuth" } }, "PasswordPolicy": { "target": "com.amazonaws.amplifybackend#UpdateBackendAuthPasswordPolicyConfig", "traits": { "smithy.api#documentation": "

Describes the password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.

", "smithy.api#jsonName": "passwordPolicy" } }, "VerificationMessage": { "target": "com.amazonaws.amplifybackend#UpdateBackendAuthVerificationMessageConfig", "traits": { "smithy.api#documentation": "

Describes the email or SMS verification message for your Amazon Cognito user pool, configured as a part of your Amplify project.

", "smithy.api#jsonName": "verificationMessage" } } }, "traits": { "smithy.api#documentation": "

Describes the Amazon Cognito user pool configuration for the authorization resource to be configured for your Amplify project on an update.

" } }, "com.amazonaws.amplifybackend#UpdateBackendAuthVerificationMessageConfig": { "type": "structure", "members": { "DeliveryMethod": { "target": "com.amazonaws.amplifybackend#DeliveryMethod", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The type of verification message to send.

", "smithy.api#jsonName": "deliveryMethod", "smithy.api#required": {} } }, "EmailSettings": { "target": "com.amazonaws.amplifybackend#EmailSettings", "traits": { "smithy.api#documentation": "

The settings for the email message.

", "smithy.api#jsonName": "emailSettings" } }, "SmsSettings": { "target": "com.amazonaws.amplifybackend#SmsSettings", "traits": { "smithy.api#documentation": "

The settings for the SMS message.

", "smithy.api#jsonName": "smsSettings" } } }, "traits": { "smithy.api#documentation": "

Updates the configuration of the email or SMS message for the auth resource configured for your Amplify project.

" } }, "com.amazonaws.amplifybackend#UpdateBackendConfig": { "type": "operation", "input": { "target": "com.amazonaws.amplifybackend#UpdateBackendConfigRequest" }, "output": { "target": "com.amazonaws.amplifybackend#UpdateBackendConfigResponse" }, "errors": [ { "target": "com.amazonaws.amplifybackend#BadRequestException" }, { "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" }, { "target": "com.amazonaws.amplifybackend#NotFoundException" }, { "target": "com.amazonaws.amplifybackend#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "

Updates the AWS resources required to access the Amplify Admin UI.

", "smithy.api#http": { "method": "POST", "uri": "/backend/{AppId}/config/update", "code": 200 } } }, "com.amazonaws.amplifybackend#UpdateBackendConfigRequest": { "type": "structure", "members": { "AppId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The app ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "LoginAuthConfig": { "target": "com.amazonaws.amplifybackend#LoginAuthConfigReqObj", "traits": { "smithy.api#documentation": "

Describes the Amazon Cognito configuration for Admin UI access.

", "smithy.api#jsonName": "loginAuthConfig" } } }, "traits": { "smithy.api#documentation": "

The request body for UpdateBackendConfig.

", "smithy.api#input": {} } }, "com.amazonaws.amplifybackend#UpdateBackendConfigResponse": { "type": "structure", "members": { "AppId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The app ID.

", "smithy.api#jsonName": "appId" } }, "BackendManagerAppId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The app ID for the backend manager.

", "smithy.api#jsonName": "backendManagerAppId" } }, "Error": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

If the request fails, this error is returned.

", "smithy.api#jsonName": "error" } }, "LoginAuthConfig": { "target": "com.amazonaws.amplifybackend#LoginAuthConfigReqObj", "traits": { "smithy.api#documentation": "

Describes the Amazon Cognito configurations for the Admin UI auth resource to log in with.

", "smithy.api#jsonName": "loginAuthConfig" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.amplifybackend#UpdateBackendJob": { "type": "operation", "input": { "target": "com.amazonaws.amplifybackend#UpdateBackendJobRequest" }, "output": { "target": "com.amazonaws.amplifybackend#UpdateBackendJobResponse" }, "errors": [ { "target": "com.amazonaws.amplifybackend#BadRequestException" }, { "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" }, { "target": "com.amazonaws.amplifybackend#NotFoundException" }, { "target": "com.amazonaws.amplifybackend#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "

Updates a specific job.

", "smithy.api#http": { "method": "POST", "uri": "/backend/{AppId}/job/{BackendEnvironmentName}/{JobId}", "code": 200 } } }, "com.amazonaws.amplifybackend#UpdateBackendJobRequest": { "type": "structure", "members": { "AppId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The app ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "BackendEnvironmentName": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The name of the backend environment.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "JobId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The ID for the job.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Operation": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

Filters the list of response objects to include only those with the specified operation name.

", "smithy.api#jsonName": "operation" } }, "Status": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

Filters the list of response objects to include only those with the specified status.

", "smithy.api#jsonName": "status" } } }, "traits": { "smithy.api#documentation": "

The request body for GetBackendJob.

", "smithy.api#input": {} } }, "com.amazonaws.amplifybackend#UpdateBackendJobResponse": { "type": "structure", "members": { "AppId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The app ID.

", "smithy.api#jsonName": "appId" } }, "BackendEnvironmentName": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The name of the backend environment.

", "smithy.api#jsonName": "backendEnvironmentName" } }, "CreateTime": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The time when the job was created.

", "smithy.api#jsonName": "createTime" } }, "Error": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

If the request fails, this error is returned.

", "smithy.api#jsonName": "error" } }, "JobId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The ID for the job.

", "smithy.api#jsonName": "jobId" } }, "Operation": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The name of the operation.

", "smithy.api#jsonName": "operation" } }, "Status": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The current status of the request.

", "smithy.api#jsonName": "status" } }, "UpdateTime": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The time when the job was last updated.

", "smithy.api#jsonName": "updateTime" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.amplifybackend#UpdateBackendStorage": { "type": "operation", "input": { "target": "com.amazonaws.amplifybackend#UpdateBackendStorageRequest" }, "output": { "target": "com.amazonaws.amplifybackend#UpdateBackendStorageResponse" }, "errors": [ { "target": "com.amazonaws.amplifybackend#BadRequestException" }, { "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" }, { "target": "com.amazonaws.amplifybackend#NotFoundException" }, { "target": "com.amazonaws.amplifybackend#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "

Updates an existing backend storage resource.

", "smithy.api#http": { "method": "POST", "uri": "/backend/{AppId}/storage/{BackendEnvironmentName}", "code": 200 } } }, "com.amazonaws.amplifybackend#UpdateBackendStorageRequest": { "type": "structure", "members": { "AppId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The app ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "BackendEnvironmentName": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The name of the backend environment.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ResourceConfig": { "target": "com.amazonaws.amplifybackend#UpdateBackendStorageResourceConfig", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The resource configuration for updating backend storage.

", "smithy.api#jsonName": "resourceConfig", "smithy.api#required": {} } }, "ResourceName": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The name of the storage resource.

", "smithy.api#jsonName": "resourceName", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The request body for UpdateBackendStorage.

", "smithy.api#input": {} } }, "com.amazonaws.amplifybackend#UpdateBackendStorageResourceConfig": { "type": "structure", "members": { "Permissions": { "target": "com.amazonaws.amplifybackend#BackendStoragePermissions", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The authorization configuration for the storage S3 bucket.

", "smithy.api#jsonName": "permissions", "smithy.api#required": {} } }, "ServiceName": { "target": "com.amazonaws.amplifybackend#ServiceName", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The name of the storage service.

", "smithy.api#jsonName": "serviceName", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The resource configuration for updating backend storage.

" } }, "com.amazonaws.amplifybackend#UpdateBackendStorageResponse": { "type": "structure", "members": { "AppId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The app ID.

", "smithy.api#jsonName": "appId" } }, "BackendEnvironmentName": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The name of the backend environment.

", "smithy.api#jsonName": "backendEnvironmentName" } }, "JobId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The ID for the job.

", "smithy.api#jsonName": "jobId" } }, "Status": { "target": "com.amazonaws.amplifybackend#__string", "traits": { "smithy.api#documentation": "

The current status of the request.

", "smithy.api#jsonName": "status" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.amplifybackend#__boolean": { "type": "boolean" }, "com.amazonaws.amplifybackend#__double": { "type": "double" }, "com.amazonaws.amplifybackend#__integerMin1Max25": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 25 } } }, "com.amazonaws.amplifybackend#__string": { "type": "string" } } }