libZSservicesZSamazonka-amplifybackendZSamazonka-amplifybackend
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.AmplifyBackend.Lens

Description

 
Synopsis

Operations

CloneBackend

cloneBackend_backendEnvironmentName :: Lens' CloneBackend Text Source #

The name of the backend environment.

cloneBackend_targetEnvironmentName :: Lens' CloneBackend Text Source #

The name of the destination backend environment to be created.

cloneBackendResponse_error :: Lens' CloneBackendResponse (Maybe Text) Source #

If the request fails, this error is returned.

DeleteToken

deleteTokenResponse_isSuccess :: Lens' DeleteTokenResponse (Maybe Bool) Source #

Indicates whether the request succeeded or failed.

CreateBackendConfig

ListBackendJobs

listBackendJobs_status :: Lens' ListBackendJobs (Maybe Text) Source #

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

listBackendJobs_operation :: Lens' ListBackendJobs (Maybe Text) Source #

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

listBackendJobs_nextToken :: Lens' ListBackendJobs (Maybe Text) Source #

The token for the next set of results.

listBackendJobs_maxResults :: Lens' ListBackendJobs (Maybe Natural) Source #

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

GetBackend

getBackend_backendEnvironmentName :: Lens' GetBackend (Maybe Text) Source #

The name of the backend environment.

getBackendResponse_error :: Lens' GetBackendResponse (Maybe Text) Source #

If the request failed, this is the returned error.

getBackendResponse_amplifyMetaConfig :: Lens' GetBackendResponse (Maybe Text) Source #

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

getBackendResponse_amplifyFeatureFlags :: Lens' GetBackendResponse (Maybe Text) Source #

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

getBackendResponse_backendEnvironmentList :: Lens' GetBackendResponse (Maybe [Text]) Source #

A list of backend environments in an array.

GetBackendAuth

getBackendAuthResponse_error :: Lens' GetBackendAuthResponse (Maybe Text) Source #

If the request fails, this error is returned.

getBackendAuthResponse_resourceConfig :: Lens' GetBackendAuthResponse (Maybe CreateBackendAuthResourceConfig) Source #

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

CreateBackendAuth

createBackendAuthResponse_error :: Lens' CreateBackendAuthResponse (Maybe Text) Source #

If the request fails, this error is returned.

RemoveBackendConfig

removeBackendConfigResponse_error :: Lens' RemoveBackendConfigResponse (Maybe Text) Source #

If the request fails, this error is returned.

CreateBackend

createBackend_resourceConfig :: Lens' CreateBackend (Maybe ResourceConfig) Source #

The resource configuration for the create backend request.

createBackend_backendEnvironmentName :: Lens' CreateBackend Text Source #

The name of the backend environment.

createBackendResponse_error :: Lens' CreateBackendResponse (Maybe Text) Source #

If the request fails, this error is returned.

GenerateBackendAPIModels

UpdateBackendConfig

updateBackendConfig_loginAuthConfig :: Lens' UpdateBackendConfig (Maybe LoginAuthConfigReqObj) Source #

Describes the Amazon Cognito configuration for Admin UI access.

updateBackendConfigResponse_error :: Lens' UpdateBackendConfigResponse (Maybe Text) Source #

If the request fails, this error is returned.

updateBackendConfigResponse_loginAuthConfig :: Lens' UpdateBackendConfigResponse (Maybe LoginAuthConfigReqObj) Source #

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

CreateToken

createTokenResponse_ttl :: Lens' CreateTokenResponse (Maybe Text) Source #

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

createTokenResponse_sessionId :: Lens' CreateTokenResponse (Maybe Text) Source #

A unique ID provided when creating a new challenge token.

createTokenResponse_challengeCode :: Lens' CreateTokenResponse (Maybe Text) Source #

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

GetBackendAPI

getBackendAPI_resourceConfig :: Lens' GetBackendAPI (Maybe BackendAPIResourceConfig) Source #

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

getBackendAPI_backendEnvironmentName :: Lens' GetBackendAPI Text Source #

The name of the backend environment.

getBackendAPIResponse_error :: Lens' GetBackendAPIResponse (Maybe Text) Source #

If the request fails, this error is returned.

UpdateBackendJob

updateBackendJob_status :: Lens' UpdateBackendJob (Maybe Text) Source #

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

updateBackendJob_operation :: Lens' UpdateBackendJob (Maybe Text) Source #

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

updateBackendJobResponse_error :: Lens' UpdateBackendJobResponse (Maybe Text) Source #

If the request fails, this error is returned.

UpdateBackendAPI

updateBackendAPI_resourceConfig :: Lens' UpdateBackendAPI (Maybe BackendAPIResourceConfig) Source #

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

updateBackendAPIResponse_error :: Lens' UpdateBackendAPIResponse (Maybe Text) Source #

If the request fails, this error is returned.

DeleteBackendAPI

deleteBackendAPI_resourceConfig :: Lens' DeleteBackendAPI (Maybe BackendAPIResourceConfig) Source #

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

deleteBackendAPIResponse_error :: Lens' DeleteBackendAPIResponse (Maybe Text) Source #

If the request fails, this error is returned.

GetBackendJob

getBackendJob_backendEnvironmentName :: Lens' GetBackendJob Text Source #

The name of the backend environment.

getBackendJobResponse_error :: Lens' GetBackendJobResponse (Maybe Text) Source #

If the request fails, this error is returned.

getBackendJobResponse_updateTime :: Lens' GetBackendJobResponse (Maybe Text) Source #

The time when the job was last updated.

DeleteBackend

deleteBackend_backendEnvironmentName :: Lens' DeleteBackend Text Source #

The name of the backend environment.

deleteBackendResponse_error :: Lens' DeleteBackendResponse (Maybe Text) Source #

If the request fails, this error is returned.

DeleteBackendAuth

deleteBackendAuthResponse_error :: Lens' DeleteBackendAuthResponse (Maybe Text) Source #

If the request fails, this error is returned.

UpdateBackendAuth

updateBackendAuthResponse_error :: Lens' UpdateBackendAuthResponse (Maybe Text) Source #

If the request fails, this error is returned.

GetToken

getTokenResponse_ttl :: Lens' GetTokenResponse (Maybe Text) Source #

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

getTokenResponse_sessionId :: Lens' GetTokenResponse (Maybe Text) Source #

A unique ID provided when creating a new challenge token.

getTokenResponse_challengeCode :: Lens' GetTokenResponse (Maybe Text) Source #

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

getTokenResponse_httpStatus :: Lens' GetTokenResponse Int Source #

The response's http status code.

RemoveAllBackends

removeAllBackends_cleanAmplifyApp :: Lens' RemoveAllBackends (Maybe Bool) Source #

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

removeAllBackendsResponse_error :: Lens' RemoveAllBackendsResponse (Maybe Text) Source #

If the request fails, this error is returned.

CreateBackendAPI

createBackendAPIResponse_error :: Lens' CreateBackendAPIResponse (Maybe Text) Source #

If the request fails, this error is returned.

GetBackendAPIModels

ImportBackendAuth

importBackendAuth_identityPoolId :: Lens' ImportBackendAuth (Maybe Text) Source #

The ID of the Amazon Cognito identity pool.

importBackendAuth_userPoolId :: Lens' ImportBackendAuth Text Source #

The ID of the Amazon Cognito user pool.

importBackendAuth_nativeClientId :: Lens' ImportBackendAuth Text Source #

The ID of the Amazon Cognito native client.

importBackendAuth_webClientId :: Lens' ImportBackendAuth Text Source #

The ID of the Amazon Cognito web client.

importBackendAuthResponse_error :: Lens' ImportBackendAuthResponse (Maybe Text) Source #

If the request fails, this error is returned.

Types

BackendAPIAppSyncAuthSettings

backendAPIAppSyncAuthSettings_openIDProviderName :: Lens' BackendAPIAppSyncAuthSettings (Maybe Text) Source #

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

backendAPIAppSyncAuthSettings_openIDClientId :: Lens' BackendAPIAppSyncAuthSettings (Maybe Text) Source #

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

backendAPIAppSyncAuthSettings_openIDIssueURL :: Lens' BackendAPIAppSyncAuthSettings (Maybe Text) Source #

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

backendAPIAppSyncAuthSettings_cognitoUserPoolId :: Lens' BackendAPIAppSyncAuthSettings (Maybe Text) Source #

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

backendAPIAppSyncAuthSettings_openIDAuthTTL :: Lens' BackendAPIAppSyncAuthSettings (Maybe Text) Source #

The expiry time for the OpenID authentication mechanism.

backendAPIAppSyncAuthSettings_description :: Lens' BackendAPIAppSyncAuthSettings (Maybe Text) Source #

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

backendAPIAppSyncAuthSettings_expirationTime :: Lens' BackendAPIAppSyncAuthSettings (Maybe Double) Source #

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

backendAPIAppSyncAuthSettings_openIDIatTTL :: Lens' BackendAPIAppSyncAuthSettings (Maybe Text) Source #

The expiry time for the OpenID authentication mechanism.

BackendAPIAuthType

backendAPIAuthType_mode :: Lens' BackendAPIAuthType (Maybe Mode) Source #

Describes the authentication mode.

BackendAPIConflictResolution

BackendAPIResourceConfig

backendAPIResourceConfig_apiName :: Lens' BackendAPIResourceConfig (Maybe Text) Source #

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

backendAPIResourceConfig_service :: Lens' BackendAPIResourceConfig (Maybe Text) Source #

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

backendAPIResourceConfig_transformSchema :: Lens' BackendAPIResourceConfig (Maybe Text) Source #

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

backendAPIResourceConfig_additionalAuthTypes :: Lens' BackendAPIResourceConfig (Maybe [BackendAPIAuthType]) Source #

Additional authentication methods used to interact with your data models.

backendAPIResourceConfig_conflictResolution :: Lens' BackendAPIResourceConfig (Maybe BackendAPIConflictResolution) Source #

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

backendAPIResourceConfig_defaultAuthType :: Lens' BackendAPIResourceConfig (Maybe BackendAPIAuthType) Source #

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

BackendAuthAppleProviderConfig

backendAuthAppleProviderConfig_clientId :: Lens' BackendAuthAppleProviderConfig (Maybe Text) Source #

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

BackendAuthSocialProviderConfig

backendAuthSocialProviderConfig_clientId :: Lens' BackendAuthSocialProviderConfig (Maybe Text) Source #

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

backendAuthSocialProviderConfig_clientSecret :: Lens' BackendAuthSocialProviderConfig (Maybe Text) Source #

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

BackendJobRespObj

backendJobRespObj_status :: Lens' BackendJobRespObj (Maybe Text) Source #

The current status of the request.

backendJobRespObj_error :: Lens' BackendJobRespObj (Maybe Text) Source #

If the request fails, this error is returned.

backendJobRespObj_updateTime :: Lens' BackendJobRespObj (Maybe Text) Source #

The time when the job was last updated.

backendJobRespObj_createTime :: Lens' BackendJobRespObj (Maybe Text) Source #

The time when the job was created.

CreateBackendAuthForgotPasswordConfig

createBackendAuthForgotPasswordConfig_emailSettings :: Lens' CreateBackendAuthForgotPasswordConfig (Maybe EmailSettings) Source #

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

createBackendAuthForgotPasswordConfig_smsSettings :: Lens' CreateBackendAuthForgotPasswordConfig (Maybe SmsSettings) Source #

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

createBackendAuthForgotPasswordConfig_deliveryMethod :: Lens' CreateBackendAuthForgotPasswordConfig DeliveryMethod Source #

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

CreateBackendAuthIdentityPoolConfig

createBackendAuthIdentityPoolConfig_unauthenticatedLogin :: Lens' CreateBackendAuthIdentityPoolConfig Bool Source #

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

createBackendAuthIdentityPoolConfig_identityPoolName :: Lens' CreateBackendAuthIdentityPoolConfig Text Source #

Name of the Amazon Cognito identity pool used for authorization.

CreateBackendAuthMFAConfig

createBackendAuthMFAConfig_settings :: Lens' CreateBackendAuthMFAConfig (Maybe Settings) Source #

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

createBackendAuthMFAConfig_mfaMode :: Lens' CreateBackendAuthMFAConfig MFAMode Source #

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

CreateBackendAuthOAuthConfig

createBackendAuthOAuthConfig_redirectSignOutURIs :: Lens' CreateBackendAuthOAuthConfig [Text] Source #

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

createBackendAuthOAuthConfig_redirectSignInURIs :: Lens' CreateBackendAuthOAuthConfig [Text] Source #

The redirected URI for signing in to your Amplify app.

createBackendAuthOAuthConfig_oAuthGrantType :: Lens' CreateBackendAuthOAuthConfig OAuthGrantType Source #

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

createBackendAuthOAuthConfig_oAuthScopes :: Lens' CreateBackendAuthOAuthConfig [OAuthScopesElement] Source #

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

CreateBackendAuthPasswordPolicyConfig

createBackendAuthPasswordPolicyConfig_additionalConstraints :: Lens' CreateBackendAuthPasswordPolicyConfig (Maybe [AdditionalConstraintsElement]) Source #

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

createBackendAuthPasswordPolicyConfig_minimumLength :: Lens' CreateBackendAuthPasswordPolicyConfig Double Source #

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

CreateBackendAuthResourceConfig

createBackendAuthResourceConfig_identityPoolConfigs :: Lens' CreateBackendAuthResourceConfig (Maybe CreateBackendAuthIdentityPoolConfig) Source #

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

createBackendAuthResourceConfig_authResources :: Lens' CreateBackendAuthResourceConfig AuthResources Source #

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

createBackendAuthResourceConfig_userPoolConfigs :: Lens' CreateBackendAuthResourceConfig CreateBackendAuthUserPoolConfig Source #

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

createBackendAuthResourceConfig_service :: Lens' CreateBackendAuthResourceConfig Service Source #

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

CreateBackendAuthUserPoolConfig

createBackendAuthUserPoolConfig_passwordPolicy :: Lens' CreateBackendAuthUserPoolConfig (Maybe CreateBackendAuthPasswordPolicyConfig) Source #

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

createBackendAuthUserPoolConfig_mfa :: Lens' CreateBackendAuthUserPoolConfig (Maybe CreateBackendAuthMFAConfig) Source #

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

createBackendAuthUserPoolConfig_forgotPassword :: Lens' CreateBackendAuthUserPoolConfig (Maybe CreateBackendAuthForgotPasswordConfig) Source #

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

createBackendAuthUserPoolConfig_oAuth :: Lens' CreateBackendAuthUserPoolConfig (Maybe CreateBackendAuthOAuthConfig) Source #

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

createBackendAuthUserPoolConfig_signInMethod :: Lens' CreateBackendAuthUserPoolConfig SignInMethod Source #

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.

EmailSettings

LoginAuthConfigReqObj

loginAuthConfigReqObj_awsUserPoolsWebClientId :: Lens' LoginAuthConfigReqObj (Maybe Text) Source #

The web client ID for the Amazon Cognito user pools.

loginAuthConfigReqObj_awsCognitoIdentityPoolId :: Lens' LoginAuthConfigReqObj (Maybe Text) Source #

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

loginAuthConfigReqObj_awsUserPoolsId :: Lens' LoginAuthConfigReqObj (Maybe Text) Source #

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

loginAuthConfigReqObj_awsCognitoRegion :: Lens' LoginAuthConfigReqObj (Maybe Text) Source #

The AWS Region for the Amplify Admin UI login.

ResourceConfig

Settings

settings_smsMessage :: Lens' Settings (Maybe Text) Source #

The body of the SMS message.

SmsSettings

smsSettings_smsMessage :: Lens' SmsSettings (Maybe Text) Source #

The body of the SMS message.

SocialProviderSettings

UpdateBackendAuthForgotPasswordConfig

updateBackendAuthForgotPasswordConfig_emailSettings :: Lens' UpdateBackendAuthForgotPasswordConfig (Maybe EmailSettings) Source #

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

updateBackendAuthForgotPasswordConfig_smsSettings :: Lens' UpdateBackendAuthForgotPasswordConfig (Maybe SmsSettings) Source #

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

updateBackendAuthForgotPasswordConfig_deliveryMethod :: Lens' UpdateBackendAuthForgotPasswordConfig (Maybe DeliveryMethod) Source #

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

UpdateBackendAuthIdentityPoolConfig

updateBackendAuthIdentityPoolConfig_unauthenticatedLogin :: Lens' UpdateBackendAuthIdentityPoolConfig (Maybe Bool) Source #

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

UpdateBackendAuthMFAConfig

updateBackendAuthMFAConfig_settings :: Lens' UpdateBackendAuthMFAConfig (Maybe Settings) Source #

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

updateBackendAuthMFAConfig_mfaMode :: Lens' UpdateBackendAuthMFAConfig (Maybe MFAMode) Source #

The MFA mode for the backend of your Amplify project.

UpdateBackendAuthOAuthConfig

updateBackendAuthOAuthConfig_socialProviderSettings :: Lens' UpdateBackendAuthOAuthConfig (Maybe SocialProviderSettings) Source #

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

updateBackendAuthOAuthConfig_domainPrefix :: Lens' UpdateBackendAuthOAuthConfig (Maybe Text) Source #

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

updateBackendAuthOAuthConfig_oAuthScopes :: Lens' UpdateBackendAuthOAuthConfig (Maybe [OAuthScopesElement]) Source #

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

updateBackendAuthOAuthConfig_oAuthGrantType :: Lens' UpdateBackendAuthOAuthConfig (Maybe OAuthGrantType) Source #

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

updateBackendAuthOAuthConfig_redirectSignOutURIs :: Lens' UpdateBackendAuthOAuthConfig (Maybe [Text]) Source #

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

updateBackendAuthOAuthConfig_redirectSignInURIs :: Lens' UpdateBackendAuthOAuthConfig (Maybe [Text]) Source #

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

UpdateBackendAuthPasswordPolicyConfig

updateBackendAuthPasswordPolicyConfig_additionalConstraints :: Lens' UpdateBackendAuthPasswordPolicyConfig (Maybe [AdditionalConstraintsElement]) Source #

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

updateBackendAuthPasswordPolicyConfig_minimumLength :: Lens' UpdateBackendAuthPasswordPolicyConfig (Maybe Double) Source #

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

UpdateBackendAuthResourceConfig

updateBackendAuthResourceConfig_identityPoolConfigs :: Lens' UpdateBackendAuthResourceConfig (Maybe UpdateBackendAuthIdentityPoolConfig) Source #

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

updateBackendAuthResourceConfig_authResources :: Lens' UpdateBackendAuthResourceConfig AuthResources Source #

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

updateBackendAuthResourceConfig_userPoolConfigs :: Lens' UpdateBackendAuthResourceConfig UpdateBackendAuthUserPoolConfig Source #

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

updateBackendAuthResourceConfig_service :: Lens' UpdateBackendAuthResourceConfig Service Source #

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

UpdateBackendAuthUserPoolConfig

updateBackendAuthUserPoolConfig_passwordPolicy :: Lens' UpdateBackendAuthUserPoolConfig (Maybe UpdateBackendAuthPasswordPolicyConfig) Source #

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

updateBackendAuthUserPoolConfig_mfa :: Lens' UpdateBackendAuthUserPoolConfig (Maybe UpdateBackendAuthMFAConfig) Source #

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

updateBackendAuthUserPoolConfig_forgotPassword :: Lens' UpdateBackendAuthUserPoolConfig (Maybe UpdateBackendAuthForgotPasswordConfig) Source #

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

updateBackendAuthUserPoolConfig_oAuth :: Lens' UpdateBackendAuthUserPoolConfig (Maybe UpdateBackendAuthOAuthConfig) Source #

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